There are two APIs that interact with Salesforce console apps—the Lightning
Console JavaScript API and the Salesforce Console Integration Toolkit. This guide provides
reference material for both. Although both APIs provide similar functionality, they do not share
methods and are restricted to Lightning Experience
and Salesforce Classic, respectively. You cannot use
the Salesforce Console Integration Toolkit with Lightning console apps, and you cannot use
the Lightning Console JavaScript API in the Salesforce Classic 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.
To use this guide, it helps if you have a basic familiarity with:
- JavaScript
- Visualforce
- Web services
- Software development
- Salesforce console
- Lightning
- Lightning console apps
j