Class Index | File Index

Classes


Class LiveChatListener


Defined in: sdk.js.

Class Summary
Constructor Attributes Constructor Name and Description
 
Listener interface for a LiveChatConnection.
Method Summary
Method Attributes Method Name and Description
 
Notification that the connection was closed.
 
error(message)
An error message was received from the channel.
 
info(message)
An informational message was received from the channel.
 
message(message)
A user message was received from the channel.
 
updateUsers(usersCSV)
The channels users changed (user joined, left, etc.
 
updateUsersXML(usersXML)
The channels users changed (user joined, left, etc.
Class Detail
LiveChatListener()
Listener interface for a LiveChatConnection. This gives asynchronous notification when a channel receives a message, or notice.
Method Detail
closed()
Notification that the connection was closed.

error(message)
An error message was received from the channel. This could be an access error, or message failure.
Parameters:
message

info(message)
An informational message was received from the channel. Such as a new user joined, private request, etc.
Parameters:
message

message(message)
A user message was received from the channel.
Parameters:
message

updateUsers(usersCSV)
The channels users changed (user joined, left, etc.) This contains a comma separated values (CSV) list of the current channel users. It can be passed to the SDKConnection.getUsers() API to obtain the UserConfig info for the users.
Parameters:
usersCSV

updateUsersXML(usersXML)
The channels users changed (user joined, left, etc.) This contains a HTML list of the current channel users. It can be inserted into an HTML document to display the users.
Parameters:
usersXML

Documentation generated by JsDoc Toolkit 2.4.0 on Tue Oct 17 2017 14:11:30 GMT-0400 (EDT)