ServiceHooksRestClient class

new ServiceHooksRestClient(options: IVssRestClientOptions)

Paramètres

Créer un abonnement

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

Paramètres

Retours

Requête pour les abonnements de hook de service.

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

Paramètres

Retours

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

Retours

Supprimez un abonnement de hooks de service spécifique.

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

Paramètres

Retours

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

Retours

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

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

Paramètres

Retours

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

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

Paramètres

Retours

Obtenez une notification spécifique pour un abonnement.

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

Paramètres

Retours

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

Retours

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

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

Paramètres

Retours

Obtenez un abonnement de hooks de service spécifique.

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

Paramètres

Retours

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

Paramètres

Retours

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

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

Paramètres

Retours

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

Retours

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

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

Paramètres

Retours

Obtenez la liste des éditeurs.

function listPublishers(): Promise<Publisher[]>

Retours

Obtenez la liste des abonnements.

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

Paramètres

Retours

Publier un événement externe.

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

Paramètres

Retours

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

Paramètres

Retours

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

Retours

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

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

Paramètres

Retours

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

Retours

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

Paramètres

Retours