Salesforce Console Developer Guide

Clouds with binary code floating aboveCloud with binary code floating above

No Results

Search Tips:

  • Please consider misspellings
  • Try different search keywords
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
Use Page Context in the Utility Bar API
Using Page References to Open Console Workspace Tabs and Subtabs
Debugging
Methods
Methods for Navigation Items
Methods for Workspace Tabs and Subtabs
Methods for the Utility Bar
LWC Methods for Enhanced Messaging
Aura Methods for Enhanced Messaging
Methods for Chat
Methods for Omni-Channel
acceptAgentWork()
closeAgentWork()
declineAgentWork()
getAgentWorkload()
getAgentWorks()
getServicePresenceStatusChannels()
getServicePresenceStatusId()
login()
logout()
lowerAgentWorkFlag()
raiseAgentWorkFlag()
setServicePresenceStatus()
Events
Salesforce Classic API
Other Resources
PDF

logout for Lightning Experience

Logs an agent out of Omni-Channel.

Sample Code

Component code:

<aura:component implements="flexipage:availableForAllPageTypes" access="global" >
    <lightning:omniToolkitAPI aura:id="omniToolkit" />
    <lightning:button label="Logout" onclick="{! c.logout }" />
</aura:component>

Controller code:

({
    logout: function(cmp, evt, hlp) {
        var omniAPI = cmp.find("omniToolkit");
        omniAPI.logout().then(function(result) {
            if (result) {
                console.log("Logout successful");
            } else {
                console.log("Logout failed");
            }
        }).catch(function(error) {
            console.log(error);
        });
    }
})

Response

This method returns a promise that, upon success, resolves to true and is rejected on error.