VssNotificationEvent interface

Balíček:

azure-devops-extension-api

Jedná se o typ používaný pro aktivaci oznámení určených pro subsystém v sadě Notifications SDK. U komponent, které nemůžou přímo využívat závislost na sadě Notifications SDK, můžou použít ITeamFoundationEventService.PublishNotification a implementace ISubscriber sady Notifications SDK ji získá.

Vlastnosti

actors	Volitelné: Seznam herců, které jsou další identity s odpovídajícími rolemi, které jsou pro událost relevantní.
artifactUris	Volitelné: Seznam artefaktů odkazovaných na tuto událost nebo ovlivněný touto událostí.
data	Povinné: Datová část události. Pokud jsou data řetězcem, musí být ve formátu Json nebo XML. Jinak musí mít atribut formátu serializace.
eventType	Povinné: Název události. Tato událost musí být zaregistrovaná v kontextu, který se aktivuje.
expiresIn	Jak dlouho vyprší platnost události a vyčistí se. Výchozí hodnota je použít výchozí systém.
itemId	ID položky, artefaktu, rozšíření, projektu atd.
processDelay	Jak dlouho čekat před zpracováním této události Výchozí hodnota je okamžitě zpracovat.
scopes	Volitelné: Seznam oborů, které jsou relevantní pro událost.
sourceEventCreatedTime	Toto je čas, kdy byla vytvořena původní zdrojová událost pro tuto VssNotificationEvent. Například v případě oznámení o dokončení sestavení SourceEventCreatedTime by mělo být čas dokončení sestavení, nikoli čas, kdy byla tato událost vyvolána.

Podrobnosti vlastnosti

actors

Volitelné: Seznam herců, které jsou další identity s odpovídajícími rolemi, které jsou pro událost relevantní.

actors: EventActor[]

Hodnota vlastnosti

EventActor[]

artifactUris

Volitelné: Seznam artefaktů odkazovaných na tuto událost nebo ovlivněný touto událostí.

artifactUris: string[]

Hodnota vlastnosti

string[]

data

Povinné: Datová část události. Pokud jsou data řetězcem, musí být ve formátu Json nebo XML. Jinak musí mít atribut formátu serializace.

data: any

Hodnota vlastnosti

any

eventType

Povinné: Název události. Tato událost musí být zaregistrovaná v kontextu, který se aktivuje.

eventType: string

Hodnota vlastnosti

string

expiresIn

Jak dlouho vyprší platnost události a vyčistí se. Výchozí hodnota je použít výchozí systém.

expiresIn: any

Hodnota vlastnosti

any

itemId

ID položky, artefaktu, rozšíření, projektu atd.

itemId: string

Hodnota vlastnosti

string

processDelay

Jak dlouho čekat před zpracováním této události Výchozí hodnota je okamžitě zpracovat.

processDelay: any

Hodnota vlastnosti

any

scopes

Volitelné: Seznam oborů, které jsou relevantní pro událost.

scopes: EventScope[]

Hodnota vlastnosti

EventScope[]

sourceEventCreatedTime

Toto je čas, kdy byla vytvořena původní zdrojová událost pro tuto VssNotificationEvent. Například v případě oznámení o dokončení sestavení SourceEventCreatedTime by mělo být čas dokončení sestavení, nikoli čas, kdy byla tato událost vyvolána.

sourceEventCreatedTime: Date

Hodnota vlastnosti

Date