ServiceHooksRestClient class

Balíček:

azure-devops-extension-api

Základní třída, která by se měla používat (odvozená z) k vytváření požadavků na rozhraní REST api služby VSS

Extends

RestClientBase

Konstruktory

ServiceHooksRestClient(IVssRestClientOptions)

Metody

createSubscription(Subscription)	Vytvořte předplatné.
createSubscriptionsQuery(SubscriptionsQuery)	Dotaz na předplatná pro připojení služby
createTestNotification(Notification, boolean)	Odešle testovací oznámení. To je užitečné při ověřování konfigurace aktualizovaného nebo nového předplatného pro připojení služby.
deleteSubscription(string)	Odstraňte konkrétní předplatné služby hooks.
getConsumer(string, string)	Získejte konkrétní službu příjemce. Volitelně můžete odfiltrovat akce příjemce, které nepodporují žádné typy událostí pro zadaného vydavatele.
getConsumerAction(string, string, string)	Získejte podrobnosti o konkrétní akci příjemce.
getEventType(string, string)	Získejte konkrétní typ události.
getNotification(string, number)	Získejte konkrétní oznámení pro předplatné.
getNotifications(string, number, NotificationStatus, NotificationResult)	Získejte seznam oznámení pro konkrétní předplatné. Oznámení obsahuje podrobnosti o události, požadavku a odpovědi služby příjemce.
getPublisher(string)	Získejte konkrétního vydavatele hooks služby.
getSubscription(string)	Získejte konkrétní předplatné služby hooks.
getSubscriptionDiagnostics(string)
listConsumerActions(string, string)	Získejte seznam akcí příjemce pro konkrétního příjemce.
listConsumers(string)	Získejte seznam dostupných služeb pro uživatele. Volitelně můžete filtrovat podle příjemců, kteří podporují alespoň jeden typ události od konkrétního vydavatele.
listEventTypes(string)	Získejte typy událostí pro konkrétního vydavatele.
listPublishers()	Získejte seznam vydavatelů.
listSubscriptions(string, string, string, string)	Získejte seznam předplatných.
publishExternalEvent(string, string)	Publikujte externí událost.
queryInputValues(InputValuesQuery, string)
queryNotifications(NotificationsQuery)	Dotaz na oznámení Oznámení obsahuje podrobnosti o události, požadavku a odpovědi služby příjemce.
queryPublishers(PublishersQuery)	Dotaz na vydavatele služby hook.
replaceSubscription(Subscription, string)	Aktualizace předplatného <param name="subscriptionId">ID předplatného, které chcete aktualizovat.< /Param>
updateSubscriptionDiagnostics(UpdateSubscripitonDiagnosticsParameters, string)

Podrobnosti konstruktoru

ServiceHooksRestClient(IVssRestClientOptions)

new ServiceHooksRestClient(options: IVssRestClientOptions)

Parametry

options

IVssRestClientOptions

Podrobnosti metody

createSubscription(Subscription)

Vytvořte předplatné.

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

Parametry

subscription

Subscription

Předplatné, které se má vytvořit.

Návraty

Promise<Subscription>

createSubscriptionsQuery(SubscriptionsQuery)

Dotaz na předplatná pro připojení služby

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

Parametry

query

SubscriptionsQuery

Návraty

Promise<SubscriptionsQuery>

createTestNotification(Notification, boolean)

Odešle testovací oznámení. To je užitečné při ověřování konfigurace aktualizovaného nebo nového předplatného pro připojení služby.

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

Parametry

testNotification

Notification

useRealData

boolean

Povolte testování pouze se skutečnými daty v existujících předplatných.

Návraty

Promise<Notification>

deleteSubscription(string)

Odstraňte konkrétní předplatné služby hooks.

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

Parametry

subscriptionId

string

ID předplatného.

Návraty

Promise<void>

getConsumer(string, string)

Získejte konkrétní službu příjemce. Volitelně můžete odfiltrovat akce příjemce, které nepodporují žádné typy událostí pro zadaného vydavatele.

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

Parametry

consumerId

string

ID příjemce.

publisherId

string

Návraty

Promise<Consumer>

getConsumerAction(string, string, string)

Získejte podrobnosti o konkrétní akci příjemce.

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

Parametry

consumerId

string

ID příjemce.

consumerActionId

string

ID pro consumerActionId.

publisherId

string

Návraty

Promise<ConsumerAction>

getEventType(string, string)

Získejte konkrétní typ události.

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

Parametry

publisherId

string

ID vydavatele.

eventTypeId

string

Návraty

Promise<EventTypeDescriptor>

getNotification(string, number)

Získejte konkrétní oznámení pro předplatné.

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

Parametry

subscriptionId

string

ID předplatného.

notificationId

number

Návraty

Promise<Notification>

getNotifications(string, number, NotificationStatus, NotificationResult)

Získejte seznam oznámení pro konkrétní předplatné. Oznámení obsahuje podrobnosti o události, požadavku a odpovědi služby příjemce.

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

Parametry

subscriptionId

string

ID předplatného.

maxResults

number

Maximální počet oznámení, která se mají vrátit. Výchozí hodnota je 100.

status

NotificationStatus

Dostávat jenom oznámení s tímto stavem.

result

NotificationResult

Získejte jenom oznámení s tímto typem výsledku.

Návraty

Promise<Notification[]>

getPublisher(string)

Získejte konkrétního vydavatele hooks služby.

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

Parametry

publisherId

string

ID vydavatele.

Návraty

Promise<Publisher>

getSubscription(string)

Získejte konkrétní předplatné služby hooks.

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

Parametry

subscriptionId

string

ID předplatného.

Návraty

Promise<Subscription>

getSubscriptionDiagnostics(string)

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

Parametry

subscriptionId

string

Návraty

Promise<SubscriptionDiagnostics>

listConsumerActions(string, string)

Získejte seznam akcí příjemce pro konkrétního příjemce.

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

Parametry

consumerId

string

ID příjemce.

publisherId

string

Návraty

Promise<ConsumerAction[]>

listConsumers(string)

Získejte seznam dostupných služeb pro uživatele. Volitelně můžete filtrovat podle příjemců, kteří podporují alespoň jeden typ události od konkrétního vydavatele.

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

Parametry

publisherId

string

Návraty

Promise<Consumer[]>

listEventTypes(string)

Získejte typy událostí pro konkrétního vydavatele.

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

Parametry

publisherId

string

ID vydavatele.

Návraty

Promise<EventTypeDescriptor[]>

listPublishers()

Získejte seznam vydavatelů.

function listPublishers(): Promise<Publisher[]>

Návraty

Promise<Publisher[]>

listSubscriptions(string, string, string, string)

Získejte seznam předplatných.

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

Parametry

publisherId

string

ID předplatného.

eventType

string

Typ události, podle které se má filtrovat (pokud existuje).

consumerId

string

ID příjemce.

consumerActionId

string

ID pro consumerActionId.

Návraty

Promise<Subscription[]>

publishExternalEvent(string, string)

Publikujte externí událost.

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

Parametry

publisherId

string

channelId

string

Návraty

Promise<PublisherEvent[]>

queryInputValues(InputValuesQuery, string)

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

Parametry

inputValuesQuery

InputValuesQuery

publisherId

string

Návraty

Promise<InputValuesQuery>

queryNotifications(NotificationsQuery)

Dotaz na oznámení Oznámení obsahuje podrobnosti o události, požadavku a odpovědi služby příjemce.

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

Parametry

query

NotificationsQuery

Návraty

Promise<NotificationsQuery>

queryPublishers(PublishersQuery)

Dotaz na vydavatele služby hook.

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

Parametry

query

PublishersQuery

Návraty

Promise<PublishersQuery>

replaceSubscription(Subscription, string)

Aktualizace předplatného <param name="subscriptionId">ID předplatného, které chcete aktualizovat.< /Param>

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

Parametry

subscription

Subscription

subscriptionId

string

Návraty

Promise<Subscription>

updateSubscriptionDiagnostics(UpdateSubscripitonDiagnosticsParameters, string)

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

Parametry

updateParameters

UpdateSubscripitonDiagnosticsParameters

subscriptionId

string

Návraty

Promise<SubscriptionDiagnostics>