IWidgetConfiguration interface

Balíček:

azure-devops-extension-api

Autoři widgetů implementují toto rozhraní pro svoji konfiguraci.

Vlastnosti

listen	Poslech zprávy od hostitele
load	Hostitel ho volá k nastavení konfigurace widgetu, která používá nastavení sdílená s widgetem k dokončení jeho vykreslování.
onSave	Zavolá ho hostitel, když uživatel klikne na tlačítko Uložit. Očekává se, že autor widgetu v případě potřeby spustí ověření. Pokud jste připravení k uložení, použijte WidgetHelpers.WidgetConfigurationSave.Valid() k vrácení serializovaného vlastního nastavení widgetu z konfigurace. Pokud vlastní nastavení nejsou platná a nejsou připravená k uložení, pak pomocí WidgetHelpers.WidgetConfigurationSave.Invalid() upozorněte hostitele, aby přestal ukládat.
onSaveComplete	(Volitelné) Zavolá ho hostitel, když je konfigurace připravená k uložení (když uživatel klikne na tlačítko Uložit na konfiguračním panelu).

Podrobnosti vlastnosti

listen

Poslech zprávy od hostitele

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

Hodnota vlastnosti

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

load

Hostitel ho volá k nastavení konfigurace widgetu, která používá nastavení sdílená s widgetem k dokončení jeho vykreslování.

load: (widgetSettings: WidgetSettings, widgetConfigurationContext: IWidgetConfigurationContext) => Promise<WidgetStatus>

Hodnota vlastnosti

(widgetSettings: WidgetSettings, widgetConfigurationContext: IWidgetConfigurationContext) => Promise<WidgetStatus>

onSave

Zavolá ho hostitel, když uživatel klikne na tlačítko Uložit. Očekává se, že autor widgetu v případě potřeby spustí ověření. Pokud jste připravení k uložení, použijte WidgetHelpers.WidgetConfigurationSave.Valid() k vrácení serializovaného vlastního nastavení widgetu z konfigurace. Pokud vlastní nastavení nejsou platná a nejsou připravená k uložení, pak pomocí WidgetHelpers.WidgetConfigurationSave.Invalid() upozorněte hostitele, aby přestal ukládat.

onSave: () => Promise<SaveStatus>

Hodnota vlastnosti

() => Promise<SaveStatus>

onSaveComplete

(Volitelné) Zavolá ho hostitel, když je konfigurace připravená k uložení (když uživatel klikne na tlačítko Uložit na konfiguračním panelu).

onSaveComplete?: () => void

Hodnota vlastnosti

() => void