Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface NotificationSubscriptionUpdateParameters

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.

Hierarchy

  • NotificationSubscriptionUpdateParameters

Index

Properties

Optional adminSettings

Admin-managed settings for the subscription. Only applies to subscriptions where the subscriber is a group.

Optional channel

Channel for delivering notifications triggered by the subscription.

Optional description

description: string

Updated description for the subscription. Typically describes filter criteria which helps identity the subscription.

Optional filter

Matching criteria for the subscription. ExpressionFilter

Optional 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.

Optional statusMessage

statusMessage: string

Optional message that provides more details about the updated status.

Optional userSettings

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.

Generated using TypeDoc