IConfigurableWidget interface

Paquete:

azure-devops-extension-api

Los widgets configurables implementan esta interfaz

Extends

IWidget

Propiedades

reload

Cuando se cambia la vista de configuración, se espera que el widget actualice su vista.

Propiedades heredadas

disableWidgetForStakeholders	El marco llama a este método para determinar si el widget debe deshabilitarse para los usuarios con licencia de parte interesada.
lightbox	Ejecutar widget en modo lightboxed
listen	Escucha del mensaje desde el host
load	Los widgets usan la configuración proporcionada, así como las llamadas del lado servidor para completar su experiencia de representación. En el futuro, se espera que los widgets proporcionen una experiencia de carga mientras se esperan a que se completen las llamadas. Hasta entonces, el host del widget proporcionará la experiencia de carga.
onDashboardLoaded	Los widgets administran las operaciones que no son necesarias para la carga inicial, pero son necesarias para la experiencia completa del widget.
preload	los widgets usan la configuración proporcionada junto con los datos almacenados en caché que pueden tener para pintar un estado interactivo. El widget no debe realizar ninguna llamada de red.

Detalles de las propiedades

reload

Cuando se cambia la vista de configuración, se espera que el widget actualice su vista.

reload: (newWidgetSettings: WidgetSettings) => Promise<WidgetStatus>

Valor de propiedad

(newWidgetSettings: WidgetSettings) => Promise<WidgetStatus>

Detalles de las propiedades heredadas

disableWidgetForStakeholders

El marco llama a este método para determinar si el widget debe deshabilitarse para los usuarios con licencia de parte interesada.

disableWidgetForStakeholders?: (widgetSettings: WidgetSettings) => Promise<boolean>

Valor de propiedad

(widgetSettings: WidgetSettings) => Promise<boolean>

heredado deIWidget.disableWidgetForStakeholders

lightbox

Ejecutar widget en modo lightboxed

lightbox?: (widgetSettings: WidgetSettings, lightboxSize: Size) => Promise<WidgetStatus>

Valor de propiedad

(widgetSettings: WidgetSettings, lightboxSize: Size) => Promise<WidgetStatus>

heredado de IWidget.lightbox

listen

Escucha del mensaje desde el host

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

Valor de propiedad

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

heredado de IWidget.listen

load

Los widgets usan la configuración proporcionada, así como las llamadas del lado servidor para completar su experiencia de representación. En el futuro, se espera que los widgets proporcionen una experiencia de carga mientras se esperan a que se completen las llamadas. Hasta entonces, el host del widget proporcionará la experiencia de carga.

load: (widgetSettings: WidgetSettings) => Promise<WidgetStatus>

Valor de propiedad

(widgetSettings: WidgetSettings) => Promise<WidgetStatus>

heredado de IWidget.load

onDashboardLoaded

Los widgets administran las operaciones que no son necesarias para la carga inicial, pero son necesarias para la experiencia completa del widget.

onDashboardLoaded?: () => void

Valor de propiedad

() => void

heredado deIWidget.onDashboardLoaded

preload

los widgets usan la configuración proporcionada junto con los datos almacenados en caché que pueden tener para pintar un estado interactivo. El widget no debe realizar ninguna llamada de red.

preload: (widgetSettings: WidgetSettings) => Promise<WidgetStatus>

Valor de propiedad

(widgetSettings: WidgetSettings) => Promise<WidgetStatus>

heredado de IWidget.preload