Partager via

IWidget interface

  • Référence
Paquet:
azure-devops-extension-api

Tous les widgets implémentent cette interface

Propriétés

disableWidgetForStakeholders

Le framework appelle cette méthode pour déterminer si le widget doit être désactivé pour les utilisateurs disposant d’une licence de partie prenante
lightbox

Exécuter le widget en mode lightboxed
listen

Écouter le message de l’hôte
load

Les widgets utilisent les paramètres fournis ainsi que les appels côté serveur pour terminer leur expérience de rendu. À l’avenir, les widgets sont censés fournir une expérience de chargement pendant que les appels sont attendus pour être terminés. D’ici là, l’hôte du widget fournit l’expérience de chargement
onDashboardLoaded

Les widgets gèrent toutes les opérations qui ne sont pas nécessaires pour le chargement initial, mais qui sont requises pour l’expérience de widget complète.
preload

les widgets utilisent les paramètres fournis ainsi que les données mises en cache qu’ils peuvent avoir pour peindre un état interactif. Aucun appel réseau ne doit être effectué par le widget.

Détails de la propriété

disableWidgetForStakeholders

Le framework appelle cette méthode pour déterminer si le widget doit être désactivé pour les utilisateurs disposant d’une licence de partie prenante

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

Valeur de propriété

(widgetSettings: WidgetSettings) => Promise<boolean>

lightbox

Exécuter le widget en mode lightboxed

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

Valeur de propriété

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

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

Les widgets utilisent les paramètres fournis ainsi que les appels côté serveur pour terminer leur expérience de rendu. À l’avenir, les widgets sont censés fournir une expérience de chargement pendant que les appels sont attendus pour être terminés. D’ici là, l’hôte du widget fournit l’expérience de chargement

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

Valeur de propriété

(widgetSettings: WidgetSettings) => Promise<WidgetStatus>

onDashboardLoaded

Les widgets gèrent toutes les opérations qui ne sont pas nécessaires pour le chargement initial, mais qui sont requises pour l’expérience de widget complète.

onDashboardLoaded?: () => void

Valeur de propriété

() => void

preload

les widgets utilisent les paramètres fournis ainsi que les données mises en cache qu’ils peuvent avoir pour peindre un état interactif. Aucun appel réseau ne doit être effectué par le widget.

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

Valeur de propriété

(widgetSettings: WidgetSettings) => Promise<WidgetStatus>