PushTopic クエリ

PushTopic クエリは PushTopic チャネルの基礎であり、作成、更新、削除、復元のどのレコードイベントが発生したら通知を生成するかを定義します。このクエリは、有効な SOQL クエリである必要があります。通知が適時に送信されるようにするために、次の要件が PushTopic クエリに適用されます。

• クエリの SELECT 句には Id を含める必要があります。例: SELECT Id, Name FROM....
• 1 つのクエリにつきエンティティは 1 つのみです。
• オブジェクトは、指定された API バージョンで有効である必要があります。

PushTopic の SELECT 句に指定した項目によって通知の本文が構成され、PushTopic チャネルでストリーミングされます。たとえば、PushTopic クエリが SELECT Id, Name, Status__c FROM Invoice_Statement__c の場合、ID、Name、および Status__c 項目はそのチャネルで送信されるすべての通知に含まれます。そのチャネルに表示される通知メッセージの例を次に示します。

1{
2  "channel": "/topic/InvoiceStatementUpdates",
3  "data":
4  {
5    "event":
6    {
7
8      "createdDate":"2016-03-29T16:40:08.208Z",
9      "replayId":13,
10      "type":"created"
11
12    },
13    "sobject":
14    {
15      "Name": "INV-0001", 
16      "Id": "a00D0000008o6y8IAA",
17      "Status__c": "Open"
18    }
19  }
20}

PushTopic クエリを変更した場合、それらの変更はサーバーで直ちに有効になります。クライアントは、新しい SOQL クエリに一致した場合にのみイベントを受け取ります。PushTopic の Name を変更しても、現在の登録には影響はありません。新しい登録では、新しいチャネル名を使用する必要があります。