VssNotificationEvent interface

Paket:

azure-devops-extension-api

Dies ist der Typ, der zum Auslösen von Benachrichtigungen verwendet wird, die für das Subsystem im Notifications SDK vorgesehen sind. Für Komponenten, die keine Abhängigkeit vom Notifications SDK direkt annehmen können, können sie ITeamFoundationEventService.PublishNotification und die Notifications SDK ISubscriber-Implementierung verwenden.

Eigenschaften

actors	Optional: Eine Liste der Akteure, die zusätzliche Identitäten mit entsprechenden Rollen sind, die für das Ereignis relevant sind.
artifactUris	Optional: Eine Liste von Artefakten, auf die von diesem Ereignis verwiesen oder davon betroffen ist.
data	Erforderlich: Die Ereignisnutzlast. Wenn Es sich bei Daten um eine Zeichenfolge handelt, muss sie im JSON- oder XML-Format vorliegen. Andernfalls muss es über ein Serialisierungsformat-Attribut verfügen.
eventType	Erforderlich: Der Name des Ereignisses. Dieses Ereignis muss im Kontext registriert werden, in dem es ausgelöst wird.
expiresIn	Wie lange das Ereignis abläuft und bereinigt wird. Standardmäßig wird der Systemstandard verwendet.
itemId	Die ID des Elements, Artefakts, Erweiterung, Projekts usw.
processDelay	Wie lange gewartet werden muss, bevor dieses Ereignis verarbeitet wird. Der Standardwert besteht darin, sofort zu verarbeiten.
scopes	Optional: Eine Liste der Bereiche, die für das Ereignis relevant sind.
sourceEventCreatedTime	Dies ist der Zeitpunkt, zu dem das ursprüngliche Quellereignis für dieses VssNotificationEvent erstellt wurde. Bei einer Benachrichtigung über den Abschluss des Builds sollte SourceEventCreatedTime z. B. der Zeitpunkt sein, zu dem der Build abgeschlossen wurde, und nicht der Zeitpunkt, zu dem dieses Ereignis ausgelöst wurde.

Details zur Eigenschaft

actors

Optional: Eine Liste der Akteure, die zusätzliche Identitäten mit entsprechenden Rollen sind, die für das Ereignis relevant sind.

actors: EventActor[]

Eigenschaftswert

EventActor[]

artifactUris

Optional: Eine Liste von Artefakten, auf die von diesem Ereignis verwiesen oder davon betroffen ist.

artifactUris: string[]

Eigenschaftswert

string[]

data

Erforderlich: Die Ereignisnutzlast. Wenn Es sich bei Daten um eine Zeichenfolge handelt, muss sie im JSON- oder XML-Format vorliegen. Andernfalls muss es über ein Serialisierungsformat-Attribut verfügen.

data: any

Eigenschaftswert

any

eventType

Erforderlich: Der Name des Ereignisses. Dieses Ereignis muss im Kontext registriert werden, in dem es ausgelöst wird.

eventType: string

Eigenschaftswert

string

expiresIn

Wie lange das Ereignis abläuft und bereinigt wird. Standardmäßig wird der Systemstandard verwendet.

expiresIn: any

Eigenschaftswert

any

itemId

Die ID des Elements, Artefakts, Erweiterung, Projekts usw.

itemId: string

Eigenschaftswert

string

processDelay

Wie lange gewartet werden muss, bevor dieses Ereignis verarbeitet wird. Der Standardwert besteht darin, sofort zu verarbeiten.

processDelay: any

Eigenschaftswert

any

scopes

Optional: Eine Liste der Bereiche, die für das Ereignis relevant sind.

scopes: EventScope[]

Eigenschaftswert

EventScope[]

sourceEventCreatedTime

Dies ist der Zeitpunkt, zu dem das ursprüngliche Quellereignis für dieses VssNotificationEvent erstellt wurde. Bei einer Benachrichtigung über den Abschluss des Builds sollte SourceEventCreatedTime z. B. der Zeitpunkt sein, zu dem der Build abgeschlossen wurde, und nicht der Zeitpunkt, zu dem dieses Ereignis ausgelöst wurde.

sourceEventCreatedTime: Date

Eigenschaftswert

Date