IConfigurableWidget interface

Pacchetto:

azure-devops-extension-api

I widget configurabili implementano questa interfaccia

Extends

IWidget

Proprietà

reload

Quando la visualizzazione di configurazione viene modificata, il widget dovrebbe aggiornarne la visualizzazione.

Proprietà ereditate

disableWidgetForStakeholders	Il framework chiama questo metodo per determinare se il widget deve essere disabilitato per gli utenti con licenza stakeholder
lightbox	Eseguire il widget in modalità lightboxed
listen	Ascoltare il messaggio dall'host
load	I widget usano le impostazioni fornite e le chiamate lato server per completare l'esperienza di rendering. In futuro, si prevede che i widget forniscano un'esperienza di caricamento mentre le chiamate sono in attesa di essere completate. Fino a allora, l'host del widget fornirà l'esperienza di caricamento
onDashboardLoaded	I widget gestiscono tutte le operazioni non necessarie per il caricamento iniziale, ma sono necessarie per l'esperienza completa del widget.
preload	I widget usano le impostazioni fornite insieme ai dati memorizzati nella cache che potrebbero dover disegnare uno stato interattivo. Nessuna chiamata di rete deve essere effettuata dal widget.

Dettagli proprietà

reload

Quando la visualizzazione di configurazione viene modificata, il widget dovrebbe aggiornarne la visualizzazione.

reload: (newWidgetSettings: WidgetSettings) => Promise<WidgetStatus>

Valore della proprietà

(newWidgetSettings: WidgetSettings) => Promise<WidgetStatus>

Dettagli proprietà ereditate

disableWidgetForStakeholders

Il framework chiama questo metodo per determinare se il widget deve essere disabilitato per gli utenti con licenza stakeholder

disableWidgetForStakeholders?: (widgetSettings: WidgetSettings) => Promise<boolean>

Valore della proprietà

(widgetSettings: WidgetSettings) => Promise<boolean>

Ereditato daIWidget.disableWidgetForStakeholders

lightbox

Eseguire il widget in modalità lightboxed

lightbox?: (widgetSettings: WidgetSettings, lightboxSize: Size) => Promise<WidgetStatus>

Valore della proprietà

(widgetSettings: WidgetSettings, lightboxSize: Size) => Promise<WidgetStatus>

ereditato daIWidget.lightbox

listen

Ascoltare il messaggio dall'host

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

Valore della proprietà

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

ereditato daIWidget.listen

load

I widget usano le impostazioni fornite e le chiamate lato server per completare l'esperienza di rendering. In futuro, si prevede che i widget forniscano un'esperienza di caricamento mentre le chiamate sono in attesa di essere completate. Fino a allora, l'host del widget fornirà l'esperienza di caricamento

load: (widgetSettings: WidgetSettings) => Promise<WidgetStatus>

Valore della proprietà

(widgetSettings: WidgetSettings) => Promise<WidgetStatus>

ereditato da IWidget.load

onDashboardLoaded

I widget gestiscono tutte le operazioni non necessarie per il caricamento iniziale, ma sono necessarie per l'esperienza completa del widget.

onDashboardLoaded?: () => void

Valore della proprietà

() => void

ereditato daIWidget.onDashboardLoaded

preload

I widget usano le impostazioni fornite insieme ai dati memorizzati nella cache che potrebbero dover disegnare uno stato interattivo. Nessuna chiamata di rete deve essere effettuata dal widget.

preload: (widgetSettings: WidgetSettings) => Promise<WidgetStatus>

Valore della proprietà

(widgetSettings: WidgetSettings) => Promise<WidgetStatus>

ereditato daIWidget.preload