NotificationRestClient 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

NotificationRestClient(IVssRestClientOptions)

Metodi

createSubscription(NotificationSubscriptionCreateParameters)	Creare una nuova sottoscrizione.
deleteSubscription(string)	Eliminazione di una sottoscrizione.
getEventType(string)	Ottiene un tipo di evento specifico.
getNotificationReasons(number)
getSettings()
getSubscriber(string)	Ottiene le preferenze di recapito di un sottoscrittore di notifiche.
getSubscription(string, SubscriptionQueryFlags)	Ottenere una sottoscrizione di notifica in base al relativo ID.
getSubscriptionDiagnostics(string)	Ottenere le impostazioni di diagnostica per una sottoscrizione.
getSubscriptionTemplates()	Ottenere i modelli di sottoscrizione disponibili.
listEventTypes(string)	Elencare i tipi di evento disponibili per questo servizio. Facoltativamente, filtrare in base solo ai tipi di evento per il server di pubblicazione specificato.
listLogs(string, string, Date, Date)	Ottenere un elenco dei log di diagnostica per questo servizio.
listNotificationReasons(number)
listSubscriptions(string, string[], SubscriptionQueryFlags)	Ottenere un elenco di sottoscrizioni di notifica, in base agli ID sottoscrizione o a tutte le sottoscrizioni per un determinato utente o gruppo.
performBatchNotificationOperations(BatchNotificationOperation)
publishEvent(VssNotificationEvent)	Pubblicare un evento. Questa richiesta deve essere indirizzata al servizio "extmgmt".
publishTokenEvent(VssNotificationEvent)	Pubblicare un evento. Questa richiesta è solo per il servizio token perché si tratta di un solo servizio di distribuzione.
queryEventTypes(FieldValuesQuery, string)
querySubscriptions(SubscriptionQuery)	Query per le sottoscrizioni. Se corrisponde a una o più condizioni specificate, viene restituita una sottoscrizione.
transformEvent(EventTransformRequest)	Tranform a notification event.Tranform a notification event.
updateSettings(NotificationAdminSettingsUpdateParameters)
updateSubscriber(NotificationSubscriberUpdateParameters, string)	Aggiornare le preferenze di recapito di un sottoscrittore di notifiche.
updateSubscription(NotificationSubscriptionUpdateParameters, string)	Aggiornare una sottoscrizione esistente. A seconda del tipo di sottoscrizione e delle autorizzazioni, il chiamante può aggiornare la descrizione, le impostazioni di filtro, le impostazioni del canale (recapito) e altro ancora.
updateSubscriptionDiagnostics(UpdateSubscripitonDiagnosticsParameters, string)	Aggiornare le impostazioni di diagnostica per una sottoscrizione.
updateSubscriptionUserSettings(SubscriptionUserSettings, string, string)	Aggiornare le impostazioni dell'utente specificato per la sottoscrizione specificata. Questa API viene in genere usata per acconsentire esplicitamente o rifiutare esplicitamente una sottoscrizione condivisa. Le impostazioni utente possono essere applicate solo alle sottoscrizioni condivise, ad esempio le sottoscrizioni del team o le sottoscrizioni predefinite.

Dettagli costruttore

NotificationRestClient(IVssRestClientOptions)

new NotificationRestClient(options: IVssRestClientOptions)

Parametri

options

IVssRestClientOptions

Dettagli metodo

createSubscription(NotificationSubscriptionCreateParameters)

Creare una nuova sottoscrizione.

function createSubscription(createParameters: NotificationSubscriptionCreateParameters): Promise<NotificationSubscription>

Parametri

createParameters

NotificationSubscriptionCreateParameters

Restituisce

Promise<NotificationSubscription>

deleteSubscription(string)

Eliminazione di una sottoscrizione.

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

Parametri

subscriptionId

string

Restituisce

Promise<void>

getEventType(string)

Ottiene un tipo di evento specifico.

function getEventType(eventType: string): Promise<NotificationEventType>

Parametri

eventType

string

ID del tipo di evento.

Restituisce

Promise<NotificationEventType>

getNotificationReasons(number)

function getNotificationReasons(notificationId: number): Promise<NotificationReason>

Parametri

notificationId

number

Restituisce

Promise<NotificationReason>

getSettings()

function getSettings(): Promise<NotificationAdminSettings>

Restituisce

Promise<NotificationAdminSettings>

getSubscriber(string)

Ottiene le preferenze di recapito di un sottoscrittore di notifiche.

function getSubscriber(subscriberId: string): Promise<NotificationSubscriber>

Parametri

subscriberId

string

ID dell'utente o del gruppo.

Restituisce

Promise<NotificationSubscriber>

getSubscription(string, SubscriptionQueryFlags)

Ottenere una sottoscrizione di notifica in base al relativo ID.

function getSubscription(subscriptionId: string, queryFlags?: SubscriptionQueryFlags): Promise<NotificationSubscription>

Parametri

subscriptionId

string

queryFlags

SubscriptionQueryFlags

Restituisce

Promise<NotificationSubscription>

getSubscriptionDiagnostics(string)

Ottenere le impostazioni di diagnostica per una sottoscrizione.

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

Parametri

subscriptionId

string

ID della sottoscrizione delle notifiche.

Restituisce

Promise<SubscriptionDiagnostics>

getSubscriptionTemplates()

Ottenere i modelli di sottoscrizione disponibili.

function getSubscriptionTemplates(): Promise<NotificationSubscriptionTemplate[]>

Restituisce

Promise<NotificationSubscriptionTemplate[]>

listEventTypes(string)

Elencare i tipi di evento disponibili per questo servizio. Facoltativamente, filtrare in base solo ai tipi di evento per il server di pubblicazione specificato.

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

Parametri

publisherId

string

Limite ai tipi di evento per questo server di pubblicazione

Restituisce

Promise<NotificationEventType[]>

listLogs(string, string, Date, Date)

Ottenere un elenco dei log di diagnostica per questo servizio.

function listLogs(source: string, entryId?: string, startTime?: Date, endTime?: Date): Promise<INotificationDiagnosticLog[]>

Parametri

source

string

ID che specifica il tipo di log per cui verificare la diagnostica.

entryId

string

ID del log specifico per cui eseguire una query.

startTime

Date

Ora di inizio per l'intervallo di tempo in cui eseguire una query.

endTime

Date

Ora di fine per l'intervallo di tempo in cui eseguire la query.

Restituisce

Promise<INotificationDiagnosticLog[]>

listNotificationReasons(number)

function listNotificationReasons(notificationIds?: number): Promise<NotificationReason[]>

Parametri

notificationIds

number

Restituisce

Promise<NotificationReason[]>

listSubscriptions(string, string[], SubscriptionQueryFlags)

Ottenere un elenco di sottoscrizioni di notifica, in base agli ID sottoscrizione o a tutte le sottoscrizioni per un determinato utente o gruppo.

function listSubscriptions(targetId?: string, ids?: string[], queryFlags?: SubscriptionQueryFlags): Promise<NotificationSubscription[]>

Parametri

targetId

string

ID utente o gruppo

ids

string[]

Elenco di ID sottoscrizione

queryFlags

SubscriptionQueryFlags

Restituisce

Promise<NotificationSubscription[]>

performBatchNotificationOperations(BatchNotificationOperation)

function performBatchNotificationOperations(operation: BatchNotificationOperation): Promise<void>

Parametri

operation

BatchNotificationOperation

Restituisce

Promise<void>

publishEvent(VssNotificationEvent)

Pubblicare un evento. Questa richiesta deve essere indirizzata al servizio "extmgmt".

function publishEvent(notificationEvent: VssNotificationEvent): Promise<VssNotificationEvent>

Parametri

notificationEvent

VssNotificationEvent

Restituisce

Promise<VssNotificationEvent>

publishTokenEvent(VssNotificationEvent)

Pubblicare un evento. Questa richiesta è solo per il servizio token perché si tratta di un solo servizio di distribuzione.

function publishTokenEvent(notificationEvent: VssNotificationEvent): Promise<VssNotificationEvent>

Parametri

notificationEvent

VssNotificationEvent

Restituisce

Promise<VssNotificationEvent>

queryEventTypes(FieldValuesQuery, string)

function queryEventTypes(inputValuesQuery: FieldValuesQuery, eventType: string): Promise<NotificationEventField[]>

Parametri

inputValuesQuery

FieldValuesQuery

eventType

string

Restituisce

Promise<NotificationEventField[]>

querySubscriptions(SubscriptionQuery)

Query per le sottoscrizioni. Se corrisponde a una o più condizioni specificate, viene restituita una sottoscrizione.

function querySubscriptions(subscriptionQuery: SubscriptionQuery): Promise<NotificationSubscription[]>

Parametri

subscriptionQuery

SubscriptionQuery

Restituisce

Promise<NotificationSubscription[]>

transformEvent(EventTransformRequest)

Tranform a notification event.Tranform a notification event.

function transformEvent(transformRequest: EventTransformRequest): Promise<EventTransformResult>

Parametri

transformRequest

EventTransformRequest

Oggetto da trasformare.

Restituisce

Promise<EventTransformResult>

updateSettings(NotificationAdminSettingsUpdateParameters)

function updateSettings(updateParameters: NotificationAdminSettingsUpdateParameters): Promise<NotificationAdminSettings>

Parametri

updateParameters

NotificationAdminSettingsUpdateParameters

Restituisce

Promise<NotificationAdminSettings>

updateSubscriber(NotificationSubscriberUpdateParameters, string)

Aggiornare le preferenze di recapito di un sottoscrittore di notifiche.

function updateSubscriber(updateParameters: NotificationSubscriberUpdateParameters, subscriberId: string): Promise<NotificationSubscriber>

Parametri

updateParameters

NotificationSubscriberUpdateParameters

subscriberId

string

ID dell'utente o del gruppo.

Restituisce

Promise<NotificationSubscriber>

updateSubscription(NotificationSubscriptionUpdateParameters, string)

Aggiornare una sottoscrizione esistente. A seconda del tipo di sottoscrizione e delle autorizzazioni, il chiamante può aggiornare la descrizione, le impostazioni di filtro, le impostazioni del canale (recapito) e altro ancora.

function updateSubscription(updateParameters: NotificationSubscriptionUpdateParameters, subscriptionId: string): Promise<NotificationSubscription>

Parametri

updateParameters

NotificationSubscriptionUpdateParameters

subscriptionId

string

Restituisce

Promise<NotificationSubscription>

updateSubscriptionDiagnostics(UpdateSubscripitonDiagnosticsParameters, string)

Aggiornare le impostazioni di diagnostica per una sottoscrizione.

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

Parametri

updateParameters

UpdateSubscripitonDiagnosticsParameters

subscriptionId

string

ID della sottoscrizione delle notifiche.

Restituisce

Promise<SubscriptionDiagnostics>

updateSubscriptionUserSettings(SubscriptionUserSettings, string, string)

Aggiornare le impostazioni dell'utente specificato per la sottoscrizione specificata. Questa API viene in genere usata per acconsentire esplicitamente o rifiutare esplicitamente una sottoscrizione condivisa. Le impostazioni utente possono essere applicate solo alle sottoscrizioni condivise, ad esempio le sottoscrizioni del team o le sottoscrizioni predefinite.

function updateSubscriptionUserSettings(userSettings: SubscriptionUserSettings, subscriptionId: string, userId: string): Promise<SubscriptionUserSettings>

Parametri

userSettings

SubscriptionUserSettings

subscriptionId

string

userId

string

ID dell'utente

Restituisce

Promise<SubscriptionUserSettings>