Why Your UI Matters

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 Classic or Lightning console apps. Methods are implemented differently in each API, however.

You Use the Methods in Different Places

It’s really pretty simple.

• Lightning components only work in Lightning Experience. So for Lightning components, use the Lightning Console JavaScript API methods in the JavaScript controller of a Lightning component.
• Visualforce or iframed, third-party pages work in both Lightning Experience and Salesforce Classic. For Visualforce and iframe pages, use the Classic methods from the Salesforce Console Integration Toolkit. However, there are limitations regarding which methods you can use. Salesforce Console Integration Toolkit Methods Supported in Lightning Console JavaScript API, provides details on the supported methods.

  When you are using the Salesforce Console Integration Toolkit in Salesforce Classic, you use methods within <script> tags for Visualforce pages or iframed, third-party pages.

The Input Syntax for Methods is Different

Methods in the Lightning Console JavaScript 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 APIs Provide Different Methods

Although some of the methods in the Lightning Experience methods are similar to the Salesforce Classic methods, 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.