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
訂用帳戶的識別碼。
傳回
Promise<void>
getConsumer(string, string)
取得特定的取用者服務。 選擇性地篩選掉不支援指定發行者之任何事件種類的取用者動作。
function getConsumer(consumerId: string, publisherId?: string): Promise<Consumer>參數
- consumerId
-
string
取用者的識別碼。
- publisherId
-
string
傳回
Promise<Consumer>
getConsumerAction(string, string, string)
取得特定取用者動作的詳細資料。
function getConsumerAction(consumerId: string, consumerActionId: string, publisherId?: string): Promise<ConsumerAction>參數
- consumerId
-
string
取用者的識別碼。
- consumerActionId
-
string
consumerActionId 的識別碼。
- publisherId
-
string
傳回
Promise<ConsumerAction>
getEventType(string, string)
取得特定的事件種類。
function getEventType(publisherId: string, eventTypeId: string): Promise<EventTypeDescriptor>參數
- publisherId
-
string
發行者的識別碼。
- eventTypeId
-
string
傳回
Promise<EventTypeDescriptor>
getNotification(string, number)
取得訂用帳戶的特定通知。
function getNotification(subscriptionId: string, notificationId: number): Promise<Notification>參數
- subscriptionId
-
string
訂用帳戶的識別碼。
- notificationId
-
number
傳回
Promise<Notification>
getNotifications(string, number, NotificationStatus, NotificationResult)
取得特定訂用帳戶的通知清單。 通知包含事件、要求和取用者服務回應的詳細資料。
function getNotifications(subscriptionId: string, maxResults?: number, status?: NotificationStatus, result?: NotificationResult): Promise<Notification[]>參數
- subscriptionId
-
string
訂用帳戶的識別碼。
- maxResults
-
number
要傳回的通知數目上限。 預設值為 100。
- status
- NotificationStatus
僅取得具有此狀態的通知。
- result
- NotificationResult
只取得具有此結果類型的通知。
傳回
Promise<Notification[]>
getPublisher(string)
取得特定的服務勾點發行者。
function getPublisher(publisherId: string): Promise<Publisher>參數
- publisherId
-
string
發行者的識別碼。
傳回
Promise<Publisher>
getSubscription(string)
取得特定的服務勾點訂用帳戶。
function getSubscription(subscriptionId: string): Promise<Subscription>參數
- subscriptionId
-
string
訂用帳戶的識別碼。
傳回
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
取用者的識別碼。
- 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
發行者的識別碼。
傳回
Promise<EventTypeDescriptor[]>
listPublishers()
listSubscriptions(string, string, string, string)
取得訂用帳戶清單。
function listSubscriptions(publisherId?: string, eventType?: string, consumerId?: string, consumerActionId?: string): Promise<Subscription[]>參數
- publisherId
-
string
訂用帳戶的識別碼。
- eventType
-
string
如果有任何) ，則為要篩選 (的事件種類。
- consumerId
-
string
取用者的識別碼。
- consumerActionId
-
string
consumerActionId 的識別碼。
傳回
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>