VssNotificationEvent interface

这是用于触发通知 SDK 中子系统的通知的类型。 对于不能直接依赖于 Notifications SDK 的组件,可以使用 ITeamFoundationEventService.PublishNotification,Notifications SDK ISubscriber 实现将获取它。

属性

actors

可选:参与者列表,这些参与者是具有与事件相关的相应角色的其他标识。

artifactUris

可选:受此事件引用或影响的项目列表。

data

必需:事件有效负载。 如果 Data 是字符串,则必须采用 Json 或 XML 格式。 否则,它必须具有序列化格式属性。

eventType

必需:事件的名称。 必须在要触发的上下文中注册此事件。

expiresIn

事件过期并将被清理的时长。 默认使用系统默认值。

itemId

项、项目、扩展、项目等的 ID。

processDelay

处理此事件之前需要等待多长时间。 默认为立即处理。

scopes

可选:与事件相关的范围列表。

sourceEventCreatedTime

这是创建此 VssNotificationEvent 的原始源事件的时间。 例如,对于类似生成完成通知的内容,SourceEventCreatedTime 应是生成完成的时间,而不是引发此事件的时间。

属性详细信息

actors

可选:参与者列表,这些参与者是具有与事件相关的相应角色的其他标识。

actors: EventActor[]

属性值

artifactUris

可选:受此事件引用或影响的项目列表。

artifactUris: string[]

属性值

string[]

data

必需:事件有效负载。 如果 Data 是字符串,则必须采用 Json 或 XML 格式。 否则,它必须具有序列化格式属性。

data: any

属性值

any

eventType

必需:事件的名称。 必须在要触发的上下文中注册此事件。

eventType: string

属性值

string

expiresIn

事件过期并将被清理的时长。 默认使用系统默认值。

expiresIn: any

属性值

any

itemId

项、项目、扩展、项目等的 ID。

itemId: string

属性值

string

processDelay

处理此事件之前需要等待多长时间。 默认为立即处理。

processDelay: any

属性值

any

scopes

可选:与事件相关的范围列表。

scopes: EventScope[]

属性值

sourceEventCreatedTime

这是创建此 VssNotificationEvent 的原始源事件的时间。 例如,对于类似生成完成通知的内容,SourceEventCreatedTime 应是生成完成的时间,而不是引发此事件的时间。

sourceEventCreatedTime: Date

属性值

Date