IWidgetConfiguration interface

Paket:

azure-devops-extension-api

Widgetförfattare implementerar det här gränssnittet för sin konfiguration.

Egenskaper

listen	Lyssna på meddelande från värden
load	Anropas av värden för att konfigurera widgetkonfigurationen, som använder inställningarna som delas med widgeten för att slutföra återgivningen.
onSave	Anropas av värden när användaren klickar på knappen Spara. Widgetförfattaren förväntas köra valideringar om det behövs. Om du är redo att spara kan du använda WidgetHelpers.WidgetConfigurationSave.Valid() för att returnera de serialiserade anpassade inställningarna för widgeten från configuraton. Om anpassade inställningar inte är giltiga och därför inte är redo att sparas använder du WidgetHelpers.WidgetConfigurationSave.Invalid() för att meddela värden att sluta spara.
onSaveComplete	(Valfritt) Anropas av värden när konfigurationen är redo att sparas (när användaren klickar på knappen Spara på konfigurationspanelen)

Egenskapsinformation

listen

Lyssna på meddelande från värden

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

Egenskapsvärde

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

load

Anropas av värden för att konfigurera widgetkonfigurationen, som använder inställningarna som delas med widgeten för att slutföra återgivningen.

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

Egenskapsvärde

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

onSave

Anropas av värden när användaren klickar på knappen Spara. Widgetförfattaren förväntas köra valideringar om det behövs. Om du är redo att spara kan du använda WidgetHelpers.WidgetConfigurationSave.Valid() för att returnera de serialiserade anpassade inställningarna för widgeten från configuraton. Om anpassade inställningar inte är giltiga och därför inte är redo att sparas använder du WidgetHelpers.WidgetConfigurationSave.Invalid() för att meddela värden att sluta spara.

onSave: () => Promise<SaveStatus>

Egenskapsvärde

() => Promise<SaveStatus>

onSaveComplete

(Valfritt) Anropas av värden när konfigurationen är redo att sparas (när användaren klickar på knappen Spara på konfigurationspanelen)

onSaveComplete?: () => void

Egenskapsvärde

() => void