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à lightbox
listen	Ascolta il messaggio dall'host
load	I widget utilizzano 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 ad allora, l'host del widget fornirà l'esperienza di caricamento
onDashboardLoaded	I widget gestiscono tutte le operazioni che non sono necessarie per il caricamento iniziale, ma che sono necessarie per l'esperienza completa del widget.
preload	I widget utilizzano le impostazioni fornite insieme a tutti i dati memorizzati nella cache che potrebbero avere per dipingere 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à lightbox

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

Valore della proprietà

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

listen

Ascolta il messaggio dall'host

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

Valore della proprietà

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

load

I widget utilizzano 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 ad 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 caricamento iniziale, ma che sono necessarie per l'esperienza completa del widget.

onDashboardLoaded?: () => void

Valore della proprietà

() => void

preload

I widget utilizzano le impostazioni fornite insieme a tutti i dati memorizzati nella cache che potrebbero avere per dipingere uno stato interattivo. Nessuna chiamata di rete deve essere effettuata dal widget.

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

Valore della proprietà

(widgetSettings: WidgetSettings) => Promise<WidgetStatus>