Message Service の範囲の定義

Lightning Message Service では、登録コンポーネントがメッセージを受信するアプリケーション内の場所の範囲を定義できます。範囲をアプリケーションの有効な領域に制限したり、アプリケーション全体に設定したりできます。

Lightning Web コンポーネントの範囲設定機能は、@wire(MessageContext) を使用する場合にのみ利用できます。

アプリケーションの有効な領域には、選択したナビゲーションタブおよび項目、ユーティリティ項目、ES6 ライブラリが含まれます。ユーティリティ項目は常に有効です。ナビゲーションタブとナビゲーション項目には、以下が含まれます。

  • 標準ナビゲーションタブ
  • コンソールナビゲーションワークスペースタブ
  • コンソールナビゲーションサブタブ
  • コンソールナビゲーション項目

有効な登録範囲領域とアプリケーションの登録範囲領域を示している図

アプリケーションの任意の場所からメッセージチャネルでメッセージを受信するには、lightning/messageService から APPLICATION_SCOPE をインポートします。次に、subscribe() をコールして、4 番目の subscriberOptions パラメーター (省略可能) の { scope: APPLICATION_SCOPE } を渡します。

有効な領域からのメッセージの受信がデフォルトの動作です。範囲を有効な領域に制限するために scope プロパティを含める必要はありません。