IWidgetConfiguration interface

Balíček:

azure-devops-extension-api

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

Vlastnosti

listen	Naslouchání zprávě z hostitele
load	Zavolá hostitel, aby nastavil konfiguraci widgetu, která používá nastavení sdílená s widgetem k dokončení jeho vykreslování.
onSave	Volá se hostitelem, když uživatel klikne na tlačítko Uložit. Autor widgetu by měl v případě potřeby spouštět ověření. Pokud jste připravení k uložení, použijte WidgetHelpers.WidgetConfigurationSave.Valid() k vrácení serializovaného vlastního nastavení widgetu z konfigurátoru. Pokud vlastní nastavení není platné a proto není připraveno k uložení, použijte WidgetHelpers.WidgetConfigurationSave.Invalid() a upozorněte hostitele na zastavení ukládání.
onSaveComplete	(Volitelné) Zavolá 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

Naslouchání zprávě z hostitele

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

Hodnota vlastnosti

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

load

Zavolá hostitel, aby nastavil konfiguraci 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

Volá se hostitelem, když uživatel klikne na tlačítko Uložit. Autor widgetu by měl v případě potřeby spouštět ověření. Pokud jste připravení k uložení, použijte WidgetHelpers.WidgetConfigurationSave.Valid() k vrácení serializovaného vlastního nastavení widgetu z konfigurátoru. Pokud vlastní nastavení není platné a proto není připraveno k uložení, použijte WidgetHelpers.WidgetConfigurationSave.Invalid() a upozorněte hostitele na zastavení ukládání.

onSave: () => Promise<SaveStatus>

Hodnota vlastnosti

() => Promise<SaveStatus>

onSaveComplete

(Volitelné) Zavolá 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