NotificationsQuery interface
Defines a query for service hook notifications.
Properties
| associated |
The subscriptions associated with the notifications returned from the query |
| include |
If true, we will return all notification history for the query provided; otherwise, the summary is returned. |
| max |
Optional maximum date at which the notification was created |
| max |
Optional maximum number of overall results to include |
| max |
Optional maximum number of results for each subscription. Only takes effect when a list of subscription ids is supplied in the query. |
| min |
Optional minimum date at which the notification was created |
| publisher |
Optional publisher id to restrict the results to |
| results | Results from the query |
| result |
Optional notification result type to filter results to |
| status | Optional notification status to filter results to |
| subscription |
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
includeDetails
If true, we will return all notification history for the query provided; otherwise, the summary is returned.
includeDetails: booleanProperty Value
boolean
maxCreatedDate
Optional maximum date at which the notification was created
maxCreatedDate: DateProperty Value
Date
maxResults
Optional maximum number of overall results to include
maxResults: numberProperty 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: numberProperty Value
number
minCreatedDate
Optional minimum date at which the notification was created
minCreatedDate: DateProperty Value
Date
publisherId
Optional publisher id to restrict the results to
publisherId: stringProperty Value
string
results
resultType
Optional notification result type to filter results to
resultType: NotificationResultProperty Value
status
Optional notification status to filter results to
status: NotificationStatusProperty Value
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[]