IWidgetConfiguration interface

Csomag:

azure-devops-extension-api

A widget szerzői ezt a felületet a konfigurációjukhoz implementálják.

Tulajdonságok

listen	Üzenet meghallgatása a gazdagépről
load	A gazdagép hívja meg a widget konfigurációjának beállításához, amely a widgettel megosztott beállításokat használja a renderelési élmény befejezéséhez.
onSave	A gazdagép hívja meg, amikor a felhasználó a Mentés gombra kattint. A widget szerzőjének szükség esetén érvényesítést kell futtatnia. Ha készen áll a mentésre, akkor a WidgetHelpers.WidgetConfigurationSave.Valid() használatával adja vissza a vezérlő szerializált egyéni beállításait a konfigurációból. Ha az egyéni beállítások érvénytelenek, és így nem állnak készen a mentésre, akkor a WidgetHelpers.WidgetConfigurationSave.Invalid() használatával értesítse a gazdagépet a mentés leállításáról.
onSaveComplete	(Nem kötelező) A gazdagép hívja meg, amikor a konfiguráció készen áll a mentésre (amikor a felhasználó a konfigurációs panelen a mentés gombra kattint)

Tulajdonság adatai

listen

Üzenet meghallgatása a gazdagépről

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

Tulajdonság értéke

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

load

A gazdagép hívja meg a widget konfigurációjának beállításához, amely a widgettel megosztott beállításokat használja a renderelési élmény befejezéséhez.

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

Tulajdonság értéke

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

onSave

A gazdagép hívja meg, amikor a felhasználó a Mentés gombra kattint. A widget szerzőjének szükség esetén érvényesítést kell futtatnia. Ha készen áll a mentésre, akkor a WidgetHelpers.WidgetConfigurationSave.Valid() használatával adja vissza a vezérlő szerializált egyéni beállításait a konfigurációból. Ha az egyéni beállítások érvénytelenek, és így nem állnak készen a mentésre, akkor a WidgetHelpers.WidgetConfigurationSave.Invalid() használatával értesítse a gazdagépet a mentés leállításáról.

onSave: () => Promise<SaveStatus>

Tulajdonság értéke

() => Promise<SaveStatus>

onSaveComplete

(Nem kötelező) A gazdagép hívja meg, amikor a konfiguráció készen áll a mentésre (amikor a felhasználó a konfigurációs panelen a mentés gombra kattint)

onSaveComplete?: () => void

Tulajdonság értéke

() => void