WidgetMetadata interface

Paquet:

azure-devops-extension-api

Informations basées sur des contributions décrivant les widgets de tableau de bord.

Propriétés

allowedSizes	Tailles prises en charge par le widget.
analyticsServiceRequired	Opt-in boolean qui indique si le widget nécessite que le service Analytics fonctionne. Les widgets nécessitant le service d’analyse sont masqués dans le catalogue si le service Analytics n’est pas disponible.
catalogIconUrl	Ressource pour une icône dans le catalogue de widgets.
catalogInfoUrl	Chaîne d’URL d’option pointant vers les informations du widget. Valeur par défaut pour l’URL de la Place de marché d’extension si elle est omise
configurationContributionId	ID de la contribution sous-jacente définissant l’interface utilisateur de configuration personnalisée du widget fournie. Null si l’interface utilisateur de configuration personnalisée n’est pas disponible.
configurationContributionRelativeId	ID relatif de la contribution sous-jacente définissant l’interface utilisateur de configuration personnalisée du widget fournie. Null si l’interface utilisateur de configuration personnalisée n’est pas disponible.
configurationRequired	Indique si le widget nécessite une configuration avant d’être ajouté au tableau de bord.
contentUri	Uri du contenu du widget à charger à partir de .
contributionId	ID de la contribution sous-jacente définissant le widget fourni.
defaultSettings	Paramètres par défaut facultatifs à copier dans les paramètres du widget.
description	Informations récapitulatives décrivant le widget.
isEnabled	Les widgets peuvent être désactivés par l’App Store. Nous devons gérer correctement les éléments suivants : - persistance (Autoriser) - Demandes (balise désactivée et contexte)
isNameConfigurable	Désactiver la valeur booléenne qui indique si le widget prend en charge la configuration de nom/titre du widget. Les widgets ignorant le nom doivent le définir sur false dans le manifeste.
isVisibleFromCatalog	Désactiver la valeur booléenne indiquant si le widget est masqué dans le catalogue. En règle générale, cela permet aux développeurs de désactiver la création d’un widget déconseillé. Un widget doit avoir un état par défaut fonctionnel, ou avoir une expérience de configuration, afin d’être visible à partir du catalogue.
keywords	Mots clés associés à ce widget, non filtrables et invisibles
lightboxOptions	Propriétés d’opt-in pour la personnalisation de la présentation du widget dans une boîte de dialogue « lightbox ».
loadingImageUrl	Ressource pour une image d’espace réservé de chargement sur le tableau de bord
name	Nom d’utilisateur du type de widget. Chaque widget doit utiliser une valeur unique ici.
publisherName	Nom de l’éditeur de ce type de widget.
supportedScopes	Contrat de données requis pour que le widget fonctionne et fonctionne dans son conteneur.
tags	Balises associées à ce widget, visibles sur chaque widget et filtrables.
targets	ID cibles de contribution
typeId	Déconseillé : ID local unique pour les développeurs de ce type de widget. ContributionId fournit un identificateur global unique pour les types de widgets.

Détails de la propriété

allowedSizes

Tailles prises en charge par le widget.

allowedSizes: WidgetSize[]

Valeur de propriété

WidgetSize[]

analyticsServiceRequired

Opt-in boolean qui indique si le widget nécessite que le service Analytics fonctionne. Les widgets nécessitant le service d’analyse sont masqués dans le catalogue si le service Analytics n’est pas disponible.

analyticsServiceRequired: boolean

Valeur de propriété

boolean

catalogIconUrl

Ressource pour une icône dans le catalogue de widgets.

catalogIconUrl: string

Valeur de propriété

string

catalogInfoUrl

Chaîne d’URL d’option pointant vers les informations du widget. Valeur par défaut pour l’URL de la Place de marché d’extension si elle est omise

catalogInfoUrl: string

Valeur de propriété

string

configurationContributionId

ID de la contribution sous-jacente définissant l’interface utilisateur de configuration personnalisée du widget fournie. Null si l’interface utilisateur de configuration personnalisée n’est pas disponible.

configurationContributionId: string

Valeur de propriété

string

configurationContributionRelativeId

ID relatif de la contribution sous-jacente définissant l’interface utilisateur de configuration personnalisée du widget fournie. Null si l’interface utilisateur de configuration personnalisée n’est pas disponible.

configurationContributionRelativeId: string

Valeur de propriété

string

configurationRequired

Indique si le widget nécessite une configuration avant d’être ajouté au tableau de bord.

configurationRequired: boolean

Valeur de propriété

boolean

contentUri

Uri du contenu du widget à charger à partir de .

contentUri: string

Valeur de propriété

string

contributionId

ID de la contribution sous-jacente définissant le widget fourni.

contributionId: string

Valeur de propriété

string

defaultSettings

Paramètres par défaut facultatifs à copier dans les paramètres du widget.

defaultSettings: string

Valeur de propriété

string

description

Informations récapitulatives décrivant le widget.

description: string

Valeur de propriété

string

isEnabled

Les widgets peuvent être désactivés par l’App Store. Nous devons gérer correctement les éléments suivants : - persistance (Autoriser) - Demandes (balise désactivée et contexte)

isEnabled: boolean

Valeur de propriété

boolean

isNameConfigurable

Désactiver la valeur booléenne qui indique si le widget prend en charge la configuration de nom/titre du widget. Les widgets ignorant le nom doivent le définir sur false dans le manifeste.

isNameConfigurable: boolean

Valeur de propriété

boolean

isVisibleFromCatalog

Désactiver la valeur booléenne indiquant si le widget est masqué dans le catalogue. En règle générale, cela permet aux développeurs de désactiver la création d’un widget déconseillé. Un widget doit avoir un état par défaut fonctionnel, ou avoir une expérience de configuration, afin d’être visible à partir du catalogue.

isVisibleFromCatalog: boolean

Valeur de propriété

boolean

keywords

Mots clés associés à ce widget, non filtrables et invisibles

keywords: string[]

Valeur de propriété

string[]

lightboxOptions

Propriétés d’opt-in pour la personnalisation de la présentation du widget dans une boîte de dialogue « lightbox ».

lightboxOptions: LightboxOptions

Valeur de propriété

LightboxOptions

loadingImageUrl

Ressource pour une image d’espace réservé de chargement sur le tableau de bord

loadingImageUrl: string

Valeur de propriété

string

name

Nom d’utilisateur du type de widget. Chaque widget doit utiliser une valeur unique ici.

name: string

Valeur de propriété

string

publisherName

Nom de l’éditeur de ce type de widget.

publisherName: string

Valeur de propriété

string

supportedScopes

Contrat de données requis pour que le widget fonctionne et fonctionne dans son conteneur.

supportedScopes: WidgetScope[]

Valeur de propriété

WidgetScope[]

tags

Balises associées à ce widget, visibles sur chaque widget et filtrables.

tags: string[]

Valeur de propriété

string[]

targets

ID cibles de contribution

targets: string[]

Valeur de propriété

string[]

typeId

Déconseillé : ID local unique pour les développeurs de ce type de widget. ContributionId fournit un identificateur global unique pour les types de widgets.

typeId: string

Valeur de propriété

string