Edit

Share via

VssNotificationEvent interface

  • Reference
Package:
azure-devops-extension-api

This is the type used for firing notifications intended for the subsystem in the Notifications SDK. For components that can't take a dependency on the Notifications SDK directly, they can use ITeamFoundationEventService.PublishNotification and the Notifications SDK ISubscriber implementation will get it.

Properties

actors

Optional: A list of actors which are additional identities with corresponding roles that are relevant to the event.
artifactUris

Optional: A list of artifacts referenced or impacted by this event.
data

Required: The event payload. If Data is a string, it must be in Json or XML format. Otherwise it must have a serialization format attribute.
eventType

Required: The name of the event. This event must be registered in the context it is being fired.
expiresIn

How long before the event expires and will be cleaned up. The default is to use the system default.
itemId

The id of the item, artifact, extension, project, etc.
processDelay

How long to wait before processing this event. The default is to process immediately.
scopes

Optional: A list of scopes which are relevant to the event.
sourceEventCreatedTime

This is the time the original source event for this VssNotificationEvent was created. For example, for something like a build completion notification SourceEventCreatedTime should be the time the build finished not the time this event was raised.

Property Details

actors

Optional: A list of actors which are additional identities with corresponding roles that are relevant to the event.

actors: EventActor[]

Property Value

EventActor[]

artifactUris

Optional: A list of artifacts referenced or impacted by this event.

artifactUris: string[]

Property Value

string[]

data

Required: The event payload. If Data is a string, it must be in Json or XML format. Otherwise it must have a serialization format attribute.

data: any

Property Value

any

eventType

Required: The name of the event. This event must be registered in the context it is being fired.

eventType: string

Property Value

string

expiresIn

How long before the event expires and will be cleaned up. The default is to use the system default.

expiresIn: any

Property Value

any

itemId

The id of the item, artifact, extension, project, etc.

itemId: string

Property Value

string

processDelay

How long to wait before processing this event. The default is to process immediately.

processDelay: any

Property Value

any

scopes

Optional: A list of scopes which are relevant to the event.

scopes: EventScope[]

Property Value

EventScope[]

sourceEventCreatedTime

This is the time the original source event for this VssNotificationEvent was created. For example, for something like a build completion notification SourceEventCreatedTime should be the time the build finished not the time this event was raised.

sourceEventCreatedTime: Date

Property Value

Date