Compartilhar via

ServiceHooksRestClient class

  • Referência
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)

Criar uma assinatura.
createSubscriptionsQuery(SubscriptionsQuery)

Consultar 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 de consumidor específico. Opcionalmente, filtre ações do consumidor que não dão suporte a nenhum tipo de evento para o publicador especificado.
getConsumerAction(string, string, string)

Obtenha detalhes sobre uma ação específica do consumidor.
getEventType(string, string)

Obter 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 para e a resposta do serviço de 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 dos serviços de consumidor do gancho de serviço disponíveis. Opcionalmente, filtre por consumidores que dão 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 assinaturas.
publishExternalEvent(string, string)

Publicar um evento externo.
queryInputValues(InputValuesQuery, string)
queryNotifications(NotificationsQuery)

Consultar notificações. Uma notificação inclui detalhes sobre o evento, a solicitação para e a resposta do serviço de consumidor.
queryPublishers(PublishersQuery)

Consultar editores de gancho de serviço.
replaceSubscription(Subscription, string)

Atualizar uma assinatura. <param name="subscriptionId">ID de uma assinatura que você deseja atualizar.< /param>
updateSubscriptionDiagnostics(UpdateSubscripitonDiagnosticsParameters, string)

Detalhes do construtor

ServiceHooksRestClient(IVssRestClientOptions) 

new ServiceHooksRestClient(options: IVssRestClientOptions)

Parâmetros

options
IVssRestClientOptions

Detalhes do método

createSubscription(Subscription)

Criar uma assinatura.

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

Parâmetros

subscription
Subscription

Assinatura a ser criada.

Retornos

Promise<Subscription>

createSubscriptionsQuery(SubscriptionsQuery)

Consultar assinaturas de gancho de serviço.

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

Parâmetros

query
SubscriptionsQuery

Retornos

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

Permitir somente testes com dados reais em assinaturas existentes.

Retornos

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 assinatura.

Retornos

Promise<void>

getConsumer(string, string)

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

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

Parâmetros

consumerId

string

ID para um consumidor.

publisherId

string

Retornos

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 para um consumidor.

consumerActionId

string

ID de um consumerActionId.

publisherId

string

Retornos

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

Retornos

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 assinatura.

notificationId

number

Retornos

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 para 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 assinatura.

maxResults

number

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

status
NotificationStatus

Obtenha apenas notificações com esse status.

result
NotificationResult

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

Retornos

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.

Retornos

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 assinatura.

Retornos

Promise<Subscription>

getSubscriptionDiagnostics(string) 

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

Parâmetros

subscriptionId

string

Retornos

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 para um consumidor.

publisherId

string

Retornos

Promise<ConsumerAction[]>

listConsumers(string)

Obtenha uma lista dos serviços de consumidor do gancho de serviço disponíveis. Opcionalmente, filtre por consumidores que dão suporte a pelo menos um tipo de evento do editor específico.

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

Parâmetros

publisherId

string

Retornos

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.

Retornos

Promise<EventTypeDescriptor[]>

listPublishers()

Obtenha uma lista de editores.

function listPublishers(): Promise<Publisher[]>

Retornos

Promise<Publisher[]>

listSubscriptions(string, string, string, string)

Obtenha uma lista de assinaturas.

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

Parâmetros

publisherId

string

ID de uma assinatura.

eventType

string

O tipo de evento no qual filtrar (se houver).

consumerId

string

ID para um consumidor.

consumerActionId

string

ID de um consumerActionId.

Retornos

Promise<Subscription[]>

publishExternalEvent(string, string)

Publicar um evento externo.

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

Parâmetros

publisherId

string

channelId

string

Retornos

Promise<PublisherEvent[]>

queryInputValues(InputValuesQuery, string) 

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

Parâmetros

inputValuesQuery
InputValuesQuery
publisherId

string

Retornos

Promise<InputValuesQuery>

queryNotifications(NotificationsQuery)

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

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

Parâmetros

query
NotificationsQuery

Retornos

Promise<NotificationsQuery>

queryPublishers(PublishersQuery)

Consultar editores de gancho de serviço.

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

Parâmetros

query
PublishersQuery

Retornos

Promise<PublishersQuery>

replaceSubscription(Subscription, string)

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

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

Parâmetros

subscription
Subscription
subscriptionId

string

Retornos

Promise<Subscription>

updateSubscriptionDiagnostics(UpdateSubscripitonDiagnosticsParameters, string) 

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

Parâmetros

updateParameters
UpdateSubscripitonDiagnosticsParameters
subscriptionId

string

Retornos

Promise<SubscriptionDiagnostics>