ストリーミング API 開発者ガイド
jデュラブル汎用ストリーミングのサンプル
デュラブル汎用ストリーミング Visualforce のサンプルでは、再生オプションを使用してデュラブル汎用イベント通知の登録と受信を行う方法について説明しています。
ストリーミングチャネルを作成する
組織で適切なストリーミング API 権限を有効にする必要があります。
Salesforce UI を使用して、StreamingChannel オブジェクトを作成します。
- Developer Edition 組織にログインします。
- Salesforce Classic を使用している場合は、[すべてのタブ] (+) で [ストリーミングチャネル] を選択します。Lightning Experience を使用している場合は、アプリケーションランチャーから [すべての項目] を選択し、[ストリーミングチャネル] をクリックします。
- [ストリーミングチャネル] ページで [新規] をクリックして、ストリーミングチャネルを作成します。
-
[ストリーミングチャネル名] に「/u/TestStreaming」と入力し、説明 (省略可能) を追加します。新しい [ストリーミングチャネル] ページは、次のようになります。
- [保存] をクリックします。これで、クライアントが通知用に登録できるストリーミングチャネルが作成されました。
StreamingChannel は通常の作成可能な Salesforce オブジェクトであるため、Apex や、SOAP API または REST API などのデータ API を使用するか、ワークベンチなどのツールを使用して、プログラムで作成することもできます。詳細は、「リファレンス: StreamingChannel」を参照してください。
Visualforce ページを使用して汎用イベントを生成および再生する
このステップでは、Visualforce ページを使用して独自のストリーミングイベントを生成し、それらのイベントを異なるオプションで再生します。
Visualforce ページは、イベントを再生するオプションを使用してイベントに登録するストリーミングクライアントをシミュレーションします。Visualforce ページでは、イベントのメッセージ、および作成するメッセージ数を指定できます。このページはイベントをリスンし、受信したイベントを [通知] セクションに表示します。イベントを生成したら、次のイベントからイベントの再生を開始できます。
- 再生 ID によって指定した、特定のイベント後のすべてのイベント。
- 登録直後にブロードキャストされた最初のイベント (再生オプション -1)。
- 過去 24 時間以内に組織に保持された最も古いイベント (再生オプション -2)。このサンプルでは、再生オプション -2 をデフォルトオプションとして使用しています。
この Visualforce のサンプルは、デュラブルストリーミングデモアプリケーションの一部です。
- [永続ストリーミングデモ] アプリケーションを開きます。
-
[永続汎用ストリーミングデモ] タブをクリックします。
Visualforce ページが読み込まれ、以前に作成したテストチャネルに登録されます。
- Visualforce ページで、いくつかのイベントを生成します。メッセージテキストに任意のテキスト (「テストメッセージ」など) を入力します。イベント数に「10」と入力します。
-
[生成] をクリックします。
-
イベントが読み取られる時点を変更するには、[ID から再実行] 項目に読み取りを開始する再生 ID を入力します。たとえば、再生 ID 5 のイベントより後のすべてのイベントを読み取るには、「5」と入力します。その後、[登録を更新] をクリックします。
[通知] セクションが更新され、再生 ID 6 以降の最新 5 件のイベントのみが表示されます。
-
登録後に送信されたイベントのみを受信するには、[ID から再実行] 項目に「-1」と入力します。その後、[登録を更新] をクリックします。
この時点後の新規イベントのみが表示されるため、[通知] セクションはクリアされます。
-
「新規イベント」というメッセージのいくつかの新しいイベントをステップ 3 と同様の方法で生成します。
[通知] セクションが新規イベントで更新され、古いイベントは表示されません。
-
再生オプションを -2 に戻します。
ページには、以前送信されたイベントも含めて、すべてのイベントが表示されます。
