setUtilityHighlighted() for Lightning Experience

Arguments

Sample Code

This component, when added to a single-column Lightning page used in a utility bar, sets a utility as highlighted when the button is pressed.

Component code:

1<aura:component implements="flexipage:availableForAllPageTypes" access="global" >
2    <lightning:utilityBarAPI aura:id="utilitybar" />
3    <lightning:button label="Set Utility Highlighted" onclick="{! c.setUtilityHighlighted}" />
4</aura:component>

Controller code:

1({
2    setUtilityHighlighted : function(component, event, helper) {
3        var utilityAPI = component.find("utilitybar");
4        utilityAPI.setUtilityHighlighted({
5            highlighted: true
6        });
7    }
8})

Response

This method returns a promise that, upon success, resolves to true.