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

Lightning Experience の getUtilityInfo()

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

引数

名前	型	説明
utilityId	string	状態を取得するユーティリティの ID。ユーティリティ内からコールする場合は省略可能。

サンプルコード

このコンポーネントにはボタンがあり、押すと、囲んでいるユーティリティの情報が取得され、現在表示されていない場合は開き、表示されている場合は閉じます。

コンポーネントコード:

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

コントローラーコード:

1({
2    getUtilityInfo : function(component, event, helper) {
3        var utilityBarAPI = component.find("utilitybar");
4        utilityBarAPI.getUtilityInfo().then(function(response) {
5            if (response.utilityVisible) {
6                utilityBarAPI.minimizeUtility();
7            }
8            else {
9                utilityBarAPI.openUtility();
10            }
11        })
12        .catch(function(error) {
13            console.log(error);
14        });
15    }
16})

応答

このメソッドは、成功時に囲んでいるユーティリティを表し、次の項目が含まれる 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 の getUtilityInfo()

引数

サンプルコード

応答