NotificationSubscription interface

Package:

azure-devops-extension-api

A subscription defines criteria for matching events and how the subscription's subscriber should be notified about those events.

Properties

adminSettings	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.
extendedProperties	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.
lastModifiedBy	User that last modified (or created) the subscription.
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.
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.
statusMessage	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.
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.

Property Details

adminSettings

Admin-managed settings for the subscription. Only applies when the subscriber is a group.

adminSettings: SubscriptionAdminSettings

Property Value

SubscriptionAdminSettings

channel

Channel for delivering notifications triggered by the subscription.

channel: ISubscriptionChannel

Property Value

ISubscriptionChannel

description

Description of the subscription. Typically describes filter criteria which helps identity the subscription.

description: string

Property Value

string

diagnostics

Diagnostics for this subscription.

diagnostics: SubscriptionDiagnostics

Property Value

SubscriptionDiagnostics

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: ISubscriptionFilter

Property Value

ISubscriptionFilter

flags

Read-only indicators that further describe the subscription.

flags: SubscriptionFlags

Property Value

SubscriptionFlags

id

Subscription identifier.

id: string

Property Value

string

lastModifiedBy

User that last modified (or created) the subscription.

lastModifiedBy: IdentityRef

Property Value

IdentityRef

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: Date

Property Value

Date

permissions

The permissions the user have for this subscriptions.

permissions: SubscriptionPermissions

Property Value

SubscriptionPermissions

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: SubscriptionScope

Property Value

SubscriptionScope

status

Status of the subscription. Typically indicates whether the subscription is enabled or not.

status: SubscriptionStatus

Property Value

SubscriptionStatus

statusMessage

Message that provides more details about the status of the subscription.

statusMessage: string

Property Value

string

subscriber

User or group that will receive notifications for events matching the subscription's filter criteria.

subscriber: IdentityRef

Property Value

IdentityRef

url

REST API URL of the subscription.

url: string

Property 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

Property Value

SubscriptionUserSettings