ServiceHooksRestClient class

new ServiceHooksRestClient(options: IVssRestClientOptions)

パラメーター

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

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

パラメーター

戻り値

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

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

パラメーター

戻り値

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

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

パラメーター

戻り値

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

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

パラメーター

戻り値

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

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

パラメーター

戻り値

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

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

パラメーター

戻り値

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

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

パラメーター

戻り値

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

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

パラメーター

戻り値

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

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

パラメーター

戻り値

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

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

パラメーター

戻り値

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

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

パラメーター

戻り値

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

パラメーター

戻り値

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

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

パラメーター

戻り値

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

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

パラメーター

戻り値

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

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

パラメーター

戻り値

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

function listPublishers(): Promise<Publisher[]>

戻り値

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

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

パラメーター

戻り値

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

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

パラメーター

戻り値

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

パラメーター

戻り値

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

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

パラメーター

戻り値

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

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

パラメーター

戻り値

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

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

パラメーター

戻り値

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

パラメーター

戻り値