IWidget interface

Balíček:

azure-devops-extension-api

Toto rozhraní implementují všechny widgety.

Vlastnosti

disableWidgetForStakeholders	Architektura volá tuto metodu, aby určila, jestli má být widget zakázán pro uživatele s licencí účastníka.
lightbox	Spuštění widgetu v režimu lightboxed
listen	Naslouchání zprávě z hostitele
load	Widgety používají k dokončení vykreslování nastavení poskytnutá i volání na straně serveru. V budoucnu se očekává, že widgety budou poskytovat prostředí načítání, zatímco se čekají na dokončení volání. Do té doby bude hostitel widgetu poskytovat prostředí načítání.
onDashboardLoaded	Widgety spravují všechny operace, které nejsou nezbytné pro počáteční načtení, ale vyžadují se pro úplné prostředí widgetu.
preload	widgety používají nastavení, která jsou k dispozici spolu s daty uloženými v mezipaměti, které mohou muset nakreslit interaktivní stav. Widget by neměl provádět žádná síťová volání.

Podrobnosti vlastnosti

disableWidgetForStakeholders

Architektura volá tuto metodu, aby určila, jestli má být widget zakázán pro uživatele s licencí účastníka.

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

Hodnota vlastnosti

(widgetSettings: WidgetSettings) => Promise<boolean>

lightbox

Spuštění widgetu v režimu lightboxed

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

Hodnota vlastnosti

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

listen

Naslouchání zprávě z hostitele

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

Hodnota vlastnosti

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

load

Widgety používají k dokončení vykreslování nastavení poskytnutá i volání na straně serveru. V budoucnu se očekává, že widgety budou poskytovat prostředí načítání, zatímco se čekají na dokončení volání. Do té doby bude hostitel widgetu poskytovat prostředí načítání.

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

Hodnota vlastnosti

(widgetSettings: WidgetSettings) => Promise<WidgetStatus>

onDashboardLoaded

Widgety spravují všechny operace, které nejsou nezbytné pro počáteční načtení, ale vyžadují se pro úplné prostředí widgetu.

onDashboardLoaded?: () => void

Hodnota vlastnosti

() => void

preload

widgety používají nastavení, která jsou k dispozici spolu s daty uloženými v mezipaměti, které mohou muset nakreslit interaktivní stav. Widget by neměl provádět žádná síťová volání.

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

Hodnota vlastnosti

(widgetSettings: WidgetSettings) => Promise<WidgetStatus>