Partager via

IConfigurableWidget interface

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

Les widgets configurables implémentent cette interface

Extends
IWidget

Propriétés

reload

Lorsque l’affichage de configuration est modifié, le widget est censé mettre à jour son affichage.

Propriétés héritées

disableWidgetForStakeholders

L’infrastructure appelle cette méthode pour déterminer si le widget doit être désactivé pour les utilisateurs disposant d’une licence 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. Jusqu’à ce moment- là, l’hôte du widget fournira l’expérience de chargement
onDashboardLoaded

Les widgets gèrent les opérations qui ne sont pas nécessaires pour la charge initiale, mais qui sont requises pour l’expérience complète du widget.
preload

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

Détails de la propriété

reload

Lorsque l’affichage de configuration est modifié, le widget est censé mettre à jour son affichage.

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

Valeur de propriété

(newWidgetSettings: WidgetSettings) => Promise<WidgetStatus>

Détails de la propriété héritée

disableWidgetForStakeholders

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

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

Valeur de propriété

(widgetSettings: WidgetSettings) => Promise<boolean>

héritée deIWidget.disableWidgetForStakeholders

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>

héritée de IWidget.lightbox

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

héritée deIWidget.listen

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. Jusqu’à ce moment- là, l’hôte du widget fournira l’expérience de chargement

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

Valeur de propriété

(widgetSettings: WidgetSettings) => Promise<WidgetStatus>

héritée de IWidget.load

onDashboardLoaded

Les widgets gèrent les opérations qui ne sont pas nécessaires pour la charge initiale, mais qui sont requises pour l’expérience complète du widget.

onDashboardLoaded?: () => void

Valeur de propriété

() => void

héritée deIWidget.onDashboardLoaded

preload

les widgets utilisent les paramètres fournis avec les données mises en cache qu’ils peuvent avoir à 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>

héritée de IWidget.preload