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

PushTopic

組織のレコードへの変更をストリーミング API ユーザに通知するための基礎となるクエリを表します。このオブジェクトは API バージョン 21.0 以降で使用できます。

サポートされているコール

create()、delete()、describeSObjects()、query()、retrieve()、update()、upsert()

特別なアクセスルール

このオブジェクトは、組織でストリーミング API が有効になっている場合にのみ使用できます。
「作成」権限を持つユーザがこのレコードを作成できます。
通知を受信するには、PushTopic クエリのオブジェクトおよび PushTopic 自体の両方への参照アクセス権が必要です。

項目

項目	詳細
ApiVersion	型 double プロパティ Create、Filter、Sort、Update 説明必須。Query で指定されるクエリを実行するために使用する API バージョン。API バージョンは 20.0 以降である必要があります。クエリがパッケージからのカスタムオブジェクトに適用される場合、この値がパッケージの ApiVersion に一致する必要があります。値の例:
Description	型 string プロパティ Create、Filter、Nillable、Sort、Update 説明 PushTopic の説明。最大 400 文字です。
IsActive	型 boolean プロパティ Create、Defaulted on create、Filter、Group、Sort、Update 説明レコードが組織の割り当てに現在含まれるかどうかを示す。
Name	型 string プロパティ Create、Filter、Group、Sort、Update 説明必須。`MyNewCases` や `TeamUpdatedContacts` などの PushTopic の内容を説明する名前。最大 25 文字です。この値ではチャネルを特定します。値は一意である必要があります。
NotifyForFields	型 picklist プロパティ Create、Defaulted on create、Filter、Group、Restricted picklist、Sort、Update 説明通知を生成するために評価される項目を指定します。可能な値は次のとおりです。 `All` `Referenced` (デフォルト) `Select` `Where`
NotifyForOperationCreate	型 boolean プロパティ Create、Filter、Update 説明作成操作で通知を生成する場合は `true`、それ以外の場合は `false`。デフォルトは `true` です。この項目は、API バージョン 29.0 以降で使用できます。
NotifyForOperationDelete	型 boolean プロパティ Create、Filter、Update 説明削除操作で通知を生成する場合は `true`、それ以外の場合は `false`。デフォルトは `true` です。削除および復元イベント通知を取得するには、クライアントは cometd/29.0 (またはそれ以降) のストリーミング API エンドポイントを使用して接続する必要があります。この項目は、API バージョン 29.0 以降で使用できます。
NotifyForOperationUndelete	型 boolean プロパティ Create、Filter、Update 説明復元操作で通知を生成する場合は `true`、それ以外の場合は `false`。デフォルトは `true` です。削除および復元イベント通知を取得するには、クライアントは cometd/29.0 (またはそれ以降) のストリーミング API エンドポイントを使用して接続する必要があります。この項目は、API バージョン 29.0 以降で使用できます。
NotifyForOperationUpdate	型 boolean プロパティ Create、Filter、Update 説明更新操作で通知を生成する場合は `true`、それ以外の場合は `false`。デフォルトは `true` です。この項目は、API バージョン 29.0 以降で使用できます。
NotifyForOperations	型 picklist プロパティ Defaulted on create、Filter、Group、Restricted picklist、Sort 説明通知を生成できるレコードイベントを指定します。 API バージョン 29.0 以降では、この項目は参照のみであり、イベントの削除および復元に関する情報は含まれません。通知を生成するレコードイベントを指定するには、NotifyForOperationCreate、NotifyForOperationDelete、NotifyForOperationUndelete、NotifyForOperationUpdate を使用します。可能な値は次のとおりです。 `All` (デフォルト) `Create` `Extended` `Update` `Extended` の値は、作成操作と更新操作のいずれもイベントを生成するように設定されていないことを示します。
Query	型 string プロパティ Create、Filter、Sort、Update 説明必須。イベントのチャネルへの送信をトリガするレコードへの変更を特定する SOQL クエリステートメント。最大 1,300 文字です。

使用方法

PushTopic は、いつチャネル内で通知を生成するかを定義します。設定する項目を決定するには、『ストリーミング API 開発者ガイド』の次のリンク先を参照してください。

Salesforce プラットフォームのオブジェクトリファレンス

PushTopic

サポートされているコール

特別なアクセスルール

項目

使用方法

関連項目: