Platform Events Developer Guide (プラットフォームイベント開発者ガイド)
jLightning コンポーネントでのプラットフォームイベント通知の登録
Lightning Web コンポーネントまたは Aura コンポーネントの empApi コンポーネントを使用して、プラットフォームイベントを登録します。empApi コンポーネントによって、ストリーミングチャネルの登録とイベントメッセージのリスンを行うメソッドにアクセスできます。
empApi コンポーネントは、共有 CometD ベースストリーミング API 接続を使用して、ブラウザで複数のストリーミングアプリケーションを実行できるようにします。
Lightning Web コンポーネントでの登録
Lightning Web コンポーネントの empApi メソッドを使用するには、次に示すように lightning/empApi モジュールからそのメソッドをインポートします。
1import { subscribe, unsubscribe, onError, setDebugFlag, isEmpEnabled }
2 from 'lightning/empApi';次に、インポートしたメソッドを JavaScript コードでコールします。
lightning/empApi モジュールの使用例と詳細なリファレンスについては、Lightning コンポーネントライブラリの lightning-emp-api に関するドキュメントを参照してください。
Aura Component コンポーネントでの登録
Aura コンポーネントで empApi メソッドを使用するには、カスタムコンポーネント内に lightning:empApi コンポーネントを追加して、aura:id 属性を割り当てます。
<lightning:empApi aura:id="empApi"/>次に、クライアント側コントローラで、コンポーネントメソッドをコールする関数を追加します。
lightning:empApi コンポーネントの使用例と詳細なリファレンスについては、Lightning コンポーネントライブラリの lightning:empApi に関するドキュメントを参照して���ださい。