Salesforce Console Developer Guide
jNewer Version Available
getUtilityInfo() for Lightning Experience
Returns the state of the current utility as a utilityInfo object.
Arguments
| Name | Type | Description |
|---|---|---|
| utilityId | string | The ID of the utility for which to retrieve the state. Optional when called within a utility. |
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:
Controller code:
Response
This method returns a promise that, upon success, resolves to a utilityInfo object representing the enclosing utility, containing the following fields.
| 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 |