VssNotificationEvent interface

Pakket:

azure-devops-extension-api

Dit is het type dat wordt gebruikt voor het activeren van meldingen die zijn bedoeld voor het subsysteem in de Notifications SDK. Voor onderdelen die niet rechtstreeks afhankelijk kunnen zijn van de Notifications SDK, kunnen ze ITeamFoundationEventService.PublishNotification gebruiken. De implementatie van de Notifications SDK ISubscriber haalt deze op.

Eigenschappen

actors	Optioneel: een lijst met actoren die aanvullende identiteiten zijn met bijbehorende rollen die relevant zijn voor de gebeurtenis.
artifactUris	Optioneel: een lijst met artefacten waarnaar wordt verwezen of beïnvloed door deze gebeurtenis.
data	Vereist: de nettolading van de gebeurtenis. Als Gegevens een tekenreeks is, moet deze de Json- of XML-indeling hebben. Anders moet het kenmerk serialisatie-indeling hebben.
eventType	Vereist: de naam van de gebeurtenis. Deze gebeurtenis moet worden geregistreerd in de context waarin deze wordt geactiveerd.
expiresIn	Hoe lang voordat de gebeurtenis verloopt en wordt opgeschoond. De standaardinstelling van het systeem is.
itemId	De id van het item, artefact, extensie, project, enzovoort.
processDelay	Hoe lang moet worden gewacht voordat deze gebeurtenis wordt verwerkt. De standaardinstelling is om onmiddellijk te verwerken.
scopes	Optioneel: een lijst met bereiken die relevant zijn voor de gebeurtenis.
sourceEventCreatedTime	Dit is het tijdstip waarop de oorspronkelijke brongebeurtenis voor dit VssNotificationEvent is gemaakt. Voor iets als een melding over voltooiing van een build moet SourceEventCreatedTime bijvoorbeeld het tijdstip zijn waarop de build is voltooid en niet het tijdstip waarop deze gebeurtenis is gegenereerd.

Eigenschapdetails

actors

Optioneel: een lijst met actoren die aanvullende identiteiten zijn met bijbehorende rollen die relevant zijn voor de gebeurtenis.

actors: EventActor[]

Waarde van eigenschap

EventActor[]

artifactUris

Optioneel: een lijst met artefacten waarnaar wordt verwezen of beïnvloed door deze gebeurtenis.

artifactUris: string[]

Waarde van eigenschap

string[]

data

Vereist: de nettolading van de gebeurtenis. Als Gegevens een tekenreeks is, moet deze de Json- of XML-indeling hebben. Anders moet het kenmerk serialisatie-indeling hebben.

data: any

Waarde van eigenschap

any

eventType

Vereist: de naam van de gebeurtenis. Deze gebeurtenis moet worden geregistreerd in de context waarin deze wordt geactiveerd.

eventType: string

Waarde van eigenschap

string

expiresIn

Hoe lang voordat de gebeurtenis verloopt en wordt opgeschoond. De standaardinstelling van het systeem is.

expiresIn: any

Waarde van eigenschap

any

itemId

De id van het item, artefact, extensie, project, enzovoort.

itemId: string

Waarde van eigenschap

string

processDelay

Hoe lang moet worden gewacht voordat deze gebeurtenis wordt verwerkt. De standaardinstelling is om onmiddellijk te verwerken.

processDelay: any

Waarde van eigenschap

any

scopes

Optioneel: een lijst met bereiken die relevant zijn voor de gebeurtenis.

scopes: EventScope[]

Waarde van eigenschap

EventScope[]

sourceEventCreatedTime

Dit is het tijdstip waarop de oorspronkelijke brongebeurtenis voor dit VssNotificationEvent is gemaakt. Voor iets als een melding over voltooiing van een build moet SourceEventCreatedTime bijvoorbeeld het tijdstip zijn waarop de build is voltooid en niet het tijdstip waarop deze gebeurtenis is gegenereerd.

sourceEventCreatedTime: Date

Waarde van eigenschap

Date