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

1swfobject.registerObject("clippy.codeblock-1", "9");
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17<apex:page>
18    <apex:includeScript value="/support/console/32.0/integration.js"/>
19    <a href="#" onClick="testLogout();return false;">Log out of Omni-Channel</a> 
20
21    <script type="text/javascript">
22        function testLogout() {
23            sforce.console.presence.logout(function(result) { 
24                if (result.success) { 
25                    alert('Logout successfully');
26                } else {
27                    alert('Logout failed');
28                }
29           }); 
30        }
31    </script>
32</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.