Salesforce Console Developer Guide
jNote: 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.
getServicePresenceStatusId
Retrieves an agent’s current presence status. Available in API versions 32.0 and
later.
Syntax
1sforce.console.presence.getServicePresenceStatusId(callback:function)Arguments
| Name | Type | Description |
|---|---|---|
| callback | function | JavaScript method to call when the agent’s presence status is retrieved. |
Sample Code–Visualforce
1<apex:page>
2 <apex:includeScript value="/support/console/68.0/integration.js"/>
3 <a href="#" onClick="testGetStatusId();return false;">Get Omni-Channel Status ID</a>
4
5 <script type="text/javascript">
6 function testGetStatusId() {
7 sforce.console.presence.getServicePresenceStatusId(function(result) {
8 if (result.success) {
9 alert('Get Status Id successful');
10 alert('Status Id is: ' + result.statusId);
11 } else {
12 alert('Get Status Id failed');
13 }
14 });
15 }
16 </script>
17</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. |
| statusName | String | The name of the agent’s current presence status. |
| statusApiName | String | The API name of the agent’s current presence status. |
| statusId | String | The ID of the agent’s current presence status. |