ServiceHooksRestClient class

Paket:

azure-devops-extension-api

Basisklasse, die verwendet (von abgeleitet) werden soll, um Anforderungen an VSS-REST-APIs zu senden

Extends

RestClientBase

Konstruktoren

ServiceHooksRestClient(IVssRestClientOptions)

Methoden

createSubscription(Subscription)	Erstellen eines Abonnements
createSubscriptionsQuery(SubscriptionsQuery)	Abfrage für Service Hook-Abonnements.
createTestNotification(Notification, boolean)	Sendet eine Testbenachrichtigung. Dies ist nützlich, um die Konfiguration eines aktualisierten oder neuen Diensthooksabonnements zu überprüfen.
deleteSubscription(string)	Löschen Sie ein bestimmtes Service Hooks-Abonnement.
getConsumer(string, string)	Rufen Sie einen bestimmten Consumerdienst ab. Filtern Sie optional Consumeraktionen heraus, die keine Ereignistypen für den angegebenen Herausgeber unterstützen.
getConsumerAction(string, string, string)	Ruft Details zu einer bestimmten Consumeraktion ab.
getEventType(string, string)	Ruft einen bestimmten Ereignistyp ab.
getNotification(string, number)	Rufen Sie eine bestimmte Benachrichtigung für ein Abonnement ab.
getNotifications(string, number, NotificationStatus, NotificationResult)	Rufen Sie eine Liste der Benachrichtigungen für ein bestimmtes Abonnement ab. Eine Benachrichtigung enthält Details zum Ereignis, zur Anforderung an und zur Antwort des Consumerdiensts.
getPublisher(string)	Rufen Sie einen bestimmten Service Hooks-Herausgeber ab.
getSubscription(string)	Rufen Sie ein bestimmtes Service Hooks-Abonnement ab.
getSubscriptionDiagnostics(string)
listConsumerActions(string, string)	Rufen Sie eine Liste der Consumeraktionen für einen bestimmten Consumer ab.
listConsumers(string)	Rufen Sie eine Liste der verfügbaren Service Hook-Consumerdienste ab. Filtern Sie optional nach Consumern, die mindestens einen Ereignistyp des jeweiligen Herausgebers unterstützen.
listEventTypes(string)	Rufen Sie die Ereignistypen für einen bestimmten Herausgeber ab.
listPublishers()	Rufen Sie eine Liste der Herausgeber ab.
listSubscriptions(string, string, string, string)	Rufen Sie eine Liste der Abonnements ab.
publishExternalEvent(string, string)	Veröffentlichen Sie ein externes Ereignis.
queryInputValues(InputValuesQuery, string)
queryNotifications(NotificationsQuery)	Abfragen von Benachrichtigungen. Eine Benachrichtigung enthält Details zum Ereignis, zur Anforderung an und zur Antwort des Consumerdiensts.
queryPublishers(PublishersQuery)	Abfrage für Service Hook-Herausgeber.
replaceSubscription(Subscription, string)	Aktualisieren sie ein Abonnement. <param name="subscriptionId">ID für ein Abonnement, das Sie aktualisieren möchten.< /Param>
updateSubscriptionDiagnostics(UpdateSubscripitonDiagnosticsParameters, string)

Details zum Konstruktor

ServiceHooksRestClient(IVssRestClientOptions)

new ServiceHooksRestClient(options: IVssRestClientOptions)

Parameter

options

IVssRestClientOptions

Details zur Methode

createSubscription(Subscription)

Erstellen eines Abonnements

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

Parameter

subscription

Subscription

Das zu erstellende Abonnement.

Gibt zurück

Promise<Subscription>

createSubscriptionsQuery(SubscriptionsQuery)

Abfrage für Service Hook-Abonnements.

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

Parameter

query

SubscriptionsQuery

Gibt zurück

Promise<SubscriptionsQuery>

createTestNotification(Notification, boolean)

Sendet eine Testbenachrichtigung. Dies ist nützlich, um die Konfiguration eines aktualisierten oder neuen Diensthooksabonnements zu überprüfen.

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

Parameter

testNotification

Notification

useRealData

boolean

Nur Tests mit echten Daten in vorhandenen Abonnements zulassen.

Gibt zurück

Promise<Notification>

deleteSubscription(string)

Löschen Sie ein bestimmtes Service Hooks-Abonnement.

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

Parameter

subscriptionId

string

ID für ein Abonnement.

Gibt zurück

Promise<void>

getConsumer(string, string)

Rufen Sie einen bestimmten Consumerdienst ab. Filtern Sie optional Consumeraktionen heraus, die keine Ereignistypen für den angegebenen Herausgeber unterstützen.

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

Parameter

consumerId

string

ID für einen Consumer.

publisherId

string

Gibt zurück

Promise<Consumer>

getConsumerAction(string, string, string)

Ruft Details zu einer bestimmten Consumeraktion ab.

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

Parameter

consumerId

string

ID für einen Consumer.

consumerActionId

string

ID für eine consumerActionId.

publisherId

string

Gibt zurück

Promise<ConsumerAction>

getEventType(string, string)

Ruft einen bestimmten Ereignistyp ab.

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

Parameter

publisherId

string

ID für einen Herausgeber.

eventTypeId

string

Gibt zurück

Promise<EventTypeDescriptor>

getNotification(string, number)

Rufen Sie eine bestimmte Benachrichtigung für ein Abonnement ab.

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

Parameter

subscriptionId

string

ID für ein Abonnement.

notificationId

number

Gibt zurück

Promise<Notification>

getNotifications(string, number, NotificationStatus, NotificationResult)

Rufen Sie eine Liste der Benachrichtigungen für ein bestimmtes Abonnement ab. Eine Benachrichtigung enthält Details zum Ereignis, zur Anforderung an und zur Antwort des Consumerdiensts.

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

Parameter

subscriptionId

string

ID für ein Abonnement.

maxResults

number

Maximale Anzahl von zurückgegebenen Benachrichtigungen. Der Standardwert ist 100.

status

NotificationStatus

Rufen Sie nur Benachrichtigungen mit diesem status ab.

result

NotificationResult

Ruft nur Benachrichtigungen mit diesem Ergebnistyp ab.

Gibt zurück

Promise<Notification[]>

getPublisher(string)

Rufen Sie einen bestimmten Service Hooks-Herausgeber ab.

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

Parameter

publisherId

string

ID für einen Herausgeber.

Gibt zurück

Promise<Publisher>

getSubscription(string)

Rufen Sie ein bestimmtes Service Hooks-Abonnement ab.

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

Parameter

subscriptionId

string

ID für ein Abonnement.

Gibt zurück

Promise<Subscription>

getSubscriptionDiagnostics(string)

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

Parameter

subscriptionId

string

Gibt zurück

Promise<SubscriptionDiagnostics>

listConsumerActions(string, string)

Rufen Sie eine Liste der Consumeraktionen für einen bestimmten Consumer ab.

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

Parameter

consumerId

string

ID für einen Consumer.

publisherId

string

Gibt zurück

Promise<ConsumerAction[]>

listConsumers(string)

Rufen Sie eine Liste der verfügbaren Service Hook-Consumerdienste ab. Filtern Sie optional nach Consumern, die mindestens einen Ereignistyp des jeweiligen Herausgebers unterstützen.

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

Parameter

publisherId

string

Gibt zurück

Promise<Consumer[]>

listEventTypes(string)

Rufen Sie die Ereignistypen für einen bestimmten Herausgeber ab.

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

Parameter

publisherId

string

ID für einen Herausgeber.

Gibt zurück

Promise<EventTypeDescriptor[]>

listPublishers()

Rufen Sie eine Liste der Herausgeber ab.

function listPublishers(): Promise<Publisher[]>

Gibt zurück

Promise<Publisher[]>

listSubscriptions(string, string, string, string)

Rufen Sie eine Liste der Abonnements ab.

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

Parameter

publisherId

string

ID für ein Abonnement.

eventType

string

Der Ereignistyp, nach dem gefiltert werden soll (falls vorhanden).

consumerId

string

ID für einen Consumer.

consumerActionId

string

ID für eine consumerActionId.

Gibt zurück

Promise<Subscription[]>

publishExternalEvent(string, string)

Veröffentlichen Sie ein externes Ereignis.

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

Parameter

publisherId

string

channelId

string

Gibt zurück

Promise<PublisherEvent[]>

queryInputValues(InputValuesQuery, string)

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

Parameter

inputValuesQuery

InputValuesQuery

publisherId

string

Gibt zurück

Promise<InputValuesQuery>

queryNotifications(NotificationsQuery)

Abfragen von Benachrichtigungen. Eine Benachrichtigung enthält Details zum Ereignis, zur Anforderung an und zur Antwort des Consumerdiensts.

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

Parameter

query

NotificationsQuery

Gibt zurück

Promise<NotificationsQuery>

queryPublishers(PublishersQuery)

Abfrage für Service Hook-Herausgeber.

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

Parameter

query

PublishersQuery

Gibt zurück

Promise<PublishersQuery>

replaceSubscription(Subscription, string)

Aktualisieren sie ein Abonnement. <param name="subscriptionId">ID für ein Abonnement, das Sie aktualisieren möchten.< /Param>

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

Parameter

subscription

Subscription

subscriptionId

string

Gibt zurück

Promise<Subscription>

updateSubscriptionDiagnostics(UpdateSubscripitonDiagnosticsParameters, string)

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

Parameter

updateParameters

UpdateSubscripitonDiagnosticsParameters

subscriptionId

string

Gibt zurück

Promise<SubscriptionDiagnostics>