ServiceHooksRestClient class

Paket:

azure-devops-extension-api

Basklass som ska användas (härledd från) för att göra begäranden till VSS REST-API:er

Extends

RestClientBase

Konstruktorer

ServiceHooksRestClient(IVssRestClientOptions)

Metoder

createSubscription(Subscription)	Skapa en prenumeration.
createSubscriptionsQuery(SubscriptionsQuery)	Fråga efter tjänstkrokprenumerationer.
createTestNotification(Notification, boolean)	Skickar ett testmeddelande. Det här är användbart för att verifiera konfigurationen av en uppdaterad eller ny prenumeration för tjänstkrokar.
deleteSubscription(string)	Ta bort en specifik prenumeration för tjänstkrokar.
getConsumer(string, string)	Hämta en specifik konsumenttjänst. Du kan också filtrera bort konsumentåtgärder som inte stöder några händelsetyper för den angivna utgivaren.
getConsumerAction(string, string, string)	Få information om en specifik konsumentåtgärd.
getEventType(string, string)	Hämta en specifik händelsetyp.
getNotification(string, number)	Få ett specifikt meddelande för en prenumeration.
getNotifications(string, number, NotificationStatus, NotificationResult)	Hämta en lista över meddelanden för en specifik prenumeration. Ett meddelande innehåller information om händelsen, begäran till och svaret från konsumenttjänsten.
getPublisher(string)	Hämta en specifik utgivare av tjänstkrokar.
getSubscription(string)	Hämta en specifik prenumeration för tjänstkrokar.
getSubscriptionDiagnostics(string)
listConsumerActions(string, string)	Hämta en lista över konsumentåtgärder för en specifik konsument.
listConsumers(string)	Få en lista över tillgängliga service hook konsumenttjänster. Du kan också filtrera efter konsumenter som stöder minst en händelsetyp från den specifika utgivaren.
listEventTypes(string)	Hämta händelsetyperna för en specifik utgivare.
listPublishers()	Hämta en lista över utgivare.
listSubscriptions(string, string, string, string)	Hämta en lista över prenumerationer.
publishExternalEvent(string, string)	Publicera en extern händelse.
queryInputValues(InputValuesQuery, string)
queryNotifications(NotificationsQuery)	Fråga efter meddelanden. Ett meddelande innehåller information om händelsen, begäran till och svaret från konsumenttjänsten.
queryPublishers(PublishersQuery)	Fråga efter service hook-utgivare.
replaceSubscription(Subscription, string)	Uppdatera en prenumeration. <param name="subscriptionId">ID för en prenumeration som du vill uppdatera.</param>
updateSubscriptionDiagnostics(UpdateSubscripitonDiagnosticsParameters, string)

Konstruktorinformation

ServiceHooksRestClient(IVssRestClientOptions)

new ServiceHooksRestClient(options: IVssRestClientOptions)

Parametrar

options

IVssRestClientOptions

Metodinformation

createSubscription(Subscription)

Skapa en prenumeration.

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

Parametrar

subscription

Subscription

Prenumeration som ska skapas.

Returer

Promise<Subscription>

createSubscriptionsQuery(SubscriptionsQuery)

Fråga efter tjänstkrokprenumerationer.

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

Parametrar

query

SubscriptionsQuery

Returer

Promise<SubscriptionsQuery>

createTestNotification(Notification, boolean)

Skickar ett testmeddelande. Det här är användbart för att verifiera konfigurationen av en uppdaterad eller ny prenumeration för tjänstkrokar.

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

Parametrar

testNotification

Notification

useRealData

boolean

Tillåt endast testning med verkliga data i befintliga prenumerationer.

Returer

Promise<Notification>

deleteSubscription(string)

Ta bort en specifik prenumeration för tjänstkrokar.

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

Parametrar

subscriptionId

string

ID för en prenumeration.

Returer

Promise<void>

getConsumer(string, string)

Hämta en specifik konsumenttjänst. Du kan också filtrera bort konsumentåtgärder som inte stöder några händelsetyper för den angivna utgivaren.

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

Parametrar

consumerId

string

ID för en konsument.

publisherId

string

Returer

Promise<Consumer>

getConsumerAction(string, string, string)

Få information om en specifik konsumentåtgärd.

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

Parametrar

consumerId

string

ID för en konsument.

consumerActionId

string

ID för ett consumerActionId.

publisherId

string

Returer

Promise<ConsumerAction>

getEventType(string, string)

Hämta en specifik händelsetyp.

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

Parametrar

publisherId

string

ID för en utgivare.

eventTypeId

string

Returer

Promise<EventTypeDescriptor>

getNotification(string, number)

Få ett specifikt meddelande för en prenumeration.

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

Parametrar

subscriptionId

string

ID för en prenumeration.

notificationId

number

Returer

Promise<Notification>

getNotifications(string, number, NotificationStatus, NotificationResult)

Hämta en lista över meddelanden för en specifik prenumeration. Ett meddelande innehåller information om händelsen, begäran till och svaret från konsumenttjänsten.

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

Parametrar

subscriptionId

string

ID för en prenumeration.

maxResults

number

Maximalt antal meddelanden som ska returneras. Standardvärdet är 100.

status

NotificationStatus

Hämta endast meddelanden med den här statusen.

result

NotificationResult

Få endast meddelanden med den här resultattypen.

Returer

Promise<Notification[]>

getPublisher(string)

Hämta en specifik utgivare av tjänstkrokar.

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

Parametrar

publisherId

string

ID för en utgivare.

Returer

Promise<Publisher>

getSubscription(string)

Hämta en specifik prenumeration för tjänstkrokar.

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

Parametrar

subscriptionId

string

ID för en prenumeration.

Returer

Promise<Subscription>

getSubscriptionDiagnostics(string)

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

Parametrar

subscriptionId

string

Returer

Promise<SubscriptionDiagnostics>

listConsumerActions(string, string)

Hämta en lista över konsumentåtgärder för en specifik konsument.

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

Parametrar

consumerId

string

ID för en konsument.

publisherId

string

Returer

Promise<ConsumerAction[]>

listConsumers(string)

Få en lista över tillgängliga service hook konsumenttjänster. Du kan också filtrera efter konsumenter som stöder minst en händelsetyp från den specifika utgivaren.

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

Parametrar

publisherId

string

Returer

Promise<Consumer[]>

listEventTypes(string)

Hämta händelsetyperna för en specifik utgivare.

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

Parametrar

publisherId

string

ID för en utgivare.

Returer

Promise<EventTypeDescriptor[]>

listPublishers()

Hämta en lista över utgivare.

function listPublishers(): Promise<Publisher[]>

Returer

Promise<Publisher[]>

listSubscriptions(string, string, string, string)

Hämta en lista över prenumerationer.

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

Parametrar

publisherId

string

ID för en prenumeration.

eventType

string

Händelsetypen som ska filtreras på (om någon).

consumerId

string

ID för en konsument.

consumerActionId

string

ID för ett consumerActionId.

Returer

Promise<Subscription[]>

publishExternalEvent(string, string)

Publicera en extern händelse.

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

Parametrar

publisherId

string

channelId

string

Returer

Promise<PublisherEvent[]>

queryInputValues(InputValuesQuery, string)

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

Parametrar

inputValuesQuery

InputValuesQuery

publisherId

string

Returer

Promise<InputValuesQuery>

queryNotifications(NotificationsQuery)

Fråga efter meddelanden. Ett meddelande innehåller information om händelsen, begäran till och svaret från konsumenttjänsten.

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

Parametrar

query

NotificationsQuery

Returer

Promise<NotificationsQuery>

queryPublishers(PublishersQuery)

Fråga efter service hook-utgivare.

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

Parametrar

query

PublishersQuery

Returer

Promise<PublishersQuery>

replaceSubscription(Subscription, string)

Uppdatera en prenumeration. <param name="subscriptionId">ID för en prenumeration som du vill uppdatera.</param>

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

Parametrar

subscription

Subscription

subscriptionId

string

Returer

Promise<Subscription>

updateSubscriptionDiagnostics(UpdateSubscripitonDiagnosticsParameters, string)

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

Parametrar

updateParameters

UpdateSubscripitonDiagnosticsParameters

subscriptionId

string

Returer

Promise<SubscriptionDiagnostics>