VssNotificationEvent interface
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 direkt kan vara beroende av Notifications SDK kan de använda ITeamFoundationEventService.PublishNotification och implementeringen av Notifications SDK ISubscriber får det.
Egenskaper
| actors | Valfritt: En lista över aktörer som är ytterligare identiteter med motsvarande roller som är relevanta för händelsen. |
| artifact |
Valfritt: En lista över artefakter som refereras till eller påverkas av den här händelsen. |
| data | Obligatoriskt: Händelsenyttolasten. Om Data är en sträng måste den vara i Json- eller XML-format. Annars måste det ha ett serialiseringsformatattribut. |
| event |
Obligatoriskt: Namnet på händelsen. Den här händelsen måste registreras i den kontext som den utlöses. |
| expires |
Hur lång tid innan händelsen upphör att gälla och rensas. Standardvärdet är att använda systemets standardvärde. |
| item |
ID:t för objektet, artefakten, tillägget, projektet osv. |
| process |
Hur lång tid du ska vänta innan du bearbetar den här händelsen. Standardvärdet är att bearbeta omedelbart. |
| scopes | Valfritt: En lista över omfång som är relevanta för händelsen. |
| source |
Det här är den tid då den ursprungliga källhändelsen för denna VssNotificationEvent skapades. För något som liknar ett meddelande om att bygget har slutförts bör till exempel SourceEventCreatedTime vara den tidpunkt då bygget slutfördes, inte den tidpunkt då den här händelsen skapades. |
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
artifactUris
Valfritt: En lista över artefakter som refereras till eller påverkas av den här händelsen.
artifactUris: string[]
Egenskapsvärde
string[]
data
Obligatoriskt: Händelsenyttolasten. Om Data är en sträng måste den vara i Json- eller XML-format. Annars måste det ha ett serialiseringsformatattribut.
data: any
Egenskapsvärde
any
eventType
Obligatoriskt: 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 du ska vänta innan du bearbetar den här händelsen. 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
sourceEventCreatedTime
Det här är den tid då den ursprungliga källhändelsen för denna VssNotificationEvent skapades. För något som liknar ett meddelande om att bygget har slutförts bör till exempel SourceEventCreatedTime vara den tidpunkt då bygget slutfördes, inte den tidpunkt då den här händelsen skapades.
sourceEventCreatedTime: Date
Egenskapsvärde
Date