Lightning Experience の getNavigationItems()
項目メニューのすべてのナビゲーションに関する情報を返します。このメソッドは、Lightning コンソールアプリケーションでのみ機能します。
引数
なし
サンプルコード
このコンポーネントにはボタンがあり、押すと、コンソールアプリケーションのナビゲーション項目に関する情報が返されます。
コンポーネントコード:
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>コントローラコード:
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})応答
このメソッドは、成功時に navigationItemInfo オブジェクトの配列に解決される Promise を返します。エラー時には Promise は却下されます。
navigationItemInfo オブジェクトには次の項目が含まれます。
| 名前 | 型 | 説明 |
|---|---|---|
| label | string | ナビゲーション項目の表示ラベル (Account や Case など)。 |
| developerName | string | 項目を一意に識別するナビゲーション項目の API 参照名。たとえば、Salesforce_Account または Your_VF_Page_Name です。 |
| selected | boolean | タブが現在選択されている場合は true、そうでない場合は false。 |
| pageReference | object | 現在のページの表現。オブジェクトは、ページ種別 (例: standard__objectPage や standard__navItemPage)、オブジェクトの API 参照名、ページの状態などの情報を返します。 |
navigationItemInfo オブジェクトの構造を次に示します。
1{
2 developerName : string,
3 label : string,
4 pageReference: object,
5 selected : boolean
6}