How are the Classic and Lightning Console APIs Different?

The user interface of your org dictates which development tools you can use with the Salesforce console.

Console Integration Toolkit versus Lightning Console JavaScript API

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.

Here’s what’s different between the Lightning Console JavaScript API and the Salesforce Console Integration Toolkit.

You Use the Methods in Different Places

In Aura components, use the Lightning Console JavaScript API methods in the JavaScript controller of a Lightning component.
In Lightning web components, you can use only the utility bar and workspace API methods, wire adapters, and Lightning message channels. Lightning web components don’t currently support working with navigation items.
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. Classic Console API Methods Supported in the Lightning Console 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 (Aura components) take a JSON array of arguments:

1workspace.openTab({
2    url: '#https://salesforce.com',
3    focus: true,
4    label: 'Salesforce',
5});

Similarly, methods in the Lightning Console JavaScript API (LWC) take a JSON array of arguments:

1openTab({
2  url: "#/sObject/001R0000003HgssIAC/view",
3  label: "Global Media",
4  focus: true,
5});

For Aura components, required parameters are passed to the method in an object. For LWC, required parameters are explicitly passed to the method.

Methods in the Salesforce Console Integration Toolkit don’t:

1sforce.console.openPrimaryTab(null, 'https://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.

Console API Method Parity—What’s Different Between Lightning Experience and Salesforce Classic?

The Lightning Console JavaScript API provides methods similar to those methods in the Salesforce Console Integration Toolkit.
Classic Console API Methods Supported in the Lightning Console API

Visualforce pages and third-party web tabs that use some Salesforce Console Integration Toolkit methods work in Lightning Experience as-is. Just point to the latest version of the toolkit script in your Visualforce pages or third-party web tabs. Third-party content must be allowlisted with CSP directives via Trusted URLs. This table lists the Salesforce Console Integration Toolkit methods that you can use in Lightning Console JavaScript API starting with API version 42.0.
Utility Bar API Method Parity

The utility bar API provides methods for Aura Components and Lightning Web Components (LWC) in Lightning Experience only. Salesforce Classic isn’t supported.

See Also