VssNotificationEvent interface
這是用於引發通知的類型,用於通知 SDK 中的子系統。 對於無法直接相依于 Notifications SDK 的元件,他們可以使用 ITeamFoundationEventService.PublishNotification 和 Notifications SDK ISubscriber 實作來取得它。
屬性
actors | 選擇性:動作專案清單,這些動作專案是與事件相關的對應角色的額外身分識別。 |
artifact |
選擇性:此事件所參考或受影響的成品清單。 |
data | 必要:事件承載。 如果 Data 是字串,它必須是 Json 或 XML 格式。 否則,它必須具有序列化格式屬性。 |
event |
必要:事件的名稱。 此事件必須在引發的內容中註冊。 |
expires |
事件到期前多久,將會清除。 預設值是使用系統預設值。 |
item |
專案的識別碼、成品、延伸模組、專案等。 |
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
專案的識別碼、成品、延伸模組、專案等。
itemId: string
屬性值
string
processDelay
處理此事件之前等候的時間長度。 預設值為立即處理。
processDelay: any
屬性值
any
scopes
sourceEventCreatedTime
這是建立此 VssNotificationEvent 的原始來源事件的時間。 例如,對於類似建置完成通知 SourceEventCreatedTime 之類的專案,應該是建置完成的時間,而不是引發此事件的時間。
sourceEventCreatedTime: Date
屬性值
Date