NotificationSubscription interface

Pacote:

azure-devops-extension-api

Uma subscrição define critérios para eventos correspondentes e como o subscritor da subscrição deve ser notificado sobre esses eventos.

Propriedades

adminSettings	Administração definições geridas para a subscrição. Só se aplica quando o subscritor é um grupo.
channel	Canal para a entrega de notificações acionadas pela subscrição.
description	Descrição da subscrição. Normalmente, descreve critérios de filtro que ajudam a identificar a subscrição.
diagnostics	Diagnósticos para esta subscrição.
extendedProperties	Quaisquer propriedades adicionais, como a descrição detalhada para diferentes contextos, contextos de utilizador/grupo
filter	Critérios correspondentes para a subscrição. ExpressionFilter
flags	Indicadores só de leitura que descrevem ainda mais a subscrição.
id	Identificador de subscrição.
lastModifiedBy	Utilizador que modificou (ou criou) a subscrição pela última vez.
modifiedDate	Data da última modificação da subscrição. Se a subscrição não tiver sido atualizada desde que foi criada, este valor indicará quando a subscrição foi criada.
permissions	As permissões que o utilizador tem para estas subscrições.
scope	O contentor no qual os eventos têm de ser publicados para serem correspondidos pela subscrição. Se estiver vazio, o âmbito é o anfitrião atual (normalmente uma conta ou coleção de projetos). Por exemplo, uma subscrição no âmbito do projeto A não produzirá notificações para eventos publicados a partir do projeto B.
status	Estado da subscrição. Normalmente, indica se a subscrição está ativada ou não.
statusMessage	Mensagem que fornece mais detalhes sobre o estado da subscrição.
subscriber	Utilizador ou grupo que receberá notificações para eventos que correspondam aos critérios de filtro da subscrição.
url	URL da API REST da subscrição.
userSettings	Definições geridas pelo utilizador para a subscrição. Só se aplica quando o subscritor é um grupo. Normalmente, é utilizado para indicar se o utilizador de chamadas é optado por entrar ou sair de uma subscrição de grupo.

Detalhes de Propriedade

adminSettings

Administração definições geridas para a subscrição. Só se aplica quando o subscritor é um grupo.

adminSettings: SubscriptionAdminSettings

Valor de Propriedade

SubscriptionAdminSettings

channel

Canal para a entrega de notificações acionadas pela subscrição.

channel: ISubscriptionChannel

Valor de Propriedade

ISubscriptionChannel

description

Descrição da subscrição. Normalmente, descreve critérios de filtro que ajudam a identificar a subscrição.

description: string

Valor de Propriedade

string

diagnostics

Diagnósticos para esta subscrição.

diagnostics: SubscriptionDiagnostics

Valor de Propriedade

SubscriptionDiagnostics

extendedProperties

Quaisquer propriedades adicionais, como a descrição detalhada para diferentes contextos, contextos de utilizador/grupo

extendedProperties: {[key: string]: string}

Valor de Propriedade

{[key: string]: string}

filter

Critérios correspondentes para a subscrição. ExpressionFilter

filter: ISubscriptionFilter

Valor de Propriedade

ISubscriptionFilter

flags

Indicadores só de leitura que descrevem ainda mais a subscrição.

flags: SubscriptionFlags

Valor de Propriedade

SubscriptionFlags

id

Identificador de subscrição.

id: string

Valor de Propriedade

string

lastModifiedBy

Utilizador que modificou (ou criou) a subscrição pela última vez.

lastModifiedBy: IdentityRef

Valor de Propriedade

IdentityRef

modifiedDate

Data da última modificação da subscrição. Se a subscrição não tiver sido atualizada desde que foi criada, este valor indicará quando a subscrição foi criada.

modifiedDate: Date

Valor de Propriedade

Date

permissions

As permissões que o utilizador tem para estas subscrições.

permissions: SubscriptionPermissions

Valor de Propriedade

SubscriptionPermissions

scope

O contentor no qual os eventos têm de ser publicados para serem correspondidos pela subscrição. Se estiver vazio, o âmbito é o anfitrião atual (normalmente uma conta ou coleção de projetos). Por exemplo, uma subscrição no âmbito do projeto A não produzirá notificações para eventos publicados a partir do projeto B.

scope: SubscriptionScope

Valor de Propriedade

SubscriptionScope

status

Estado da subscrição. Normalmente, indica se a subscrição está ativada ou não.

status: SubscriptionStatus

Valor de Propriedade

SubscriptionStatus

statusMessage

Mensagem que fornece mais detalhes sobre o estado da subscrição.

statusMessage: string

Valor de Propriedade

string

subscriber

Utilizador ou grupo que receberá notificações para eventos que correspondam aos critérios de filtro da subscrição.

subscriber: IdentityRef

Valor de Propriedade

IdentityRef

url

URL da API REST da subscrição.

url: string

Valor de Propriedade

string

userSettings

Definições geridas pelo utilizador para a subscrição. Só se aplica quando o subscritor é um grupo. Normalmente, é utilizado para indicar se o utilizador de chamadas é optado por entrar ou sair de uma subscrição de grupo.

userSettings: SubscriptionUserSettings

Valor de Propriedade

SubscriptionUserSettings