ServiceHooksRestClient class

Paket:

azure-devops-extension-api

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

Extends

RestClientBase

Konstruktoren

ServiceHooksRestClient(IVssRestClientOptions)

Methoden

createSubscription(Subscription)	Erstellen Sie ein Abonnement.
createSubscriptionsQuery(SubscriptionsQuery)	Abfrage für Diensthakenabonnements.
createTestNotification(Notification, boolean)	Sendet eine Testbenachrichtigung. Dies ist nützlich, um die Konfiguration eines aktualisierten oder neuen Diensthakenabonnements zu überprüfen.
deleteSubscription(string)	Löschen eines bestimmten Diensthakenabonnements.
getConsumer(string, string)	Rufen Sie einen bestimmten Verbraucherdienst ab. Optional können Sie Verbraucheraktionen herausfiltern, die keine Ereignistypen für den angegebenen Herausgeber unterstützen.
getConsumerAction(string, string, string)	Rufen Sie Details zu einer bestimmten Verbraucheraktion 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)	Dient zum Abrufen einer Liste von Benachrichtigungen für ein bestimmtes Abonnement. Eine Benachrichtigung enthält Details über das Ereignis, die Anforderung und die Antwort des Verbraucherdiensts.
getPublisher(string)	Rufen Sie einen bestimmten Dienst-Hooks-Herausgeber ab.
getSubscription(string)	Rufen Sie ein bestimmtes Service hooks-Abonnement ab.
getSubscriptionDiagnostics(string)
listConsumerActions(string, string)	Ruft eine Liste der Verbraucheraktionen für einen bestimmten Verbraucher ab.
listConsumers(string)	Dient zum Abrufen einer Liste der verfügbaren Diensthaken-Consumerdienste. Filtern Sie optional nach Consumern, die mindestens einen Ereignistyp vom jeweiligen Herausgeber unterstützen.
listEventTypes(string)	Rufen Sie die Ereignistypen für einen bestimmten Herausgeber ab.
listPublishers()	Dient zum Abrufen einer Liste von Herausgebern.
listSubscriptions(string, string, string, string)	Dient zum Abrufen einer Liste von Abonnements.
publishExternalEvent(string, string)	Veröffentlichen sie ein externes Ereignis.
queryInputValues(InputValuesQuery, string)
queryNotifications(NotificationsQuery)	Abfrage nach Benachrichtigungen. Eine Benachrichtigung enthält Details über das Ereignis, die Anforderung und die Antwort des Verbraucherdiensts.
queryPublishers(PublishersQuery)	Abfrage für Diensthaken-Herausgeber.
replaceSubscription(Subscription, string)	Aktualisieren eines Abonnements. <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 Sie ein Abonnement.

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

Parameter

subscription

Subscription

Abonnement, das erstellt werden soll.

Gibt zurück

Promise<Subscription>

createSubscriptionsQuery(SubscriptionsQuery)

Abfrage für Diensthakenabonnements.

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 Diensthakenabonnements 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 eines bestimmten Diensthakenabonnements.

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 Verbraucherdienst ab. Optional können Sie Verbraucheraktionen herausfiltern, 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 Verbraucher.

publisherId

string

Gibt zurück

Promise<Consumer>

getConsumerAction(string, string, string)

Rufen Sie Details zu einer bestimmten Verbraucheraktion ab.

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

Parameter

consumerId

string

ID für einen Verbraucher.

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)

Dient zum Abrufen einer Liste von Benachrichtigungen für ein bestimmtes Abonnement. Eine Benachrichtigung enthält Details über das Ereignis, die Anforderung und die Antwort des Verbraucherdiensts.

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

Parameter

subscriptionId

string

ID für ein Abonnement.

maxResults

number

Maximale Anzahl der zurückzugebenden Benachrichtigungen. Der Standardwert ist 100.

status

NotificationStatus

Erhalten Sie nur Benachrichtigungen mit diesem Status.

result

NotificationResult

Rufen Sie nur Benachrichtigungen mit diesem Ergebnistyp ab.

Gibt zurück

Promise<Notification[]>

getPublisher(string)

Rufen Sie einen bestimmten Dienst-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)

Ruft eine Liste der Verbraucheraktionen für einen bestimmten Verbraucher ab.

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

Parameter

consumerId

string

ID für einen Verbraucher.

publisherId

string

Gibt zurück

Promise<ConsumerAction[]>

listConsumers(string)

Dient zum Abrufen einer Liste der verfügbaren Diensthaken-Consumerdienste. Filtern Sie optional nach Consumern, die mindestens einen Ereignistyp vom jeweiligen Herausgeber 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()

Dient zum Abrufen einer Liste von Herausgebern.

function listPublishers(): Promise<Publisher[]>

Gibt zurück

Promise<Publisher[]>

listSubscriptions(string, string, string, string)

Dient zum Abrufen einer Liste von Abonnements.

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 Verbraucher.

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)

Abfrage nach Benachrichtigungen. Eine Benachrichtigung enthält Details über das Ereignis, die Anforderung und die Antwort des Verbraucherdiensts.

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

Parameter

query

NotificationsQuery

Gibt zurück

Promise<NotificationsQuery>

queryPublishers(PublishersQuery)

Abfrage für Diensthaken-Herausgeber.

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

Parameter

query

PublishersQuery

Gibt zurück

Promise<PublishersQuery>

replaceSubscription(Subscription, string)

Aktualisieren eines Abonnements. <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>