The CTI OS Client Interface Library uses the Arguments structure to pass key-value pairs between the client and the server (for more information about Arguments, see Helper Classes). Throughout this document all event and method parameter lists, as well as object properties, are listed with the keywords and the types associated with those keywords.
The expected (required and optional) keywords are referred to in this document by string name. For example, the Agent's property for agent identifier is referred to as AgentID.
In addition to using the string name for a keyword, programmers can take advantage of an enumeration of keywords as well.
The enumeration of keywords is presently only available in the C++ CIL.
For each string keyword, a corresponding enumerated keyword exists. The enumerated keyword is the same name, preceded by the prefix "ekw". For example, the AgentID string keyword is mapped to the enumerated keyword ekwAgentID.
Usage Example in C++:
Arguments& args = Arguments::CreateInstance(); args.AddItem(ekwAgentID, "22866"); args.AddItem(ekwAgentInstrument, "23901"); pAgent->Login(args); args.Release();
The complete set of standard keywords used in CTI OS is available in the C++ header file "ctioskeywords.h", located in the \Distribution\cpp\Include directory on the CTI OS toolkit media.
Java CIL Keywords
For Java CIL, the CtiOs_IKeywordIDs interface contains a list of known Java CIL CTI OS keywords. For more information, see the Java CIL Javadoc file.
.NET CIL Keywords
The Cisco.CtiOs.Util.Keywords.Enum_CtiOs enum contains the list of CTI OS keyword IDs.