Salesforce Console Developer Guide

Salesforce Console Developer Guide
Lightning Console API
How are the Classic and Lightning Console APIs Different?
Lightning Console JavaScript API
Lightning Console JavaScript API Syntax
Using Background Utility Items
Using Pop-Out Utilities
Using Events with the Lightning Console JavaScript API
Using Page Context in the Utility Bar API
Using Page References to Open Console Workspace Tabs and Subtabs
Debugging
Methods
Events
lightning:tabClosed
lightning:tabCreated
lightning:tabFocused
lightning:tabRefreshed
lightning:tabReplaced
lightning:tabUpdated
Events for Chat
Events for Messaging
Events for Omni-Channel
lightning:omniChannelLoginSuccess
lightning:omniChannelStatusChanged
lightning:omniChannelLogout
lightning:omniChannelWorkAssigned
lightning:omniChannelWorkAccepted
lightning:omniChannelWorkDeclined
lightning:omniChannelWorkClosed
lightning:omniChannelWorkloadChanged
Salesforce Classic API
Other Resources
PDF

Newer Version Available

This content describes an older version of this product. View Latest

lightning:omniChannelWorkClosed

Indicates that an agent has closed a tab in the console that’s associated with a work item. When the tab is closed, the status of the AgentWork object associated with it automatically changes to Closed.

Response

Name Type Description
workItemId string The ID of the object that’s routed through Omni-Channel. This object becomes a work assignment with a workId when it’s assigned to an agent.
workId string The ID of a work assignment that’s routed to an agent.

Example

This example prints work details to the browser’s developer console when an Omni-Channel user closes a tab in the console that’s associated with a work item.

Component code:

Controller code: