login
Logs an agent into Omni-Channel with a specific presence status. You also can use
this method to reconnect to Omni-Channel after a connection error. Available in API versions
32.0 and later.
Syntax
sforce.console.presence.login(statusId:String, (optional) callback:function)
Arguments
Name | Type | Description |
---|---|---|
statusId | String | The ID of the presence status. 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 is logged in with the presence status associated with statusId. |
Sample Code–Visualforce
<apex:page>
<apex:includeScript value="/support/console/64.0/integration.js"/>
<a href="#" onClick="testLogin('0N5xx00000000081');return false;">Log In to Omni-Channel</a>
<script type="text/javascript">
function testLogin(statusId) {
//Gets the Salesforce ID of the presence status entity which the current user has been assigned through their permission set or profile.
//These values are for example purposes only.
sforce.console.presence.login(statusId, function(result) {
if (result.success) {
alert('Login successful');
} else {
alert('Login failed');
}
});
}
</script>
</apex:page>