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

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

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

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

同時 CometD クライアント制限は、empApi コンポーネントに適用されます。empApi を使用してログインしているユーザーは、それぞれ 1 つの同時クライアントとして計数されます。empApi コンポーネントは、多数のユーザーが使用するアプリケーションまたはサイト (Experience Cloud サイトなど) では制限に達する可能性があるため、お勧めできません。この制限は、他の CometD クライアントと共有されます。詳細は、『プラットフォームイベント開発者ガイド』の「プラットフォームイベントの割り当て」を参照してください。

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 コンポーネントでの登録