Salesforce Console Developer Guide

What Is the Console Developer Guide?
Why Your UI Matters
Console API Method Parity
Lightning Console JavaScript API for Lightning Experience (Pilot)
Salesforce Console Integration Toolkit for Salesforce Classic
Methods for Salesforce Classic
Methods for Lightning Experience (Pilot)
Events for Lightning Experience (Pilot)
Other Resources
PDF

Newer Version Available

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

Why Your UI Matters

The Lightning Console JavaScript API provides much of the same functionality as the Salesforce Console Integration Toolkit, but in Lightning Experience only. The user interface of your org dictates which development tools you can use with the Salesforce console.

The Lightning Console JavaScript API is available as a developer preview. The Lightning Console JavaScript API isn’t generally available unless or until Salesforce announces its general availability in documentation or in press releases or public statements. We can’t guarantee general availability within any particular time frame or at all. All commands, parameters, and other features are subject to change or deprecation at any time, with or without notice. Don’t implement functionality developed with these commands or tools.

We also provide the Lightning Console JavaScript API to selected customers through a pilot program that requires agreement to specific terms and conditions. To be nominated to participate in the program, contact Salesforce. Pilot programs are subject to change, and we can’t guarantee acceptance. Make your purchase decisions only on the basis of generally available products and features. You can provide feedback and suggestions for the Lightning Console JavaScript API in the IdeaExchange.

Note

What’s the Difference Between the Lightning Console JavaScript API and the Salesforce Console Integration Toolkit?

Both the Lightning Console JavaScript API and the Salesforce Console Integration Toolkit are JavaScript APIs that allow you to interact with the Salesforce console. Methods are implemented differently in each API, however.

You use the methods in different places

When you are using the Lightning Console JavaScript API in Lightning Experience, you use methods in the JavaScript controller of a Lightning component. You can’t use the Lightning Console JavaScript API in Visualforce pages or other iframed pages within a Lightning console app.

When you are using the Salesforce Console Integration Toolkit in Salesforce Classic, you use methods within <script> tags on a Visualforce page.

The input syntax for methods is different
Methods in the Lightning Console JavaScript API’s workspace API take a JSON array of arguments:
1workspace.openTab({
2    url: 'https://salesforce.com', 
3    focus: true, 
4    label: 'Salesforce',
5});
Methods in the Salesforce Console Integration Toolkit don’t:
1sforce.console.openPrimaryTab(null, 'http://www.salesforce.com', false, 
2                'salesforce', openSuccess, 'salesforceTab');
The two APIs provide different methods

Although some of the methods in the Lightning Console JavaScript API are similar to methods in the Salesforce Console Integration Toolkit, they have different names and provide different functionality.

The Lightning Console JavaScript API also provides methods for use with the utility bar, which is available in Lightning Experience only.