IWidget interface

Pacchetto:

azure-devops-extension-api

Tutti i widget implementano questa interfaccia

Proprietà

disableWidgetForStakeholders	Il framework chiama questo metodo per determinare se il widget deve essere disabilitato per gli utenti con licenza degli stakeholder
lightbox	Esegui 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, i widget devono fornire 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 che non sono necessarie per il carico 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à

disableWidgetForStakeholders

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

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

Valore della proprietà

(widgetSettings: WidgetSettings) => Promise<boolean>

lightbox

Esegui widget in modalità lightboxed

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

Valore della proprietà

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

listen

Ascoltare il messaggio dall'host

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

Valore della proprietà

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

load

I widget usano le impostazioni fornite e le chiamate lato server per completare l'esperienza di rendering. In futuro, i widget devono fornire 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>

onDashboardLoaded

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

onDashboardLoaded?: () => void

Valore della proprietà

() => void

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>