ServiceHooksRestClient class
VSS REST API への要求を行うために使用する (派生する) 基本クラス
- Extends
メソッド
コンストラクターの詳細
ServiceHooksRestClient(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()
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 を更新するサブスクリプションの </パラメータ>
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>