VssNotificationEvent interface
これは、Notifications SDK のサブシステムを対象とした通知を発生させるために使用される型です。 Notifications SDK に直接依存できないコンポーネントの場合は、ITeamFoundationEventService.PublishNotification を使用でき、Notifications SDK ISubscriber の実装によって取得されます。
プロパティ
actors | 省略可能: イベントに関連する対応するロールを持つ追加の ID であるアクターの一覧。 |
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