Class Index
JavaScript class objects and methods to handle the subscription to Finesse events.
Allow clients to make Finesse API requests and consume Finesse events by
calling a set of exposed functions.
JavaScript class objects and methods to handle gadget container services.
This class provides container-level services for gadget developers, exposing container events by
calling a set of exposed functions.
This is the set of Topics used for subscribing for events from ContainerServices.
FinesseToaster is a utility class to show toaster
notification in Finesse.
JavaScript representation of a GadgetViewChangedEvent object.
JavaScript representation of a MaxAvailableHeightChangedEvent object.
JavaScript representation of a TimerTickEvent object.
JavaScript representation of a WorkflowActionEvent object.
This is the set of possible HandledBy values used for WorkflowActionEvent from ContainerServices.
Supports writing messages to a central log.
Allows gadgets to call the log function to publish client logging messages over the hub.
Namespace for JavaScript class objects and methods related to Digital Channel management.
Fi
nesse digital
channel state control (referred to as FNC elsewhere in this document)
is a programmable desktop component that was introduced in Finesse 12.0.
Fi
nesse digital
channel state control (referred to as FNC elsewhere in this document)
is a programmable desktop component that was introduced in Finesse 12.0.
The Config object for gadgets within the Finesse desktop container which
contains configuration data provided by the container page.
These interfaces are just a convenience for documenting common parameter structures.
This "interface" defines REST Object callback handlers, passed as an argument to
Object getter methods in cases where the Object is going to be created.
This "interface" defines REST Object callback handlers, passed as an argument to
Object getter methods in cases where the Object is going to be created.
JavaScript classes and methods that represent REST objects and collections.
JavaScript representation of a ChatConfig object.
A Contact is a single entry in a PhoneBook, consisting of a First and Last Name,
a Phone Number, and a Description.
JavaScript representation of a Contacts collection object.
A Dialog is an attempted connection between or among multiple participants,
for example, a regular phone call, a conference, or a silent monitor session.
Set of action constants for a Dialog.
Possible Dialog Participant State constants.
Possible dialog state reasons code constants.
Possible Dialog State constants.
A DialogBase is an attempted connection between or among multiple participants,
for example, a regular phone call, a chat, or an email.
Set of action constants for a Dialog.
Actions used to handle tasks that are associated with a given media at logout time.
JavaScript representation of a Dialogs collection object.
JavaScript representation of a ECCVariableConfig object.
The action to be taken in the event this media is interrupted.
A Media represents a non-voice channel,
for example, a chat or a email.
Possible Media state values.
A MediaDialog is an attempted connection between or among multiple participants,
for example, a chat or email.
Possible Dialog State constants.
Set of action constants for a Media Dialog.
JavaScript representation of a collection of Dialogs for a specific non-voice Media.
JavaScript representation of a MediaList collection object.
Utility class used to synchronize media login options after recovering from a connection or system failure.
Possible MediaOptionsHelper state values.
The MediaPropertiesLayout handles which call variables are associated with Dialogs.
Format of MediaPropertiesLayout Object.
A PhoneBook is a list of Contacts available to a User for quick dial.
JavaScript representation of a PhoneBooks collection object.
The Queue object represents a queue with uri, queue name, and statistics for that queue.
JavaScript representation of a Queues collection object.
Utility class for looking up a ReasonCode using the code and category.
JavaScript representation of a ReasonCodes collection object.
JavaScript representation of a REST object.
This is the base collection object.
JavaScript representation of a SystemInfo object.
SystemInfo status values.
JavaScript representation of a Team object.
JavaScript representation of a Team Not Ready ReasonCode object.
JavaScript representation of a TeamNotReadyReasonCodes collection object.
JavaScript representation of a TeamSignOutReasonCodes collection object.
The User represents a Finesse Agent or Supervisor.
Possible Agent Media States.
Possible User state values.
Possible Mobile Agent Work Mode Types.
Possible Wrap-up Mode Types.
JavaScript representation of a UserMediaPropertiesLayout collection object.
JavaScript representation of a UserMediaPropertiesLayouts collection object.
JavaScript representation of a Users collection object.
A WrapUpReason is a code and description identifying a particular reason that a
User is in WORK (WrapUp) mode.
JavaScript representation of a WrapUpReasons collection object.
ShortcutKeyService allows components or gadgets to create
shortcut keys for any component or gadget related actions.
RestCacheDataService allows gadgets to cache there data locally
in IndexedDB that can be available across the failover on the other side without even making
a REST call.
Utilities is collection of utility methods.
WorkflowService provides API consists of methods that would allow a gadgets to submit workflow task.