Cisco Cisco Computer Telephony Integration Option 9.0 Developer's Guide

Page of 546
C H A P T E R
 
12-1
Cisco ICM Software CTI OS Developer’s Guide Release 6.0(0)
 
12
Helper Classes
The CTI OS Client Interface Library make extensive use of several custom data 
structures. This chapter describes the CTI OS Helper Classes (data structures). 
The following helper classes are distributed with the Client Interface Library:
Arg. The Arg structure is the basic data type used in the CIL for any parameter 
included in methods or events. Objects of this type allow the CIL to be fully 
extensible and reusable. Arg supports many useful types including string, 
integer, Boolean, and Arguments array. Arg is the base class for the Arguments 
class. In most programming scenarios, programmers will not use Arg directly, 
but indirectly through the Arguments class.
Arguments. The Arguments structure is used to maintain and send a set of 
key-value pairs between the CIL and CTI OS Server for events and requests. 
The Arguments array elements must all be of type Arg. The Arguments 
structure enables future growth of the CTI OS feature set, without requiring 
changes to the method call signature. 
CilRefArg. The CilRefArg class is a specialized subclass of Arg. It is used to 
store a reference to an object derived from CCtiOsObject (C++ only). For 
instance, it can hold reference to a CAgent, CCall, CSkillGroup, 
CCtiOsSession, or CWaitObject.
CCtiosException. The CCtiosException class is used by CTIOS to provide 
detailed information when an exception occurs (C++ and Java only). When an 
exception is caught as CCtiosException, the programmer can query it for 
details such as error codes and error messages.