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.

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 an account or project collection). For example, a subscription scoped to project A will not produce notifications for events published from project B.

NotificationSubscriptionTemplate

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.

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.

SubscriptionScope

SubscriptionStatus

Subscription status values. A value greater than or equal to zero indicates the subscription is enabled. A negative value indicates the subscription is disabled.

Enum Value

Notes

jailedByNotificationsVolume

Subscription is disabled because it generated a high volume of notifications.

pendingDeletion

Subscription is disabled and will be deleted.

disabledBySystem

Subscription is disabled service due to failures.

disabledInactiveIdentity

Subscription is disabled because the identity is no longer active

disabledMessageQueueNotSupported

Subscription is disabled because message queue is not supported.

disabledMissingIdentity

Subscription is disabled because its subscriber is unknown.

disabledInvalidRoleExpression

Subscription is disabled because it has an invalid role expression.

disabledInvalidPathClause

Subscription is disabled because it has an invalid filter expression.

disabledAsDuplicateOfDefault

Subscription is disabled because it is a duplicate of a default subscription.

disabledByAdmin

Subscription is disabled by an administrator, not the subscription's subscriber.

disabled

Subscription is disabled, typically by the owner of the subscription, and will not produce any notifications.

enabled

Subscription is active.

enabledOnProbation

Subscription is active, but is on probation due to failed deliveries or other issues with the subscription.

SubscriptionTemplateType

Enum Value

Notes

user

team

both

none

SubscriptionUserSettings

User-managed settings for a group subscription.

Field

Type

Notes

optedOut

boolean

Indicates whether the user will receive notifications for the associated group subscription.

ValueDefinition

Encapsulates the properties of a field value definition. It has the information needed to retrieve the list of possible values for a certain field and how to handle that field values in the UI. This information includes what type of object this value represents, which property to use for UI display and which property to use for saving the subscription

Field

Type

Notes

dataSource

array (object)

Gets or sets the data source.

endPoint

string

Gets or sets the rest end point.

resultTemplate

string

Gets or sets the result template.

VssJsonCollectionWrapper<T>

This class is used to serialized collections as a single JSON object on the wire, to avoid serializing JSON arrays directly to the client, which can be a security hole

VssJsonCollectionWrapperBase

Field

Type

count

int32

VssNotificationEvent

This is the type used for firing notifications intended for the subsystem in the Notifications SDK. For components that can't take a dependency on the Notifications SDK directly, they can use ITeamFoundationEventService.PublishNotification and the Notifications SDK ISubscriber implementation will get it.