NotificationSubscription interface
A subscription defines criteria for matching events and how the subscription's subscriber should be notified about those events.
Properties
| admin |
Admin-managed settings for the subscription. Only applies when the subscriber is a group. |
| channel | Channel for delivering notifications triggered by the subscription. |
| description | Description of the subscription. Typically describes filter criteria which helps identity the subscription. |
| diagnostics | Diagnostics for this subscription. |
| extended |
Any extra properties like detailed description for different contexts, user/group contexts |
| filter | Matching criteria for the subscription. ExpressionFilter |
| flags | Read-only indicators that further describe the subscription. |
| id | Subscription identifier. |
| last |
User that last modified (or created) the subscription. |
| modified |
Date when the subscription was last modified. If the subscription has not been updated since it was created, this value will indicate when the subscription was created. |
| permissions | The permissions the user have for this subscriptions. |
| scope | The container in which events must be published from in order to be matched by the subscription. If empty, the scope is the current host (typically an account or project collection). For example, a subscription scoped to project A will not produce notifications for events published from project B. |
| status | Status of the subscription. Typically indicates whether the subscription is enabled or not. |
| status |
Message that provides more details about the status of the subscription. |
| subscriber | User or group that will receive notifications for events matching the subscription's filter criteria. |
| url | REST API URL of the subscription. |
| user |
User-managed settings for the subscription. Only applies when the subscriber is a group. Typically used to indicate whether the calling user is opted in or out of a group subscription. |
Property Details
adminSettings
Admin-managed settings for the subscription. Only applies when the subscriber is a group.
adminSettings: SubscriptionAdminSettingsProperty Value
channel
Channel for delivering notifications triggered by the subscription.
channel: ISubscriptionChannelProperty Value
description
Description of the subscription. Typically describes filter criteria which helps identity the subscription.
description: stringProperty Value
string
diagnostics
Diagnostics for this subscription.
diagnostics: SubscriptionDiagnosticsProperty Value
extendedProperties
Any extra properties like detailed description for different contexts, user/group contexts
extendedProperties: {[key: string]: string}Property Value
{[key: string]: string}
filter
Matching criteria for the subscription. ExpressionFilter
filter: ISubscriptionFilterProperty Value
flags
Read-only indicators that further describe the subscription.
flags: SubscriptionFlagsProperty Value
id
Subscription identifier.
id: stringProperty Value
string
lastModifiedBy
User that last modified (or created) the subscription.
lastModifiedBy: IdentityRefProperty Value
modifiedDate
Date when the subscription was last modified. If the subscription has not been updated since it was created, this value will indicate when the subscription was created.
modifiedDate: DateProperty Value
Date
permissions
The permissions the user have for this subscriptions.
permissions: SubscriptionPermissionsProperty Value
scope
The container in which events must be published from in order to be matched by the subscription. If empty, the scope is the current host (typically an account or project collection). For example, a subscription scoped to project A will not produce notifications for events published from project B.
scope: SubscriptionScopeProperty Value
status
Status of the subscription. Typically indicates whether the subscription is enabled or not.
status: SubscriptionStatusProperty Value
statusMessage
Message that provides more details about the status of the subscription.
statusMessage: stringProperty Value
string
subscriber
User or group that will receive notifications for events matching the subscription's filter criteria.
subscriber: IdentityRefProperty Value
url
REST API URL of the subscription.
url: stringProperty Value
string
userSettings
User-managed settings for the subscription. Only applies when the subscriber is a group. Typically used to indicate whether the calling user is opted in or out of a group subscription.
userSettings: SubscriptionUserSettings