IConfigurableWidget interface

Paket:

azure-devops-extension-api

Konfigurierbare Widgets implementieren diese Schnittstelle

Extends

IWidget

Eigenschaften

reload

Wenn die Konfigurationsansicht geändert wird, wird erwartet, dass das Widget seine Ansicht aktualisiert.

Geerbte 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

reload

Wenn die Konfigurationsansicht geändert wird, wird erwartet, dass das Widget seine Ansicht aktualisiert.

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

Eigenschaftswert

(newWidgetSettings: WidgetSettings) => Promise<WidgetStatus>

Geerbte Eigenschaftsdetails

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>

Geerbt vonIWidget.disableWidgetForStakeholders

lightbox

Ausführen des Widgets im Lightboxmodus

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

Eigenschaftswert

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

Geerbt vonIWidget.lightbox

listen

Lauschen auf Nachrichten vom Host

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

Eigenschaftswert

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

Geerbt vonIWidget.listen

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>

Geerbt vonIWidget.load

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

Geerbt vonIWidget.onDashboardLoaded

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>

Geerbt vonIWidget.preload