IConfigurableWidget interface

Paket:

azure-devops-extension-api

Konfigurerbara widgetar implementerar det här gränssnittet

Extends

IWidget

Egenskaper

reload

När konfigurationsvyn ändras förväntas widgeten uppdatera vyn.

Ärvda egenskaper

disableWidgetForStakeholders	Ramverket anropar den här metoden för att avgöra om widgeten ska inaktiveras för användare med intressentlicens
lightbox	Kör widget i ljust läge
listen	Lyssna på meddelande från värden
load	Widgetar använder de inställningar som tillhandahålls samt anrop på serversidan för att slutföra återgivningen. I framtiden förväntas widgetar ge en inläsningsupplevelse medan anropen väntar på att slutföras. Tills dess kommer widgetvärden att tillhandahålla inläsningsupplevelsen
onDashboardLoaded	Widgetar hanterar alla åtgärder som inte behövs för den inledande inläsningen, men som krävs för den fullständiga widgetupplevelsen.
preload	widgetar använder de inställningar som tillhandahålls tillsammans med cachelagrade data som de kan behöva för att måla ett interaktivt tillstånd. Inga nätverksanrop ska göras av widgeten.

Egenskapsinformation

reload

När konfigurationsvyn ändras förväntas widgeten uppdatera vyn.

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

Egenskapsvärde

(newWidgetSettings: WidgetSettings) => Promise<WidgetStatus>

Information om ärvda egenskaper

disableWidgetForStakeholders

Ramverket anropar den här metoden för att avgöra om widgeten ska inaktiveras för användare med intressentlicens

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

Egenskapsvärde

(widgetSettings: WidgetSettings) => Promise<boolean>

ärvd frånIWidget.disableWidgetForStakeholders

lightbox

Kör widget i ljust läge

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

Egenskapsvärde

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

ärvd frånIWidget.lightbox

listen

Lyssna på meddelande från värden

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

Egenskapsvärde

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

ärvd frånIWidget.listen

load

Widgetar använder de inställningar som tillhandahålls samt anrop på serversidan för att slutföra återgivningen. I framtiden förväntas widgetar ge en inläsningsupplevelse medan anropen väntar på att slutföras. Tills dess kommer widgetvärden att tillhandahålla inläsningsupplevelsen

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

Egenskapsvärde

(widgetSettings: WidgetSettings) => Promise<WidgetStatus>

ärvd frånIWidget.load

onDashboardLoaded

Widgetar hanterar alla åtgärder som inte behövs för den inledande inläsningen, men som krävs för den fullständiga widgetupplevelsen.

onDashboardLoaded?: () => void

Egenskapsvärde

() => void

ärvd frånIWidget.onDashboardLoaded

preload

widgetar använder de inställningar som tillhandahålls tillsammans med cachelagrade data som de kan behöva för att måla ett interaktivt tillstånd. Inga nätverksanrop ska göras av widgeten.

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

Egenskapsvärde

(widgetSettings: WidgetSettings) => Promise<WidgetStatus>

ärvd frånIWidget.preload