NotificationSubscriptionUpdateParameters interface
Parameters for updating an existing subscription. A subscription defines criteria for matching events and how the subscription's subscriber should be notified about those events. Note: only the fields to be updated should be set.
| admin |
Admin-managed settings for the subscription. Only applies to subscriptions where the subscriber is a group. |
| channel | Channel for delivering notifications triggered by the subscription. |
| description | Updated description for the subscription. Typically describes filter criteria which helps identity the subscription. |
| filter | Matching criteria for the 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 the current account or project collection). For example, a subscription scoped to project A will not produce notifications for events published from project B. |
| status | Updated status for the subscription. Typically used to enable or disable a subscription. |
| status |
Optional message that provides more details about the updated status. |
| user |
User-managed settings for the subscription. Only applies to subscriptions where the subscriber is a group. Typically used to opt-in or opt-out a user from a group subscription. |
Admin-managed settings for the subscription. Only applies to subscriptions where the subscriber is a group.
adminSettings: SubscriptionAdminSettingsProperty Value
Channel for delivering notifications triggered by the subscription.
channel: ISubscriptionChannelProperty Value
Updated description for the subscription. Typically describes filter criteria which helps identity the subscription.
description: stringProperty Value
string
Matching criteria for the subscription. ExpressionFilter
filter: ISubscriptionFilterProperty Value
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 the current 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
Updated status for the subscription. Typically used to enable or disable a subscription.
status: SubscriptionStatusProperty Value
Optional message that provides more details about the updated status.
statusMessage: stringProperty Value
string
User-managed settings for the subscription. Only applies to subscriptions where the subscriber is a group. Typically used to opt-in or opt-out a user from a group subscription.
userSettings: SubscriptionUserSettings