Microsoft.VisualStudio.Services.Notifications.WebApi Namespace
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
Actor |
|
Actor |
|
Artifact |
Artifact filter options. Used in "follow" subscriptions. |
Base |
|
Batch |
|
Block |
|
Block |
Exception thrown when updating the filter of a subscription to/from block filter |
Block |
|
Constant |
|
Diagnostic |
|
Diagnostic |
|
Diagnostic |
|
Email |
|
Email |
|
Event |
|
Event |
|
Event |
|
Events |
Encapsulates events result properties. It defines the total number of events used and the number of matched events. |
Event |
A transform request specify the properties of a notification event to be transformed. |
Event |
Result of transforming a notification event. |
Expression |
|
Expression |
Subscription Filter Clause represents a single clause in a subscription filter e.g. If the subscription has the following criteria "Project Name = [Current Project] AND Assigned To = [Me] it will be represented as two Filter Clauses Clause 1: Index = 1, Logical Operator: NULL , FieldName = 'Project Name', Operator = '=', Value = '[Current Project]' Clause 2: Index = 2, Logical Operator: 'AND' , FieldName = 'Assigned To' , Operator = '=', Value = '[Me]' |
Expression |
Represents a hierarchy of SubscritionFilterClauses that have been grouped together through either adding a group in the WebUI or using parethesis in the Subscription condition string |
Expression |
|
Field |
|
Field |
|
Field |
|
Generated |
|
Group |
|
Invalid |
|
Invalid |
Exception thrown when an invalid subscription query is specified. |
Invalid |
Exception thrown when querying for a certain target and providing AlwaysReturnBasicInformation flag |
Json |
Json based PathSubscriptionExpression This class is responsible for translating both ways between Json Paths stored in the dabases into a readable FilterName/Operator/FilterValue |
Json |
|
Matcher |
|
Message |
|
Notification |
|
Notification |
|
Notification |
|
Notification |
|
Notification |
|
Notification |
|
Notification |
|
Notification |
|
Notification |
|
Notification |
|
Notification |
|
Notification |
|
Notification |
|
Notification |
|
Notification |
|
Notification |
|
Notification |
|
Notification |
|
Notification |
|
Notification |
|
Notification |
|
Notification |
|
Notification |
Abstract base class for all of the diagnostic logs. |
Notification |
|
Notification |
|
Notification |
|
Notification |
Encapsulates the properties of a filterable field. A filterable field is a field in an event that can used to filter notifications for a certain event type. |
Notification |
Encapsulates the properties of a field type. It includes a unique id for the operator and a localized string for display name |
Notification |
Encapsulates the properties of a field type. It describes the data type of a field, the operators it support and how to populate it in the UI |
Notification |
Encapsulates the properties of a notification event publisher. |
Notification |
Encapsulates the properties of an event role. An event Role is used for role based subscription for example for a buildCompletedEvent, one role is request by field |
Notification |
Encapsulates the properties of an event type. It defines the fields, that can be used for filtering, for that event type. |
Notification |
Encapsulates the properties of a category. A category will be used by the UI to group event types |
Notification |
Exception thrown when an invalid event type is used in an unsupported way. |
Notification |
Exception thrown when a specified event type could not be found. |
Notification |
|
Notification |
Exception thrown when a specified event type does not support the specified scope |
Notification |
|
Notification |
|
Notification |
|
Notifications |
Encapsulates notifications result properties. It defines the number of notifications and the recipients of notifications. |
Notification |
|
Notification |
|
Notification |
|
Notification |
A subscriber is a user or group that has the potential to receive notifications. |
Notification |
Updates to a subscriber. Typically used to change (or set) a preferred email address or default delivery preference. |
Notification |
A subscription defines criteria for matching events and how the subscription's subscriber should be notified about those events. |
Notification |
Exception thrown when the specified channel cannot be used in this context. |
Notification |
Parameters for creating a new subscription. A subscription defines criteria for matching events and how the subscription's subscriber should be notified about those events. |
Notification |
|
Notification |
|
Notification |
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. |
Operator |
Encapsulates the properties of an operator constraint. An operator constraint defines if some operator is available only for specific scope like a project scope. |
Path |
|
Processed |
|
Processing |
|
Processing |
|
Remote |
|
Role |
|
Service |
|
Service |
|
Soap |
|
Subscription |
Admin-managed settings for a group subscription. |
Subscription |
|
Subscription |
|
Subscription |
|
Subscription |
|
Subscription |
|
Subscription |
Encapsulates the properties of a SubscriptionEvaluationRequest. It defines the subscription to be evaluated and time interval for events used in evaluation. |
Subscription |
Ecapsulates the subscription evaluation results. It defines the Date Interval that was used, number of events evaluated and events and notifications results |
Subscription |
Encapsulates the subscription evaluation settings needed for the UI |
Subscription |
|
Subscription |
|
Subscription |
Encapsulates the properties needed to manage subscriptions, opt in and out of subscriptions. |
Subscription |
Exception thrown a user tries to opt out of subscription that the admin blocked out of it |
Subscription |
Exception thrown a user tries to opt out of non group subscription |
Subscription |
Notification subscriptions query input. |
Subscription |
Conditions a subscription must match to qualify for the query result set. Not all fields are required. A subscription must match all conditions specified in order to qualify for the result set. |
Subscription |
A resource, typically an account or project, in which events are published from. |
Subscription |
|
Subscription |
|
Subscription |
|
Subscription |
|
Subscription |
|
Subscription |
User-managed settings for a group subscription. |
Token | |
Type |
|
Unsupported |
Exception thrown when the specified subscriber has unsupported type for updating delivery preferences |
Unsupported |
|
Unsupported |
|
Update |
|
Update |
|
User |
|
User |
|
Value |
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 |
XPath |
This class is responsible for translating both ways between XPath stored in the dabases into a readable FilterName/Operator/FilterValue |
XPath |
INotification |
Abstraction interface for the diagnostic log. Primarily for deserialization. |
ISubscription |
|
ISubscription |
Default |
Default delivery preference for group subscribers. Indicates how the subscriber should be notified. |
Evaluation |
Describes the subscription evaluation operation status. |
Event |
Set of flags used to determine which set of information is retrieved when querying for event publishers |
Event |
Set of flags used to determine which set of information is retrieved when querying for eventtypes |
Field |
Verious filters that can be used with a subscription field. |
Notification |
|
Notification |
|
Notification |
|
Notification |
Delivery preference for a subscriber. Indicates how the subscriber should be notified. |
Subscriber |
|
Subscription |
|
Subscription |
Read-only indicators that further describe the subscription. |
Subscription |
The permissions that a user has to a certain subscription |
Subscription |
Flags that influence the result set of a subscription query. |
Subscription |
Subscription status values. A value greater than or equal to zero indicates the subscription is enabled. A negative value indicates the subscription is disabled. |
Subscription |
Set of flags used to determine which set of templates is retrieved when querying for subscription templates |
Subscription |