NotificationSubscriptionCreateParameters interface
Parameters for creating a new subscription. A subscription defines criteria for matching events and how the subscription's subscriber should be notified about those events.
Properties
| channel | Channel for delivering notifications triggered by the new subscription. |
| description | Brief description for the new subscription. Typically describes filter criteria which helps identity the subscription. |
| filter | Matching criteria for the new subscription. ExpressionFilter |
| scope | The container in which events must be published from in order to be matched by the new subscription. If not specified, defaults to 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. |
| subscriber | User or group that will receive notifications for events matching the subscription's filter criteria. If not specified, defaults to the calling user. |
Property Details
channel
Channel for delivering notifications triggered by the new subscription.
channel: ISubscriptionChannelProperty Value
description
Brief description for the new subscription. Typically describes filter criteria which helps identity the subscription.
description: stringProperty Value
string
filter
Matching criteria for the new subscription. ExpressionFilter
filter: ISubscriptionFilterProperty Value
scope
The container in which events must be published from in order to be matched by the new subscription. If not specified, defaults to 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
subscriber
User or group that will receive notifications for events matching the subscription's filter criteria. If not specified, defaults to the calling user.
subscriber: IdentityRef