VssNotificationEvent interface

  • Referência
Pacote:
azure-devops-extension-api

Este é o tipo utilizado para acionar notificações destinadas ao subsistema no SDK de Notificações. Para componentes que não podem assumir uma dependência diretamente no SDK de Notificações, podem utilizar ITeamFoundationEventService.PublishNotification e a implementação ISubscriber do SDK de Notificações irá obtê-la.

Propriedades

actors

Opcional: uma lista de atores que são identidades adicionais com funções correspondentes que são relevantes para o evento.
artifactUris

Opcional: uma lista de artefactos referenciados ou afetados por este evento.
data

Obrigatório: o payload do evento. Se Dados for uma cadeia, tem de estar no formato Json ou XML. Caso contrário, tem de ter um atributo de formato de serialização.
eventType

Obrigatório: o nome do evento. Este evento tem de ser registado no contexto em que está a ser acionado.
expiresIn

Quanto tempo antes de o evento expirar e será limpo. A predefinição é utilizar a predefinição do sistema.
itemId

O ID do item, artefacto, extensão, projeto, etc.
processDelay

Quanto tempo esperar antes de processar este evento. A predefinição é processar imediatamente.
scopes

Opcional: uma lista de âmbitos relevantes para o evento.
sourceEventCreatedTime

Esta é a hora em que o evento de origem original para este VssNotificationEvent foi criado. Por exemplo, para algo como uma notificação de conclusão de compilação SourceEventCreatedTime deve ser a hora em que a compilação terminou e não a hora em que este evento foi gerado.

Detalhes de Propriedade

actors

Opcional: uma lista de atores que são identidades adicionais com funções correspondentes que são relevantes para o evento.

actors: EventActor[]

Valor de Propriedade

EventActor[]

artifactUris

Opcional: uma lista de artefactos referenciados ou afetados por este evento.

artifactUris: string[]

Valor de Propriedade

string[]

data

Obrigatório: o payload do evento. Se Dados for uma cadeia, tem de estar no formato Json ou XML. Caso contrário, tem de ter um atributo de formato de serialização.

data: any

Valor de Propriedade

any

eventType

Obrigatório: o nome do evento. Este evento tem de ser registado no contexto em que está a ser acionado.

eventType: string

Valor de Propriedade

string

expiresIn

Quanto tempo antes de o evento expirar e será limpo. A predefinição é utilizar a predefinição do sistema.

expiresIn: any

Valor de Propriedade

any

itemId

O ID do item, artefacto, extensão, projeto, etc.

itemId: string

Valor de Propriedade

string

processDelay

Quanto tempo esperar antes de processar este evento. A predefinição é processar imediatamente.

processDelay: any

Valor de Propriedade

any

scopes

Opcional: uma lista de âmbitos relevantes para o evento.

scopes: EventScope[]

Valor de Propriedade

EventScope[]

sourceEventCreatedTime

Esta é a hora em que o evento de origem original para este VssNotificationEvent foi criado. Por exemplo, para algo como uma notificação de conclusão de compilação SourceEventCreatedTime deve ser a hora em que a compilação terminou e não a hora em que este evento foi gerado.

sourceEventCreatedTime: Date

Valor de Propriedade

Date