Salesforce Console Developer Guide
jNote: This release is in preview. Features described here don’t become generally available until the latest general availability date that Salesforce announces for this release. Before then, and where features are noted as beta, pilot, or developer preview, we can’t guarantee general availability within any particular time frame or at all. Make your purchase decisions only on the basis of generally available products and features.
getUtilityInfo() for Lightning Experience
For LWC usage, see getInfo().
Arguments
| Name | Type | Description |
|---|---|---|
| utilityId | string | The ID of the utility for which to retrieve the state. |
Aura Components Sample Code
This component has a button that, when pressed, retrieves the enclosing utility’s info and opens it if it’s not currently visible, and closes it otherwise.
Component code:
1<aura:component implements="flexipage:availableForAllPageTypes" access="global" >
2 <lightning:utilityBarAPI aura:id="utilitybar" />
3 <lightning:button label="Get Utility Info" onclick="{! c.handleGetUtilityInfo }" />
4</aura:component>Controller code:
1({
2 handleGetUtilityInfo : function(component, event, helper) {
3 var utilityBarAPI = component.find("utilitybar");
4 utilityBarAPI.getUtilityInfo().then(function(response) {
5 if (response.utilityVisible) {
6 utilityBarAPI.minimizeUtility();
7 }
8 else {
9 utilityBarAPI.openUtility();
10 }
11 })
12 .catch(function(error) {
13 console.log(error);
14 });
15 }
16})Response
This method returns a promise that resolves to a utilityInfo object representing the enclosing utility, containing the following fields. The promise is rejected on error.
| Name | Type | Description |
|---|---|---|
| id | string | The ID of the utility. |
| isLoaded | boolean | Whether the utility is loaded. |
| utilityLabel | string | The label of the utility. |
| utilityIcon | string | The SLDS icon ID of the utility’s icon. |
| utilityIconVariant | string | The SLDS icon variant of the utility’s icon. |
| utilityHighlighted | boolean | Whether the utility is highlighted. |
| utilityVisible | boolean | Whether the utility is visible. |
| utilityPoppedOut | boolean | Whether the utility is popped out. |
| panelHeaderLabel | string | The label of the utility panel. |
| panelHeaderIcon | string | The SLDS icon ID of the utility panel’s icon. |
| panelHeaderIconVariant | string | The SLDS icon variant of the utility panel’s icon. |
| panelHeight | integer | The height of the utility panel in pixels. |
| panelWidth | integer | The width of the utility panel in pixels |