IWidget interface

Csomag:

azure-devops-extension-api

Minden widget implementálja ezt a felületet

Tulajdonságok

disableWidgetForStakeholders	A keretrendszer meghívja ezt a metódust annak megállapításához, hogy le kell-e tiltani a widgetet az érintett licenccel rendelkező felhasználók számára
lightbox	Widget futtatása világosdobozos módban
listen	A gazdagép üzenetének meghallgatása
load	A widgetek a megadott beállításokat és kiszolgálóoldali hívásokat használják a renderelési élményük befejezéséhez. A jövőben a widgetek betöltési élményt fognak nyújtani, miközben a hívások befejeződnek. Addig a widget-gazdagép biztosítja a betöltési élményt
onDashboardLoaded	A widgetek kezelik azokat a műveleteket, amelyek nem szükségesek a kezdeti betöltéshez, de a widget teljes működéséhez szükségesek.
preload	A widgetek a megadott beállításokat használják a gyorsítótárazott adatokkal együtt, amelyeknek interaktív állapotot kell festeniük. A widgetnek nem szabad hálózati hívásokat kezdeményeznie.

Tulajdonság adatai

disableWidgetForStakeholders

A keretrendszer meghívja ezt a metódust annak megállapításához, hogy le kell-e tiltani a widgetet az érintett licenccel rendelkező felhasználók számára

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

Tulajdonság értéke

(widgetSettings: WidgetSettings) => Promise<boolean>

lightbox

Widget futtatása világosdobozos módban

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

Tulajdonság értéke

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

listen

A gazdagép üzenetének meghallgatása

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

Tulajdonság értéke

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

load

A widgetek a megadott beállításokat és kiszolgálóoldali hívásokat használják a renderelési élményük befejezéséhez. A jövőben a widgetek betöltési élményt fognak nyújtani, miközben a hívások befejeződnek. Addig a widget-gazdagép biztosítja a betöltési élményt

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

Tulajdonság értéke

(widgetSettings: WidgetSettings) => Promise<WidgetStatus>

onDashboardLoaded

A widgetek kezelik azokat a műveleteket, amelyek nem szükségesek a kezdeti betöltéshez, de a widget teljes működéséhez szükségesek.

onDashboardLoaded?: () => void

Tulajdonság értéke

() => void

preload

A widgetek a megadott beállításokat használják a gyorsítótárazott adatokkal együtt, amelyeknek interaktív állapotot kell festeniük. A widgetnek nem szabad hálózati hívásokat kezdeményeznie.

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

Tulajdonság értéke

(widgetSettings: WidgetSettings) => Promise<WidgetStatus>