IWidget interface

Paket:

azure-devops-extension-api

Alle Widgets implementieren diese Schnittstelle

Eigenschaften

disableWidgetForStakeholders	Das Framework ruft diese Methode auf, um festzustellen, ob das Widget für Benutzer mit Stakeholder-Lizenz deaktiviert werden soll.
lightbox	Widget im Lightbox-Modus ausführen
listen	Nachricht vom Host abhören
load	Widgets verwenden die bereitgestellten Einstellungen sowie serverseitige Aufrufe, um die Renderingerfahrung abzuschließen. In Zukunft wird erwartet, dass Widgets eine Ladeerfahrung bieten, während die Aufrufe auf den Abschluss gewartet werden. Bis dahin stellt der Widgethost die Ladeerfahrung bereit.
onDashboardLoaded	Widgets verwalten alle Vorgänge, die für die anfängliche Auslastung nicht erforderlich sind, aber für die vollständige Widget-Erfahrung erforderlich sind.
preload	Widgets verwenden die bereitgestellten Einstellungen zusammen mit den zwischengespeicherten Daten, die sie möglicherweise zum Zeichnen eines interaktiven Zustands haben. Vom Widget sollten keine Netzwerkanrufe getätigt werden.

Details zur Eigenschaft

disableWidgetForStakeholders

Das Framework ruft diese Methode auf, um festzustellen, ob das Widget für Benutzer mit Stakeholder-Lizenz deaktiviert werden soll.

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

Eigenschaftswert

(widgetSettings: WidgetSettings) => Promise<boolean>

lightbox

Widget im Lightbox-Modus ausführen

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

Eigenschaftswert

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

listen

Nachricht vom Host abhören

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

Eigenschaftswert

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

load

Widgets verwenden die bereitgestellten Einstellungen sowie serverseitige Aufrufe, um die Renderingerfahrung abzuschließen. In Zukunft wird erwartet, dass Widgets eine Ladeerfahrung bieten, während die Aufrufe auf den Abschluss gewartet werden. 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 die anfängliche Auslastung nicht erforderlich sind, aber für die vollständige Widget-Erfahrung erforderlich sind.

onDashboardLoaded?: () => void

Eigenschaftswert

() => void

preload

Widgets verwenden die bereitgestellten Einstellungen zusammen mit den zwischengespeicherten Daten, die sie möglicherweise zum Zeichnen eines interaktiven Zustands haben. Vom Widget sollten keine Netzwerkanrufe getätigt werden.

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

Eigenschaftswert

(widgetSettings: WidgetSettings) => Promise<WidgetStatus>