Salesforce Console Developer Guide
j
No Results
Search Tips:
- Please consider misspellings
- Try different search keywords
setServicePresenceStatus
Sets an agent's presence status to a status with a particular ID. In API version 35.0
and later, we log the user into presence if that user is not already logged in, so you don’t
have to make additional calls. You also can use this method to reconnect to Omni-Channel
after a connection error.
Syntax
sforce.console.presence.setServicePresenceStatus(statusId:String,
(optional) callback:function)Arguments
| Name | Type | Description |
|---|---|---|
| statusId | String | The ID of the presence status you want to set the agent to. Agents must be given access to this presence status through their associated profile or permission set. |
| callback | function | JavaScript method to call when the agent’s status is changed to the presence status associated with statusId. |
Sample Code–Visualforce
<apex:page>
<apex:includeScript value="/support/console/63.0/integration.js"/>
<a href="#" onClick="testSetStatus('0N5xx00000000081');return false;">Set Presence Status</a>
<script type="text/javascript">
function testSetStatus(statusId) {
//Sets the user’s presence status to statusID. Assumes that the user was assigned this presence status through Setup.
//These values are for example purposes only
sforce.console.presence.setServicePresenceStatus(statusId, function(result) {
if (result.success) {
alert('Set status successful');
alert('Current statusId is: ' + result.statusId);
alert('Channel list attached to this status is: ' + result.channels); //printout in console for lists
} else {
alert('Set status failed');
}
});
}
</script>
</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 setting the agent’s status was successful; false if setting the agent’s status 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. |
| channels | JSON string of channel objects | Returns the IDs and API names of the channels associated with the presence status. |