IConfigurableWidget interface

Pakket:

azure-devops-extension-api

Configureerbare widgets implementeren deze interface

Uitbreiding

IWidget

Eigenschappen

reload

Wanneer de configuratieweergave wordt gewijzigd, wordt verwacht dat de widget de weergave bijwerkt.

Overgenomen eigenschappen

disableWidgetForStakeholders	Dit 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 instellingen die zijn opgegeven en aanroepen aan de serverzijde om hun renderingervaring te voltooien. In de toekomst zullen widgets naar verwachting 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 belasting, maar zijn vereist voor de volledige widgetervaring.
preload	widgets maken gebruik van de instellingen die samen met de gegevens in de cache zijn opgegeven die ze mogelijk moeten gebruiken om een interactieve status te schilderen. Er mogen geen netwerkoproepen worden gedaan door de widget.

Eigenschapdetails

reload

Wanneer de configuratieweergave wordt gewijzigd, wordt verwacht dat de widget de weergave bijwerkt.

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

Waarde van eigenschap

(newWidgetSettings: WidgetSettings) => Promise<WidgetStatus>

Details van overgenomen eigenschap

disableWidgetForStakeholders

Dit 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>

overgenomen vanIWidget.disableWidgetForStakeholders

lightbox

Widget uitvoeren in lightboxed-modus

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

Waarde van eigenschap

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

overgenomen vanIWidget.lightbox-

listen

Luisteren naar bericht van host

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

Waarde van eigenschap

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

overgenomen vanIWidget.listen

load

Widgets gebruiken de instellingen die zijn opgegeven en aanroepen aan de serverzijde om hun renderingervaring te voltooien. In de toekomst zullen widgets naar verwachting 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>

overgenomen van IWidget.load

onDashboardLoaded

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

onDashboardLoaded?: () => void

Waarde van eigenschap

() => void

overgenomen vanIWidget.onDashboardLoaded

preload

widgets maken gebruik van de instellingen die samen met de gegevens in de cache zijn opgegeven die ze mogelijk moeten gebruiken om een interactieve status te schilderen. Er mogen geen netwerkoproepen worden gedaan door de widget.

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

Waarde van eigenschap

(widgetSettings: WidgetSettings) => Promise<WidgetStatus>

overgenomen vanIWidget.preload