IWidget interface

Balíček:

azure-devops-extension-api

Toto rozhraní implementují všechny widgety.

Vlastnosti

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

Podrobnosti vlastnosti

disableWidgetForStakeholders

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

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

Hodnota vlastnosti

(widgetSettings: WidgetSettings) => Promise<boolean>

lightbox

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

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

Hodnota vlastnosti

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

listen

Poslech zprávy od 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í poskytnutá nastavení a volání na straně serveru. V budoucnu se očekává, že widgety budou poskytovat prostředí pro načítání, zatímco se čekají na dokončení volání. Do té doby bude hostitel widgetu poskytovat prostředí pro načítání.

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

Hodnota vlastnosti

(widgetSettings: WidgetSettings) => Promise<WidgetStatus>

onDashboardLoaded

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

onDashboardLoaded?: () => void

Hodnota vlastnosti

() => void

preload

Widgety používají k vykreslení interaktivního stavu poskytnutá nastavení spolu s daty uloženými v mezipaměti. Widget by neměl provádět žádná síťová volání.

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

Hodnota vlastnosti

(widgetSettings: WidgetSettings) => Promise<WidgetStatus>