ServiceHooksRestClient class

Pakiet:

azure-devops-extension-api

Klasa bazowa, która powinna być używana (pochodna) do tworzenia żądań do interfejsów API REST usługi VSS

Rozszerzenie

RestClientBase

Konstruktory

ServiceHooksRestClient(IVssRestClientOptions)

Metody

createSubscription(Subscription)	Utwórz subskrypcję.
createSubscriptionsQuery(SubscriptionsQuery)	Zapytanie o subskrypcje punktów zaczepienia usługi.
createTestNotification(Notification, boolean)	Wysyła powiadomienie testowe. Jest to przydatne do weryfikowania konfiguracji zaktualizowanej lub nowej subskrypcji punktów zaczepienia usługi.
deleteSubscription(string)	Usuń określoną subskrypcję punktów zaczepienia usługi.
getConsumer(string, string)	Uzyskaj określoną usługę konsumenta. Opcjonalnie odfiltruj akcje konsumentów, które nie obsługują żadnych typów zdarzeń dla określonego wydawcy.
getConsumerAction(string, string, string)	Uzyskaj szczegółowe informacje o określonej akcji konsumenta.
getEventType(string, string)	Pobierz określony typ zdarzenia.
getNotification(string, number)	Pobierz konkretne powiadomienie dotyczące subskrypcji.
getNotifications(string, number, NotificationStatus, NotificationResult)	Pobierz listę powiadomień dla określonej subskrypcji. Powiadomienie zawiera szczegółowe informacje o zdarzeniu, żądaniu i odpowiedzi od usługi konsumenta.
getPublisher(string)	Pobierz określonego wydawcę punktów zaczepienia usługi.
getSubscription(string)	Uzyskaj określoną subskrypcję punktów zaczepienia usługi.
getSubscriptionDiagnostics(string)
listConsumerActions(string, string)	Pobieranie listy akcji konsumenckich dla określonego konsumenta.
listConsumers(string)	Pobierz listę dostępnych usług konsumenckich z punktami zaczepienia usług. Opcjonalnie filtruj według użytkowników, którzy obsługują co najmniej jeden typ zdarzenia od określonego wydawcy.
listEventTypes(string)	Pobierz typy zdarzeń dla określonego wydawcy.
listPublishers()	Pobierz listę wydawców.
listSubscriptions(string, string, string, string)	Pobierz listę subskrypcji.
publishExternalEvent(string, string)	Publikowanie zdarzenia zewnętrznego.
queryInputValues(InputValuesQuery, string)
queryNotifications(NotificationsQuery)	Wysyłanie zapytań o powiadomienia. Powiadomienie zawiera szczegółowe informacje o zdarzeniu, żądaniu i odpowiedzi od usługi konsumenta.
queryPublishers(PublishersQuery)	Wykonywanie zapytań o wydawców punktów zaczepienia usługi.
replaceSubscription(Subscription, string)	Aktualizowanie subskrypcji. <parametrm name="subscriptionId">identyfikator subskrypcji, którą chcesz zaktualizować.</param>
updateSubscriptionDiagnostics(UpdateSubscripitonDiagnosticsParameters, string)

Szczegóły konstruktora

ServiceHooksRestClient(IVssRestClientOptions)

new ServiceHooksRestClient(options: IVssRestClientOptions)

Parametry

options

IVssRestClientOptions

Szczegóły metody

createSubscription(Subscription)

Utwórz subskrypcję.

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

Parametry

subscription

Subscription

Subskrypcja do utworzenia.

Zwraca

Promise<Subscription>

createSubscriptionsQuery(SubscriptionsQuery)

Zapytanie o subskrypcje punktów zaczepienia usługi.

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

Parametry

query

SubscriptionsQuery

Zwraca

Promise<SubscriptionsQuery>

createTestNotification(Notification, boolean)

Wysyła powiadomienie testowe. Jest to przydatne do weryfikowania konfiguracji zaktualizowanej lub nowej subskrypcji punktów zaczepienia usługi.

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

Parametry

testNotification

Notification

useRealData

boolean

Zezwalaj tylko na testowanie z rzeczywistymi danymi w istniejących subskrypcjach.

Zwraca

Promise<Notification>

deleteSubscription(string)

Usuń określoną subskrypcję punktów zaczepienia usługi.

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

Parametry

subscriptionId

string

Identyfikator subskrypcji.

Zwraca

Promise<void>

getConsumer(string, string)

Uzyskaj określoną usługę konsumenta. Opcjonalnie odfiltruj akcje konsumentów, które nie obsługują żadnych typów zdarzeń dla określonego wydawcy.

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

Parametry

consumerId

string

Identyfikator odbiorcy.

publisherId

string

Zwraca

Promise<Consumer>

getConsumerAction(string, string, string)

Uzyskaj szczegółowe informacje o określonej akcji konsumenta.

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

Parametry

consumerId

string

Identyfikator odbiorcy.

consumerActionId

string

Identyfikator identyfikatora consumerActionId.

publisherId

string

Zwraca

Promise<ConsumerAction>

getEventType(string, string)

Pobierz określony typ zdarzenia.

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

Parametry

publisherId

string

Identyfikator wydawcy.

eventTypeId

string

Zwraca

Promise<EventTypeDescriptor>

getNotification(string, number)

Pobierz konkretne powiadomienie dotyczące subskrypcji.

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

Parametry

subscriptionId

string

Identyfikator subskrypcji.

notificationId

number

Zwraca

Promise<Notification>

getNotifications(string, number, NotificationStatus, NotificationResult)

Pobierz listę powiadomień dla określonej subskrypcji. Powiadomienie zawiera szczegółowe informacje o zdarzeniu, żądaniu i odpowiedzi od usługi konsumenta.

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

Parametry

subscriptionId

string

Identyfikator subskrypcji.

maxResults

number

Maksymalna liczba powiadomień do zwrócenia. Wartość domyślna to 100.

status

NotificationStatus

Pobierz tylko powiadomienia o tym stanie.

result

NotificationResult

Pobieraj tylko powiadomienia o tym typie wyników.

Zwraca

Promise<Notification[]>

getPublisher(string)

Pobierz określonego wydawcę punktów zaczepienia usługi.

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

Parametry

publisherId

string

Identyfikator wydawcy.

Zwraca

Promise<Publisher>

getSubscription(string)

Uzyskaj określoną subskrypcję punktów zaczepienia usługi.

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

Parametry

subscriptionId

string

Identyfikator subskrypcji.

Zwraca

Promise<Subscription>

getSubscriptionDiagnostics(string)

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

Parametry

subscriptionId

string

Zwraca

Promise<SubscriptionDiagnostics>

listConsumerActions(string, string)

Pobieranie listy akcji konsumenckich dla określonego konsumenta.

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

Parametry

consumerId

string

Identyfikator odbiorcy.

publisherId

string

Zwraca

Promise<ConsumerAction[]>

listConsumers(string)

Pobierz listę dostępnych usług konsumenckich z punktami zaczepienia usług. Opcjonalnie filtruj według użytkowników, którzy obsługują co najmniej jeden typ zdarzenia od określonego wydawcy.

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

Parametry

publisherId

string

Zwraca

Promise<Consumer[]>

listEventTypes(string)

Pobierz typy zdarzeń dla określonego wydawcy.

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

Parametry

publisherId

string

Identyfikator wydawcy.

Zwraca

Promise<EventTypeDescriptor[]>

listPublishers()

Pobierz listę wydawców.

function listPublishers(): Promise<Publisher[]>

Zwraca

Promise<Publisher[]>

listSubscriptions(string, string, string, string)

Pobierz listę subskrypcji.

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

Parametry

publisherId

string

Identyfikator subskrypcji.

eventType

string

Typ zdarzenia do filtrowania (jeśli istnieje).

consumerId

string

Identyfikator odbiorcy.

consumerActionId

string

Identyfikator identyfikatora consumerActionId.

Zwraca

Promise<Subscription[]>

publishExternalEvent(string, string)

Publikowanie zdarzenia zewnętrznego.

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

Parametry

publisherId

string

channelId

string

Zwraca

Promise<PublisherEvent[]>

queryInputValues(InputValuesQuery, string)

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

Parametry

inputValuesQuery

InputValuesQuery

publisherId

string

Zwraca

Promise<InputValuesQuery>

queryNotifications(NotificationsQuery)

Wysyłanie zapytań o powiadomienia. Powiadomienie zawiera szczegółowe informacje o zdarzeniu, żądaniu i odpowiedzi od usługi konsumenta.

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

Parametry

query

NotificationsQuery

Zwraca

Promise<NotificationsQuery>

queryPublishers(PublishersQuery)

Wykonywanie zapytań o wydawców punktów zaczepienia usługi.

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

Parametry

query

PublishersQuery

Zwraca

Promise<PublishersQuery>

replaceSubscription(Subscription, string)

Aktualizowanie subskrypcji. <parametrm name="subscriptionId">identyfikator subskrypcji, którą chcesz zaktualizować.</param>

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

Parametry

subscription

Subscription

subscriptionId

string

Zwraca

Promise<Subscription>

updateSubscriptionDiagnostics(UpdateSubscripitonDiagnosticsParameters, string)

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

Parametry

updateParameters

UpdateSubscripitonDiagnosticsParameters

subscriptionId

string

Zwraca

Promise<SubscriptionDiagnostics>