Newer Version Available

This content describes an older version of this product. View Latest

getAllUtilityInfo() for Lightning Experience

Returns the state of all utilities as an array of utilityInfo objects.

Arguments

None.

Sample Code

This component has a button that, when pressed, retrieves all utilityInfo objects and opens the first utility, ordered by ID.

Component code:

Controller code:

Response

This method returns a promise that, upon success, resolves to an array of utilityInfo objects, 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