IWidgetConfiguration interface

Paquet:

azure-devops-extension-api

Les auteurs de widgets implémentent cette interface pour leur configuration.

Propriétés

listen	Écouter le message de l’hôte
load	Appelé par l’hôte pour configurer la configuration du widget, qui utilise les paramètres partagés avec le widget pour terminer son expérience de rendu.
onSave	Appelé par l’hôte lorsque l’utilisateur clique sur le bouton Enregistrer. L’auteur du widget doit exécuter des validations si nécessaire. Si vous êtes prêt à enregistrer, utilisez WidgetHelpers.WidgetConfigurationSave.Valid() pour retourner les paramètres personnalisés sérialisés du widget à partir du configuraton. Si les paramètres personnalisés ne sont pas valides et ne sont donc pas prêts à être enregistrés, utilisez WidgetHelpers.WidgetConfigurationSave.Invalid() pour avertir l’hôte d’arrêter l’enregistrement.
onSaveComplete	(Facultatif) Appelé par l’hôte lorsque la configuration est prête à être enregistrée (lorsque l’utilisateur clique sur le bouton Enregistrer dans le panneau de configuration)

Détails de la propriété

listen

Écouter le message de l’hôte

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

Valeur de propriété

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

load

Appelé par l’hôte pour configurer la configuration du widget, qui utilise les paramètres partagés avec le widget pour terminer son expérience de rendu.

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

Valeur de propriété

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

onSave

Appelé par l’hôte lorsque l’utilisateur clique sur le bouton Enregistrer. L’auteur du widget doit exécuter des validations si nécessaire. Si vous êtes prêt à enregistrer, utilisez WidgetHelpers.WidgetConfigurationSave.Valid() pour retourner les paramètres personnalisés sérialisés du widget à partir du configuraton. Si les paramètres personnalisés ne sont pas valides et ne sont donc pas prêts à être enregistrés, utilisez WidgetHelpers.WidgetConfigurationSave.Invalid() pour avertir l’hôte d’arrêter l’enregistrement.

onSave: () => Promise<SaveStatus>

Valeur de propriété

() => Promise<SaveStatus>

onSaveComplete

(Facultatif) Appelé par l’hôte lorsque la configuration est prête à être enregistrée (lorsque l’utilisateur clique sur le bouton Enregistrer dans le panneau de configuration)

onSaveComplete?: () => void

Valeur de propriété

() => void