IWidgetConfiguration interface

Pacchetto:

azure-devops-extension-api

Gli autori del widget implementano questa interfaccia per la configurazione.

Proprietà

listen	Ascoltare il messaggio dall'host
load	Chiamato dall'host per configurare la configurazione del widget, che usa le impostazioni condivise con il widget per completare l'esperienza di rendering.
onSave	Chiamato dall'host quando l'utente fa clic sul pulsante Salva. Se necessario, è previsto che l'autore del widget esegua le convalida. Se è possibile salvare, usare WidgetHelpers.WidgetConfigurationSave.Valid() per restituire le impostazioni personalizzate serializzate del widget dalla configurazione. Se le impostazioni personalizzate non sono valide e quindi non sono pronte per il salvataggio, usare WidgetHelpers.WidgetConfigurationSave.Invalid() per notificare all'host di arrestare il salvataggio.
onSaveComplete	(Facoltativo) Chiamato dall'host quando la configurazione è pronta per essere salvata (quando l'utente fa clic sul pulsante salva nel pannello di configurazione)

Dettagli proprietà

listen

Ascoltare il messaggio dall'host

listen?: (event: string, eventArgs: EventArgs<T>) => void

Valore della proprietà

(event: string, eventArgs: EventArgs<T>) => void

load

Chiamato dall'host per configurare la configurazione del widget, che usa le impostazioni condivise con il widget per completare l'esperienza di rendering.

load: (widgetSettings: WidgetSettings, widgetConfigurationContext: IWidgetConfigurationContext) => Promise<WidgetStatus>

Valore della proprietà

(widgetSettings: WidgetSettings, widgetConfigurationContext: IWidgetConfigurationContext) => Promise<WidgetStatus>

onSave

Chiamato dall'host quando l'utente fa clic sul pulsante Salva. Se necessario, è previsto che l'autore del widget esegua le convalida. Se è possibile salvare, usare WidgetHelpers.WidgetConfigurationSave.Valid() per restituire le impostazioni personalizzate serializzate del widget dalla configurazione. Se le impostazioni personalizzate non sono valide e quindi non sono pronte per il salvataggio, usare WidgetHelpers.WidgetConfigurationSave.Invalid() per notificare all'host di arrestare il salvataggio.

onSave: () => Promise<SaveStatus>

Valore della proprietà

() => Promise<SaveStatus>

onSaveComplete

(Facoltativo) Chiamato dall'host quando la configurazione è pronta per essere salvata (quando l'utente fa clic sul pulsante salva nel pannello di configurazione)

onSaveComplete?: () => void

Valore della proprietà

() => void