この文章は Salesforce 機械翻訳システムを使用して翻訳されました。詳細はこちらをご参照ください。

Lightning Experience の getAllUtilityInfo()

すべてのユーティリティの状態を utilityInfo オブジェクトの配列として返します。

引数

なし。

サンプルコード

このコンポーネントにはボタンがあり、押すと、すべての utilityInfo オブジェクトが取得され、ID 順で最初のユーティリティが開きます。

コンポーネントコード:

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

コントローラーコード:

1({
2    getAllUtilityInfo : function(component, event, helper) {
3        var utilityBarAPI = component.find("utilitybar");
4        utilityBarAPI.getAllUtilityInfo().then(function(response) {
5            var myUtilityInfo = response[0];
6            utilityBarAPI.openUtility({
7                utilityId: myUtilityInfo.id
8            });
9       })
10        .catch(function(error) {
11            console.log(error);
12        });
13    }
14})

応答

このメソッドは、成功時に次の項目が含まれる utilityInfo オブジェクトの配列に解決される Promise を返します。

名前	型	説明
id	string	ユーティリティの ID。
isLoaded	boolean	ユーティリティが読み込まれるかどうか。
utilityLabel	string	ユーティリティの表示ラベル。
utilityIcon	string	ユーティリティのアイコンの SLDS アイコン ID。
utilityIconVariant	string	ユーティリティのアイコンの SLDS アイコンのバリエーション。
utilityHighlighted	boolean	ユーティリティが��調表示されるかどうか。
utilityVisible	boolean	ユーティリティが表示されるかどうか。
utilityPoppedOut	boolean	ユーティリティがポップアウトされるかどうか。
panelHeaderLabel	string	ユーティリティパネルの表示ラベル。
panelHeaderIcon	string	ユーティリティパネルのアイコンの SLDS アイコン ID。
panelHeaderIconVariant	string	ユーティリティパネルのアイコンの SLDS アイコンのバリエーション。
panelHeight	integer	ユーティリティパネルの高さ (ピクセル単位)。
panelWidth	integer	ユーティリティパネルの幅 (ピクセル単位)。

Salesforce コンソール開発者ガイド

Lightning Experience の getAllUtilityInfo()

引数

サンプルコード

応答