IWidget interface

Paket:

azure-devops-extension-api

Alla widgetar implementerar det här gränssnittet

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 ljusboxat läge
listen	Lyssna på meddelande från värden
load	Widgetar använder de angivna inställningarna samt anrop på serversidan för att slutföra renderingsupplevelsen. I framtiden förväntas widgetar ge en inläsningsupplevelse medan samtalen väntar på att slutföras. Fram till dess kommer widgetvärden att tillhandahålla inläsningsupplevelsen
onDashboardLoaded	Widgetar hanterar alla åtgärder som inte är nödvändiga för den första inläsningen men som krävs för den fullständiga widgetupplevelsen.
preload	Widgets använder de inställningar som tillhandahålls tillsammans med eventuella cachade data som de kan ha för att måla ett interaktivt tillstånd. Inga nätverksanrop ska göras av widgeten.

Egenskapsinformation

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>

lightbox

Kör widget i ljusboxat läge

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

Egenskapsvärde

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

listen

Lyssna på meddelande från värden

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

Egenskapsvärde

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

load

Widgetar använder de angivna inställningarna samt anrop på serversidan för att slutföra renderingsupplevelsen. I framtiden förväntas widgetar ge en inläsningsupplevelse medan samtalen väntar på att slutföras. Fram till dess kommer widgetvärden att tillhandahålla inläsningsupplevelsen

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

Egenskapsvärde

(widgetSettings: WidgetSettings) => Promise<WidgetStatus>

onDashboardLoaded

Widgetar hanterar alla åtgärder som inte är nödvändiga för den första inläsningen men som krävs för den fullständiga widgetupplevelsen.

onDashboardLoaded?: () => void

Egenskapsvärde

() => void

preload

Widgets använder de inställningar som tillhandahålls tillsammans med eventuella cachade data som de kan ha 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>