Dela via

VssNotificationEvent interface

  • Referens
Paket:
azure-devops-extension-api

Det här är den typ som används för att starta meddelanden som är avsedda för undersystemet i Notifications SDK. För komponenter som inte kan vara beroende av Notifications SDK direkt kan de använda ITeamFoundationEventService.PublishNotification så får implementeringen av Notifications SDK ISubscriber det.

Egenskaper

actors

Valfritt: En lista över aktörer som är ytterligare identiteter med motsvarande roller som är relevanta för händelsen.
artifactUris

Valfritt: En lista över artefakter som refereras till eller påverkas av den här händelsen.
data

Krävs: Händelsenyttolasten. Om Data är en sträng måste den vara i Json- eller XML-format. Annars måste den ha ett serialiseringsformatattribut.
eventType

Krävs: Namnet på händelsen. Den här händelsen måste registreras i den kontext som den utlöses.
expiresIn

Hur lång tid innan händelsen upphör att gälla och rensas. Standardvärdet är att använda systemets standardvärde.
itemId

ID:t för objektet, artefakten, tillägget, projektet osv.
processDelay

Hur lång tid att vänta innan den här händelsen bearbetas. Standardvärdet är att bearbeta omedelbart.
scopes

Valfritt: En lista över omfång som är relevanta för händelsen.
sourceEventCreatedTime

Det här är den tidpunkt då den ursprungliga källhändelsen för vssNotificationEvent skapades. Till exempel, för något som liknar ett meddelande om att bygget har slutförts ska SourceEventCreatedTime vara den tidpunkt då bygget slutfördes, inte den tidpunkt då händelsen aktiverades.

Egenskapsinformation

actors

Valfritt: En lista över aktörer som är ytterligare identiteter med motsvarande roller som är relevanta för händelsen.

actors: EventActor[]

Egenskapsvärde

EventActor[]

artifactUris

Valfritt: En lista över artefakter som refereras till eller påverkas av den här händelsen.

artifactUris: string[]

Egenskapsvärde

string[]

data

Krävs: Händelsenyttolasten. Om Data är en sträng måste den vara i Json- eller XML-format. Annars måste den ha ett serialiseringsformatattribut.

data: any

Egenskapsvärde

any

eventType

Krävs: Namnet på händelsen. Den här händelsen måste registreras i den kontext som den utlöses.

eventType: string

Egenskapsvärde

string

expiresIn

Hur lång tid innan händelsen upphör att gälla och rensas. Standardvärdet är att använda systemets standardvärde.

expiresIn: any

Egenskapsvärde

any

itemId

ID:t för objektet, artefakten, tillägget, projektet osv.

itemId: string

Egenskapsvärde

string

processDelay

Hur lång tid att vänta innan den här händelsen bearbetas. Standardvärdet är att bearbeta omedelbart.

processDelay: any

Egenskapsvärde

any

scopes

Valfritt: En lista över omfång som är relevanta för händelsen.

scopes: EventScope[]

Egenskapsvärde

EventScope[]

sourceEventCreatedTime

Det här är den tidpunkt då den ursprungliga källhändelsen för vssNotificationEvent skapades. Till exempel, för något som liknar ett meddelande om att bygget har slutförts ska SourceEventCreatedTime vara den tidpunkt då bygget slutfördes, inte den tidpunkt då händelsen aktiverades.

sourceEventCreatedTime: Date

Egenskapsvärde

Date