Lightning Experience の refreshNavigationItem()

このメソッドは、バックグラウンドで更新を行います。リストビューに保存されていない変更がある場合、このメソッドは false を返し、ナビゲーション項目を更新しません。このメソッドは、ナビゲーションタブにフォーカスを設定しません。

ワークスペースタブとして開いている場合、次のナビゲーション項目はサポートされません。

• カスタム Visualforce タブ
• カスタム Aura コンポーネントタブ
• カスタム Web タブ
• ホーム
• Chatter
• ダッシュボード
• レポート

引数

サンプルコード

この Aura コンポーネントにはボタンがあり、押すと、ナビゲーション項目が更新されます。

コンポーネントコード:

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

コントローラコード:

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

応答

このメソッドは、成功時に true に解決される Promise を返します。エラー時には Promise は却下されます。