Lightning Experience の onUtilityClick()
ユーティリティの eventHandler を登録します。この eventHandler は、ユーティリティがクリックされるとコールされます。
このメソッドを使用するときは、次の点に留意してください。
- メソッドは、標準ナビゲーションやコンソールナビゲーションを使用する Lightning アプリケーションでサポートされています。
- このメソッドを使用すると、utilityItem ごとに複数のコールバックを登録できます (順次実行する場合)。
- 登録したコールバックは削除できません。
引数
| 名前 | 型 | 説明 |
|---|---|---|
| utilityId | string | コールバックを登録するユーティリティの ID。ユーティリティ内からコールする場合は省略可能。 |
| eventHandler | function | ユーティリティがクリックされるとコールされる JavaScript 関数。 |
サンプルコード
このコンポーネントにはボタンがあり、押すと、囲んでいるユーティリティの eventHandler 関数が登録されます。
コンポーネントコード:
コントローラーコード:
応答
このメソッドは、成功時に true に解決され、エラー時に却下される Promise を返します。eventHandler では、次の項目が含まれる応答 JSON オブジェクトが想定されています。
| 名前 | 型 | 説明 |
|---|---|---|
| utilityId | string | クリックされた utilityBar 項目ボタンの ID。 |
| panelVisible | boolean | ボタンのクリック後にユーティリティ項目パネルが非表示になっている場合は false。ボタンのクリック後にユーティリティ項目パネルが表示されている場合は false。 |