Salesforce Console Developer Guide
jNewer Version Available
openUtility() for Lightning Experience
Opens a utility. If the utility is already open, this method has no effect. Only one
utility can be open at a time. If another utility is already open, openUtility() minimizes the utility. This method isn’t
supported for Lightning Web Components (LWC).
For LWC usage, see open().
Arguments
| Name | Type | Description |
|---|---|---|
| utilityId | string | The ID of the utility to open. Optional when called within a utility. |
Aura Components Sample Code
This component, when added to a single-column Lightning page used in a utility bar, opens the utility when the button is pressed.
Component code:
Controller code:
This example opens a utility from outside of the utility, using the utilityId field.
Component code:
Controller code:
Response
This method returns a promise that, upon success, resolves to true.