IConfigurableWidget interface

Balíček:

azure-devops-extension-api

Konfigurovatelné widgety implementují toto rozhraní

Extends

IWidget

Vlastnosti

reload

Při změně zobrazení konfigurace se očekává, že widget aktualizuje zobrazení.

Zděděné vlastnosti

disableWidgetForStakeholders	Architektura tuto metodu volá k určení, jestli má být widget pro uživatele s licencí účastníka zakázaný.
lightbox	Spuštění widgetu v režimu Lightboxed
listen	Poslechněte si zprávu z hostitele
load	Widgety používají k dokončení vykreslování poskytnutá nastavení i volání na straně serveru. V budoucnu se očekává, že widgety budou poskytovat prostředí pro načítání, zatímco se čeká na dokončení volání. Do té doby bude prostředí načítání poskytovat hostitel widgetu.
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í poskytnutá nastavení spolu s daty uloženými v mezipaměti, která mohou mít k vykreslení interaktivního stavu. Widget by neměl provádět žádná síťová volání.

Podrobnosti vlastnosti

reload

Při změně zobrazení konfigurace se očekává, že widget aktualizuje zobrazení.

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

Hodnota vlastnosti

(newWidgetSettings: WidgetSettings) => Promise<WidgetStatus>

Podrobnosti zděděných vlastností

disableWidgetForStakeholders

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

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

Hodnota vlastnosti

(widgetSettings: WidgetSettings) => Promise<boolean>

Zděděno ZIWidget.disableWidgetForStakeholders

lightbox

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

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

Hodnota vlastnosti

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

Zděděno zIWidget.lightbox

listen

Poslechněte si zprávu z hostitele

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

Hodnota vlastnosti

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

Zděděno zIWidget.listen

load

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

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

Hodnota vlastnosti

(widgetSettings: WidgetSettings) => Promise<WidgetStatus>

Zděděno zIWidget.load

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

Zděděno zIWidget.onDashboardLoaded

preload

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

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

Hodnota vlastnosti

(widgetSettings: WidgetSettings) => Promise<WidgetStatus>

Zděděno zIWidget.preload