VssNotificationEvent interface
这是用于触发通知 SDK 中子系统的通知的类型。 对于无法直接依赖通知 SDK 的组件,他们可以使用 ITeamFoundationEventService.PublishNotification,并且 Notifications SDK ISubscriber 实现将获取它。
属性
| actors | 可选:具有与事件相关的相应角色的其他标识的参与者列表。 |
| artifact |
可选:此事件引用或影响的项目列表。 |
| data | 必需:事件有效负载。 如果 Data 是字符串,则它必须采用 Json 或 XML 格式。 否则,它必须具有序列化格式属性。 |
| event |
必需:事件的名称。 必须在要触发的上下文中注册此事件。 |
| expires |
事件过期前多长时间,将被清理。 默认值是使用系统默认值。 |
| item |
项、项目、扩展、项目等的 ID。 |
| process |
处理此事件之前要等待多长时间。 默认值是立即处理。 |
| scopes | 可选:与事件相关的范围列表。 |
| source |
这是创建此 VssNotificationEvent 的原始源事件的时间。 例如,对于生成完成通知 SourceEventCreatedTime 之类的内容,应是生成完成的时间,而不是引发此事件的时间。 |
属性详细信息
actors
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
sourceEventCreatedTime
这是创建此 VssNotificationEvent 的原始源事件的时间。 例如,对于生成完成通知 SourceEventCreatedTime 之类的内容,应是生成完成的时间,而不是引发此事件的时间。
sourceEventCreatedTime: Date
属性值
Date