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 partes interesadas
lightbox	Ejecutar widget en modo lightboxed
listen	Escuchar el mensaje del anfitrión
load	Los widgets utilizan la configuración proporcionada, así como las llamadas del lado del servidor para completar su experiencia de renderizado. 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 cualquier operación que no sea necesaria para la carga inicial, pero que sea necesaria para la experiencia completa del widget.
preload	Los widgets utilizan la configuración proporcionada junto con los datos almacenados en caché que puedan 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 partes interesadas

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

Valor de propiedad

(widgetSettings: WidgetSettings) => Promise<boolean>

lightbox

Ejecutar widget en modo lightboxed

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

Valor de propiedad

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

listen

Escuchar el mensaje del anfitrión

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

Valor de propiedad

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

load

Los widgets utilizan la configuración proporcionada, así como las llamadas del lado del servidor para completar su experiencia de renderizado. 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 cualquier operación que no sea necesaria para la carga inicial, pero que sea necesaria para la experiencia completa del widget.

onDashboardLoaded?: () => void

Valor de propiedad

() => void

preload

Los widgets utilizan la configuración proporcionada junto con los datos almacenados en caché que puedan 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>