Gadget Configuration

Class finesse.gadget.Config

Provides configuration data from the container page for the gadgets Config object in the Finesse desktop. When Finesse desktop load successfully, the container loads configuration details from the server. While creating gadgets, these configurations are passed to the gadgets as finesse.gadget.Config object. For more information on gadgets.

Field Details

Field

Description

authorization

The Base64 encoded "id:password" that can be used for non-SSO authentication by the gadget to make Finesse REST API requests.

authToken

The token used for authentication in SSO deployments.

clientDriftInMillis

The time difference between the client and the server in milliseconds.

compatibilityMode

The configuration of the client compatibility mode. This field is used to display a message to the user or handle compatibility mode use cases in the gadget.

The compatibility mode in Internet Explorer is a feature that helps you to view webpages that were designed for the previous versions of the browser. Enabling this feature affects the newer sites that were designed for modern browsers.

country

The country code of the client derived from the locale.

extension

The extension with which the user signs in.

host

The Finesse server IP address or host.

hostPort

The connections and listening port of the Finesse server host.

id

The unique identifier of the signed-in agent, which is used to uniquely identify an agent using the Cisco Finesse REST API URI and in the desktop notifications.

language

The language code of the client derived from the locale.

locale

The locale of the client.

localhostFQDN

The fully qualified domain name of the local host.

localhostPort

The connections and listening port of the local host.

mobileAgentDialNumber

The phone number that the system calls to connect with the mobile agent.

mobileAgentMode

The work mode of the mobile agent that is found in finesse.restservices.User.WorkMode.

peripheralId

Unique identifier of the CTI server peripheral that Finesse is connected to.

pubsubDomain

The pub sub domain of the XMPP service where the pub subservice is running.

restHost

The IP address or host of the Finesse API.

scheme

The type of HTTP protocol (http or https).

skillTargetId

Unique identifier for the skill target assigned to the user in the Unified CCE Database. It is supported from Cisco Finesse, Release 12.5(1) ES2 onwards.

Note

This is only supported for Unified CCE deployments.

systemAuthMode

The system authorization mode of the Finesse deployment.

teamId

Unique identifier of the team that the user belongs to.

teamName

The name of the team that the user belongs to.

toasterNotificationTimeout

The duration in seconds, the Cisco Finesse toaster notification remains opened.

xmppDomain

The domain of the XMPP service.