ServiceHooksRestClient class
应使用 (派生自) 的基类向 VSS REST API 发出请求
- Extends
构造函数
| Service |
方法
构造函数详细信息
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)
获取可用服务挂钩使用者服务的列表。 （可选）按支持来自特定发布者至少一个事件类型的使用者进行筛选。
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>