IWidget interface

Paquete:

azure-devops-extension-api

Todos los widgets implementan esta interfaz

Propiedades

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 claro
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 espera 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 llamadas de red.

Detalles de las propiedades

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>

lightbox

Ejecutar widget en modo claro

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

Valor de propiedad

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

listen

Escucha del mensaje desde el host

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

Valor de propiedad

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

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 espera 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>

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

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 llamadas de red.

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

Valor de propiedad

(widgetSettings: WidgetSettings) => Promise<WidgetStatus>