NotificationRestClient class

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

Extends

Metodi

createSubscription(NotificationSubscriptionCreateParameters)

Creare una nuova sottoscrizione.

deleteSubscription(string)

Eliminare una sottoscrizione.

getEventType(string)

Ottiene un tipo di evento specifico.

getNotificationReasons(number)
getSettings()
getSubscriber(string)

Ottenere 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 di 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é è un servizio di sola distribuzione.

queryEventTypes(FieldValuesQuery, string)
querySubscriptions(SubscriptionQuery)

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

transformEvent(EventTransformRequest)

Eseguire la trascrizione di un evento di notifica.

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 sottoscrizioni team o sottoscrizioni predefinite.

Dettagli costruttore

NotificationRestClient(IVssRestClientOptions)

new NotificationRestClient(options: IVssRestClientOptions)

Parametri

Dettagli metodo

createSubscription(NotificationSubscriptionCreateParameters)

Creare una nuova sottoscrizione.

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

Parametri

Valori restituiti

deleteSubscription(string)

Eliminare una sottoscrizione.

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

Parametri

subscriptionId

string

Valori restituiti

Promise<void>

getEventType(string)

Ottiene un tipo di evento specifico.

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

Parametri

eventType

string

ID del tipo di evento.

Valori restituiti

getNotificationReasons(number)

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

Parametri

notificationId

number

Valori restituiti

getSettings()

function getSettings(): Promise<NotificationAdminSettings>

Valori restituiti

getSubscriber(string)

Ottenere le preferenze di recapito di un sottoscrittore di notifiche.

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

Parametri

subscriberId

string

ID dell'utente o del gruppo.

Valori restituiti

getSubscription(string, SubscriptionQueryFlags)

Ottenere una sottoscrizione di notifica in base al relativo ID.

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

Parametri

subscriptionId

string

Valori restituiti

getSubscriptionDiagnostics(string)

Ottenere le impostazioni di diagnostica per una sottoscrizione.

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

Parametri

subscriptionId

string

ID della sottoscrizione delle notifiche.

Valori restituiti

getSubscriptionTemplates()

Ottenere i modelli di sottoscrizione disponibili.

function getSubscriptionTemplates(): Promise<NotificationSubscriptionTemplate[]>

Valori restituiti

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

Valori restituiti

listLogs(string, string, Date, Date)

Ottenere un elenco di 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 una query.

Valori restituiti

listNotificationReasons(number)

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

Parametri

notificationIds

number

Valori restituiti

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

Valori restituiti

performBatchNotificationOperations(BatchNotificationOperation)

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

Parametri

Valori restituiti

Promise<void>

publishEvent(VssNotificationEvent)

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

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

Parametri

notificationEvent
VssNotificationEvent

Valori restituiti

publishTokenEvent(VssNotificationEvent)

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

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

Parametri

notificationEvent
VssNotificationEvent

Valori restituiti

queryEventTypes(FieldValuesQuery, string)

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

Parametri

inputValuesQuery
FieldValuesQuery
eventType

string

Valori restituiti

querySubscriptions(SubscriptionQuery)

Eseguire una 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

Valori restituiti

transformEvent(EventTransformRequest)

Eseguire la trascrizione di un evento di notifica.

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

Parametri

transformRequest
EventTransformRequest

Oggetto da trasformare.

Valori restituiti

updateSettings(NotificationAdminSettingsUpdateParameters)

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

Parametri

Valori restituiti

updateSubscriber(NotificationSubscriberUpdateParameters, string)

Aggiornare le preferenze di recapito di un sottoscrittore di notifiche.

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

Parametri

subscriberId

string

ID dell'utente o del gruppo.

Valori restituiti

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

subscriptionId

string

Valori restituiti

updateSubscriptionDiagnostics(UpdateSubscripitonDiagnosticsParameters, string)

Aggiornare le impostazioni di diagnostica per una sottoscrizione.

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

Parametri

subscriptionId

string

ID della sottoscrizione delle notifiche.

Valori restituiti

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 sottoscrizioni team o sottoscrizioni predefinite.

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

Parametri

subscriptionId

string

userId

string

ID dell'utente

Valori restituiti