NotificationRestClient class

套件:

azure-devops-extension-api

應該使用 (衍生自) 的基類，向 VSS REST API 提出要求

Extends

RestClientBase

建構函式

NotificationRestClient(IVssRestClientOptions)

方法

createSubscription(NotificationSubscriptionCreateParameters)	建立新的訂用帳戶。
deleteSubscription(string)	刪除訂用帳戶。
getEventType(string)	取得特定的事件種類。
getNotificationReasons(number)
getSettings()
getSubscriber(string)	取得通知訂閱者的傳遞喜好設定。
getSubscription(string, SubscriptionQueryFlags)	依識別碼取得通知訂閱。
getSubscriptionDiagnostics(string)	取得訂用帳戶的診斷設定。
getSubscriptionTemplates()	取得可用的訂用帳戶範本。
listEventTypes(string)	列出此服務可用的事件種類。 選擇性地只篩選指定發行者的事件種類。
listLogs(string, string, Date, Date)	取得此服務的診斷記錄清單。
listNotificationReasons(number)
listSubscriptions(string, string[], SubscriptionQueryFlags)	依訂用帳戶識別碼或指定使用者或群組的所有訂用帳戶，取得通知訂閱的清單。
performBatchNotificationOperations(BatchNotificationOperation)
publishEvent(VssNotificationEvent)	發佈事件。 此要求必須導向至服務 「extmgmt」。
publishTokenEvent(VssNotificationEvent)	發佈事件。 此要求僅適用于權杖服務，因為它是僅部署服務。
queryEventTypes(FieldValuesQuery, string)
querySubscriptions(SubscriptionQuery)	查詢訂用帳戶。 如果訂閱符合一或多個指定的條件，則會傳回訂閱。
transformEvent(EventTransformRequest)	轉換通知事件。
updateSettings(NotificationAdminSettingsUpdateParameters)
updateSubscriber(NotificationSubscriberUpdateParameters, string)	更新通知訂閱者的傳遞喜好設定。
updateSubscription(NotificationSubscriptionUpdateParameters, string)	更新現有的訂用帳戶。 根據訂用帳戶和許可權的類型，呼叫者可以更新描述、篩選設定、通道 (傳遞) 設定等等。
updateSubscriptionDiagnostics(UpdateSubscripitonDiagnosticsParameters, string)	更新訂用帳戶的診斷設定。
updateSubscriptionUserSettings(SubscriptionUserSettings, string, string)	更新指定之訂用帳戶的指定使用者設定。 此 API 通常用來加入宣告或退出共用訂用帳戶。 使用者設定只能套用至共用訂用帳戶，例如小組訂用帳戶或預設訂用帳戶。

建構函式詳細資料

NotificationRestClient(IVssRestClientOptions)

new NotificationRestClient(options: IVssRestClientOptions)

參數

options

IVssRestClientOptions

方法詳細資料

createSubscription(NotificationSubscriptionCreateParameters)

建立新的訂用帳戶。

function createSubscription(createParameters: NotificationSubscriptionCreateParameters): Promise<NotificationSubscription>

參數

createParameters

NotificationSubscriptionCreateParameters

傳回

Promise<NotificationSubscription>

deleteSubscription(string)

刪除訂用帳戶。

function deleteSubscription(subscriptionId: string): Promise<void>

參數

subscriptionId

string

傳回

Promise<void>

getEventType(string)

取得特定的事件種類。

function getEventType(eventType: string): Promise<NotificationEventType>

參數

eventType

string

事件種類的識別碼。

傳回

Promise<NotificationEventType>

getNotificationReasons(number)

function getNotificationReasons(notificationId: number): Promise<NotificationReason>

參數

notificationId

number

傳回

Promise<NotificationReason>

getSettings()

function getSettings(): Promise<NotificationAdminSettings>

傳回

Promise<NotificationAdminSettings>

getSubscriber(string)

取得通知訂閱者的傳遞喜好設定。

function getSubscriber(subscriberId: string): Promise<NotificationSubscriber>

參數

subscriberId

string

使用者或群組的識別碼。

傳回

Promise<NotificationSubscriber>

getSubscription(string, SubscriptionQueryFlags)

依識別碼取得通知訂閱。

function getSubscription(subscriptionId: string, queryFlags?: SubscriptionQueryFlags): Promise<NotificationSubscription>

參數

subscriptionId

string

queryFlags

SubscriptionQueryFlags

傳回

Promise<NotificationSubscription>

getSubscriptionDiagnostics(string)

取得訂用帳戶的診斷設定。

function getSubscriptionDiagnostics(subscriptionId: string): Promise<SubscriptionDiagnostics>

參數

subscriptionId

string

通知訂閱的識別碼。

傳回

Promise<SubscriptionDiagnostics>

getSubscriptionTemplates()

取得可用的訂用帳戶範本。

function getSubscriptionTemplates(): Promise<NotificationSubscriptionTemplate[]>

傳回

Promise<NotificationSubscriptionTemplate[]>

listEventTypes(string)

列出此服務可用的事件種類。 選擇性地只篩選指定發行者的事件種類。

function listEventTypes(publisherId?: string): Promise<NotificationEventType[]>

參數

publisherId

string

限制為此發行者的事件種類

傳回

Promise<NotificationEventType[]>

listLogs(string, string, Date, Date)

取得此服務的診斷記錄清單。

function listLogs(source: string, entryId?: string, startTime?: Date, endTime?: Date): Promise<INotificationDiagnosticLog[]>

參數

source

string

識別碼，指定要檢查診斷的記錄類型。

entryId

string

要查詢之特定記錄檔的識別碼。

startTime

Date

要查詢的時間範圍的開始時間。

endTime

Date

要查詢的時間範圍的結束時間。

傳回

Promise<INotificationDiagnosticLog[]>

listNotificationReasons(number)

function listNotificationReasons(notificationIds?: number): Promise<NotificationReason[]>

參數

notificationIds

number

傳回

Promise<NotificationReason[]>

listSubscriptions(string, string[], SubscriptionQueryFlags)

依訂用帳戶識別碼或指定使用者或群組的所有訂用帳戶，取得通知訂閱的清單。

function listSubscriptions(targetId?: string, ids?: string[], queryFlags?: SubscriptionQueryFlags): Promise<NotificationSubscription[]>

參數

targetId

string

使用者或群組識別碼

ids

string[]

訂用帳戶識別碼清單

queryFlags

SubscriptionQueryFlags

傳回

Promise<NotificationSubscription[]>

performBatchNotificationOperations(BatchNotificationOperation)

function performBatchNotificationOperations(operation: BatchNotificationOperation): Promise<void>

參數

operation

BatchNotificationOperation

傳回

Promise<void>

publishEvent(VssNotificationEvent)

發佈事件。 此要求必須導向至服務 「extmgmt」。

function publishEvent(notificationEvent: VssNotificationEvent): Promise<VssNotificationEvent>

參數

notificationEvent

VssNotificationEvent

傳回

Promise<VssNotificationEvent>

publishTokenEvent(VssNotificationEvent)

發佈事件。 此要求僅適用于權杖服務，因為它是僅部署服務。

function publishTokenEvent(notificationEvent: VssNotificationEvent): Promise<VssNotificationEvent>

參數

notificationEvent

VssNotificationEvent

傳回

Promise<VssNotificationEvent>

queryEventTypes(FieldValuesQuery, string)

function queryEventTypes(inputValuesQuery: FieldValuesQuery, eventType: string): Promise<NotificationEventField[]>

參數

inputValuesQuery

FieldValuesQuery

eventType

string

傳回

Promise<NotificationEventField[]>

querySubscriptions(SubscriptionQuery)

查詢訂用帳戶。 如果訂閱符合一或多個指定的條件，則會傳回訂閱。

function querySubscriptions(subscriptionQuery: SubscriptionQuery): Promise<NotificationSubscription[]>

參數

subscriptionQuery

SubscriptionQuery

傳回

Promise<NotificationSubscription[]>

transformEvent(EventTransformRequest)

轉換通知事件。

function transformEvent(transformRequest: EventTransformRequest): Promise<EventTransformResult>

參數

transformRequest

EventTransformRequest

要轉換的物件。

傳回

Promise<EventTransformResult>

updateSettings(NotificationAdminSettingsUpdateParameters)

function updateSettings(updateParameters: NotificationAdminSettingsUpdateParameters): Promise<NotificationAdminSettings>

參數

updateParameters

NotificationAdminSettingsUpdateParameters

傳回

Promise<NotificationAdminSettings>

updateSubscriber(NotificationSubscriberUpdateParameters, string)

更新通知訂閱者的傳遞喜好設定。

function updateSubscriber(updateParameters: NotificationSubscriberUpdateParameters, subscriberId: string): Promise<NotificationSubscriber>

參數

updateParameters

NotificationSubscriberUpdateParameters

subscriberId

string

使用者或群組的識別碼。

傳回

Promise<NotificationSubscriber>

updateSubscription(NotificationSubscriptionUpdateParameters, string)

更新現有的訂用帳戶。 根據訂用帳戶和許可權的類型，呼叫者可以更新描述、篩選設定、通道 (傳遞) 設定等等。

function updateSubscription(updateParameters: NotificationSubscriptionUpdateParameters, subscriptionId: string): Promise<NotificationSubscription>

參數

updateParameters

NotificationSubscriptionUpdateParameters

subscriptionId

string

傳回

Promise<NotificationSubscription>

updateSubscriptionDiagnostics(UpdateSubscripitonDiagnosticsParameters, string)

更新訂用帳戶的診斷設定。

function updateSubscriptionDiagnostics(updateParameters: UpdateSubscripitonDiagnosticsParameters, subscriptionId: string): Promise<SubscriptionDiagnostics>

參數

updateParameters

UpdateSubscripitonDiagnosticsParameters

subscriptionId

string

通知訂閱的識別碼。

傳回

Promise<SubscriptionDiagnostics>

updateSubscriptionUserSettings(SubscriptionUserSettings, string, string)

更新指定之訂用帳戶的指定使用者設定。 此 API 通常用來加入宣告或退出共用訂用帳戶。 使用者設定只能套用至共用訂用帳戶，例如小組訂用帳戶或預設訂用帳戶。

function updateSubscriptionUserSettings(userSettings: SubscriptionUserSettings, subscriptionId: string, userId: string): Promise<SubscriptionUserSettings>

參數

userSettings

SubscriptionUserSettings

subscriptionId

string

userId

string

使用者的識別碼

傳回

Promise<SubscriptionUserSettings>