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

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

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

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

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

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

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>