Class Index | File Index

Classes


Class WebLiveChatListener


Defined in: sdk.js.

Class Summary
Constructor Attributes Constructor Name and Description
 
The WebLiveChatListener provides an integration between a LiveChatConnection and an HTML document.
Field Summary
Field Attributes Field Name and Description
 
Configure the chat to auto accept a bot after waiting
 
Allow the chat box background color to be set.
 
Set if the back link should be displayed.
 
Variables used to get the user and bot images.
 
Set the location of the button and box, one of "bottom-right", "bottom-left", "top-right", "top-left".
 
Print response in chat bubble.
 
Set the caption for the button bar button.
 
Set if the box chat log should be shown.
 
Configure message log format (table or log).
 
Box chat chat room option.
 
Allow the chat box button color to be set.
 
Provide an email chat log menu item.
 
Configure if chat should be given focus after message.
 
Set styles explicitly to avoid inheriting page styles.
 
Chat box height.
 
Allow the chat box hover button color to be set.
 
Link to online user list users to their profile page.
 
Box chat loading message to display.
 
Chat box offset from side.
 
Box chat show online users option.
 
Override the URL used in the chat box popup.
 
Element id and class prefix.
 
Prompt for name/email before connecting.
 
Ask the user if they want an email of the chat log on close.
 
Show Box Max
 
Allow the close button on the box button bar to be removed, and maximize on any click to the button bar.
 
Show and hides menu bar
 
Show Send Image
 
JSON object of all currently logged in users in the chat room take from updateUsersXML.
 
Allow the user to modify style sheets.
 
Chat Button Vertial Offset
 
Chat box width.
Method Summary
Method Attributes Method Name and Description
 
 
boot()
 
 
Close the embedding div in the current webpage.
 
Notification that the connection was closed.
 
Check contact info and connect.
 
Create an embedding bar and div in the current web page.
 
error(message)
An error message was received from the channel.
 
exit()
 
Increase the size of the video element for the userid.
 
flag(user)
 
info(message)
An informational message was received from the channel.
 
Search for link using .
 
Maximize the embedding div in the current webpage.
 
message(message)
A user message was received from the channel.
 
Minimize the live chat embedding box.
 
Minimize the contact info box.
 
Minimize the email chat log confirm dialog.
 
muteAudio(user)
Mute the audio for the userid.
 
muteVideo(user)
Mute the video for the userid.
 
 
ping()
 
Create a popup window live chat session.
 
pvt(user)
 
 
 
Minimize the email chat log confirm dialog.
 
 
 
Decrease the size of the video element for the userid.
 
 
 
 
 
updateUsers(usersCSV)
The channels users changed (user joined, left, etc.
 
updateUsersXML(usersXML)
The channels users changed (user joined, left, etc.
 
whisper(user)
Class Detail
WebLiveChatListener()
The WebLiveChatListener provides an integration between a LiveChatConnection and an HTML document. It updates the document to message received from the connection, and sends messages from the document's form. The HTML document requires the following elements: - chat - chat text input for sending messages - send - button for sending chat input - response -

paragraph for last chat message - console -

table for chat log, and user log - scroller -
div for chat log scroll pane - online -
table for chat user list
Field Detail
autoAccept
Configure the chat to auto accept a bot after waiting

background
Allow the chat box background color to be set.

backlink
Set if the back link should be displayed.

botThumb
Variables used to get the user and bot images.

boxLocation
Set the location of the button and box, one of "bottom-right", "bottom-left", "top-right", "top-left".

bubble
Print response in chat bubble.

caption
Set the caption for the button bar button.

chatLog
Set if the box chat log should be shown.

chatLogType
Configure message log format (table or log).

chatroom
Box chat chat room option.

color
Allow the chat box button color to be set.

emailChatLog
Provide an email chat log menu item.

focus
Configure if chat should be given focus after message.

forceStyles
Set styles explicitly to avoid inheriting page styles. Disable this to be able to override styles.

height
Chat box height.

hoverColor
Allow the chat box hover button color to be set.

linkUsers
Link to online user list users to their profile page.

loading
Box chat loading message to display.

offset
Chat box offset from side.

online
Box chat show online users option.

popupURL
Override the URL used in the chat box popup.

prefix
Element id and class prefix. Can be used to have multiple avatars in the same page, or avoid naming collisions.

promptContactInfo
Prompt for name/email before connecting.

promptEmailChatLog
Ask the user if they want an email of the chat log on close.

showBoxmax
Show Box Max

showClose
Allow the close button on the box button bar to be removed, and maximize on any click to the button bar.

showMenubar
Show and hides menu bar

showSendImage
Show Send Image

users
JSON object of all currently logged in users in the chat room take from updateUsersXML.

version
Allow the user to modify style sheets.

verticalOffset
Chat Button Vertial Offset

width
Chat box width.
Method Detail
accept()

boot()

clear()

closeBox()
Close the embedding div in the current webpage.

closed()
Notification that the connection was closed.

contactConnect()
Check contact info and connect.

createBox()
Create an embedding bar and div in the current web page.

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

exit()

expandVideo(user)
Increase the size of the video element for the userid.
Parameters:
user

flag(user)
Parameters:
user

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

linkChatPostbacks(node)
Parameters:
node

maximizeBox()
Maximize the embedding div in the current webpage.

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

minimizeBox()
Minimize the live chat embedding box.

minimizeContactInfoBox()
Minimize the contact info box.

minimizeEmailChatLogBox()
Minimize the email chat log confirm dialog.

muteAudio(user)
Mute the audio for the userid.
Parameters:
user

muteVideo(user)
Mute the video for the userid.
Parameters:
user

normalMode()

ping()

popup()
Create a popup window live chat session.

pvt(user)
Parameters:
user

sendAttachment()

sendEmailChatLog()

sendEmailChatLogBox()
Minimize the email chat log confirm dialog.

sendImage()

sendMessage()

shrinkVideo(user)
Decrease the size of the video element for the userid.
Parameters:
user

spyMode()

toggleChime()

toggleKeepAlive()

toggleSpeak()

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

whisper(user)
Parameters:
user

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