IWidget interface

Pakket:

azure-devops-extension-api

Alle widgets implementeren deze interface

Eigenschappen

disableWidgetForStakeholders	Het framework roept deze methode aan om te bepalen of de widget moet worden uitgeschakeld voor gebruikers met een licentie voor belanghebbenden
lightbox	Widget uitvoeren in lightboxed-modus
listen	Luisteren naar bericht van host
load	Widgets gebruiken de opgegeven instellingen en aanroepen aan de serverzijde om hun weergave-ervaring te voltooien. In de toekomst wordt verwacht dat widgets een laadervaring bieden terwijl de aanroepen worden gewacht om te worden voltooid. Tot die tijd biedt de widgethost de laadervaring
onDashboardLoaded	Widgets beheren bewerkingen die niet nodig zijn voor de eerste keer laden, maar wel vereist zijn voor de volledige widgetervaring.
preload	widgets gebruiken de instellingen die worden geleverd samen met de gegevens in de cache die ze mogelijk hebben om een interactieve status te schetsen. Er mogen geen netwerkoproepen worden gedaan door de widget.

Eigenschapdetails

disableWidgetForStakeholders

Het framework roept deze methode aan om te bepalen of de widget moet worden uitgeschakeld voor gebruikers met een licentie voor belanghebbenden

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

Waarde van eigenschap

(widgetSettings: WidgetSettings) => Promise<boolean>

lightbox

Widget uitvoeren in lightboxed-modus

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

Waarde van eigenschap

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

listen

Luisteren naar bericht van host

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

Waarde van eigenschap

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

load

Widgets gebruiken de opgegeven instellingen en aanroepen aan de serverzijde om hun weergave-ervaring te voltooien. In de toekomst wordt verwacht dat widgets een laadervaring bieden terwijl de aanroepen worden gewacht om te worden voltooid. Tot die tijd biedt de widgethost de laadervaring

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

Waarde van eigenschap

(widgetSettings: WidgetSettings) => Promise<WidgetStatus>

onDashboardLoaded

Widgets beheren bewerkingen die niet nodig zijn voor de eerste keer laden, maar wel vereist zijn voor de volledige widgetervaring.

onDashboardLoaded?: () => void

Waarde van eigenschap

() => void

preload

widgets gebruiken de instellingen die worden geleverd samen met de gegevens in de cache die ze mogelijk hebben om een interactieve status te schetsen. Er mogen geen netwerkoproepen worden gedaan door de widget.

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

Waarde van eigenschap

(widgetSettings: WidgetSettings) => Promise<WidgetStatus>