Cisco Cisco Computer Telephony Integration Option 9.0 Developer's Guide

Page of 668
 
Chapter 9      Agent Object
Methods
9-44
CTI OS Developer’s Guide for Cisco ICM/IPCC Enterprise & Hosted Editions Release 7.1(1) 
SetAgentState
The SetAgentState method requests a new agent state. Login and Logout are valid 
agent states and can be set using the SetAgentState method as well as by using the 
Login and Logout methods.
Syntax
C++:
int SetAgentState(Arguments& args)
COM:
HRESULT SetAgentState (/*[in]*/ IArguments *args, 
/*[out,retval]*/ int * errorcode)
VB:
SetAgentState (args As CTIOSCLIENTLib.IArguments) As Long
Java:
int SetAgentState(Arguments args)
.NET:
CilError SetAgentState(Arguments args)
Input Parameters
args
Input parameter in the form of an Arguments array that contains one or more 
of the SetAgentState parameters listed in 
.
Table 9-14 SetAgentState Parameters 
Keyword
Type
Description
AgentState (required)
INT
The state to which to set the specified 
agent. The value of this field must be 
one of the values in 
AgentID (required)
STRING
*
The agent’s login ID.
AgentInstrument
STRING
*
The agent’s instrument number. 
Optional if Agent Extension is 
provided.
PositionID
STRING
*
Required for Alcatel only.
AgentPassword 
(optional)
STRING
*
The agent’s password.