ServiceHooksRestClient class

Pakket:

azure-devops-extension-api

Basisklasse die moet worden gebruikt (afgeleid van) om aanvragen te doen voor VSS REST API's

Extends

RestClientBase

Constructors

ServiceHooksRestClient(IVssRestClientOptions)

Methoden

createSubscription(Subscription)	Maak een abonnement.
createSubscriptionsQuery(SubscriptionsQuery)	Query's uitvoeren op servicehookabonnementen.
createTestNotification(Notification, boolean)	Hiermee wordt een testmelding verzonden. Dit is handig voor het controleren van de configuratie van een bijgewerkt of nieuw servicehookabonnement.
deleteSubscription(string)	Een specifiek servicehookabonnement verwijderen.
getConsumer(string, string)	Een specifieke consumentenservice ophalen. U kunt desgewenst consumentenacties uitfilteren die geen gebeurtenistypen ondersteunen voor de opgegeven uitgever.
getConsumerAction(string, string, string)	Meer informatie over een specifieke consumentenactie.
getEventType(string, string)	Een specifiek gebeurtenistype ophalen.
getNotification(string, number)	Ontvang een specifieke melding voor een abonnement.
getNotifications(string, number, NotificationStatus, NotificationResult)	Een lijst met meldingen voor een specifiek abonnement ophalen. Een melding bevat details over de gebeurtenis, de aanvraag aan en het antwoord van de consumentenservice.
getPublisher(string)	Een specifieke servicehookuitgever ophalen.
getSubscription(string)	Een specifiek servicehookabonnement aanschaffen.
getSubscriptionDiagnostics(string)
listConsumerActions(string, string)	Een lijst met consumentenacties voor een specifieke consument ophalen.
listConsumers(string)	Een lijst met beschikbare servicehookconsumerservices ophalen. U kunt eventueel filteren op consumenten die ondersteuning bieden voor ten minste één gebeurtenistype van de specifieke uitgever.
listEventTypes(string)	De gebeurtenistypen voor een specifieke uitgever ophalen.
listPublishers()	Een lijst met uitgevers ophalen.
listSubscriptions(string, string, string, string)	Een lijst met abonnementen ophalen.
publishExternalEvent(string, string)	Een externe gebeurtenis publiceren.
queryInputValues(InputValuesQuery, string)
queryNotifications(NotificationsQuery)	Query uitvoeren voor meldingen. Een melding bevat details over de gebeurtenis, de aanvraag aan en het antwoord van de consumentenservice.
queryPublishers(PublishersQuery)	Query voor servicehookuitgevers.
replaceSubscription(Subscription, string)	Een abonnement bijwerken. <param name="subscriptionId">ID voor een abonnement dat u wilt bijwerken.< /Param>
updateSubscriptionDiagnostics(UpdateSubscripitonDiagnosticsParameters, string)

Constructordetails

ServiceHooksRestClient(IVssRestClientOptions)

new ServiceHooksRestClient(options: IVssRestClientOptions)

Parameters

options

IVssRestClientOptions

Methodedetails

createSubscription(Subscription)

Maak een abonnement.

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

Parameters

subscription

Subscription

Abonnement dat moet worden gemaakt.

Retouren

Promise<Subscription>

createSubscriptionsQuery(SubscriptionsQuery)

Query's uitvoeren op servicehookabonnementen.

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

Parameters

query

SubscriptionsQuery

Retouren

Promise<SubscriptionsQuery>

createTestNotification(Notification, boolean)

Hiermee wordt een testmelding verzonden. Dit is handig voor het controleren van de configuratie van een bijgewerkt of nieuw servicehookabonnement.

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

Parameters

testNotification

Notification

useRealData

boolean

Alleen testen met echte gegevens in bestaande abonnementen toestaan.

Retouren

Promise<Notification>

deleteSubscription(string)

Een specifiek servicehookabonnement verwijderen.

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

Parameters

subscriptionId

string

Id voor een abonnement.

Retouren

Promise<void>

getConsumer(string, string)

Een specifieke consumentenservice ophalen. U kunt desgewenst consumentenacties uitfilteren die geen gebeurtenistypen ondersteunen voor de opgegeven uitgever.

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

Parameters

consumerId

string

Id voor een consument.

publisherId

string

Retouren

Promise<Consumer>

getConsumerAction(string, string, string)

Meer informatie over een specifieke consumentenactie.

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

Parameters

consumerId

string

Id voor een consument.

consumerActionId

string

Id voor een consumerActionId.

publisherId

string

Retouren

Promise<ConsumerAction>

getEventType(string, string)

Een specifiek gebeurtenistype ophalen.

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

Parameters

publisherId

string

Id voor een uitgever.

eventTypeId

string

Retouren

Promise<EventTypeDescriptor>

getNotification(string, number)

Ontvang een specifieke melding voor een abonnement.

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

Parameters

subscriptionId

string

Id voor een abonnement.

notificationId

number

Retouren

Promise<Notification>

getNotifications(string, number, NotificationStatus, NotificationResult)

Een lijst met meldingen voor een specifiek abonnement ophalen. Een melding bevat details over de gebeurtenis, de aanvraag aan en het antwoord van de consumentenservice.

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

Parameters

subscriptionId

string

Id voor een abonnement.

maxResults

number

Maximum aantal meldingen dat moet worden geretourneerd. De standaardwaarde is 100.

status

NotificationStatus

Ontvang alleen meldingen met deze status.

result

NotificationResult

Ontvang alleen meldingen met dit resultaattype.

Retouren

Promise<Notification[]>

getPublisher(string)

Een specifieke servicehookuitgever ophalen.

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

Parameters

publisherId

string

Id voor een uitgever.

Retouren

Promise<Publisher>

getSubscription(string)

Een specifiek servicehookabonnement aanschaffen.

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

Parameters

subscriptionId

string

Id voor een abonnement.

Retouren

Promise<Subscription>

getSubscriptionDiagnostics(string)

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

Parameters

subscriptionId

string

Retouren

Promise<SubscriptionDiagnostics>

listConsumerActions(string, string)

Een lijst met consumentenacties voor een specifieke consument ophalen.

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

Parameters

consumerId

string

Id voor een consument.

publisherId

string

Retouren

Promise<ConsumerAction[]>

listConsumers(string)

Een lijst met beschikbare servicehookconsumerservices ophalen. U kunt eventueel filteren op consumenten die ondersteuning bieden voor ten minste één gebeurtenistype van de specifieke uitgever.

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

Parameters

publisherId

string

Retouren

Promise<Consumer[]>

listEventTypes(string)

De gebeurtenistypen voor een specifieke uitgever ophalen.

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

Parameters

publisherId

string

Id voor een uitgever.

Retouren

Promise<EventTypeDescriptor[]>

listPublishers()

Een lijst met uitgevers ophalen.

function listPublishers(): Promise<Publisher[]>

Retouren

Promise<Publisher[]>

listSubscriptions(string, string, string, string)

Een lijst met abonnementen ophalen.

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

Parameters

publisherId

string

Id voor een abonnement.

eventType

string

Het gebeurtenistype waarop moet worden gefilterd (indien van toepassing).

consumerId

string

Id voor een consument.

consumerActionId

string

Id voor een consumerActionId.

Retouren

Promise<Subscription[]>

publishExternalEvent(string, string)

Een externe gebeurtenis publiceren.

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

Parameters

publisherId

string

channelId

string

Retouren

Promise<PublisherEvent[]>

queryInputValues(InputValuesQuery, string)

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

Parameters

inputValuesQuery

InputValuesQuery

publisherId

string

Retouren

Promise<InputValuesQuery>

queryNotifications(NotificationsQuery)

Query uitvoeren voor meldingen. Een melding bevat details over de gebeurtenis, de aanvraag aan en het antwoord van de consumentenservice.

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

Parameters

query

NotificationsQuery

Retouren

Promise<NotificationsQuery>

queryPublishers(PublishersQuery)

Query voor servicehookuitgevers.

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

Parameters

query

PublishersQuery

Retouren

Promise<PublishersQuery>

replaceSubscription(Subscription, string)

Een abonnement bijwerken. <param name="subscriptionId">ID voor een abonnement dat u wilt bijwerken.< /Param>

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

Parameters

subscription

Subscription

subscriptionId

string

Retouren

Promise<Subscription>

updateSubscriptionDiagnostics(UpdateSubscripitonDiagnosticsParameters, string)

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

Parameters

updateParameters

UpdateSubscripitonDiagnosticsParameters

subscriptionId

string

Retouren

Promise<SubscriptionDiagnostics>