Contents

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

ChatObject.disconnect	Disconnects the current chat session.
ChatObject.getAttribute	Retrieves the value of the specified chat object attribute.
ChatObject.listen	Allows a CIC user to listen in on a chat.
ChatObject.pause	Pauses recording of the current chat session.
ChatObject.pickup	Picks up (answers) a chat.
ChatObject.private	Makes a chat private so it cannot be seen to or recorded by another CIC user.
ChatObject.record	Records a chat.
ChatObject.sendChatMessage	Sends a chat message to the remote party on behalf of the current user.
ChatObject.setAttribute	Sets the value of specified chat object attribute.

Callbacks

ChatObject.errorHandler	Name of the function to be called when an error occurs. Compatible with scripts for Scripter .NET Client or Interaction Connect.
ChatObject.ObjectDestroyedHandler	ChatObject.objectDestroyedHandler is invoked when the chat object is no longer valid. Compatible with scripts for Scripter .NET Client or Interaction Connect.
ChatObject.ObjectSpecificChangeHandler	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.
ChatObject.ObjectSpecificErrorHandler	Invoked when an error occurs with the chat object. Compatible with scripts for Scripter .NET Client or Interaction Connect.
ChatObject.ReceivedFileHandler	This handler is called when a chat object receives a new file. Compatible with scripts for Scripter .NET Client or Interaction Connect.
ChatObject.ReceivedURLHandler	This handler is called when a chat object receives a new URL. Compatible with scripts for Scripter .NET Client or Interaction Connect.
ChatObject.stateChangeHandler	This handler is invoked whenever the call state changes. Compatible with scripts for Scripter .NET Client or Interaction Connect.
ChatObject.SubObjectChangeHandler	This method is called when a sub-object is affected by an event. Compatible with scripts for Scripter .NET Client or Interaction Connect.
ChatObject.requestedAttributeReturnHandler	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.
ChatObject.chatObjectInitializedHandler	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

ChatObject.creationTime	Returns the date and time that the chat object was created.
ChatObject.direction	Returns the direction of the chat (e.g. inbound, outbound, etc.).
ChatObject.id	Assigns or returns the ID of the chat object.
ChatObject.isMonitored	Indicates whether or not a chat is being listened to.
ChatObject.isPaused	Indicates whether recording of a chat has been paused.
ChatObject.isPrivate	Indicates whether is in a private state, meaning that no one can monitor the chat.
ChatObject.isRecording	Indicates whether a chat is being recorded.
ChatObject.lastError	Returns the text of the last error that occurred. This property is automatically cleared before each method or property call on this object.
ChatObject.lastErrorId	Returns the id of the last error that occurred. This property is automatically cleared before each method or property call on this object.
ChatObject.localId	Returns the Station Id of the CIC user associated with the chat.
ChatObject.localLocation	Returns the phone extension of the CIC station participating in a chat.
ChatObject.localName	Returns the name of the connected party in a chat object.
ChatObject.remoteId	Returns the registered name of the remote chat user.
ChatObject.messages	Returns an array of messages about a chat interaction after the chat object has been initialized.
ChatObject.RemoteLocation	Returns the IP address of the chat user.
ChatObject.RemoteName	Retrieves or sets the name of the chat user.
ChatObject.state	Returns the numeric call state value for a chat object. This value indicates the current condition of the chat object.
ChatObject.stateString	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.