Note: 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.

login for Lightning Experience

Logs an agent in to Omni-Channel with a specific presence status.

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.

Sample Code

Component code:

1<aura:component implements="flexipage:availableForAllPageTypes" access="global" >
2    <lightning:omniToolkitAPI aura:id="omniToolkit" />
3    <lightning:button label="Login" onclick="{! c.login }" />
4</aura:component>

Controller code:

1({
2    login: function(cmp, evt, hlp) {
3        var omniAPI = cmp.find("omniToolkit");
4        omniAPI.login({statusId: "0N5xx0000000001"}).then(function(result) {
5            if (result) {
6                console.log("Login successful");
7            } else {
8                console.log("Login failed");
9            }
10        }).catch(function(error) {
11            console.log(error);
12        });
13    }
14})

Response

This method returns a promise that, upon success, resolves to true and is rejected on error.

Salesforce Console Developer Guide

login for Lightning Experience

Arguments

Sample Code

Response