Supported Events
The events generated by the UI Events Framework are classified into the following divisions:
- Controllable Events
- Non Controllable Events
Controllable Events
You've the option of canceling or deferring these events for a certain period of time.
| Event | Context | Notes |
|---|---|---|
| OnBeforeSave | RecordContext | This event is fired before firing the API request to commit the data to the server. End-users can do asynchronous operations in this callback or Cancel this event. This event can wait for an asynchronous operation to be completed. |
| onToolbarAgentCommand | PhoneContext | During a phone call scenario, if users want to control this
event by either resolving or rejecting it, they must pass a
promise as the return of this event callback function. On
notification of this event subscription, the user can check the
command, for example, getActiveInteractionCommands, in the event
response and pass outData for that command by resolving the
promise with that outData. The event subscription should be
added only once, during initialization of the MCA code. The user will get this event notification only once for a session. |
| onToolbarInteractionCommand | PhoneContext | During a phone call scenario if users want to control this
event by either resolving or rejecting it, they must pass a
promise as the return of this event callback function. On
notification of this event subscription, the user can check the
command in the event response. Commands supported are, accept,
disconnect, reject, setActive. These commands corresponds to
accept disconnect reject operations agent might make in the
Fusion application. The user can wire up their logic for each of these commands, on the callback of this event response. |
| OnBeforeMessageSend | RecordContext |
This event will be fired before firing the REST API request to send message to recipients, from the Compose Message smart action. The user should can perform asynchronous operations in this callback and allow or cancel this message send process. This means, this event can wait for an asynchronous operation to be completed. |
Non Controllable Events
You can't control these events in the same way that you can control controllable events. These events are similar to notification events as that notify the client when an event occurs in the application in a fire and forget mechanism.
| Events | Context | Notes |
|---|---|---|
| TabOpen | GlobalContext | This event will be fired when a browser tab or MSI tab gets opened with the fusion application. |
| TabClose | GlobalContext | This event will be fired when a browser tab or MSI tab gets closed with the fusion application. |
| TabChange | GlobalContext | This event will be fired when a browser tab or MSI tab happens with the fusion application. |
| CustomEvent | GlobalContext TabContext RecordContext |
This event can be used to support any business specific custom events. |
| ContextOpen | TabContext | This event will be fired when an object is opened in UI. For example: SR open. |
| DataLoad | RecordContext | This event will be fired when data is loaded. For example, after fetching a SR object data. |
| ContextClose | TabContext | This event will be fired when an object is closed in UI. For example, SR close. |
| FieldValueChange | RecordContext | This event will be fired when a field value change occurs. For example, SR title field change. |
| OnAfterSave | RecordContext | This event will be fired after saving a open object in UI. For example, After saving an SR. |
| SidePaneOpen | SidePaneContext | This event will be fired when a SidePane is opened. |
| SidePaneClose | SidePaneContext | This event will be fired when a SidePane is closed. |
| onDataUpdated | PhoneContext | This event is used to listen to a DataUpdate event that happens in Fusion application during a phone call scenario. |
| onOutgoingEvent | PhoneContext | This event is used to listen to an outBound call event that happens in Fusion application. |
| OnAfterMessageSen | RecordContext | This event is a notify event which will be fired after successfully sending message to recipients from Compose Message Smart Action. |
| NotificationClose | NotificationContext | This event will be fired when a Notification is closed. |
| NotificationAction | NotificationContext | This event will be fired when a Notification's action button click. |
| WindowClose | ModalWindowContext | This event will be fired when a Modal or dialog box is closed. |
Supported Operations
| Operation | Context | Notes |
|---|---|---|
| disableFeature | PhoneContext | Informs the Fusion application that a subset of available functionality must be disabled because the toolbar hasn't implemented it. |
| agentStateEvent | PhoneContext | Notifies the Fusion application of a change in the user's signed in or availability status for the specified channel |
| readyForOperation | PhoneContext | Notifies the Fusion application that the toolbar is ready for operation. |
| outboundCommError | PhoneContext | The toolbar can publish this API to notify Fusion Application that an error occurred during initiation of the outbound event. The error occurs if the identifier of the event, such as phone number, or email can't be used to establish a connection. |
| CustomEvent | GlobalContextTab TabContext Record Context |
This event can be used to support any business specific custom events. |
| closeCommEvent | PhoneContext | This action is required to publish in a call decline
scenario. When an agent clicks Decline on a call notification,
the CTI integration code base receives a notification for the
onAgentInteractionCommand event with command as
declineif it has a subscription added for
the same. |
| startCommEvent | PhoneContext | This action is required to publish when there's a call scenario in the newCommEvent. For example, in an inbound call scenario, a user side listens for onToolbarInteractionCommand and when a notification is received with the command as accept the user publishes this action to establish that call connection. |
| newCommEvent | PhoneContext | This action is required to publish when there's a ring received scenario. For example, when a user is trying to call an agent, the Fusion application should show a notification with the Accept or Decline Button. To enable this, the MCA integrated CTI should publish a newCommEvent request. |
| SetComposeMessageData | RecordContext | This operation is used to set the message data of the Compose Message Action panel which is opened through compose smart actions available on a record. It enables a user to set CC, BCC , To , Message Subject and Message Body of the compose message action panel. It also allows users to set custom fields, in the compose action panel, if they've been added through extensibility. |
| CloseModal | ModalWindowContext TabContext |
To close a modal window. |
| Close Notification | NotificationContext | To close a Notification. |
| CloseTab | TabContext | To close a particular MSI tab or browser tab. |
| ClosePopup | ModalWindowContext TabContext |
To close a dialog box. |
| ExpandSidePane | SidePaneContext | To expand a SidePane. |
| GetFieldValue | RecordContext | To fetch the current value of a field. For example, to get the current value of the Title field of an SR. |
| GetAgentInfo | GlobalContext TabContext |
To fetch the information about current logged in user. |
| FocusTab | TabContext | To focus a particular MSI tab or browser tab. |
| getConfiguration | PhoneContext | To get configuration information that enables the toolbar to evaluate the features supported by the Fusion application. |
| InvokeServiceConnection | GlobalContext | To call a service defined in application and fetch its response. |
| OpenModal | ModalWindowContext TabContext |
To open a modal window. |
| PopOperation | GlobalContext TabContext |
To open a new browser tab or MSI tab or any custom page in any desired tab. |
| OpenPopup | ModalWindowContext TabContext |
To open a dialog box. |
| Save Record | RecordContext | To save an open record. For example, save an SR form from edit page or save an SR from the create form. |
| Show Notification | NotificationContext | To show a notification. |
| UpdateSidePane | SidePaneContext | To update an existing side pane (setVisibility, setIcon and setSectionId) |
| SetFieldValue | RecordContext | To update the value of a particular field. For example, update the Title field of an SR. |
| CollapseSidePane | SidePaneContext | To collapse a SidePane |
| SetChannelAvailability | GlobalContext | Enabled or disable the phone icon. |
| SetToolbarProperties | PhoneContext | To set the dimensions of toolbar. |
| ExecuteSmartAction | SmartActionContext | To execute a SmartAction. |