NotificationsQuery interface

Package:

azure-devops-extension-api

Defines a query for service hook notifications.

Properties

associatedSubscriptions	The subscriptions associated with the notifications returned from the query
includeDetails	If true, we will return all notification history for the query provided; otherwise, the summary is returned.
maxCreatedDate	Optional maximum date at which the notification was created
maxResults	Optional maximum number of overall results to include
maxResultsPerSubscription	Optional maximum number of results for each subscription. Only takes effect when a list of subscription ids is supplied in the query.
minCreatedDate	Optional minimum date at which the notification was created
publisherId	Optional publisher id to restrict the results to
results	Results from the query
resultType	Optional notification result type to filter results to
status	Optional notification status to filter results to
subscriptionIds	Optional list of subscription ids to restrict the results to
summary	Summary of notifications - the count of each result type (success, fail, ..).

Property Details

associatedSubscriptions

The subscriptions associated with the notifications returned from the query

associatedSubscriptions: Subscription[]

Property Value

Subscription[]

includeDetails

If true, we will return all notification history for the query provided; otherwise, the summary is returned.

includeDetails: boolean

Property Value

boolean

maxCreatedDate

Optional maximum date at which the notification was created

maxCreatedDate: Date

Property Value

Date

maxResults

Optional maximum number of overall results to include

maxResults: number

Property Value

number

maxResultsPerSubscription

Optional maximum number of results for each subscription. Only takes effect when a list of subscription ids is supplied in the query.

maxResultsPerSubscription: number

Property Value

number

minCreatedDate

Optional minimum date at which the notification was created

minCreatedDate: Date

Property Value

Date

publisherId

Optional publisher id to restrict the results to

publisherId: string

Property Value

string

results

Results from the query

results: Notification[]

Property Value

Notification[]

resultType

Optional notification result type to filter results to

resultType: NotificationResult

Property Value

NotificationResult

status

Optional notification status to filter results to

status: NotificationStatus

Property Value

NotificationStatus

subscriptionIds

Optional list of subscription ids to restrict the results to

subscriptionIds: string[]

Property Value

string[]

summary

Summary of notifications - the count of each result type (success, fail, ..).

summary: NotificationSummary[]

Property Value

NotificationSummary[]