- Contents
Interaction Scripter Developer's Guide
ChatObject
ChatObject manipulates chat objects. Chat objects are very similar to call objects. The source examples for call objects can be adapted for chat objects. The methods and properties supported by scripter.chatObject are listed below. Click on a link for information concerning input parameters and return values.
Methods
Disconnects the current chat session. |
|
Retrieves the value of the specified chat object attribute. |
|
Allows a CIC user to listen in on a chat. |
|
Pauses recording of the current chat session. |
|
Picks up (answers) a chat. |
|
Makes a chat private so it cannot be seen to or recorded by another CIC user. |
|
Records a chat. |
|
Sends a chat message to the remote party on behalf of the current user. |
|
Sets the value of specified chat object attribute. |
Callbacks
Name of the function to be called when an error occurs. Compatible with scripts for Scripter .NET Client or Interaction Connect. |
|
ChatObject.objectDestroyedHandler is invoked when the chat object is no longer valid. Compatible with scripts for Scripter .NET Client or Interaction Connect. |
|
Invoked when something changes about this chat object that is not generic to all chat objects. Compatible with scripts for Scripter .NET Client or Interaction Connect. |
|
Invoked when an error occurs with the chat object. Compatible with scripts for Scripter .NET Client or Interaction Connect. |
|
This handler is called when a chat object receives a new file. Compatible with scripts for Scripter .NET Client or Interaction Connect. |
|
This handler is called when a chat object receives a new URL. Compatible with scripts for Scripter .NET Client or Interaction Connect. |
|
This handler is invoked whenever the call state changes. Compatible with scripts for Scripter .NET Client or Interaction Connect. |
|
This method is called when a sub-object is affected by an event. Compatible with scripts for Scripter .NET Client or Interaction Connect. |
|
Allows a script to asynchronously get a chat attribute by first setting this callback and then calling the chatObject.getAttribute method. Use this callback only in scripts for Interaction Connect. |
|
Allows a script to start a chat after waiting asynchronously for a ChatObject to be created. Use this callback only in scripts for Interaction Connect. |
Properties
Returns the date and time that the chat object was created. |
|
Returns the direction of the chat (e.g. inbound, outbound, etc.). |
|
Assigns or returns the ID of the chat object. |
|
Indicates whether or not a chat is being listened to. |
|
Indicates whether recording of a chat has been paused. |
|
Indicates whether is in a private state, meaning that no one can monitor the chat. |
|
Indicates whether a chat is being recorded. |
|
Returns the text of the last error that occurred. This property is automatically cleared before each method or property call on this object. |
|
Returns the id of the last error that occurred. This property is automatically cleared before each method or property call on this object. |
|
Returns the Station Id of the CIC user associated with the chat. |
|
Returns the phone extension of the CIC station participating in a chat. |
|
Returns the name of the connected party in a chat object. |
|
Returns the registered name of the remote chat user. |
|
Returns an array of messages about a chat interaction after the chat object has been initialized. |
|
Returns the IP address of the chat user. |
|
Retrieves or sets the name of the chat user. |
|
Returns the numeric call state value for a chat object. This value indicates the current condition of the chat object. |
|
Returns or assigns the string value displayed in the State field of a queue (such as the "My Calls" queue). State strings describe the current condition of a chat object. |