Cisco Cisco Computer Telephony Integration Option 9.0 Developer's Guide

Page of 508
   
8-25
CTI OS Developer’s Guide for Cisco Unified ICM/Contact Center Enterprise & Hosted
Release 8.0(1)
Chapter 8      Session Object
Methods
An output parameter (return parameter in VB) that contains an error code from 
 in 
Return Values
Default CTI OS return values. See 
Remarks
A successful RequestDesktopSettings request results in an OnGlobalSettingsDownloadConf event. For 
detailed information about the OnGlobalSettingsDownloadConf event, see 
.
SetAgent
The SetAgent method assigns an agent to this Session object. The agent object used as a parameter in 
this method should have the following properties set:
CTIOS_AGENTID
CTIOS_PERIPHERALID
To sign on a mobile agent, the following parameters must be set:
CTIOS_AGENTCALLMODE
CTIOS_AGENTREMOTENUMBER
Syntax
C++:
 int SetAgent(CAgent& agent)
COM:
 HRESULT SetAgent(/*[in]*/IAgent *agent, /*[out, retval]*/ int * errorcode)
VB:
 SetAgent (agent As CTIOSCLIENTLib.IAgent) As Long
Java:
 int SetAgent(Agent agentObject)
.NET:
 CilError SetAgent(Agent NewAgent)
Parameters
agent
The agent to be assigned to the Session object.
errorcode
An output parameter (return parameter in VB) that contains an error code from 
 in 
Return Values
If the SetAgent request is successful, it returns a CIL_OK CtiOs_Enums.CilError code and sends an 
OnSetAgentMode event to the client application.
In CTI OS Release 7.1(1) , the SetAgent request returns the following error codes:
CIL_FAIL - The request to authenticate failed. The SetAgent request will not be sent.