IWidget interface

Paket:

azure-devops-extension-api

Alle Widgets implementieren diese Schnittstelle

Eigenschaften

disableWidgetForStakeholders	Das Framework ruft diese Methode auf, um zu bestimmen, ob das Widget für Benutzer mit Der stakeholder-Lizenz deaktiviert werden soll.
lightbox	Ausführen des Widgets im Lightboxmodus
listen	Lauschen auf Nachrichten vom Host
load	Widgets verwenden die bereitgestellten Einstellungen sowie serverseitige Aufrufe, um ihr Rendering zu vervollständigen. In Zukunft wird erwartet, dass Widgets ein Ladeerlebnis bieten, während auf den Abschluss der Aufrufe gewartet wird. Bis dahin stellt der Widgethost die Ladeerfahrung bereit.
onDashboardLoaded	Widgets verwalten alle Vorgänge, die für das anfängliche Laden nicht erforderlich sind, aber für die vollständige Widgeterfahrung erforderlich sind.
preload	Widgets verwenden die bereitgestellten Einstellungen zusammen mit den zwischengespeicherten Daten, die sie möglicherweise haben, um einen interaktiven Zustand zu zeichnen. Das Widget darf keine Netzwerkaufrufe tätigen.

Details zur Eigenschaft

disableWidgetForStakeholders

Das Framework ruft diese Methode auf, um zu bestimmen, ob das Widget für Benutzer mit Der stakeholder-Lizenz deaktiviert werden soll.

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

Eigenschaftswert

(widgetSettings: WidgetSettings) => Promise<boolean>

lightbox

Ausführen des Widgets im Lightboxmodus

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

Eigenschaftswert

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

listen

Lauschen auf Nachrichten vom Host

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

Eigenschaftswert

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

load

Widgets verwenden die bereitgestellten Einstellungen sowie serverseitige Aufrufe, um ihr Rendering zu vervollständigen. In Zukunft wird erwartet, dass Widgets ein Ladeerlebnis bieten, während auf den Abschluss der Aufrufe gewartet wird. Bis dahin stellt der Widgethost die Ladeerfahrung bereit.

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

Eigenschaftswert

(widgetSettings: WidgetSettings) => Promise<WidgetStatus>

onDashboardLoaded

Widgets verwalten alle Vorgänge, die für das anfängliche Laden nicht erforderlich sind, aber für die vollständige Widgeterfahrung erforderlich sind.

onDashboardLoaded?: () => void

Eigenschaftswert

() => void

preload

Widgets verwenden die bereitgestellten Einstellungen zusammen mit den zwischengespeicherten Daten, die sie möglicherweise haben, um einen interaktiven Zustand zu zeichnen. Das Widget darf keine Netzwerkaufrufe tätigen.

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

Eigenschaftswert

(widgetSettings: WidgetSettings) => Promise<WidgetStatus>