NotificationSubscription Class

Definition

Namespace:

Microsoft.VisualStudio.Services.Notifications.WebApi

Assembly:

Microsoft.VisualStudio.Services.Notifications.WebApi.dll

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

[System.Runtime.Serialization.DataContract]
public class NotificationSubscription

type NotificationSubscription = class

Public Class NotificationSubscription

Inheritance

Object

NotificationSubscription

Attributes

DataContractAttribute

Constructors

Name	Description
NotificationSubscription()

Properties

Name	Description
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.
Links	Links to related resources, APIs, and views for 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.
UniqueId	Subscription unique identifier.
Url	REST API URL of the subscriotion.
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.