Note: This release is in preview. Features described here don’t become generally available until the latest general availability date that Salesforce announces for this release. Before then, and where features are noted as beta, pilot, or developer preview, we can’t guarantee general availability within any particular time frame or at all. Make your purchase decisions only on the basis of generally available products and features.

lightning:omniChannelLogout

Indicates that an agent has logged out of Omni-Channel.

Response

Name	Type	Description
reason	string	The reason why the agent is logged out. Possible values are: DuplicateLogin DuplicateLoginInSameBrowser MaintenanceLogout OmniSupervisorLogout

Example

This example prints a line to the browser’s developer console when an Omni-Channel user logs out of Omni-Channel.

Component code:

1<aura:component implements="flexipage:availableForAllPageTypes" access="global" >
2    <lightning:omniToolkitAPI aura:id="omniToolkit" />  
3    <aura:handler event="lightning:omniChannelLogout" action="{! c.onLogout }"/>
4</aura:component>

Controller code:

1({
2    onLogout : function(component, event, helper) {
3        console.log("Logout success.");
4        var reason = event.getParam('reason');
5        console.log(reason);
6    }, 
7})

Salesforce Console Developer Guide

lightning:omniChannelLogout

Response

Example