Share via

VssNotificationEvent interface

  • Referenz
Paket:
azure-devops-extension-api

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

Eigenschaften

actors

Optional: Eine Liste von Akteuren, bei denen es sich um zusätzliche Identitäten mit entsprechenden Rollen handelt, die für das Ereignis relevant sind.
artifactUris

Optional: Eine Liste von Artefakten, auf die von diesem Ereignis verwiesen wird.
data

Erforderlich: Die Ereignisnutzlast. Wenn Data eine Zeichenfolge ist, muss sie im JSON- oder XML-Format vorliegen. Andernfalls muss es über ein Attribut für das Serialisierungsformat verfügen.
eventType

Erforderlich: Der Name des Ereignisses. Dieses Ereignis muss in dem 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, des Artefakts, der Erweiterung, des Projekts usw.
processDelay

Wie lange auf die Verarbeitung dieses Ereignisses gewartet werden soll. Standardmäßig wird sofort verarbeitet.
scopes

Optional: Eine Liste von Bereichen, die für das Ereignis relevant sind.
sourceEventCreatedTime

Zu diesem Zeitpunkt wurde das ursprüngliche Quellereignis für dieses VssNotificationEvent erstellt. Beispielsweise sollte für eine Buildabschlussbenachrichtigung SourceEventCreatedTime der Zeitpunkt des Buildabschlusses sein, nicht der Zeitpunkt, zu dem dieses Ereignis ausgelöst wurde.

Details zur Eigenschaft

actors

Optional: Eine Liste von Akteuren, bei denen es sich um zusätzliche Identitäten mit entsprechenden Rollen handelt, die für das Ereignis relevant sind.

actors: EventActor[]

Eigenschaftswert

EventActor[]

artifactUris

Optional: Eine Liste von Artefakten, auf die von diesem Ereignis verwiesen wird.

artifactUris: string[]

Eigenschaftswert

string[]

data

Erforderlich: Die Ereignisnutzlast. Wenn Data eine Zeichenfolge ist, muss sie im JSON- oder XML-Format vorliegen. Andernfalls muss es über ein Attribut für das Serialisierungsformat verfügen.

data: any

Eigenschaftswert

any

eventType

Erforderlich: Der Name des Ereignisses. Dieses Ereignis muss in dem 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, des Artefakts, der Erweiterung, des Projekts usw.

itemId: string

Eigenschaftswert

string

processDelay

Wie lange auf die Verarbeitung dieses Ereignisses gewartet werden soll. Standardmäßig wird sofort verarbeitet.

processDelay: any

Eigenschaftswert

any

scopes

Optional: Eine Liste von Bereichen, die für das Ereignis relevant sind.

scopes: EventScope[]

Eigenschaftswert

EventScope[]

sourceEventCreatedTime

Zu diesem Zeitpunkt wurde das ursprüngliche Quellereignis für dieses VssNotificationEvent erstellt. Beispielsweise sollte für eine Buildabschlussbenachrichtigung SourceEventCreatedTime der Zeitpunkt des Buildabschlusses sein, nicht der Zeitpunkt, zu dem dieses Ereignis ausgelöst wurde.

sourceEventCreatedTime: Date

Eigenschaftswert

Date