IWidgetConfiguration interface

Paquete:

azure-devops-extension-api

Los autores de widgets implementan esta interfaz para su configuración.

Propiedades

listen	Escucha del mensaje desde el host
load	Llamado por el host para configurar la configuración del widget, que usa la configuración compartida con el widget para completar su experiencia de representación.
onSave	Llamado por el host cuando el usuario hace clic en el botón Guardar. Se espera que el autor del widget ejecute validaciones si es necesario. Si está listo para guardar, use WidgetHelpers.WidgetConfigurationSave.Valid() para devolver la configuración personalizada serializada del widget desde la configuración. Si la configuración personalizada no es válida y, por tanto, no está lista para guardarse, use WidgetHelpers.WidgetConfigurationSave.Invalid() para notificar al host que detenga el guardado.
onSaveComplete	(Opcional) Lo llama el host cuando la configuración está lista para guardarse (cuando el usuario hace clic en el botón Guardar del panel de configuración).

Detalles de las propiedades

listen

Escucha del mensaje desde el host

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

Valor de propiedad

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

load

Llamado por el host para configurar la configuración del widget, que usa la configuración compartida con el widget para completar su experiencia de representación.

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

Valor de propiedad

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

onSave

Llamado por el host cuando el usuario hace clic en el botón Guardar. Se espera que el autor del widget ejecute validaciones si es necesario. Si está listo para guardar, use WidgetHelpers.WidgetConfigurationSave.Valid() para devolver la configuración personalizada serializada del widget desde la configuración. Si la configuración personalizada no es válida y, por tanto, no está lista para guardarse, use WidgetHelpers.WidgetConfigurationSave.Invalid() para notificar al host que detenga el guardado.

onSave: () => Promise<SaveStatus>

Valor de propiedad

() => Promise<SaveStatus>

onSaveComplete

(Opcional) Lo llama el host cuando la configuración está lista para guardarse (cuando el usuario hace clic en el botón Guardar del panel de configuración).

onSaveComplete?: () => void

Valor de propiedad

() => void