Container Services Topics

Class finesse.containerservices.ContainerServices.Topics

Set of topics used for subscribing events from ContainerServices. The method to subscribe to topics is finesse.containerservices.ContainerServices.containerServices.addHandler();. For more information, see addHandler(topic, callback).

Field Details

Topic Name

Description

ACTIVE_CALL_STATUS_EVENT

Listens to an active call event. Callback is invoked when an agent voice state changes from Ready or Not Ready to any other non-callable state or vice versa.

There are two types of responses:

  • Active call—ActiveCallStatusEvent {status: true, type: "info"}

  • End or inactive call—ActiveCallStatusEvent {status: false, type: "info"}

ACTIVE_TAB

Listens to changes to the active tab. Callback is invoked when the tab containing the gadget becomes active.

The method to use when the gadget is in the active tab finesse.containerservices.ContainerServices.makeActiveTabReq()

FINESSE_MAINTENANCE_MODE_EVENT

Listens to notifications related to Finesse maintenance mode changes. Callback is invoked when the desktop migration is scheduled or about to happen. Callback contains the status of the maintenance. For more information see the section Maintenance Mode

There are two types of statuses:

  • SCHEDULED: Notified when the migration is scheduled by the Cisco Finesse server.

  • MIGRATING: Notified that the agent is migrating after 15 seconds.

GADGET_VIEW_CHANGED_EVENT

Listens to changed events of the gadget view. Callback is invoked when a gadget view changes.

There are two types of views:

  • Default (set by the developer)

  • Canvas (full-screen view)

The callback passes finesse.containerservices.GadgetViewChangedEvent.

For more information, see Finesse Desktop Gadget Development section in Cisco Finesse Web Services Developer Guide at https://developer.cisco.com/docs/finesse/#!rest-api-dev-guide.

TIMER_TICK_EVENT

Listens to the TimerTick event. Callback is invoked when this event is run. Cisco Finesse publishes TimerTickEvent to OpenAjax hub every 1000 milliseconds.

The callback passes finesse.containerservices.TimerTickEvent.

For more information, see Finesse Container Timer section in Cisco Finesse Web Services Developer Guide at https://developer.cisco.com/docs/finesse/#!rest-api-dev-guide.

WORKFLOW_ACTION_EVENT

Listens to workflow action traffic events. When the trigger and the conditions defined for a workflow are completed, then a workflow action event is published, which is used to run the workflow action.

The callback passes finesse.containerservices.WorkflowActionEvent.

For more information, see Workflow Action Event section in Cisco Finesse Web Services Developer Guide at https://developer.cisco.com/docs/finesse/#!rest-api-dev-guide.