ConfigurationEvent class

Pacchetto:

azure-devops-extension-api

Proprietà

ConfigurationChange	La configurazione è stata modificata. Quando questo evento riceve una notifica, l'anteprima viene aggiornata e il pulsante Salva è abilitato. Payload previsto durante la notifica di questo evento: { data: customSettings } {customSettings} è l'impostazione di configurazione personalizzata serializzata relativa al widget.
ConfigurationError	La configurazione tenta di eseguire chiamate API e non riesce. Quando questo evento riceve una notifica, la configurazione non esegue il rendering di una visualizzazione e viene passato un messaggio di errore all'host di configurazione. Payload previsto durante la notifica dell'evento: { data: string } {string} è il messaggio di errore visualizzato nella parte superiore della configurazione.
GeneralSettingsChanged	Le impostazioni generali di configurazione dei widget sono state modificate. Quando questo evento riceve una notifica, il nome del widget o le dimensioni del widget vengono aggiornate. Payload previsto durante la notifica di questo evento: { data: { IGeneralSettings } } {generalSettings} è l'oggetto serializzato contenente WidgetName e WidgetSize

Metodi

Args<T>(T)

Dettagli proprietà

ConfigurationChange

La configurazione è stata modificata. Quando questo evento riceve una notifica, l'anteprima viene aggiornata e il pulsante Salva è abilitato.

Payload previsto durante la notifica di questo evento: { data: customSettings }

{customSettings} è l'impostazione di configurazione personalizzata serializzata relativa al widget.

static ConfigurationChange: string

Valore della proprietà

string

ConfigurationError

La configurazione tenta di eseguire chiamate API e non riesce. Quando questo evento riceve una notifica, la configurazione non esegue il rendering di una visualizzazione e viene passato un messaggio di errore all'host di configurazione.

Payload previsto durante la notifica dell'evento: { data: string }

{string} è il messaggio di errore visualizzato nella parte superiore della configurazione.

static ConfigurationError: string

Valore della proprietà

string

GeneralSettingsChanged

Le impostazioni generali di configurazione dei widget sono state modificate. Quando questo evento riceve una notifica, il nome del widget o le dimensioni del widget vengono aggiornate.

Payload previsto durante la notifica di questo evento: { data: { IGeneralSettings } }

{generalSettings} è l'oggetto serializzato contenente WidgetName e WidgetSize

static GeneralSettingsChanged: string

Valore della proprietà

string

Dettagli metodo

Args<T>(T)

static function Args<T>(payload: T): EventArgs<T>

Parametri

payload

T

gli argomenti dell'evento passati quando si vuole inviare una notifica alla configurazione.

Restituisce

EventArgs<T>