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)	Cree 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 verificar la configuración de una suscripción de enlaces de servicio nueva o actualizada.
deleteSubscription(string)	Elimine una suscripción específica de enlaces de servicio.
getConsumer(string, string)	Obtenga un servicio de atención al consumidor específico. Opcionalmente, filtre las acciones del consumidor que no admiten ningún tipo de evento para el editor especificado.
getConsumerAction(string, string, string)	Obtén detalles sobre una acción específica del consumidor.
getEventType(string, string)	Obtiene un tipo de evento específico.
getNotification(string, number)	Recibe una notificación específica para una suscripción.
getNotifications(string, number, NotificationStatus, NotificationResult)	Obtener una lista de notificaciones para una suscripción específica. Una notificación incluye detalles sobre el evento, la solicitud y la respuesta del servicio al consumidor.
getPublisher(string)	Obtener un editor de enlaces de servicio específico.
getSubscription(string)	Obtenga una suscripción específica de enlaces de servicio.
getSubscriptionDiagnostics(string)
listConsumerActions(string, string)	Obtenga una lista de acciones del consumidor para un consumidor específico.
listConsumers(string)	Obtenga una lista de los servicios de consumidor de enlaces de servicio disponibles. Opcionalmente, filtre por consumidores que admitan al menos un tipo de evento del editor específico.
listEventTypes(string)	Obtenga los tipos de eventos para un editor específico.
listPublishers()	Obtenga una lista de editores.
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 y la respuesta del servicio al consumidor.
queryPublishers(PublishersQuery)	Consulta de editores 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)

Cree una suscripción.

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

Parámetros

subscription

Subscription

Suscripción 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 verificar la configuración de una suscripción de enlaces de servicio nueva o actualizada.

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

Parámetros

testNotification

Notification

useRealData

boolean

Solo permita pruebas con datos reales en suscripciones existentes.

Devoluciones

Promise<Notification>

deleteSubscription(string)

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

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 atención al consumidor específico. Opcionalmente, filtre las acciones del consumidor que no admiten ningún tipo de evento para el editor especificado.

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

Parámetros

consumerId

string

ID para un consumidor.

publisherId

string

Devoluciones

Promise<Consumer>

getConsumerAction(string, string, string)

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

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

Parámetros

consumerId

string

ID para un consumidor.

consumerActionId

string

ID de un 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

ID de un editor.

eventTypeId

string

Devoluciones

Promise<EventTypeDescriptor>

getNotification(string, number)

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

Obtener una lista de notificaciones para una suscripción específica. Una notificación incluye detalles sobre el evento, la solicitud y la respuesta del servicio al 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 devolverán. El valor predeterminado es 100.

status

NotificationStatus

Recibe solo notificaciones con este estado.

result

NotificationResult

Recibe solo notificaciones con este tipo de resultado.

Devoluciones

Promise<Notification[]>

getPublisher(string)

Obtener un editor de enlaces de servicio específico.

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

Parámetros

publisherId

string

ID de un editor.

Devoluciones

Promise<Publisher>

getSubscription(string)

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

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 del consumidor para un consumidor específico.

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

Parámetros

consumerId

string

ID para un consumidor.

publisherId

string

Devoluciones

Promise<ConsumerAction[]>

listConsumers(string)

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

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

Parámetros

publisherId

string

Devoluciones

Promise<Consumer[]>

listEventTypes(string)

Obtenga los tipos de eventos para un editor específico.

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

Parámetros

publisherId

string

ID de un editor.

Devoluciones

Promise<EventTypeDescriptor[]>

listPublishers()

Obtenga una lista de editores.

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

El tipo de evento por el que se va a filtrar (si lo hay).

consumerId

string

ID para un consumidor.

consumerActionId

string

ID de un 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 y la respuesta del servicio al consumidor.

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

Parámetros

query

NotificationsQuery

Devoluciones

Promise<NotificationsQuery>

queryPublishers(PublishersQuery)

Consulta de editores 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>