VssNotificationEvent interface

Pacote:

azure-devops-extension-api

Este é o tipo usado para disparar notificações destinadas ao subsistema no SDK de notificações. Para componentes que não podem depender diretamente do SDK de notificações, eles podem usar ITeamFoundationEventService.PublishNotification e a implementação ISubscriber do SDK de notificações obtê-lo-á.

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 artefatos referenciados ou impactados por esse evento.
data	Obrigatório: A carga útil do evento. Se Data for uma cadeia de caracteres, ela deverá estar no formato Json ou XML. Caso contrário, ele deve ter um atributo de formato de serialização.
eventType	Obrigatório: O nome do evento. Este evento deve ser registado no contexto em que está a ser disparado.
expiresIn	Quanto tempo antes do evento expirar e será limpo. O padrão é usar o padrão do sistema.
itemId	O id do item, artefato, extensão, projeto, etc.
processDelay	Quanto tempo esperar antes de processar este evento. O padrão é processar imediatamente.
scopes	Opcional: uma lista de escopos relevantes para o evento.
sourceEventCreatedTime	Este é o momento 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 foi concluída e não a hora em que esse 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 artefatos referenciados ou impactados por esse evento.

artifactUris: string[]

Valor de Propriedade

string[]

data

Obrigatório: A carga útil do evento. Se Data for uma cadeia de caracteres, ela deverá estar no formato Json ou XML. Caso contrário, ele deve ter um atributo de formato de serialização.

data: any

Valor de Propriedade

any

eventType

Obrigatório: O nome do evento. Este evento deve ser registado no contexto em que está a ser disparado.

eventType: string

Valor de Propriedade

string

expiresIn

Quanto tempo antes do evento expirar e será limpo. O padrão é usar o padrão do sistema.

expiresIn: any

Valor de Propriedade

any

itemId

O id do item, artefato, extensão, projeto, etc.

itemId: string

Valor de Propriedade

string

processDelay

Quanto tempo esperar antes de processar este evento. O padrão é processar imediatamente.

processDelay: any

Valor de Propriedade

any

scopes

Opcional: uma lista de escopos relevantes para o evento.

scopes: EventScope[]

Valor de Propriedade

EventScope[]

sourceEventCreatedTime

Este é o momento 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 foi concluída e não a hora em que esse evento foi gerado.

sourceEventCreatedTime: Date

Valor de Propriedade

Date