İngilizce dilinde oku Düzenle

Aracılığıyla paylaş


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.

Classes

ActorFilter
ActorNotificationReason
ArtifactFilter

Artifact filter options. Used in "follow" subscriptions.

BaseSubscriptionFilter
BatchNotificationOperation
BlockFilter
BlockFilterUpdateNotAllowedException

Exception thrown when updating the filter of a subscription to/from block filter

BlockSubscriptionChannel
ConstantToken
DiagnosticIdentity
DiagnosticNotification
DiagnosticRecipient
EmailHtmlSubscriptionChannel
EmailPlaintextSubscriptionChannel
EventBacklogStatus
EventBatch
EventProcessingLog
EventsEvaluationResult

Encapsulates events result properties. It defines the total number of events used and the number of matched events.

EventTransformRequest

A transform request specify the properties of a notification event to be transformed.

EventTransformResult

Result of transforming a notification event.

ExpressionFilter
ExpressionFilterClause

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]'

ExpressionFilterGroup

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

ExpressionFilterModel
FieldException
FieldInputValues
FieldValuesQuery
GeneratedNotification
GroupSubscriptionChannel
InvalidDiagnosticLog
InvalidNotificationSubscriptionQueryException

Exception thrown when an invalid subscription query is specified.

InvalidQueryFlagException

Exception thrown when querying for a certain target and providing AlwaysReturnBasicInformation flag

JsonPathSubscriptionExpression

Json based PathSubscriptionExpression This class is responsible for translating both ways between Json Paths stored in the dabases into a readable FilterName/Operator/FilterValue

JsonPathToken
MatcherResult
MessageQueueSubscriptionChannel
NotificationAdminSettings
NotificationAdminSettingsUpdateParameters
NotificationApiConstants
NotificationApiConstants.BatchNotificationOperationsResource
NotificationApiConstants.EventsResource
NotificationApiConstants.EventTransformsResource
NotificationApiConstants.EventTypesFieldsResource
NotificationApiConstants.EventTypesResource
NotificationApiConstants.NotificationDiagnosticLogsResource
NotificationApiConstants.NotificationReasonsResource
NotificationApiConstants.SettingsResource
NotificationApiConstants.StatisticsQueryResource
NotificationApiConstants.SubscribersResource
NotificationApiConstants.SubscriptionDiagnosticsResource
NotificationApiConstants.SubscriptionsQueryResource
NotificationApiConstants.SubscriptionsResource
NotificationApiConstants.SubscriptionTemplatesResource
NotificationApiConstants.UserSettingsResource
NotificationBacklogStatus
NotificationBatch
NotificationCommonViewData
NotificationDeliveryLog
NotificationDiagnosticLog

Abstract base class for all of the diagnostic logs.

NotificationDiagnosticLogConverter
NotificationDiagnosticLogMessage
NotificationEventBacklogStatus
NotificationEventField

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.

NotificationEventFieldOperator

Encapsulates the properties of a field type. It includes a unique id for the operator and a localized string for display name

NotificationEventFieldType

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

NotificationEventPublisher

Encapsulates the properties of a notification event publisher.

NotificationEventRole

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

NotificationEventType

Encapsulates the properties of an event type. It defines the fields, that can be used for filtering, for that event type.

NotificationEventTypeCategory

Encapsulates the properties of a category. A category will be used by the UI to group event types

NotificationEventTypeNotAllowedException

Exception thrown when an invalid event type is used in an unsupported way.

NotificationEventTypeNotFoundException

Exception thrown when a specified event type could not be found.

NotificationEventTypeNotSupportedFormatException
NotificationEventTypeNotSupportedScopeException

Exception thrown when a specified event type does not support the specified scope

NotificationJobDiagnosticLog
NotificationQueryCondition
NotificationReason
NotificationsEvaluationResult

Encapsulates notifications result properties. It defines the number of notifications and the recipients of notifications.

NotificationStatistic
NotificationStatisticsQuery
NotificationStatisticsQueryConditions
NotificationSubscriber

A subscriber is a user or group that has the potential to receive notifications.

NotificationSubscriberUpdateParameters

Updates to a subscriber. Typically used to change (or set) a preferred email address or default delivery preference.

NotificationSubscription

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

NotificationSubscriptionChannelNotAllowedException

Exception thrown when the specified channel cannot be used in this context.

NotificationSubscriptionCreateParameters

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.

NotificationSubscriptionsViewData
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.

OperatorConstraint

Encapsulates the properties of an operator constraint. An operator constraint defines if some operator is available only for specific scope like a project scope.

PathSubscriptionExpression
ProcessedEvent
ProcessingDiagnosticIdentity
ProcessingIdentities
RemoteAdminSettingsException
RoleBasedFilter
ServiceBusSubscriptionChannel
ServiceHooksSubscriptionChannel
SoapSubscriptionChannel
SubscriptionAdminSettings

Admin-managed settings for a group subscription.

SubscriptionChannelConverter
SubscriptionChannelWithAddress
SubscriptionDiagnostics
SubscriptionEvaluation
SubscriptionEvaluationClause
SubscriptionEvaluationRequest

Encapsulates the properties of a SubscriptionEvaluationRequest. It defines the subscription to be evaluated and time interval for events used in evaluation.

SubscriptionEvaluationResult

Ecapsulates the subscription evaluation results. It defines the Date Interval that was used, number of events evaluated and events and notifications results

SubscriptionEvaluationSettings

Encapsulates the subscription evaluation settings needed for the UI

SubscriptionFilterConverter
SubscriptionFilterOperators
SubscriptionManagement

Encapsulates the properties needed to manage subscriptions, opt in and out of subscriptions.

SubscriptionOptOutBlocked

Exception thrown a user tries to opt out of subscription that the admin blocked out of it

SubscriptionOptOutNotSupported

Exception thrown a user tries to opt out of non group subscription

SubscriptionQuery

Notification subscriptions query input.

SubscriptionQueryCondition

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.

SubscriptionScope

A resource, typically an account or project, in which events are published from.

SubscriptionStatisticViewData
SubscriptionTraceDiagnosticLog
SubscriptionTraceEventProcessingLog
SubscriptionTraceNotificationDeliveryLog
SubscriptionTracing
SubscriptionUserSettings

User-managed settings for a group subscription.

Token
TypeStringLookupConverter
UnsupportedDeliveryPreference

Exception thrown when the specified subscriber has unsupported type for updating delivery preferences

UnsupportedFilter
UnsupportedSubscriptionChannel
UpdateSubscripitonDiagnosticsParameters
UpdateSubscripitonTracingParameters
UserSubscriptionChannel
UserSystemSubscriptionChannel
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

XPathSubscriptionExpression

This class is responsible for translating both ways between XPath stored in the dabases into a readable FilterName/Operator/FilterValue

XPathToken

Interfaces

INotificationDiagnosticLog

Abstraction interface for the diagnostic log. Primarily for deserialization.

ISubscriptionChannel
ISubscriptionFilter

Enums

DefaultGroupDeliveryPreference

Default delivery preference for group subscribers. Indicates how the subscriber should be notified.

EvaluationOperationStatus

Describes the subscription evaluation operation status.

EventPublisherQueryFlags

Set of flags used to determine which set of information is retrieved when querying for event publishers

EventTypeQueryFlags

Set of flags used to determine which set of information is retrieved when querying for eventtypes

FieldFilterType

Verious filters that can be used with a subscription field.

NotificationOperation
NotificationReasonType
NotificationStatisticType
NotificationSubscriberDeliveryPreference

Delivery preference for a subscriber. Indicates how the subscriber should be notified.

SubscriberFlags
SubscriptionFieldType
SubscriptionFlags

Read-only indicators that further describe the subscription.

SubscriptionPermissions

The permissions that a user has to a certain subscription

SubscriptionQueryFlags

Flags that influence the result set of a subscription query.

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.

SubscriptionTemplateQueryFlags

Set of flags used to determine which set of templates is retrieved when querying for subscription templates

SubscriptionTemplateType