Class Index | File Index

Classes


Class finesse.gadget.Config

The Config object for gadgets within the Finesse desktop container which contains configuration data provided by the container page.
Defined in: finesse.js.

Class Summary
Constructor Attributes Constructor Name and Description
 
Field Summary
Field Attributes Field Name and Description
 
The base64 encoded "id:password" string used for authentication.
 
The auth token string used for authentication in SSO deployments.
 
The drift time between the client and the server in milliseconds.
 
The client compatibility mode configuration (true if it is or false otherwise).
 
The country code of the client (derived from locale).
 
The extension of the user.
 
The Finesse server IP/host as reachable from the browser.
 
The Finesse server host's port reachable from the browser.
 
The language code of the client (derived from locale).
 
The locale of the client.
 
The localhost fully qualified domain name.
 
The localhost port.
 
The dial number to use for mobile agent, or something false (undefined) for a normal login.
 
One of the work modes found in finesse.restservices.User.WorkMode, or something false (undefined) for a normal login.
 
The peripheral Id that Finesse is connected to.
 
The pub sub domain where the pub sub service is running.
 
The Finesse API IP/host as reachable from the gadget container.
 
The type of HTTP protocol (http or https).
 
The auth mode of the finesse deployment.
 
The id of the team the user belongs to.
 
The name of the team the user belongs to.
 
The time for which fineese toaster stay on the browser.
 
The domain of the XMPP server.
Class Detail
finesse.gadget.Config()
Field Detail
authorization
The base64 encoded "id:password" string used for authentication. In case of SPOG container, the credentials will not be there in browser session storage so it will be taken from the gadget prefs. Since 12.5 (CSCvs38506): SPOG will be using 'credentials' as user pref. Keeping 'authorization' for backward compatibility

authToken
The auth token string used for authentication in SSO deployments.

clientDriftInMillis
The drift time between the client and the server in milliseconds.

compatibilityMode
The client compatibility mode configuration (true if it is or false otherwise).

country
The country code of the client (derived from locale).

extension
The extension of the user.

host
The Finesse server IP/host as reachable from the browser.

hostPort
The Finesse server host's port reachable from the browser.

language
The language code of the client (derived from locale).

locale
The locale of the client.

localhostFQDN
The localhost fully qualified domain name.

localhostPort
The localhost port.

mobileAgentDialNumber
The dial number to use for mobile agent, or something false (undefined) for a normal login.

mobileAgentMode
One of the work modes found in finesse.restservices.User.WorkMode, or something false (undefined) for a normal login.

peripheralId
The peripheral Id that Finesse is connected to.

pubsubDomain
The pub sub domain where the pub sub service is running.

restHost
The Finesse API IP/host as reachable from the gadget container.

scheme
The type of HTTP protocol (http or https).

systemAuthMode
The auth mode of the finesse deployment.

teamId
The id of the team the user belongs to.

teamName
The name of the team the user belongs to.

toasterNotificationTimeout
The time for which fineese toaster stay on the browser.

xmppDomain
The domain of the XMPP server.

Documentation generated by JsDoc Toolkit 2.3.2 on Thu Jan 02 2020 09:55:47 GMT-0500 (EST)