NotificationSubscription interface

パッケージ:

azure-devops-extension-api

サブスクリプションでは、一致するイベントの条件と、それらのイベントについてサブスクリプションのサブスクライバーに通知する方法を定義します。

プロパティ

adminSettings	サブスクリプションの管理者が管理する設定。 サブスクライバーがグループである場合にのみ適用されます。
channel	サブスクリプションによってトリガーされる通知を配信するためのチャネル。
description	サブスクリプションの説明。 通常、サブスクリプションを識別するのに役立つフィルター条件について説明します。
diagnostics	このサブスクリプションの診断。
extendedProperties	さまざまなコンテキスト、ユーザー/グループ コンテキストの詳細な説明などの追加のプロパティ
filter	サブスクリプションの一致条件。 ExpressionFilter
flags	サブスクリプションをさらに説明する読み取り専用インジケーター。
id	サブスクリプション識別子。
lastModifiedBy	サブスクリプションを最後に変更 (または作成) したユーザー。
modifiedDate	サブスクリプションが最後に変更された日付。 サブスクリプションが作成されてから更新されていない場合、この値はサブスクリプションが作成された日時を示します。
permissions	ユーザーがこのサブスクリプションに対して持っているアクセス許可。
scope	サブスクリプションと一致させるためにイベントを発行する必要があるコンテナー。 空の場合、スコープは現在のホスト (通常はアカウントまたはプロジェクト コレクション) です。 たとえば、プロジェクト A をスコープとしたサブスクリプションでは、プロジェクト B から発行されたイベントの通知は生成されません。
status	サブスクリプションの状態。 通常、サブスクリプションが有効かどうかを示します。
statusMessage	サブスクリプションの状態の詳細を示すメッセージ。
subscriber	サブスクリプションのフィルター条件に一致するイベントの通知を受信するユーザーまたはグループ。
url	サブスクリプションの REST API URL。
userSettings	サブスクリプションのユーザーが管理する設定。 サブスクライバーがグループである場合にのみ適用されます。 通常、呼び出し元のユーザーがグループ サブスクリプションにオプトインされているか、またはグループ サブスクリプションからオプトアウトされているかを示すために使用されます。

プロパティの詳細

adminSettings

サブスクリプションの管理者が管理する設定。 サブスクライバーがグループである場合にのみ適用されます。

adminSettings: SubscriptionAdminSettings

プロパティ値

SubscriptionAdminSettings

channel

サブスクリプションによってトリガーされる通知を配信するためのチャネル。

channel: ISubscriptionChannel

プロパティ値

ISubscriptionChannel

description

サブスクリプションの説明。 通常、サブスクリプションを識別するのに役立つフィルター条件について説明します。

description: string

プロパティ値

string

diagnostics

このサブスクリプションの診断。

diagnostics: SubscriptionDiagnostics

プロパティ値

SubscriptionDiagnostics

extendedProperties

さまざまなコンテキスト、ユーザー/グループ コンテキストの詳細な説明などの追加のプロパティ

extendedProperties: {[key: string]: string}

プロパティ値

{[key: string]: string}

filter

サブスクリプションの一致条件。 ExpressionFilter

filter: ISubscriptionFilter

プロパティ値

ISubscriptionFilter

flags

サブスクリプションをさらに説明する読み取り専用インジケーター。

flags: SubscriptionFlags

プロパティ値

SubscriptionFlags

id

サブスクリプション識別子。

id: string

プロパティ値

string

lastModifiedBy

サブスクリプションを最後に変更 (または作成) したユーザー。

lastModifiedBy: IdentityRef

プロパティ値

IdentityRef

modifiedDate

サブスクリプションが最後に変更された日付。 サブスクリプションが作成されてから更新されていない場合、この値はサブスクリプションが作成された日時を示します。

modifiedDate: Date

プロパティ値

Date

permissions

ユーザーがこのサブスクリプションに対して持っているアクセス許可。

permissions: SubscriptionPermissions

プロパティ値

SubscriptionPermissions

scope

サブスクリプションと一致させるためにイベントを発行する必要があるコンテナー。 空の場合、スコープは現在のホスト (通常はアカウントまたはプロジェクト コレクション) です。 たとえば、プロジェクト A をスコープとしたサブスクリプションでは、プロジェクト B から発行されたイベントの通知は生成されません。

scope: SubscriptionScope

プロパティ値

SubscriptionScope

status

サブスクリプションの状態。 通常、サブスクリプションが有効かどうかを示します。

status: SubscriptionStatus

プロパティ値

SubscriptionStatus

statusMessage

サブスクリプションの状態の詳細を示すメッセージ。

statusMessage: string

プロパティ値

string

subscriber

サブスクリプションのフィルター条件に一致するイベントの通知を受信するユーザーまたはグループ。

subscriber: IdentityRef

プロパティ値

IdentityRef

url

サブスクリプションの REST API URL。

url: string

プロパティ値

string

userSettings

サブスクリプションのユーザーが管理する設定。 サブスクライバーがグループである場合にのみ適用されます。 通常、呼び出し元のユーザーがグループ サブスクリプションにオプトインされているか、またはグループ サブスクリプションからオプトアウトされているかを示すために使用されます。

userSettings: SubscriptionUserSettings

プロパティ値

SubscriptionUserSettings