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)	ID で通知サブスクリプションを取得します。
getSubscriptionDiagnostics(string)	サブスクリプションの診断設定を取得します。
getSubscriptionTemplates()	使用可能なサブスクリプション テンプレートを取得します。
listEventTypes(string)	このサービスで使用可能なイベントの種類を一覧表示します。 必要に応じて、指定したパブリッシャーのイベントの種類でのみフィルター処理します。
listLogs(string, string, Date, Date)	このサービスの診断ログの一覧を取得します。
listNotificationReasons(number)
listSubscriptions(string, string[], SubscriptionQueryFlags)	通知サブスクリプションの一覧 (サブスクリプション ID または特定のユーザーまたはグループのすべてのサブスクリプション) を取得します。
performBatchNotificationOperations(BatchNotificationOperation)
publishEvent(VssNotificationEvent)	イベントを発行します。 この要求は、サービス "extmgmt" に送信する必要があります。
publishTokenEvent(VssNotificationEvent)	イベントを発行します。 この要求は、デプロイのみのサービスであるため、トークン サービス専用です。
queryEventTypes(FieldValuesQuery, string)
querySubscriptions(SubscriptionQuery)	サブスクリプションのクエリ。 指定した条件の 1 つ以上に一致する場合、サブスクリプションが返されます。
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

イベントの種類の ID。

戻り値

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

ユーザーまたはグループの ID。

戻り値

Promise<NotificationSubscriber>

getSubscription(string, SubscriptionQueryFlags)

ID で通知サブスクリプションを取得します。

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

パラメーター

subscriptionId

string

queryFlags

SubscriptionQueryFlags

戻り値

Promise<NotificationSubscription>

getSubscriptionDiagnostics(string)

サブスクリプションの診断設定を取得します。

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

パラメーター

subscriptionId

string

通知サブスクリプションの ID。

戻り値

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

チェック 診断するログの種類を指定する ID。

entryId

string

クエリを実行する特定のログの ID。

startTime

Date

クエリを実行する時間範囲の開始時刻。

endTime

Date

クエリを実行する時間範囲の終了時刻。

戻り値

Promise<INotificationDiagnosticLog[]>

listNotificationReasons(number)

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

パラメーター

notificationIds

number

戻り値

Promise<NotificationReason[]>

listSubscriptions(string, string[], SubscriptionQueryFlags)

通知サブスクリプションの一覧 (サブスクリプション ID または特定のユーザーまたはグループのすべてのサブスクリプション) を取得します。

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

パラメーター

targetId

string

ユーザーまたはグループ ID

ids

string[]

サブスクリプション ID の一覧

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)

サブスクリプションのクエリ。 指定した条件の 1 つ以上に一致する場合、サブスクリプションが返されます。

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

ユーザーまたはグループの ID。

戻り値

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

通知サブスクリプションの ID。

戻り値

Promise<SubscriptionDiagnostics>

updateSubscriptionUserSettings(SubscriptionUserSettings, string, string)

指定したサブスクリプションの指定したユーザーの設定を更新します。 この API は、通常、共有サブスクリプションをオプトインまたはオプトアウトするために使用されます。 ユーザー設定は、チーム サブスクリプションや既定のサブスクリプションなどの共有サブスクリプションにのみ適用できます。

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

パラメーター

userSettings

SubscriptionUserSettings

subscriptionId

string

userId

string

ユーザーの ID

戻り値

Promise<SubscriptionUserSettings>