ServiceHooksRestClient class

Paquet:

azure-devops-extension-api

Classe de base qui doit être utilisée (dérivée de) pour effectuer des requêtes aux API REST VSS

Extends

RestClientBase

Constructeurs

ServiceHooksRestClient(IVssRestClientOptions)

Méthodes

createSubscription(Subscription)	Créer un abonnement
createSubscriptionsQuery(SubscriptionsQuery)	Requête pour les abonnements de hook de service.
createTestNotification(Notification, boolean)	Envoie une notification de test. Cela est utile pour vérifier la configuration d’un abonnement de hooks de service mis à jour ou nouveau.
deleteSubscription(string)	Supprimez un abonnement de hooks de service spécifique.
getConsumer(string, string)	Obtenir un service consommateur spécifique. Si vous le souhaitez, filtrez les actions du consommateur qui ne prennent en charge aucun type d’événement pour le serveur de publication spécifié.
getConsumerAction(string, string, string)	Obtenir des détails sur une action spécifique du consommateur.
getEventType(string, string)	Obtenir un type d’événement spécifique.
getNotification(string, number)	Obtenez une notification spécifique pour un abonnement.
getNotifications(string, number, NotificationStatus, NotificationResult)	Obtenez la liste des notifications pour un abonnement spécifique. Une notification inclut des détails sur l’événement, la demande adressée et la réponse du service consommateur.
getPublisher(string)	Obtenir un éditeur de hooks de service spécifique.
getSubscription(string)	Obtenez un abonnement de hooks de service spécifique.
getSubscriptionDiagnostics(string)
listConsumerActions(string, string)	Obtenez la liste des actions du consommateur pour un consommateur spécifique.
listConsumers(string)	Obtenez la liste des services consommateurs de hook de service disponibles. Si vous le souhaitez, filtrez les consommateurs qui prennent en charge au moins un type d’événement de l’éditeur spécifique.
listEventTypes(string)	Obtenez les types d’événements pour un éditeur spécifique.
listPublishers()	Obtenez la liste des éditeurs.
listSubscriptions(string, string, string, string)	Obtenez la liste des abonnements.
publishExternalEvent(string, string)	Publier un événement externe.
queryInputValues(InputValuesQuery, string)
queryNotifications(NotificationsQuery)	Requête pour les notifications. Une notification inclut des détails sur l’événement, la demande adressée et la réponse du service consommateur.
queryPublishers(PublishersQuery)	Requête pour les éditeurs de hook de service.
replaceSubscription(Subscription, string)	Mettez à jour un abonnement. <param name="subscriptionId">ID pour un abonnement que vous souhaitez mettre à jour.< /Param>
updateSubscriptionDiagnostics(UpdateSubscripitonDiagnosticsParameters, string)

Détails du constructeur

ServiceHooksRestClient(IVssRestClientOptions)

new ServiceHooksRestClient(options: IVssRestClientOptions)

Paramètres

options

IVssRestClientOptions

Détails de la méthode

createSubscription(Subscription)

Créer un abonnement

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

Paramètres

subscription

Subscription

Abonnement à créer.

Retours

Promise<Subscription>

createSubscriptionsQuery(SubscriptionsQuery)

Requête pour les abonnements de hook de service.

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

Paramètres

query

SubscriptionsQuery

Retours

Promise<SubscriptionsQuery>

createTestNotification(Notification, boolean)

Envoie une notification de test. Cela est utile pour vérifier la configuration d’un abonnement de hooks de service mis à jour ou nouveau.

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

Paramètres

testNotification

Notification

useRealData

boolean

Autorisez uniquement les tests avec des données réelles dans les abonnements existants.

Retours

Promise<Notification>

deleteSubscription(string)

Supprimez un abonnement de hooks de service spécifique.

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

Paramètres

subscriptionId

string

ID d’un abonnement.

Retours

Promise<void>

getConsumer(string, string)

Obtenir un service consommateur spécifique. Si vous le souhaitez, filtrez les actions du consommateur qui ne prennent en charge aucun type d’événement pour le serveur de publication spécifié.

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

Paramètres

consumerId

string

ID d’un consommateur.

publisherId

string

Retours

Promise<Consumer>

getConsumerAction(string, string, string)

Obtenir des détails sur une action spécifique du consommateur.

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

Paramètres

consumerId

string

ID d’un consommateur.

consumerActionId

string

ID d’un consumerActionId.

publisherId

string

Retours

Promise<ConsumerAction>

getEventType(string, string)

Obtenir un type d’événement spécifique.

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

Paramètres

publisherId

string

ID d’un éditeur.

eventTypeId

string

Retours

Promise<EventTypeDescriptor>

getNotification(string, number)

Obtenez une notification spécifique pour un abonnement.

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

Paramètres

subscriptionId

string

ID d’un abonnement.

notificationId

number

Retours

Promise<Notification>

getNotifications(string, number, NotificationStatus, NotificationResult)

Obtenez la liste des notifications pour un abonnement spécifique. Une notification inclut des détails sur l’événement, la demande adressée et la réponse du service consommateur.

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

Paramètres

subscriptionId

string

ID d’un abonnement.

maxResults

number

Nombre maximal de notifications à retourner. La valeur par défaut est 100.

status

NotificationStatus

Recevez uniquement des notifications avec cette status.

result

NotificationResult

Obtenez uniquement des notifications avec ce type de résultat.

Retours

Promise<Notification[]>

getPublisher(string)

Obtenir un éditeur de hooks de service spécifique.

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

Paramètres

publisherId

string

ID d’un éditeur.

Retours

Promise<Publisher>

getSubscription(string)

Obtenez un abonnement de hooks de service spécifique.

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

Paramètres

subscriptionId

string

ID d’un abonnement.

Retours

Promise<Subscription>

getSubscriptionDiagnostics(string)

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

Paramètres

subscriptionId

string

Retours

Promise<SubscriptionDiagnostics>

listConsumerActions(string, string)

Obtenez la liste des actions du consommateur pour un consommateur spécifique.

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

Paramètres

consumerId

string

ID d’un consommateur.

publisherId

string

Retours

Promise<ConsumerAction[]>

listConsumers(string)

Obtenez la liste des services consommateurs de hook de service disponibles. Si vous le souhaitez, filtrez les consommateurs qui prennent en charge au moins un type d’événement de l’éditeur spécifique.

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

Paramètres

publisherId

string

Retours

Promise<Consumer[]>

listEventTypes(string)

Obtenez les types d’événements pour un éditeur spécifique.

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

Paramètres

publisherId

string

ID d’un éditeur.

Retours

Promise<EventTypeDescriptor[]>

listPublishers()

Obtenez la liste des éditeurs.

function listPublishers(): Promise<Publisher[]>

Retours

Promise<Publisher[]>

listSubscriptions(string, string, string, string)

Obtenez la liste des abonnements.

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

Paramètres

publisherId

string

ID d’un abonnement.

eventType

string

Type d’événement sur lequel filtrer (le cas échéant).

consumerId

string

ID d’un consommateur.

consumerActionId

string

ID d’un consumerActionId.

Retours

Promise<Subscription[]>

publishExternalEvent(string, string)

Publier un événement externe.

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

Paramètres

publisherId

string

channelId

string

Retours

Promise<PublisherEvent[]>

queryInputValues(InputValuesQuery, string)

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

Paramètres

inputValuesQuery

InputValuesQuery

publisherId

string

Retours

Promise<InputValuesQuery>

queryNotifications(NotificationsQuery)

Requête pour les notifications. Une notification inclut des détails sur l’événement, la demande adressée et la réponse du service consommateur.

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

Paramètres

query

NotificationsQuery

Retours

Promise<NotificationsQuery>

queryPublishers(PublishersQuery)

Requête pour les éditeurs de hook de service.

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

Paramètres

query

PublishersQuery

Retours

Promise<PublishersQuery>

replaceSubscription(Subscription, string)

Mettez à jour un abonnement. <param name="subscriptionId">ID pour un abonnement que vous souhaitez mettre à jour.< /Param>

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

Paramètres

subscription

Subscription

subscriptionId

string

Retours

Promise<Subscription>

updateSubscriptionDiagnostics(UpdateSubscripitonDiagnosticsParameters, string)

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

Paramètres

updateParameters

UpdateSubscripitonDiagnosticsParameters

subscriptionId

string

Retours

Promise<SubscriptionDiagnostics>