ui.chat.Config Class
Configuration for chat component
Item Index
Properties
Properties
authInfo
Object
A {{#crossLink "ui.AuthInfo"}}{{/crossLink}} object that specifies the authentication information.
modalities
Array
An array of modality objects (defined in the API Modalities module) returned by the Modalities API
theme
Object
A {{#crossLink "ui.theme.Config"}}{{/crossLink}} provides theme customization for a UI feature(The UI feature MUST support theme customization, otherwise this will be ignored)
uiInfo
Object
A {{#crossLink "ui.UIInfo"}}{{/crossLink}} object that describes how the UI component will be rendered.
Events
onClosed
Fired when chat session is closed
onError
Fired when an error occurs
onEstablished
Fires when the chat session is established
onMessage
Fired when a chat message is received
onQueued
Fires when chat request is queued
onQueueUpdated
Fires when chat queue status changes
onRejoinUrl
Fired when chat rejoin url is received
Event Payload:
-
data
StringUrl to rejoin the chat
onSignInRedirect
Fired when popu window redirects to login page
onSignInRequest
Fires when user sign-in is requested
Event Payload:
-
data
ArrayAn array that contains information for supported sign-in types. i.e. [{ type: "MSA", policy: "MBI_SSL" }, { type: "ADD" }]
onTransferred
Fired when chat is transferred
onUnloaded
Fired when the ui component is closed