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.

interface NotificationSubscriptionUpdateParameters {
    adminSettings?: SubscriptionAdminSettings;
    channel?: ISubscriptionChannel;
    description?: string;
    filter?: ISubscriptionFilter;
    scope?: SubscriptionScope;
    status?: SubscriptionStatus;
    statusMessage?: string;
    userSettings?: SubscriptionUserSettings;
}

Properties

adminSettings? channel? description? filter? scope? status? statusMessage? userSettings?

Properties

OptionaladminSettings

adminSettings?: SubscriptionAdminSettings

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

Optionalchannel

channel?: ISubscriptionChannel

Channel for delivering notifications triggered by the subscription.

Optionaldescription

description?: string

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

Optionalfilter

filter?: ISubscriptionFilter

Matching criteria for the subscription. ExpressionFilter

Optionalscope

scope?: SubscriptionScope

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.

Optionalstatus

status?: SubscriptionStatus

Updated status for the subscription. Typically used to enable or disable a subscription.

OptionalstatusMessage

statusMessage?: string

Optional message that provides more details about the updated status.

OptionaluserSettings

userSettings?: SubscriptionUserSettings

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.

Settings

Member Visibility

On This Page

Properties