NotificationsQuery interface

パッケージ:

azure-devops-extension-api

サービスフック通知のクエリを定義します。

プロパティ

associatedSubscriptions	クエリから返される通知に関連付けられているサブスクリプション
includeDetails	true の場合、指定されたクエリのすべての通知履歴が返されます。それ以外の場合は、サマリーが返されます。
maxCreatedDate	通知が作成されたオプションの最大日付
maxResults	含める全体的な結果の最大数(オプション)
maxResultsPerSubscription	各サブスクリプションの結果の最大数をオプションで指定します。 サブスクリプション ID のリストがクエリで指定された場合にのみ有効になります。
minCreatedDate	通知が作成されたオプションの最小日付
publisherId	結果を制限するオプションのパブリッシャー ID
results	クエリの結果
resultType	結果をフィルター処理するオプションの通知結果タイプ
status	結果をフィルタリングするオプションの通知ステータス
subscriptionIds	結果を制限するサブスクリプション ID のオプションのリスト
summary	通知の概要 - 各結果の種類 (成功、失敗など) の数。

プロパティの詳細

associatedSubscriptions

クエリから返される通知に関連付けられているサブスクリプション

associatedSubscriptions: Subscription[]

プロパティ値

Subscription[]

includeDetails

true の場合、指定されたクエリのすべての通知履歴が返されます。それ以外の場合は、サマリーが返されます。

includeDetails: boolean

プロパティ値

boolean

maxCreatedDate

通知が作成されたオプションの最大日付

maxCreatedDate: Date

プロパティ値

Date

maxResults

含める全体的な結果の最大数(オプション)

maxResults: number

プロパティ値

number

maxResultsPerSubscription

各サブスクリプションの結果の最大数をオプションで指定します。 サブスクリプション ID のリストがクエリで指定された場合にのみ有効になります。

maxResultsPerSubscription: number

プロパティ値

number

minCreatedDate

通知が作成されたオプションの最小日付

minCreatedDate: Date

プロパティ値

Date

publisherId

結果を制限するオプションのパブリッシャー ID

publisherId: string

プロパティ値

string

results

クエリの結果

results: Notification[]

プロパティ値

Notification[]

resultType

結果をフィルター処理するオプションの通知結果タイプ

resultType: NotificationResult

プロパティ値

NotificationResult

status

結果をフィルタリングするオプションの通知ステータス

status: NotificationStatus

プロパティ値

NotificationStatus

subscriptionIds

結果を制限するサブスクリプション ID のオプションのリスト

subscriptionIds: string[]

プロパティ値

string[]

summary

通知の概要 - 各結果の種類 (成功、失敗など) の数。

summary: NotificationSummary[]

プロパティ値

NotificationSummary[]