ServiceHooksRestClient class

パッケージ:

azure-devops-extension-api

VSS REST API への要求を行うために使用する (から派生する) 基本クラス

Extends

RestClientBase

コンストラクター

ServiceHooksRestClient(IVssRestClientOptions)

メソッド

createSubscription(Subscription)	サブスクリプションの作成。
createSubscriptionsQuery(SubscriptionsQuery)	サービス フック サブスクリプションのクエリを実行します。
createTestNotification(Notification, boolean)	テスト通知を送信します。 これは、更新または新しいサービス フック サブスクリプションの構成を確認する場合に役立ちます。
deleteSubscription(string)	特定のサービス フック サブスクリプションを削除します。
getConsumer(string, string)	特定のコンシューマー サービスを取得します。 必要に応じて、指定したパブリッシャーのイベントの種類をサポートしていないコンシューマー アクションを除外します。
getConsumerAction(string, string, string)	特定のコンシューマー アクションに関する詳細を取得します。
getEventType(string, string)	特定のイベントの種類を取得します。
getNotification(string, number)	サブスクリプションの特定の通知を取得します。
getNotifications(string, number, NotificationStatus, NotificationResult)	特定のサブスクリプションの通知の一覧を取得します。 通知には、イベント、に対する要求、コンシューマー サービスからの応答に関する詳細が含まれます。
getPublisher(string)	特定のサービス フック パブリッシャーを取得します。
getSubscription(string)	特定のサービス フック サブスクリプションを取得します。
getSubscriptionDiagnostics(string)
listConsumerActions(string, string)	特定のコンシューマーのコンシューマー アクションの一覧を取得します。
listConsumers(string)	使用可能なサービス フック コンシューマー サービスの一覧を取得します。 必要に応じて、特定の発行元から少なくとも 1 つのイベントの種類をサポートするコンシューマーによってフィルター処理します。
listEventTypes(string)	特定の発行元のイベントの種類を取得します。
listPublishers()	発行元の一覧を取得します。
listSubscriptions(string, string, string, string)	サブスクリプションの一覧を取得します。
publishExternalEvent(string, string)	外部イベントを発行します。
queryInputValues(InputValuesQuery, string)
queryNotifications(NotificationsQuery)	通知のクエリを実行します。 通知には、イベント、に対する要求、コンシューマー サービスからの応答に関する詳細が含まれます。
queryPublishers(PublishersQuery)	サービス フックパブリッシャーのクエリを実行します。
replaceSubscription(Subscription, string)	サブスクリプションを更新します。 <更新するサブスクリプションの param name="subscriptionId">ID。</Param>
updateSubscriptionDiagnostics(UpdateSubscripitonDiagnosticsParameters, string)

コンストラクターの詳細

ServiceHooksRestClient(IVssRestClientOptions)

new ServiceHooksRestClient(options: IVssRestClientOptions)

パラメーター

options

IVssRestClientOptions

メソッドの詳細

createSubscription(Subscription)

サブスクリプションの作成。

function createSubscription(subscription: Subscription): Promise<Subscription>

パラメーター

subscription

Subscription

作成するサブスクリプション。

戻り値

Promise<Subscription>

createSubscriptionsQuery(SubscriptionsQuery)

サービス フック サブスクリプションのクエリを実行します。

function createSubscriptionsQuery(query: SubscriptionsQuery): Promise<SubscriptionsQuery>

パラメーター

query

SubscriptionsQuery

戻り値

Promise<SubscriptionsQuery>

createTestNotification(Notification, boolean)

テスト通知を送信します。 これは、更新または新しいサービス フック サブスクリプションの構成を確認する場合に役立ちます。

function createTestNotification(testNotification: Notification, useRealData?: boolean): Promise<Notification>

パラメーター

testNotification

Notification

useRealData

boolean

既存のサブスクリプションで実際のデータを使用したテストのみを許可します。

戻り値

Promise<Notification>

deleteSubscription(string)

特定のサービス フック サブスクリプションを削除します。

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

パラメーター

subscriptionId

string

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

戻り値

Promise<void>

getConsumer(string, string)

特定のコンシューマー サービスを取得します。 必要に応じて、指定したパブリッシャーのイベントの種類をサポートしていないコンシューマー アクションを除外します。

function getConsumer(consumerId: string, publisherId?: string): Promise<Consumer>

パラメーター

consumerId

string

コンシューマーの ID。

publisherId

string

戻り値

Promise<Consumer>

getConsumerAction(string, string, string)

特定のコンシューマー アクションに関する詳細を取得します。

function getConsumerAction(consumerId: string, consumerActionId: string, publisherId?: string): Promise<ConsumerAction>

パラメーター

consumerId

string

コンシューマーの ID。

consumerActionId

string

consumerActionId の ID。

publisherId

string

戻り値

Promise<ConsumerAction>

getEventType(string, string)

特定のイベントの種類を取得します。

function getEventType(publisherId: string, eventTypeId: string): Promise<EventTypeDescriptor>

パラメーター

publisherId

string

発行元の ID。

eventTypeId

string

戻り値

Promise<EventTypeDescriptor>

getNotification(string, number)

サブスクリプションの特定の通知を取得します。

function getNotification(subscriptionId: string, notificationId: number): Promise<Notification>

パラメーター

subscriptionId

string

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

notificationId

number

戻り値

Promise<Notification>

getNotifications(string, number, NotificationStatus, NotificationResult)

特定のサブスクリプションの通知の一覧を取得します。 通知には、イベント、に対する要求、コンシューマー サービスからの応答に関する詳細が含まれます。

function getNotifications(subscriptionId: string, maxResults?: number, status?: NotificationStatus, result?: NotificationResult): Promise<Notification[]>

パラメーター

subscriptionId

string

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

maxResults

number

返す通知の最大数。 既定値は 100 です。

status

NotificationStatus

この状態の通知のみを取得します。

result

NotificationResult

この結果の種類の通知のみを取得します。

戻り値

Promise<Notification[]>

getPublisher(string)

特定のサービス フック パブリッシャーを取得します。

function getPublisher(publisherId: string): Promise<Publisher>

パラメーター

publisherId

string

発行元の ID。

戻り値

Promise<Publisher>

getSubscription(string)

特定のサービス フック サブスクリプションを取得します。

function getSubscription(subscriptionId: string): Promise<Subscription>

パラメーター

subscriptionId

string

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

戻り値

Promise<Subscription>

getSubscriptionDiagnostics(string)

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

パラメーター

subscriptionId

string

戻り値

Promise<SubscriptionDiagnostics>

listConsumerActions(string, string)

特定のコンシューマーのコンシューマー アクションの一覧を取得します。

function listConsumerActions(consumerId: string, publisherId?: string): Promise<ConsumerAction[]>

パラメーター

consumerId

string

コンシューマーの ID。

publisherId

string

戻り値

Promise<ConsumerAction[]>

listConsumers(string)

使用可能なサービス フック コンシューマー サービスの一覧を取得します。 必要に応じて、特定の発行元から少なくとも 1 つのイベントの種類をサポートするコンシューマーによってフィルター処理します。

function listConsumers(publisherId?: string): Promise<Consumer[]>

パラメーター

publisherId

string

戻り値

Promise<Consumer[]>

listEventTypes(string)

特定の発行元のイベントの種類を取得します。

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

パラメーター

publisherId

string

発行元の ID。

戻り値

Promise<EventTypeDescriptor[]>

listPublishers()

発行元の一覧を取得します。

function listPublishers(): Promise<Publisher[]>

戻り値

Promise<Publisher[]>

listSubscriptions(string, string, string, string)

サブスクリプションの一覧を取得します。

function listSubscriptions(publisherId?: string, eventType?: string, consumerId?: string, consumerActionId?: string): Promise<Subscription[]>

パラメーター

publisherId

string

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

eventType

string

フィルター処理するイベントの種類 (存在する場合)。

consumerId

string

コンシューマーの ID。

consumerActionId

string

consumerActionId の ID。

戻り値

Promise<Subscription[]>

publishExternalEvent(string, string)

外部イベントを発行します。

function publishExternalEvent(publisherId: string, channelId?: string): Promise<PublisherEvent[]>

パラメーター

publisherId

string

channelId

string

戻り値

Promise<PublisherEvent[]>

queryInputValues(InputValuesQuery, string)

function queryInputValues(inputValuesQuery: InputValuesQuery, publisherId: string): Promise<InputValuesQuery>

パラメーター

inputValuesQuery

InputValuesQuery

publisherId

string

戻り値

Promise<InputValuesQuery>

queryNotifications(NotificationsQuery)

通知のクエリを実行します。 通知には、イベント、に対する要求、コンシューマー サービスからの応答に関する詳細が含まれます。

function queryNotifications(query: NotificationsQuery): Promise<NotificationsQuery>

パラメーター

query

NotificationsQuery

戻り値

Promise<NotificationsQuery>

queryPublishers(PublishersQuery)

サービス フックパブリッシャーのクエリを実行します。

function queryPublishers(query: PublishersQuery): Promise<PublishersQuery>

パラメーター

query

PublishersQuery

戻り値

Promise<PublishersQuery>

replaceSubscription(Subscription, string)

サブスクリプションを更新します。 <更新するサブスクリプションの param name="subscriptionId">ID。</Param>

function replaceSubscription(subscription: Subscription, subscriptionId?: string): Promise<Subscription>

パラメーター

subscription

Subscription

subscriptionId

string

戻り値

Promise<Subscription>

updateSubscriptionDiagnostics(UpdateSubscripitonDiagnosticsParameters, string)

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

パラメーター

updateParameters

UpdateSubscripitonDiagnosticsParameters

subscriptionId

string

戻り値

Promise<SubscriptionDiagnostics>