ServiceHooksRestClient class

Pacote:

azure-devops-extension-api

Classe base que deve ser usada (derivada de) para fazer solicitações para APIs REST do VSS

Extends

RestClientBase

Construtores

ServiceHooksRestClient(IVssRestClientOptions)

Métodos

createSubscription(Subscription)	Crie uma assinatura.
createSubscriptionsQuery(SubscriptionsQuery)	Consulta de assinaturas de gancho de serviço.
createTestNotification(Notification, boolean)	Envia uma notificação de teste. Isso é útil para verificar a configuração de uma assinatura de ganchos de serviço atualizada ou nova.
deleteSubscription(string)	Exclua uma assinatura de ganchos de serviço específica.
getConsumer(string, string)	Obtenha um serviço específico ao consumidor. Opcionalmente, filtre as ações do consumidor que não oferecem suporte a nenhum tipo de evento para o editor especificado.
getConsumerAction(string, string, string)	Obtenha detalhes sobre uma ação específica do consumidor.
getEventType(string, string)	Obtenha um tipo de evento específico.
getNotification(string, number)	Obtenha uma notificação específica para uma assinatura.
getNotifications(string, number, NotificationStatus, NotificationResult)	Obtenha uma lista de notificações para uma assinatura específica. Uma notificação inclui detalhes sobre o evento, a solicitação e a resposta do serviço ao consumidor.
getPublisher(string)	Obtenha um editor de ganchos de serviço específico.
getSubscription(string)	Obtenha uma assinatura de ganchos de serviço específica.
getSubscriptionDiagnostics(string)
listConsumerActions(string, string)	Obtenha uma lista de ações do consumidor para um consumidor específico.
listConsumers(string)	Obtenha uma lista de serviços disponíveis para consumidores com gancho de serviço. Opcionalmente, filtre por consumidores que ofereçam suporte a pelo menos um tipo de evento do editor específico.
listEventTypes(string)	Obtenha os tipos de evento para um editor específico.
listPublishers()	Obtenha uma lista de editores.
listSubscriptions(string, string, string, string)	Obtenha uma lista de subscrições.
publishExternalEvent(string, string)	Publicar um evento externo.
queryInputValues(InputValuesQuery, string)
queryNotifications(NotificationsQuery)	Consulta de notificações. Uma notificação inclui detalhes sobre o evento, a solicitação e a resposta do serviço ao consumidor.
queryPublishers(PublishersQuery)	Consulta de editores de gancho de serviço.
replaceSubscription(Subscription, string)	Atualize uma assinatura. <param name="subscriptionId">ID para uma assinatura que você deseja atualizar.</param>
updateSubscriptionDiagnostics(UpdateSubscripitonDiagnosticsParameters, string)

Detalhes do Construtor

ServiceHooksRestClient(IVssRestClientOptions)

new ServiceHooksRestClient(options: IVssRestClientOptions)

Parâmetros

options

IVssRestClientOptions

Detalhes de Método

createSubscription(Subscription)

Crie uma assinatura.

function createSubscription(subscription: Subscription): Promise<Subscription>

Parâmetros

subscription

Subscription

Subscrição a criar.

Devoluções

Promise<Subscription>

createSubscriptionsQuery(SubscriptionsQuery)

Consulta de assinaturas de gancho de serviço.

function createSubscriptionsQuery(query: SubscriptionsQuery): Promise<SubscriptionsQuery>

Parâmetros

query

SubscriptionsQuery

Devoluções

Promise<SubscriptionsQuery>

createTestNotification(Notification, boolean)

Envia uma notificação de teste. Isso é útil para verificar a configuração de uma assinatura de ganchos de serviço atualizada ou nova.

function createTestNotification(testNotification: Notification, useRealData?: boolean): Promise<Notification>

Parâmetros

testNotification

Notification

useRealData

boolean

Só permita testes com dados reais em subscrições existentes.

Devoluções

Promise<Notification>

deleteSubscription(string)

Exclua uma assinatura de ganchos de serviço específica.

function deleteSubscription(subscriptionId: string): Promise<void>

Parâmetros

subscriptionId

string

ID de uma subscrição.

Devoluções

Promise<void>

getConsumer(string, string)

Obtenha um serviço específico ao consumidor. Opcionalmente, filtre as ações do consumidor que não oferecem suporte a nenhum tipo de evento para o editor especificado.

function getConsumer(consumerId: string, publisherId?: string): Promise<Consumer>

Parâmetros

consumerId

string

ID de um consumidor.

publisherId

string

Devoluções

Promise<Consumer>

getConsumerAction(string, string, string)

Obtenha detalhes sobre uma ação específica do consumidor.

function getConsumerAction(consumerId: string, consumerActionId: string, publisherId?: string): Promise<ConsumerAction>

Parâmetros

consumerId

string

ID de um consumidor.

consumerActionId

string

ID de um consumerActionId.

publisherId

string

Devoluções

Promise<ConsumerAction>

getEventType(string, string)

Obtenha um tipo de evento específico.

function getEventType(publisherId: string, eventTypeId: string): Promise<EventTypeDescriptor>

Parâmetros

publisherId

string

ID de um editor.

eventTypeId

string

Devoluções

Promise<EventTypeDescriptor>

getNotification(string, number)

Obtenha uma notificação específica para uma assinatura.

function getNotification(subscriptionId: string, notificationId: number): Promise<Notification>

Parâmetros

subscriptionId

string

ID de uma subscrição.

notificationId

number

Devoluções

Promise<Notification>

getNotifications(string, number, NotificationStatus, NotificationResult)

Obtenha uma lista de notificações para uma assinatura específica. Uma notificação inclui detalhes sobre o evento, a solicitação e a resposta do serviço ao consumidor.

function getNotifications(subscriptionId: string, maxResults?: number, status?: NotificationStatus, result?: NotificationResult): Promise<Notification[]>

Parâmetros

subscriptionId

string

ID de uma subscrição.

maxResults

number

Número máximo de notificações a devolver. O padrão é 100.

status

NotificationStatus

Receba apenas notificações com este estado.

result

NotificationResult

Receba apenas notificações com este tipo de resultado.

Devoluções

Promise<Notification[]>

getPublisher(string)

Obtenha um editor de ganchos de serviço específico.

function getPublisher(publisherId: string): Promise<Publisher>

Parâmetros

publisherId

string

ID de um editor.

Devoluções

Promise<Publisher>

getSubscription(string)

Obtenha uma assinatura de ganchos de serviço específica.

function getSubscription(subscriptionId: string): Promise<Subscription>

Parâmetros

subscriptionId

string

ID de uma subscrição.

Devoluções

Promise<Subscription>

getSubscriptionDiagnostics(string)

function getSubscriptionDiagnostics(subscriptionId: string): Promise<SubscriptionDiagnostics>

Parâmetros

subscriptionId

string

Devoluções

Promise<SubscriptionDiagnostics>

listConsumerActions(string, string)

Obtenha uma lista de ações do consumidor para um consumidor específico.

function listConsumerActions(consumerId: string, publisherId?: string): Promise<ConsumerAction[]>

Parâmetros

consumerId

string

ID de um consumidor.

publisherId

string

Devoluções

Promise<ConsumerAction[]>

listConsumers(string)

Obtenha uma lista de serviços disponíveis para consumidores com gancho de serviço. Opcionalmente, filtre por consumidores que ofereçam suporte a pelo menos um tipo de evento do editor específico.

function listConsumers(publisherId?: string): Promise<Consumer[]>

Parâmetros

publisherId

string

Devoluções

Promise<Consumer[]>

listEventTypes(string)

Obtenha os tipos de evento para um editor específico.

function listEventTypes(publisherId: string): Promise<EventTypeDescriptor[]>

Parâmetros

publisherId

string

ID de um editor.

Devoluções

Promise<EventTypeDescriptor[]>

listPublishers()

Obtenha uma lista de editores.

function listPublishers(): Promise<Publisher[]>

Devoluções

Promise<Publisher[]>

listSubscriptions(string, string, string, string)

Obtenha uma lista de subscrições.

function listSubscriptions(publisherId?: string, eventType?: string, consumerId?: string, consumerActionId?: string): Promise<Subscription[]>

Parâmetros

publisherId

string

ID de uma subscrição.

eventType

string

O tipo de evento a ser filtrado (se houver).

consumerId

string

ID de um consumidor.

consumerActionId

string

ID de um consumerActionId.

Devoluções

Promise<Subscription[]>

publishExternalEvent(string, string)

Publicar um evento externo.

function publishExternalEvent(publisherId: string, channelId?: string): Promise<PublisherEvent[]>

Parâmetros

publisherId

string

channelId

string

Devoluções

Promise<PublisherEvent[]>

queryInputValues(InputValuesQuery, string)

function queryInputValues(inputValuesQuery: InputValuesQuery, publisherId: string): Promise<InputValuesQuery>

Parâmetros

inputValuesQuery

InputValuesQuery

publisherId

string

Devoluções

Promise<InputValuesQuery>

queryNotifications(NotificationsQuery)

Consulta de notificações. Uma notificação inclui detalhes sobre o evento, a solicitação e a resposta do serviço ao consumidor.

function queryNotifications(query: NotificationsQuery): Promise<NotificationsQuery>

Parâmetros

query

NotificationsQuery

Devoluções

Promise<NotificationsQuery>

queryPublishers(PublishersQuery)

Consulta de editores de gancho de serviço.

function queryPublishers(query: PublishersQuery): Promise<PublishersQuery>

Parâmetros

query

PublishersQuery

Devoluções

Promise<PublishersQuery>

replaceSubscription(Subscription, string)

Atualize uma assinatura. <param name="subscriptionId">ID para uma assinatura que você deseja atualizar.</param>

function replaceSubscription(subscription: Subscription, subscriptionId?: string): Promise<Subscription>

Parâmetros

subscription

Subscription

subscriptionId

string

Devoluções

Promise<Subscription>

updateSubscriptionDiagnostics(UpdateSubscripitonDiagnosticsParameters, string)

function updateSubscriptionDiagnostics(updateParameters: UpdateSubscripitonDiagnosticsParameters, subscriptionId: string): Promise<SubscriptionDiagnostics>

Parâmetros

updateParameters

UpdateSubscripitonDiagnosticsParameters

subscriptionId

string

Devoluções

Promise<SubscriptionDiagnostics>