Cisco Cisco Computer Telephony Integration Option 9.0 Developer's Guide

Page of 506
   
6-71
CTI OS Developer’s Guide for Cisco Unified Contact Center Enterprise
Release 8.5(1)
Chapter 6      Event Interfaces and Events
IAgentEvents Interface
Remarks
When PG failover occurs, it is possible that the client application will receive an OnPostLogout event 
with an EventReasonCode of CTIOS_IPCC_FORCED_LOGOUT_REASON_CODE. For example, this 
may happen on an Unified CCE system after reconnecting to a different server during a failover, because there 
is a race condition of the PG logging the agent out and the client reconnecting to the other server before it 
happens. If this happens, the client application should not disconnect from CTI OS Server.
OnPreLogout
The OnPreLogout event just before the agent is logged out. It allows for any cleanup or logic that needs 
to be done before logout is completed.
Syntax
C++:
 void OnPreLogout(Arguments& args)
COM:
void OnPreLogout (IArguments * args)
VB:
 session_OnPreLogout (ByVal args As CtiosCLIENTLib.IArguments)
Parameters
args
Arguments array containing the following fields.
Table 6-67
OnPreLogout Parameters
EnablementMask
INT
Contains the bit-mask that specifies what buttons can 
be enabled or disabled when the agent is on this state. 
UniqueObjectID
STRING
A unique object ID for the agent object.
AgentInstrument 
STRING
The agent’s ACD instrument number.
Keyword
Type
Description
Keyword
Type
Description
PeripheralID
INT
The Unified ICM PeripheralID of the ACD where the 
agent state change occurred.
PeripheralType
SHORT
The type of the peripheral.
AgentState
SHORT
One of the values in 
 representing the current 
overall state of the associated agent. 
SkillGroupNumber 
INT
The user-defined number of the agent SkillGroup 
affected by the state change, as known to the peripheral. 
May contain the special value NULL_SKILL_GROUP 
when not applicable or not available.