NotificationSubscription interface

Пакет:

azure-devops-extension-api

Подписка определяет критерии для сопоставления событий и способ уведомления подписчика об этих событиях.

Свойства

adminSettings	Администратор управляемые параметры для подписки. Применяется, только если подписчик является группой.
channel	Канал для доставки уведомлений, активированных подпиской.
description	Описание подписки. Обычно описывает критерии фильтра, которые помогают идентифицировать подписку.
diagnostics	Диагностика для этой подписки.
extendedProperties	Любые дополнительные свойства, такие как подробное описание для различных контекстов, контексты пользователей и групп
filter	Критерии соответствия для подписки. ExpressionFilter
flags	Индикаторы только для чтения, которые подробно описывают подписку.
id	Идентификатор подписки.
lastModifiedBy	Пользователь, который последним изменял (или создавал) подписку.
modifiedDate	Дата последнего изменения подписки. Если подписка не обновлялась с момента ее создания, это значение будет указывать, когда была создана подписка.
permissions	Разрешения, которые пользователь имеет для этих подписок.
scope	Контейнер, из которого должны публиковаться события, для сопоставления с подпиской. Если он пуст, область является текущим узлом (обычно это учетная запись или коллекция проектов). Например, подписка, ограниченная проектом A, не будет создавать уведомления о событиях, опубликованных из проекта B.
status	Состояние подписки. Обычно указывает, включена ли подписка.
statusMessage	Сообщение с дополнительными сведениями о состоянии подписки.
subscriber	Пользователь или группа, которые будут получать уведомления о событиях, соответствующих критериям фильтра подписки.
url	URL-адрес REST API подписки.
userSettings	Управляемые пользователем параметры для подписки. Применяется, только если подписчик является группой. Обычно используется для указания того, является ли вызывающий пользователь согласием на подписку группы или из нее.

Сведения о свойстве

adminSettings

Администратор управляемые параметры для подписки. Применяется, только если подписчик является группой.

adminSettings: SubscriptionAdminSettings

Значение свойства

SubscriptionAdminSettings

channel

Канал для доставки уведомлений, активированных подпиской.

channel: ISubscriptionChannel

Значение свойства

ISubscriptionChannel

description

Описание подписки. Обычно описывает критерии фильтра, которые помогают идентифицировать подписку.

description: string

Значение свойства

string

diagnostics

Диагностика для этой подписки.

diagnostics: SubscriptionDiagnostics

Значение свойства

SubscriptionDiagnostics

extendedProperties

Любые дополнительные свойства, такие как подробное описание для различных контекстов, контексты пользователей и групп

extendedProperties: {[key: string]: string}

Значение свойства

{[key: string]: string}

filter

Критерии соответствия для подписки. ExpressionFilter

filter: ISubscriptionFilter

Значение свойства

ISubscriptionFilter

flags

Индикаторы только для чтения, которые подробно описывают подписку.

flags: SubscriptionFlags

Значение свойства

SubscriptionFlags

id

Идентификатор подписки.

id: string

Значение свойства

string

lastModifiedBy

Пользователь, который последним изменял (или создавал) подписку.

lastModifiedBy: IdentityRef

Значение свойства

IdentityRef

modifiedDate

Дата последнего изменения подписки. Если подписка не обновлялась с момента ее создания, это значение будет указывать, когда была создана подписка.

modifiedDate: Date

Значение свойства

Date

permissions

Разрешения, которые пользователь имеет для этих подписок.

permissions: SubscriptionPermissions

Значение свойства

SubscriptionPermissions

scope

Контейнер, из которого должны публиковаться события, для сопоставления с подпиской. Если он пуст, область является текущим узлом (обычно это учетная запись или коллекция проектов). Например, подписка, ограниченная проектом A, не будет создавать уведомления о событиях, опубликованных из проекта B.

scope: SubscriptionScope

Значение свойства

SubscriptionScope

status

Состояние подписки. Обычно указывает, включена ли подписка.

status: SubscriptionStatus

Значение свойства

SubscriptionStatus

statusMessage

Сообщение с дополнительными сведениями о состоянии подписки.

statusMessage: string

Значение свойства

string

subscriber

Пользователь или группа, которые будут получать уведомления о событиях, соответствующих критериям фильтра подписки.

subscriber: IdentityRef

Значение свойства

IdentityRef

url

URL-адрес REST API подписки.

url: string

Значение свойства

string

userSettings

Управляемые пользователем параметры для подписки. Применяется, только если подписчик является группой. Обычно используется для указания того, является ли вызывающий пользователь согласием на подписку группы или из нее.

userSettings: SubscriptionUserSettings

Значение свойства

SubscriptionUserSettings