ChatConfig
Class finesse.restservices.ChatConfig
Represents the ChatConfig object and exposes methods to operate on the object against the server. The ChatConfig object is a container element that holds the Cisco Finesse chat configuration and URLs of the primary and secondary chat servers.
Field Details
Name |
Description |
---|---|
supportsSubscriptions |
Determines whether the object supports subscriptions. For more information, see Subscription Support. |
Methods
get()
Retrieves the ChatConfig settings.
Returns
{finesse.restservices.ChatConfig}
The ChatConfig object.
getPrimaryNode()
Retrieves the primary node of the chat server.
Returns
{String}
The primary node of the chat server.
getRestClass()
Retrieves the REST class for the ChatConfig object.
getRestType()
Retrieves the REST type for the ChatConfig object.
getRestUrl()
Retrieves the URL for the ChatConfig resource.
Returns
{String}
The URL for the ChatConfig resource.
getSecondaryNode()
Retrieves the secondary node (if any) of the chat server.
Returns
{String}
The secondary node of the chat server.
update(chatSettings, handlers)
Updates the chat configuration settings.
Parameters
Name |
Type |
Description |
Required |
---|---|---|---|
chatSettings |
Object |
The chat server settings which you want to configure. |
Yes |
handlers |
Object |
An object containing the handlers for the request. For more information on handlers, see Request Handlers. |
Optional |
Returns
{finesse.restservices.ChatConfig}
The ChatConfig object.