Salesforce Console Developer Guide

Salesforce Console Developer Guide
Lightning Console API
Salesforce Classic API
When to Use the Salesforce Console Integration Toolkit
Salesforce Console Integration Toolkit Support Policy
Sample Visualforce Page Using the Salesforce Console Integration Toolkit
Working with the Salesforce Console Integration Toolkit
Methods
Methods for Primary Tabs and Subtabs
Methods for Navigation Tabs
Methods for Computer-Telephony Integration (CTI)
Methods for Application-Level Custom Console Components
Methods for Push Notifications
Methods for Console Events
Methods for Chat
Methods for Omni-Channel
acceptAgentWork
closeAgentWork
declineAgentWork
getAgentWorks
getAgentWorkload
getServicePresenceStatusChannels
getServicePresenceStatusId
login
logout
setServicePresenceStatus
Methods for Omni-Channel Console Events
Other Resources
PDF

Newer Version Available

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

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

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

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 login was successful; false if the login wasn’t successful.