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

例: Lightning コンポーネントを使用した登録とイベントの再生

Lightning Web コンポーネントまたは Aura コンポーネントの empApi コンポーネントを使用して、イベントストリーミングチャネルを登録します。empApi コンポーネントによって、ストリーミングチャネルの登録とイベントメッセージのリスンを行うメソッドにアクセスできます。

次を含む、すべての種別のストリーミングイベントがサポートされます。

プラットフォームイベント
変更データキャプチャイベント
PushTopic イベント
汎用イベント

empApi コンポーネントは、共有 CometD ベースストリーミング API 接続を使用して、あるユーザのブラウザで複数のストリーミングアプリケーションを実行できるようにします。この接続は、ユーザセッション全体では共有されません。

Spring '19 (API バージョン 45.0) 以降、Lightning Web コンポーネントモデルと従来の Aura コンポーネントモデルの 2 つのプログラミングモデルを使用して Lightning コンポーネントを作成できます。Lightning Web コンポーネントは、HTML と最新の JavaScript を使用して作成されたカスタム HTML 要素です。Lightning Web コンポーネントと Aura コンポーネントはページ上で共存し、相互作用することができます。

メモ

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"/>

次に、クライアント側コントローラで、empApi メソッドをコールする関数を追加します。

lightning:empApi コンポーネントの使用例と詳細なリファレンスについては、Lightning コンポーネントライブラリの lightning:empApi に関するドキュメントを参照してください。

ストリーミング API 開発者ガイド

例: Lightning コンポーネントを使用した登録とイベントの再生

Lightning Web コンポーネントでの登録

Aura Component コンポーネントでの登録