ServiceHooksRestClient class

Pacchetto:

azure-devops-extension-api

Classe di base da usare (derivata da) per effettuare richieste alle API REST vss

Extends

RestClientBase

Costruttori

ServiceHooksRestClient(IVssRestClientOptions)

Metodi

createSubscription(Subscription)	Creare una sottoscrizione.
createSubscriptionsQuery(SubscriptionsQuery)	Query per le sottoscrizioni hook del servizio.
createTestNotification(Notification, boolean)	Invia una notifica di prova. Ciò è utile per verificare la configurazione di una sottoscrizione di hook di servizio aggiornata o nuova.
deleteSubscription(string)	Eliminare una sottoscrizione di hook del servizio specifica.
getConsumer(string, string)	Ottieni un servizio clienti specifico. Facoltativamente, filtrare le azioni consumer che non supportano alcun tipo di evento per l'editore specificato.
getConsumerAction(string, string, string)	Ottieni dettagli su un'azione specifica del consumatore.
getEventType(string, string)	Ottiene un tipo di evento specifico.
getNotification(string, number)	Ricevi una notifica specifica per un abbonamento.
getNotifications(string, number, NotificationStatus, NotificationResult)	Ricevi un elenco di notifiche per un abbonamento specifico. Una notifica include dettagli sull'evento, la richiesta e la risposta del servizio clienti.
getPublisher(string)	Ottieni un editore di hook di servizio specifico.
getSubscription(string)	Ottenere una sottoscrizione di hook del servizio specifica.
getSubscriptionDiagnostics(string)
listConsumerActions(string, string)	Ottieni un elenco di azioni dei consumatori per un consumatore specifico.
listConsumers(string)	Ottieni un elenco dei servizi disponibili per i consumatori. Facoltativamente, filtrare in base ai consumer che supportano almeno un tipo di evento dell'editore specifico.
listEventTypes(string)	Ottieni i tipi di evento per un editore specifico.
listPublishers()	Ottieni 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)	Query per le notifiche. Una notifica include dettagli sull'evento, la richiesta e la risposta del servizio clienti.
queryPublishers(PublishersQuery)	Query per i server di pubblicazione dell'hook del servizio.
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)

Creare una sottoscrizione.

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

Parametri

subscription

Subscription

Sottoscrizione da creare.

Restituisce

Promise<Subscription>

createSubscriptionsQuery(SubscriptionsQuery)

Query per le sottoscrizioni hook del servizio.

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

Parametri

query

SubscriptionsQuery

Restituisce

Promise<SubscriptionsQuery>

createTestNotification(Notification, boolean)

Invia una notifica di prova. Ciò è utile per verificare la configurazione di una sottoscrizione di hook di servizio aggiornata o nuova.

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

Parametri

testNotification

Notification

useRealData

boolean

Consentire il test solo con dati reali nelle sottoscrizioni esistenti.

Restituisce

Promise<Notification>

deleteSubscription(string)

Eliminare una sottoscrizione di hook del servizio specifica.

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

Parametri

subscriptionId

string

ID di una sottoscrizione.

Restituisce

Promise<void>

getConsumer(string, string)

Ottieni un servizio clienti specifico. Facoltativamente, filtrare le azioni consumer che non supportano alcun tipo di evento per l'editore specificato.

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

Parametri

consumerId

string

ID per un consumatore.

publisherId

string

Restituisce

Promise<Consumer>

getConsumerAction(string, string, string)

Ottieni dettagli su un'azione specifica del consumatore.

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

Parametri

consumerId

string

ID per un consumatore.

consumerActionId

string

ID per un consumerActionId.

publisherId

string

Restituisce

Promise<ConsumerAction>

getEventType(string, string)

Ottiene un tipo di evento specifico.

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

Parametri

publisherId

string

ID di un editore.

eventTypeId

string

Restituisce

Promise<EventTypeDescriptor>

getNotification(string, number)

Ricevi una notifica specifica per un abbonamento.

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

Parametri

subscriptionId

string

ID di una sottoscrizione.

notificationId

number

Restituisce

Promise<Notification>

getNotifications(string, number, NotificationStatus, NotificationResult)

Ricevi un elenco di notifiche per un abbonamento specifico. Una notifica include dettagli sull'evento, la richiesta e la risposta del servizio clienti.

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

Parametri

subscriptionId

string

ID di una sottoscrizione.

maxResults

number

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

status

NotificationStatus

Ricevi solo le notifiche con questo stato.

result

NotificationResult

Ricevi solo notifiche con questo tipo di risultato.

Restituisce

Promise<Notification[]>

getPublisher(string)

Ottieni un editore di hook di servizio specifico.

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

Parametri

publisherId

string

ID di un editore.

Restituisce

Promise<Publisher>

getSubscription(string)

Ottenere una sottoscrizione di hook del servizio specifica.

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

Parametri

subscriptionId

string

ID di una sottoscrizione.

Restituisce

Promise<Subscription>

getSubscriptionDiagnostics(string)

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

Parametri

subscriptionId

string

Restituisce

Promise<SubscriptionDiagnostics>

listConsumerActions(string, string)

Ottieni un elenco di azioni dei consumatori per un consumatore specifico.

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

Parametri

consumerId

string

ID per un consumatore.

publisherId

string

Restituisce

Promise<ConsumerAction[]>

listConsumers(string)

Ottieni un elenco dei servizi disponibili per i consumatori. Facoltativamente, filtrare in base ai consumer che supportano almeno un tipo di evento dell'editore specifico.

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

Parametri

publisherId

string

Restituisce

Promise<Consumer[]>

listEventTypes(string)

Ottieni i tipi di evento per un editore specifico.

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

Parametri

publisherId

string

ID di un editore.

Restituisce

Promise<EventTypeDescriptor[]>

listPublishers()

Ottieni 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 di una sottoscrizione.

eventType

string

Il tipo di evento in base al quale filtrare (se presente).

consumerId

string

ID per un consumatore.

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)

Query per le notifiche. Una notifica include dettagli sull'evento, la richiesta e la risposta del servizio clienti.

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

Parametri

query

NotificationsQuery

Restituisce

Promise<NotificationsQuery>

queryPublishers(PublishersQuery)

Query per i server di pubblicazione dell'hook del servizio.

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>