ServiceHooksRestClient class

Paquete:

azure-devops-extension-api

Clase base que se debe usar (derivada de) para realizar solicitudes a las API REST de VSS

Extends

RestClientBase

Constructores

ServiceHooksRestClient(IVssRestClientOptions)

Métodos

createSubscription(Subscription)	Crear una suscripción.
createSubscriptionsQuery(SubscriptionsQuery)	Consulta de suscripciones de enlace de servicio.
createTestNotification(Notification, boolean)	Envía una notificación de prueba. Esto es útil para comprobar la configuración de una suscripción de enlaces de servicio actualizada o nueva.
deleteSubscription(string)	Elimine una suscripción de enlaces de servicio específica.
getConsumer(string, string)	Obtenga un servicio de consumidor específico. Opcionalmente, filtre las acciones de consumidor que no admitan ningún tipo de evento para el publicador especificado.
getConsumerAction(string, string, string)	Obtenga detalles sobre una acción específica del consumidor.
getEventType(string, string)	Obtiene un tipo de evento específico.
getNotification(string, number)	Obtenga una notificación específica para una suscripción.
getNotifications(string, number, NotificationStatus, NotificationResult)	Obtenga una lista de notificaciones para una suscripción específica. Una notificación incluye detalles sobre el evento, la solicitud a y la respuesta del servicio de consumidor.
getPublisher(string)	Obtiene un publicador de enlaces de servicio específico.
getSubscription(string)	Obtenga una suscripción de enlaces de servicio específica.
getSubscriptionDiagnostics(string)
listConsumerActions(string, string)	Obtenga una lista de acciones de consumidor para un consumidor específico.
listConsumers(string)	Obtenga una lista de los servicios de consumidor de enlace de servicio disponibles. Opcionalmente, filtre por los consumidores que admitan al menos un tipo de evento del publicador específico.
listEventTypes(string)	Obtiene los tipos de eventos de un publicador específico.
listPublishers()	Obtenga una lista de publicadores.
listSubscriptions(string, string, string, string)	Obtenga una lista de suscripciones.
publishExternalEvent(string, string)	Publicar un evento externo.
queryInputValues(InputValuesQuery, string)
queryNotifications(NotificationsQuery)	Consulta de notificaciones. Una notificación incluye detalles sobre el evento, la solicitud a y la respuesta del servicio de consumidor.
queryPublishers(PublishersQuery)	Consulta de publicadores de enlaces de servicio.
replaceSubscription(Subscription, string)	Actualizar una suscripción. <param name="subscriptionId">ID para una suscripción que desea actualizar.< /Param>
updateSubscriptionDiagnostics(UpdateSubscripitonDiagnosticsParameters, string)

Detalles del constructor

ServiceHooksRestClient(IVssRestClientOptions)

new ServiceHooksRestClient(options: IVssRestClientOptions)

Parámetros

options

IVssRestClientOptions

Detalles del método

createSubscription(Subscription)

Crear una suscripción.

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

Parámetros

subscription

Subscription

Suscripción que se va a crear.

Devoluciones

Promise<Subscription>

createSubscriptionsQuery(SubscriptionsQuery)

Consulta de suscripciones de enlace de servicio.

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

Parámetros

query

SubscriptionsQuery

Devoluciones

Promise<SubscriptionsQuery>

createTestNotification(Notification, boolean)

Envía una notificación de prueba. Esto es útil para comprobar la configuración de una suscripción de enlaces de servicio actualizada o nueva.

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

Parámetros

testNotification

Notification

useRealData

boolean

Permitir solo pruebas con datos reales en suscripciones existentes.

Devoluciones

Promise<Notification>

deleteSubscription(string)

Elimine una suscripción de enlaces de servicio específica.

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

Parámetros

subscriptionId

string

Identificador de una suscripción.

Devoluciones

Promise<void>

getConsumer(string, string)

Obtenga un servicio de consumidor específico. Opcionalmente, filtre las acciones de consumidor que no admitan ningún tipo de evento para el publicador especificado.

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

Parámetros

consumerId

string

Identificador de un consumidor.

publisherId

string

Devoluciones

Promise<Consumer>

getConsumerAction(string, string, string)

Obtenga detalles sobre una acción específica del consumidor.

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

Parámetros

consumerId

string

Identificador de un consumidor.

consumerActionId

string

Identificador de un valor consumerActionId.

publisherId

string

Devoluciones

Promise<ConsumerAction>

getEventType(string, string)

Obtiene un tipo de evento específico.

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

Parámetros

publisherId

string

Identificador de un publicador.

eventTypeId

string

Devoluciones

Promise<EventTypeDescriptor>

getNotification(string, number)

Obtenga una notificación específica para una suscripción.

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

Parámetros

subscriptionId

string

Identificador de una suscripción.

notificationId

number

Devoluciones

Promise<Notification>

getNotifications(string, number, NotificationStatus, NotificationResult)

Obtenga una lista de notificaciones para una suscripción específica. Una notificación incluye detalles sobre el evento, la solicitud a y la respuesta del servicio de consumidor.

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

Parámetros

subscriptionId

string

Identificador de una suscripción.

maxResults

number

Número máximo de notificaciones que se van a devolver. El valor predeterminado es 100.

status

NotificationStatus

Obtenga solo notificaciones con este estado.

result

NotificationResult

Obtenga solo notificaciones con este tipo de resultado.

Devoluciones

Promise<Notification[]>

getPublisher(string)

Obtiene un publicador de enlaces de servicio específico.

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

Parámetros

publisherId

string

Identificador de un publicador.

Devoluciones

Promise<Publisher>

getSubscription(string)

Obtenga una suscripción de enlaces de servicio específica.

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

Parámetros

subscriptionId

string

Identificador de una suscripción.

Devoluciones

Promise<Subscription>

getSubscriptionDiagnostics(string)

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

Parámetros

subscriptionId

string

Devoluciones

Promise<SubscriptionDiagnostics>

listConsumerActions(string, string)

Obtenga una lista de acciones de consumidor para un consumidor específico.

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

Parámetros

consumerId

string

Identificador de un consumidor.

publisherId

string

Devoluciones

Promise<ConsumerAction[]>

listConsumers(string)

Obtenga una lista de los servicios de consumidor de enlace de servicio disponibles. Opcionalmente, filtre por los consumidores que admitan al menos un tipo de evento del publicador específico.

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

Parámetros

publisherId

string

Devoluciones

Promise<Consumer[]>

listEventTypes(string)

Obtiene los tipos de eventos de un publicador específico.

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

Parámetros

publisherId

string

Identificador de un publicador.

Devoluciones

Promise<EventTypeDescriptor[]>

listPublishers()

Obtenga una lista de publicadores.

function listPublishers(): Promise<Publisher[]>

Devoluciones

Promise<Publisher[]>

listSubscriptions(string, string, string, string)

Obtenga una lista de suscripciones.

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

Parámetros

publisherId

string

Identificador de una suscripción.

eventType

string

Tipo de evento en el que se va a filtrar (si existe).

consumerId

string

Identificador de un consumidor.

consumerActionId

string

Identificador de un valor consumerActionId.

Devoluciones

Promise<Subscription[]>

publishExternalEvent(string, string)

Publicar un evento externo.

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

Parámetros

publisherId

string

channelId

string

Devoluciones

Promise<PublisherEvent[]>

queryInputValues(InputValuesQuery, string)

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

Parámetros

inputValuesQuery

InputValuesQuery

publisherId

string

Devoluciones

Promise<InputValuesQuery>

queryNotifications(NotificationsQuery)

Consulta de notificaciones. Una notificación incluye detalles sobre el evento, la solicitud a y la respuesta del servicio de consumidor.

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

Parámetros

query

NotificationsQuery

Devoluciones

Promise<NotificationsQuery>

queryPublishers(PublishersQuery)

Consulta de publicadores de enlaces de servicio.

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

Parámetros

query

PublishersQuery

Devoluciones

Promise<PublishersQuery>

replaceSubscription(Subscription, string)

Actualizar una suscripción. <param name="subscriptionId">ID para una suscripción que desea actualizar.< /Param>

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

Parámetros

subscription

Subscription

subscriptionId

string

Devoluciones

Promise<Subscription>

updateSubscriptionDiagnostics(UpdateSubscripitonDiagnosticsParameters, string)

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

Parámetros

updateParameters

UpdateSubscripitonDiagnosticsParameters

subscriptionId

string

Devoluciones

Promise<SubscriptionDiagnostics>