getNavigationItems() for Lightning Experience

Arguments

Sample Code

This component has a button that, when pressed, returns information about the navigation items in a console app.

Component code:

1<aura:component implements="flexipage:availableForAllPageTypes" access="global">
2    <lightning:navigationItemAPI aura:id="navigationItemAPI"/>
3    <lightning:button label="Get navigation item" onclick="{!c.getNavigationItems}"/>
4</aura:component>

Controller code:

1({
2    getNavigationItems : function(component, event, helper) {
3        var navigationItemAPI = component.find("navigationItemAPI");
4        navigationItemAPI.getNavigationItems().then(function(response) {
5            console.log(response);
6        })
7        .catch(function(error) {
8            console.log(error);
9        });
10    }
11})

Response

This method returns a promise that, upon success, resolves to an array of navigationItemInfo objects. The promise is rejected on error.

The navigationItemInfo object contains the following fields.

1{
2      developerName : string,
3      label : string,
4      pageReference: object,
5      selected : boolean
6}