ServiceHooksRestClient class

Pacote:

azure-devops-extension-api

Classe base que deve ser utilizada (derivada de) para fazer pedidos às apis REST do VSS

Extends

RestClientBase

Construtores

ServiceHooksRestClient(IVssRestClientOptions)

Métodos

createSubscription(Subscription)	Criar uma subscrição.
createSubscriptionsQuery(SubscriptionsQuery)	Consulte as subscrições do service hook.
createTestNotification(Notification, boolean)	Envia uma notificação de teste. Isto é útil para verificar a configuração de uma subscrição atualizada ou nova de hooks de serviço.
deleteSubscription(string)	Eliminar uma subscrição específica de hooks de serviço.
getConsumer(string, string)	Obter um serviço de consumidor específico. Opcionalmente, filtre as ações de consumidor que não suportam quaisquer tipos de eventos para o publicador especificado.
getConsumerAction(string, string, string)	Obtenha detalhes sobre uma ação de consumidor específica.
getEventType(string, string)	Obter um tipo de evento específico.
getNotification(string, number)	Obtenha uma notificação específica para uma subscrição.
getNotifications(string, number, NotificationStatus, NotificationResult)	Obtenha uma lista de notificações para uma subscrição específica. Uma notificação inclui detalhes sobre o evento, o pedido de e a resposta do serviço de consumidor.
getPublisher(string)	Obtenha um editor específico de hooks de serviço.
getSubscription(string)	Obtenha uma subscrição específica de hooks de serviço.
getSubscriptionDiagnostics(string)
listConsumerActions(string, string)	Obtenha uma lista de ações de consumidor para um consumidor específico.
listConsumers(string)	Obtenha uma lista dos serviços de consumidor de hook de serviço disponíveis. Opcionalmente, filtre por consumidores que suportam, pelo menos, um tipo de evento do publicador específico.
listEventTypes(string)	Obtenha os tipos de eventos de um publicador 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)	Consulte as notificações. Uma notificação inclui detalhes sobre o evento, o pedido de e a resposta do serviço de consumidor.
queryPublishers(PublishersQuery)	Consulte os editores do service hook.
replaceSubscription(Subscription, string)	Atualizar uma subscrição. <param name="subscriptionId">ID de uma subscrição que pretende atualizar.< /param>
updateSubscriptionDiagnostics(UpdateSubscripitonDiagnosticsParameters, string)

Detalhes do Construtor

ServiceHooksRestClient(IVssRestClientOptions)

new ServiceHooksRestClient(options: IVssRestClientOptions)

Parâmetros

options

IVssRestClientOptions

Detalhes de Método

createSubscription(Subscription)

Criar uma subscrição.

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

Parâmetros

subscription

Subscription

Subscrição a criar.

Devoluções

Promise<Subscription>

createSubscriptionsQuery(SubscriptionsQuery)

Consulte as subscrições do service hook.

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

Parâmetros

query

SubscriptionsQuery

Devoluções

Promise<SubscriptionsQuery>

createTestNotification(Notification, boolean)

Envia uma notificação de teste. Isto é útil para verificar a configuração de uma subscrição atualizada ou nova de hooks de serviço.

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

Parâmetros

testNotification

Notification

useRealData

boolean

Permitir apenas testes com dados reais em subscrições existentes.

Devoluções

Promise<Notification>

deleteSubscription(string)

Eliminar uma subscrição específica de hooks de serviço.

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

Parâmetros

subscriptionId

string

ID de uma subscrição.

Devoluções

Promise<void>

getConsumer(string, string)

Obter um serviço de consumidor específico. Opcionalmente, filtre as ações de consumidor que não suportam quaisquer tipos de eventos para o publicador 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 de consumidor específica.

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)

Obter 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 subscrição.

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 subscrição específica. Uma notificação inclui detalhes sobre o evento, o pedido de e a resposta do serviço de 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. A predefinição é 100.

status

NotificationStatus

Obtenha apenas notificações com este estado.

result

NotificationResult

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

Devoluções

Promise<Notification[]>

getPublisher(string)

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

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

Parâmetros

publisherId

string

ID de um editor.

Devoluções

Promise<Publisher>

getSubscription(string)

Obtenha uma subscrição específica de hooks de serviço.

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 de 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 dos serviços de consumidor de hook de serviço disponíveis. Opcionalmente, filtre por consumidores que suportam, pelo menos, um tipo de evento do publicador específico.

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

Parâmetros

publisherId

string

Devoluções

Promise<Consumer[]>

listEventTypes(string)

Obtenha os tipos de eventos de um publicador 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 filtrar (se existir).

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)

Consulte as notificações. Uma notificação inclui detalhes sobre o evento, o pedido de e a resposta do serviço de consumidor.

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

Parâmetros

query

NotificationsQuery

Devoluções

Promise<NotificationsQuery>

queryPublishers(PublishersQuery)

Consulte os editores do service hook.

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

Parâmetros

query

PublishersQuery

Devoluções

Promise<PublishersQuery>

replaceSubscription(Subscription, string)

Atualizar uma subscrição. <param name="subscriptionId">ID de uma subscrição que pretende 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>