ServiceHooksRestClient class

Пакет:

azure-devops-extension-api

Базовый класс, который должен использоваться (производный от) для выполнения запросов к REST API VSS

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)	Получите список доступных сервисов для потребителей. При необходимости можно отфильтровать по потребителям, которые поддерживают хотя бы один тип события от конкретного издателя.
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

Идентификатор для подписки.

Возвращаемое значение

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.

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

Идентификатор для подписки.

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

ID для издателя.

Возвращаемое значение

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

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()

Получите список издателей.

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

Идентификатор для подписки.

eventType

string

Тип события для фильтрации (если есть).

consumerId

string

ID для потребителя.

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 для подписки, которую требуется обновить.</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>