Newer Version Available

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

getServicePresenceStatusId

Retrieves an agent’s current presence status. Available in API versions 32.0 and later.

Syntax

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

Arguments

Name Type Description
callback function JavaScript method to call when the agent’s presence status is retrieved.

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/34.0/integration.js"/>
19    <a href="#" onClick="testGetStatusId();return false;">Get Omni-Channel Status ID</a>
20    
21    <script type="text/javascript">
22        function testGetStatusId() {
23            sforce.console.presence.getServicePresenceStatusId(function(result) {
24                if (result.success) {
25                    alert('Get Status Id successful');
26                    alert('Status Id is: ' + result.statusId);
27                } else {
28                    alert('Get Status Id failed');
29                }
30            });
31        }
32    </script>
33</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 retrieving the presence status ID was successful; false if the retrieving the presence status ID wasn’t successful.
statusId String The ID of the agent’s current presence status.