Class Index | File Index

Classes


Class Index

_global_


finesse.clientservices

JavaScript class objects and methods to handle the subscription to Finesse events.

finesse.clientservices.ClientServices

Allow clients to make Finesse API requests and consume Finesse events by calling a set of exposed functions.

finesse.containerservices

JavaScript class objects and methods to handle gadget container services.

finesse.containerservices.ContainerServices

This class provides container-level services for gadget developers, exposing container events by calling a set of exposed functions.

finesse.containerservices.ContainerServices.Topics

This is the set of Topics used for subscribing for events from ContainerServices.

finesse.containerservices.FinesseToaster

FinesseToaster is a utility class to show toaster notification in Finesse.

finesse.containerservices.GadgetViewChangedEvent

JavaScript representation of a GadgetViewChangedEvent object.

finesse.containerservices.MaxAvailableHeightChangedEvent

JavaScript representation of a MaxAvailableHeightChangedEvent object.

finesse.containerservices.TimerTickEvent

JavaScript representation of a TimerTickEvent object.

finesse.containerservices.WorkflowActionEvent

JavaScript representation of a WorkflowActionEvent object.

finesse.containerservices.WorkflowActionEvent.HandledBy

This is the set of possible HandledBy values used for WorkflowActionEvent from ContainerServices.

finesse.cslogger

Supports writing messages to a central log.

finesse.cslogger.ClientLogger

Allows gadgets to call the log function to publish client logging messages over the hub.

finesse.gadget.Config

The Config object for gadgets within the Finesse desktop container which contains configuration data provided by the container page.

finesse.interfaces

These interfaces are just a convenience for documenting common parameter structures.

finesse.interfaces.RequestHandlers

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.

finesse.interfaces.RestObjectHandlers

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.

finesse.restservices

JavaScript classes and methods that represent REST objects and collections.

finesse.restservices.Contact

A Contact is a single entry in a PhoneBook, consisting of a First and Last Name, a Phone Number, and a Description.

finesse.restservices.Contacts

JavaScript representation of a Contacts collection object.

finesse.restservices.Dialog

A Dialog is an attempted connection between or among multiple participants, for example, a regular phone call, a conference, or a silent monitor session.

finesse.restservices.Dialog.Actions

Set of action constants for a Dialog.

finesse.restservices.Dialog.ParticipantStates

Possible Dialog Participant State constants.

finesse.restservices.Dialog.ReasonStates

Possible dialog state reasons code constants.

finesse.restservices.Dialog.States

Possible Dialog State constants.

finesse.restservices.DialogBase

A DialogBase is an attempted connection between or among multiple participants, for example, a regular phone call, a chat, or an email.

finesse.restservices.DialogLogoutActions

Actions used to handle tasks that are associated with a given media at logout time.

finesse.restservices.Dialogs

JavaScript representation of a Dialogs collection object.

finesse.restservices.InterruptActions

The action to be taken in the event this media is interrupted.

finesse.restservices.Media

A Media represents a non-voice channel, for example, a chat or a email.

finesse.restservices.Media.States

Possible Media state values.

finesse.restservices.MediaDialog

A MediaDialog is an attempted connection between or among multiple participants, for example, a chat or email.

finesse.restservices.MediaDialog.States

Possible Dialog State constants.

finesse.restservices.MediaDialog.TaskActions

Set of action constants for a Media Dialog.

finesse.restservices.MediaDialogs

JavaScript representation of a collection of Dialogs for a specific non-voice Media.

finesse.restservices.MediaDialogsSubscriptionManager

An internal class used to establish a Media/Dialogs subscription to be shared by MediaDialogs objects for non-voice dialog events.

finesse.restservices.MediaList

JavaScript representation of a MediaList collection object.

finesse.restservices.MediaOptionsHelper

Utility class used to synchronize media login options after recovering from a connection or system failure.

finesse.restservices.MediaOptionsHelper.States

Possible MediaOptionsHelper state values.

finesse.restservices.MediaPropertiesLayout

The MediaPropertiesLayout handles which call variables are associated with Dialogs.

finesse.restservices.MediaPropertiesLayout.Object

Format of MediaPropertiesLayout Object.

finesse.restservices.PhoneBook

A PhoneBook is a list of Contacts available to a User for quick dial.

finesse.restservices.PhoneBooks

JavaScript representation of a PhoneBooks collection object.

finesse.restservices.Queue

A Queue is a list of Contacts available to a User for quick dial.

finesse.restservices.Queues

JavaScript representation of a Queues collection object.

finesse.restservices.ReasonCodeLookup

JavaScript representation of a ReasonCodeLookup object.

finesse.restservices.ReasonCodes

JavaScript representation of a ReasonCodes collection object.

finesse.restservices.RestBase

JavaScript representation of a REST object.

finesse.restservices.RestCollectionBase

This is the base collection object.

finesse.restservices.SystemInfo

JavaScript representation of a SystemInfo object.

finesse.restservices.SystemInfo.Statuses

SystemInfo status values.

finesse.restservices.Team

A Team is a set of Agent Users, typically supervised by one or more Supervisor Users.

finesse.restservices.TeamNotReadyReasonCode

JavaScript representation of a Team Not Ready ReasonCode object.

finesse.restservices.TeamSignOutReasonCode

JavaScript representation of a TeamSignOutReasonCode object.

finesse.restservices.User

The User represents a Finesse Agent or Supervisor.

finesse.restservices.User.MediaStates

Possible Agent Media States.

finesse.restservices.User.States

Possible User state values.

finesse.restservices.User.WorkMode

Possible Mobile Agent Work Mode Types.

finesse.restservices.User.WrapUpMode

Possible Wrap-up Mode Types.

finesse.restservices.UserMediaPropertiesLayout

JavaScript representation of a UserMediaPropertiesLayout collection object.

finesse.restservices.UserMediaPropertiesLayouts

JavaScript representation of a UserMediaPropertiesLayouts collection object.

finesse.restservices.Users

JavaScript representation of a Users collection object.

finesse.restservices.WrapUpReason

A WrapUpReason is a code and description identifying a particular reason that a User is in WORK (WrapUp) mode.

finesse.restservices.WrapUpReasons

JavaScript representation of a WrapUpReasons collection object.

finesse.utilities.Utilities

Utilities is collection of utility methods.

Documentation generated by JsDoc Toolkit 2.3.2 on Mon Nov 06 2017 08:00:56 GMT-0500 (EST)