Newer Version Available

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

logout

Logs an agent out of Omni-Channel. Available in API versions 32.0 and later.

Syntax

1sforce.console.presence.logout((optional) callback:function)

Arguments

Name Type Description
callback function JavaScript method to call when the agent is logged out of Omni-Channel.

Sample Code–Visualforce

1<apex:page>
2    <apex:includeScript value="/support/console/46.0/integration.js"/>
3    <a href="#" onClick="testLogout();return false;">Log out of Omni-Channel</a> 
4
5    <script type="text/javascript">
6        function testLogout() {
7            sforce.console.presence.logout(function(result) { 
8                if (result.success) { 
9                    alert('Logout successfully');
10                } else {
11                    alert('Logout failed');
12                }
13           }); 
14        }
15    </script>
16</apex:page>

Response

This method is asynchronous so it returns its response in an object in a callback method. The response object contains the following properties:

Name Type Description
success Boolean true if the logout was successful; false if the logout wasn’t successful.