Cisco Cisco Computer Telephony Integration OS 8.5 Guide Du Développeur
3-9
CTI OS Developer’s Guide for Cisco Unified Contact Center Enterprise
Release 8.5(1)
Chapter 3 CIL Coding Conventions
UniqueObjectID
String sID = args.GetValueString(CtiOs_IkeywordIDs.CTIOS_AGENTID);
Integer IPeriph = args.GetValueIntObj(CtiOs_IkeywordIDs.CTIOS_PERIPHERALID);
if (IPeriph == null)
// Error accessing Peripheral ID! Handle Error here
else
iPeriph = IPeriph.intValue();
CTI OS defines a set of well-known keywords for event parameters and properties. The well-known
keywords are of type string and are listed throughout this document with the methods and events for
which they are valid. The complete set of valid keywords are listed in the C++ header file,
ctioskeywords.h, and are provided in the COM (Visual Basic) type library as well. Java CIL keywords
are listed in the Javadoc in the description of the CtiOs_IKeywordIDs interface.
keywords are of type string and are listed throughout this document with the methods and events for
which they are valid. The complete set of valid keywords are listed in the C++ header file,
ctioskeywords.h, and are provided in the COM (Visual Basic) type library as well. Java CIL keywords
are listed in the Javadoc in the description of the CtiOs_IKeywordIDs interface.
Setting Object Properties and Request Parameters with SetValue
The CIL also provides an extensible mechanism to set properties on CTI OS Client Interface Objects.
The SetValue mechanism, available on the CIL Interface Objects (as well as the CTI OS Arguments
class), enables setting properties of any known type to the object as a key-value pair.
The SetValue mechanism, available on the CIL Interface Objects (as well as the CTI OS Arguments
class), enables setting properties of any known type to the object as a key-value pair.
SetValue, similar to GetValue and AddItem, supports string keywords and enumerated names:
// C++
Agent a;
a.SetValue(“AgentID”, “22866”);
a.SetValue(CTIOS_AGENTID, “22866”); // alternative
a.SetValue(ekwAgentID, “22866”); // alternative
‘Visual Basic
Dim a As Agent
a.SetValue “AgentID”, “22866”
//Java. Note use of the CTIOS_AGENTID version of keywords.
String sAgentID = “22866”;
Args.SetValue(“AgentID”, sAgentID);
Args.SetValue(CtiOs_IkeywordIDs.CTIOS_AGENTID, sAgentID); // alternative
Args.SetValue(ekwAgentID, sAgentID);
The complete syntax and usage of the GetValue, AddItem, and SetValue methods is detailed in
The Arguments structure is detailed in
UniqueObjectID
The CTI OS Server creates and manages the CTI OS objects, representing all interactions for the contact
center. The CTI OS Server and CIL use the UniqueObjectID field to match up a CTI OS object on the
CIL with the corresponding object on the Server.
center. The CTI OS Server and CIL use the UniqueObjectID field to match up a CTI OS object on the
CIL with the corresponding object on the Server.
The UniqueObjectID is a variable-length string which can uniquely identify the object within the current
context of the CTI OS Server and the Unified ICME and CTI Interlink Advanced. The UniqueObjectID
is composed of an object type (e.g. call, agent, skillgroup, etc.), and two or more additional identifying
fields.
context of the CTI OS Server and the Unified ICME and CTI Interlink Advanced. The UniqueObjectID
is composed of an object type (e.g. call, agent, skillgroup, etc.), and two or more additional identifying
fields.
explains the composition of the UniqueObjectID.