NotificationSubscriptionCreateParameters interface
新しいサブスクリプションを作成するためのパラメーター。 サブスクリプションでは、一致するイベントの条件と、それらのイベントについてサブスクリプションのサブスクライバーに通知する方法を定義します。
プロパティ
| channel | 新しいサブスクリプションによってトリガーされた通知を配信するためのチャネル。 |
| description | 新しいサブスクリプションの簡単な説明。 通常、サブスクリプションの識別に役立つフィルター条件について説明します。 |
| filter | 新しいサブスクリプションの一致条件。 式フィルター |
| scope | 新しいサブスクリプションと照合するためにイベントを発行する必要があるコンテナー。 指定しない場合、既定値は現在のホスト (通常はアカウントまたはプロジェクト コレクション) です。 たとえば、プロジェクト A をスコープとするサブスクリプションでは、プロジェクト B から発行されたイベントの通知は生成されません。 |
| subscriber | サブスクリプションのフィルター条件に一致するイベントの通知を受信するユーザーまたはグループ。 指定しない場合、デフォルトは呼び出し元ユーザーになります。 |
プロパティの詳細
channel
description
新しいサブスクリプションの簡単な説明。 通常、サブスクリプションの識別に役立つフィルター条件について説明します。
description: string
プロパティ値
string
filter
scope
新しいサブスクリプションと照合するためにイベントを発行する必要があるコンテナー。 指定しない場合、既定値は現在のホスト (通常はアカウントまたはプロジェクト コレクション) です。 たとえば、プロジェクト A をスコープとするサブスクリプションでは、プロジェクト B から発行されたイベントの通知は生成されません。
scope: SubscriptionScope
プロパティ値
subscriber
サブスクリプションのフィルター条件に一致するイベントの通知を受信するユーザーまたはグループ。 指定しない場合、デフォルトは呼び出し元ユーザーになります。
subscriber: IdentityRef