メッセージチャネルの作成

Lightning メッセージチャネルを作成するには、LightningMessageChannel メタデータ型を使用します。

組織でのメッセージチャネルメタデータの定義

LightningMessageChannel を組織にリリースするには、SFDX プロジェクトを作成します。XML 定義を force-app/main/default/messageChannels/ ディレクトリに含めます。LightningMessageChannel のファイル名は、messageChannelName.messageChannel-meta.xml 形式に従います。

これをスクラッチ組織に追加するには、sf project deploy start を実行します。

これを Sandbox や Developer Edition 組織などの別の種別の組織に追加するには、sf project deploy start を実行します。

メッセージチャネルのインポート

Lightning Message Service 経由で通信するためにコンポーネントが使用する Lightning メッセージチャネルをインポートする方法を示します。

1// Syntax
2import channelName from "@salesforce/messageChannel/channelReference";

1// Syntax for resources in a managed package
2import channelName from "@salesforce/messageChannel/namespace__channelReference";

1// Example
2import recordSelected from "@salesforce/messageChannel/Record_Selected__c";

channelName — メッセージチャネルを識別するインポートされた記号。
channelReference — メッセージチャネルの API 参照名。
namespace — メッセージチャネルが管理パッケージ内にある場合は、この値は管理パッケージの名前空間です。メッセージチャネルが管理パッケージ内にない場合は、名前空間を含めないでください。

Record_Selected__c は、LightningMessageChannel メタデータ型のカスタムインスタンスを参照します。__c サフィックスが使用されますが、カスタムオブジェクトではありません。

Note

関連トピック

メタデータ API 開発者ガイド: LightningMessageChannel

The Japanese Summer '24 guide is now live

日本語の Summer '24 ガイドが公開されました! 「Component Reference (コンポーネントリファレンス)」は、以前と同様にコンポーネントライブラリにあります。