Sdílet prostřednictvím

VssNotificationEvent interface

  • Reference
Balíček:
azure-devops-extension-api

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

Vlastnosti

actors

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

Volitelné: Seznam artefaktů, na které tato událost odkazuje nebo na které má tato událost vliv.
data

Povinné: Datová část události. Pokud je data řetězec, 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 zaregistrována v kontextu, který se aktivuje.
expiresIn

Jak dlouho před vypršením platnosti události dojde k vyčištění. Ve výchozím nastavení se použije 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 zpracovat okamžitě.
scopes

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

Toto je čas vytvoření původní zdrojové události pro tuto VssNotificationEvent. Například pro něco jako oznámení o dokončení sestavení by sourceEventCreatedTime měl být čas dokončení sestavení, a ne čas, kdy byla tato událost vyvolána.

Podrobnosti vlastnosti

actors

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

actors: EventActor[]

Hodnota vlastnosti

EventActor[]

artifactUris

Volitelné: Seznam artefaktů, na které tato událost odkazuje nebo na které má tato událost vliv.

artifactUris: string[]

Hodnota vlastnosti

string[]

data

Povinné: Datová část události. Pokud je data řetězec, 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 zaregistrována v kontextu, který se aktivuje.

eventType: string

Hodnota vlastnosti

string

expiresIn

Jak dlouho před vypršením platnosti události dojde k vyčištění. Ve výchozím nastavení se použije 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 zpracovat okamžitě.

processDelay: any

Hodnota vlastnosti

any

scopes

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

scopes: EventScope[]

Hodnota vlastnosti

EventScope[]

sourceEventCreatedTime

Toto je čas vytvoření původní zdrojové události pro tuto VssNotificationEvent. Například pro něco jako oznámení o dokončení sestavení by sourceEventCreatedTime měl být čas dokončení sestavení, a ne čas, kdy byla tato událost vyvolána.

sourceEventCreatedTime: Date

Hodnota vlastnosti

Date