ServiceHooksRestClient class

Pacchetto:

azure-devops-extension-api

Classe di base che deve essere usata (derivata da) per effettuare richieste alle API REST vss

Extends

RestClientBase

Costruttori

ServiceHooksRestClient(IVssRestClientOptions)

Metodi

createSubscription(Subscription)	Creazione di una sottoscrizione.
createSubscriptionsQuery(SubscriptionsQuery)	Eseguire una query per le sottoscrizioni di service hook.
createTestNotification(Notification, boolean)	Invia una notifica di test. Ciò è utile per verificare la configurazione di una sottoscrizione aggiornata o nuova dell'hook del servizio.
deleteSubscription(string)	Eliminare una sottoscrizione del servizio specifica.
getConsumer(string, string)	Ottenere un servizio consumer specifico. Facoltativamente, filtrare le azioni consumer che non supportano alcun tipo di evento per il server di pubblicazione specificato.
getConsumerAction(string, string, string)	Ottenere informazioni dettagliate su un'azione specifica del consumer.
getEventType(string, string)	Ottenere un tipo di evento specifico.
getNotification(string, number)	Ottenere una notifica specifica per una sottoscrizione.
getNotifications(string, number, NotificationStatus, NotificationResult)	Ottenere un elenco di notifiche per una sottoscrizione specifica. Una notifica include i dettagli sull'evento, la richiesta a e la risposta dal servizio consumer.
getPublisher(string)	Ottenere un server di pubblicazione di servizi specifico.
getSubscription(string)	Ottenere una sottoscrizione di service hook specifica.
getSubscriptionDiagnostics(string)
listConsumerActions(string, string)	Ottenere un elenco di azioni consumer per un consumer specifico.
listConsumers(string)	Ottenere un elenco dei servizi consumer di service hook disponibili. Facoltativamente, filtrare da consumer che supportano almeno un tipo di evento dal server di pubblicazione specifico.
listEventTypes(string)	Ottenere i tipi di evento per un server di pubblicazione specifico.
listPublishers()	Ottenere un elenco di editori.
listSubscriptions(string, string, string, string)	Ottenere un elenco di sottoscrizioni.
publishExternalEvent(string, string)	Pubblicare un evento esterno.
queryInputValues(InputValuesQuery, string)
queryNotifications(NotificationsQuery)	Eseguire una query per le notifiche. Una notifica include i dettagli sull'evento, la richiesta a e la risposta dal servizio consumer.
queryPublishers(PublishersQuery)	Query per i server di pubblicazione di service hook.
replaceSubscription(Subscription, string)	Aggiornare una sottoscrizione. <param name="subscriptionId">ID per una sottoscrizione da aggiornare.< /Param>
updateSubscriptionDiagnostics(UpdateSubscripitonDiagnosticsParameters, string)

Dettagli costruttore

ServiceHooksRestClient(IVssRestClientOptions)

new ServiceHooksRestClient(options: IVssRestClientOptions)

Parametri

options

IVssRestClientOptions

Dettagli metodo

createSubscription(Subscription)

Creazione di una sottoscrizione.

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

Parametri

subscription

Subscription

Sottoscrizione da creare.

Restituisce

Promise<Subscription>

createSubscriptionsQuery(SubscriptionsQuery)

Eseguire una query per le sottoscrizioni di service hook.

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

Parametri

query

SubscriptionsQuery

Restituisce

Promise<SubscriptionsQuery>

createTestNotification(Notification, boolean)

Invia una notifica di test. Ciò è utile per verificare la configurazione di una sottoscrizione aggiornata o nuova dell'hook del servizio.

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

Parametri

testNotification

Notification

useRealData

boolean

Consenti solo test con dati reali nelle sottoscrizioni esistenti.

Restituisce

Promise<Notification>

deleteSubscription(string)

Eliminare una sottoscrizione del servizio specifica.

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

Parametri

subscriptionId

string

ID per una sottoscrizione.

Restituisce

Promise<void>

getConsumer(string, string)

Ottenere un servizio consumer specifico. Facoltativamente, filtrare le azioni consumer che non supportano alcun tipo di evento per il server di pubblicazione specificato.

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

Parametri

consumerId

string

ID per un consumer.

publisherId

string

Restituisce

Promise<Consumer>

getConsumerAction(string, string, string)

Ottenere informazioni dettagliate su un'azione specifica del consumer.

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

Parametri

consumerId

string

ID per un consumer.

consumerActionId

string

ID per un consumerActionId.

publisherId

string

Restituisce

Promise<ConsumerAction>

getEventType(string, string)

Ottenere un tipo di evento specifico.

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

Parametri

publisherId

string

ID per un editore.

eventTypeId

string

Restituisce

Promise<EventTypeDescriptor>

getNotification(string, number)

Ottenere una notifica specifica per una sottoscrizione.

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

Parametri

subscriptionId

string

ID per una sottoscrizione.

notificationId

number

Restituisce

Promise<Notification>

getNotifications(string, number, NotificationStatus, NotificationResult)

Ottenere un elenco di notifiche per una sottoscrizione specifica. Una notifica include i dettagli sull'evento, la richiesta a e la risposta dal servizio consumer.

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

Parametri

subscriptionId

string

ID per una sottoscrizione.

maxResults

number

Numero massimo di notifiche da restituire. Il valore predefinito è 100.

status

NotificationStatus

Ottenere solo notifiche con questo stato.

result

NotificationResult

Ottenere solo notifiche con questo tipo di risultato.

Restituisce

Promise<Notification[]>

getPublisher(string)

Ottenere un server di pubblicazione di servizi specifico.

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

Parametri

publisherId

string

ID per un editore.

Restituisce

Promise<Publisher>

getSubscription(string)

Ottenere una sottoscrizione di service hook specifica.

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

Parametri

subscriptionId

string

ID per una sottoscrizione.

Restituisce

Promise<Subscription>

getSubscriptionDiagnostics(string)

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

Parametri

subscriptionId

string

Restituisce

Promise<SubscriptionDiagnostics>

listConsumerActions(string, string)

Ottenere un elenco di azioni consumer per un consumer specifico.

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

Parametri

consumerId

string

ID per un consumer.

publisherId

string

Restituisce

Promise<ConsumerAction[]>

listConsumers(string)

Ottenere un elenco dei servizi consumer di service hook disponibili. Facoltativamente, filtrare da consumer che supportano almeno un tipo di evento dal server di pubblicazione specifico.

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

Parametri

publisherId

string

Restituisce

Promise<Consumer[]>

listEventTypes(string)

Ottenere i tipi di evento per un server di pubblicazione specifico.

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

Parametri

publisherId

string

ID per un editore.

Restituisce

Promise<EventTypeDescriptor[]>

listPublishers()

Ottenere un elenco di editori.

function listPublishers(): Promise<Publisher[]>

Restituisce

Promise<Publisher[]>

listSubscriptions(string, string, string, string)

Ottenere un elenco di sottoscrizioni.

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

Parametri

publisherId

string

ID per una sottoscrizione.

eventType

string

Tipo di evento da filtrare su (se presente).

consumerId

string

ID per un consumer.

consumerActionId

string

ID per un consumerActionId.

Restituisce

Promise<Subscription[]>

publishExternalEvent(string, string)

Pubblicare un evento esterno.

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

Parametri

publisherId

string

channelId

string

Restituisce

Promise<PublisherEvent[]>

queryInputValues(InputValuesQuery, string)

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

Parametri

inputValuesQuery

InputValuesQuery

publisherId

string

Restituisce

Promise<InputValuesQuery>

queryNotifications(NotificationsQuery)

Eseguire una query per le notifiche. Una notifica include i dettagli sull'evento, la richiesta a e la risposta dal servizio consumer.

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

Parametri

query

NotificationsQuery

Restituisce

Promise<NotificationsQuery>

queryPublishers(PublishersQuery)

Query per i server di pubblicazione di service hook.

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

Parametri

query

PublishersQuery

Restituisce

Promise<PublishersQuery>

replaceSubscription(Subscription, string)

Aggiornare una sottoscrizione. <param name="subscriptionId">ID per una sottoscrizione da aggiornare.< /Param>

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

Parametri

subscription

Subscription

subscriptionId

string

Restituisce

Promise<Subscription>

updateSubscriptionDiagnostics(UpdateSubscripitonDiagnosticsParameters, string)

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

Parametri

updateParameters

UpdateSubscripitonDiagnosticsParameters

subscriptionId

string

Restituisce

Promise<SubscriptionDiagnostics>