IConfigurableWidget interface

Paquet:

azure-devops-extension-api

Les widgets configurables implémentent cette interface

Extends

IWidget

Propriétés

reload

Lorsque la vue de configuration est modifiée, le widget est censé mettre à jour sa vue.

Propriétés héritées

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é

reload

Lorsque la vue de configuration est modifiée, le widget est censé mettre à jour sa vue.

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

Valeur de propriété

(newWidgetSettings: WidgetSettings) => Promise<WidgetStatus>

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

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>

Hérité 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é deIWidget.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é 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. 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>

Hérité deIWidget.load

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

Hérité deIWidget.onDashboardLoaded

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>

Hérité deIWidget.preload