VssNotificationEvent interface

  • Riferimento
Pacchetto:
azure-devops-extension-api

Questo è il tipo usato per la generazione di notifiche destinate al sottosistema in Notifications SDK. Per i componenti che non possono dipendere direttamente da Notifications SDK, possono usare ITeamFoundationEventService.PublishNotification e l'implementazione di Notifications SDK ISubscriber lo otterrà.For components that can't take a dependency on the Notifications SDK, they can use ITeamFoundationEventService.PublishNotification and the Notifications SDK ISubscriber implementation will get it.

Proprietà

actors

Facoltativo: elenco di attori che sono identità aggiuntive con ruoli corrispondenti rilevanti per l'evento.
artifactUris

Facoltativo: elenco di elementi a cui si fa riferimento o interessato da questo evento.
data

Obbligatorio: payload dell'evento. Se Data è una stringa, deve essere in formato JSON o XML. In caso contrario, deve avere un attributo di formato di serializzazione.
eventType

Obbligatorio: nome dell'evento. Questo evento deve essere registrato nel contesto in cui viene generato.
expiresIn

Quanto tempo prima della scadenza dell'evento e verrà eseguita la pulizia. L'impostazione predefinita consiste nell'usare l'impostazione predefinita del sistema.
itemId

ID dell'elemento, dell'artefatto, dell'estensione, del progetto e così via.
processDelay

Tempo di attesa prima dell'elaborazione di questo evento. L'impostazione predefinita consiste nell'elaborare immediatamente.
scopes

Facoltativo: elenco di ambiti rilevanti per l'evento.
sourceEventCreatedTime

Questa è l'ora in cui è stato creato l'evento di origine originale per questo vssNotificationEvent. Ad esempio, per una notifica di completamento della compilazione SourceEventCreatedTime deve essere l'ora in cui la compilazione è terminata non l'ora in cui questo evento è stato generato.

Dettagli proprietà

actors

Facoltativo: elenco di attori che sono identità aggiuntive con ruoli corrispondenti rilevanti per l'evento.

actors: EventActor[]

Valore della proprietà

EventActor[]

artifactUris

Facoltativo: elenco di elementi a cui si fa riferimento o interessato da questo evento.

artifactUris: string[]

Valore della proprietà

string[]

data

Obbligatorio: payload dell'evento. Se Data è una stringa, deve essere in formato JSON o XML. In caso contrario, deve avere un attributo di formato di serializzazione.

data: any

Valore della proprietà

any

eventType

Obbligatorio: nome dell'evento. Questo evento deve essere registrato nel contesto in cui viene generato.

eventType: string

Valore della proprietà

string

expiresIn

Quanto tempo prima della scadenza dell'evento e verrà eseguita la pulizia. L'impostazione predefinita consiste nell'usare l'impostazione predefinita del sistema.

expiresIn: any

Valore della proprietà

any

itemId

ID dell'elemento, dell'artefatto, dell'estensione, del progetto e così via.

itemId: string

Valore della proprietà

string

processDelay

Tempo di attesa prima dell'elaborazione di questo evento. L'impostazione predefinita consiste nell'elaborare immediatamente.

processDelay: any

Valore della proprietà

any

scopes

Facoltativo: elenco di ambiti rilevanti per l'evento.

scopes: EventScope[]

Valore della proprietà

EventScope[]

sourceEventCreatedTime

Questa è l'ora in cui è stato creato l'evento di origine originale per questo vssNotificationEvent. Ad esempio, per una notifica di completamento della compilazione SourceEventCreatedTime deve essere l'ora in cui la compilazione è terminata non l'ora in cui questo evento è stato generato.

sourceEventCreatedTime: Date

Valore della proprietà

Date