Lightning console apps allow users
to quickly find the information they need, and make edits while viewing multiple records on one
screen. The Lightning Console JavaScript API gives you programmatic
access to Lightning console apps, so you can fully integrate Lightning console apps with the Lightning framework and extend them to meet
your business needs.
| Available in: Lightning Experience |
| Available in: Professional, Enterprise, Performance,
Unlimited, and Developer Editions Lightning console apps are available for
an extra cost to users with Salesforce Platform user licenses for certain products. Some
restrictions apply. For pricing details, contact your Salesforce account
executive.
|
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.
The Lightning Console JavaScript API includes two libraries, the
utility bar API and the workspace API. The utility bar API provides methods that can be used from
Lightning components in the utility bar to open, resize, or minimize a utility. The workspace API
provides methods for opening, closing, and getting information about workspace tabs and subtabs.
The utility bar API can be used in Lightning apps with standard navigation and Lightning console
apps, while the workspace API can be used in Lightning console apps only.
For a full list of methods in each API, see the reference section of this guide.
j