IWidgetConfiguration interface

Pakket:

azure-devops-extension-api

Widgetauteurs implementeren deze interface voor hun configuratie.

Eigenschappen

listen	Luisteren naar bericht van host
load	Aangeroepen door de host om de widgetconfiguratie in te stellen, die gebruikmaakt van de instellingen die worden gedeeld met de widget om de weergave-ervaring te voltooien.
onSave	Aangeroepen door de host wanneer de gebruiker op de knop Opslaan klikt. Van de auteur van de widget wordt verwacht dat deze indien nodig validaties uitvoert. Als u klaar bent om op te slaan, gebruikt u WidgetHelpers.WidgetConfigurationSave.Valid() om de geserialiseerde aangepaste instellingen van de widget uit de configuratie te retourneren. Als aangepaste instellingen niet geldig zijn en dus niet gereed zijn om op te slaan, gebruikt u WidgetHelpers.WidgetConfigurationSave.Invalid() om de host te laten weten dat het opslaan moet worden gestopt.
onSaveComplete	(Optioneel) Aangeroepen door de host wanneer de configuratie gereed is om te worden opgeslagen (wanneer de gebruiker op de knop Opslaan in het configuratievenster klikt)

Eigenschapdetails

listen

Luisteren naar bericht van host

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

Waarde van eigenschap

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

load

Aangeroepen door de host om de widgetconfiguratie in te stellen, die gebruikmaakt van de instellingen die worden gedeeld met de widget om de weergave-ervaring te voltooien.

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

Waarde van eigenschap

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

onSave

Aangeroepen door de host wanneer de gebruiker op de knop Opslaan klikt. Van de auteur van de widget wordt verwacht dat deze indien nodig validaties uitvoert. Als u klaar bent om op te slaan, gebruikt u WidgetHelpers.WidgetConfigurationSave.Valid() om de geserialiseerde aangepaste instellingen van de widget uit de configuratie te retourneren. Als aangepaste instellingen niet geldig zijn en dus niet gereed zijn om op te slaan, gebruikt u WidgetHelpers.WidgetConfigurationSave.Invalid() om de host te laten weten dat het opslaan moet worden gestopt.

onSave: () => Promise<SaveStatus>

Waarde van eigenschap

() => Promise<SaveStatus>

onSaveComplete

(Optioneel) Aangeroepen door de host wanneer de configuratie gereed is om te worden opgeslagen (wanneer de gebruiker op de knop Opslaan in het configuratievenster klikt)

onSaveComplete?: () => void

Waarde van eigenschap

() => void