WidgetMetadata interface

Paquete:

azure-devops-extension-api

Información basada en la contribución que describe widgets de panel.

Propiedades

allowedSizes	Tamaños admitidos por el Widget.
analyticsServiceRequired	Boolean opcional que indica si el widget requiere que el servicio analytics funcione. Los widgets que requieren el servicio de análisis están ocultos en el catálogo si el servicio analytics no está disponible.
catalogIconUrl	Recurso para un icono en el catálogo de widgets.
catalogInfoUrl	Cadena de dirección URL de participación que apunta a la información del widget. El valor predeterminado es la dirección URL de Marketplace de extensión si se omite.
configurationContributionId	Identificador de la contribución subyacente que define la interfaz de usuario de configuración personalizada del widget proporcionada. Null si la interfaz de usuario de configuración personalizada no está disponible.
configurationContributionRelativeId	Identificador relativo de la contribución subyacente que define la interfaz de usuario de configuración personalizada del widget proporcionada. Null si la interfaz de usuario de configuración personalizada no está disponible.
configurationRequired	Indica si el widget requiere configuración antes de agregarse al panel.
contentUri	Uri del contenido del widget que se va a cargar desde .
contributionId	Identificador de la contribución subyacente que define el Widget proporcionado.
defaultSettings	Configuración predeterminada opcional que se va a copiar en la configuración del widget.
description	Información de resumen que describe el widget.
isEnabled	La tienda de aplicaciones puede deshabilitar los widgets. Necesitaremos controlar correctamente para: - persistencia (Permitir): solicitudes (etiqueta como deshabilitadas y proporcionar contexto)
isNameConfigurable	Opt-out boolean que indica si el widget admite la configuración de nombre o título del widget. Los widgets que ignoran el nombre deben establecerlo en false en el manifiesto.
isVisibleFromCatalog	Opt-out boolean que indica si el widget está oculto en el catálogo. Normalmente, esto se usa para permitir que los desarrolladores deshabiliten la creación de un widget en desuso. Un widget debe tener un estado predeterminado funcional o tener una experiencia de configuración para que sea visible desde el catálogo.
keywords	Palabras clave asociadas a este widget, no filtrables e invisibles
lightboxOptions	Propiedades de participación para personalizar la presentación del widget en un cuadro de diálogo "lightbox".
loadingImageUrl	Recurso para una imagen de marcador de posición de carga en el panel
name	Nombre orientado al usuario del tipo de widget. Cada widget debe usar un valor único aquí.
publisherName	Nombre del publicador de este tipo de widget.
supportedScopes	Contrato de datos necesario para que el widget funcione y funcione en su contenedor.
tags	Etiquetas asociadas a este widget, visibles en cada widget y filtrables.
targets	Identificadores de destino de contribución
typeId	En desuso: identificador localmente único para desarrolladores de este tipo de widget. ContributionId proporciona un identificador único global para los tipos de widget.

Detalles de las propiedades

allowedSizes

Tamaños admitidos por el Widget.

allowedSizes: WidgetSize[]

Valor de propiedad

WidgetSize[]

analyticsServiceRequired

Boolean opcional que indica si el widget requiere que el servicio analytics funcione. Los widgets que requieren el servicio de análisis están ocultos en el catálogo si el servicio analytics no está disponible.

analyticsServiceRequired: boolean

Valor de propiedad

boolean

catalogIconUrl

Recurso para un icono en el catálogo de widgets.

catalogIconUrl: string

Valor de propiedad

string

catalogInfoUrl

Cadena de dirección URL de participación que apunta a la información del widget. El valor predeterminado es la dirección URL de Marketplace de extensión si se omite.

catalogInfoUrl: string

Valor de propiedad

string

configurationContributionId

Identificador de la contribución subyacente que define la interfaz de usuario de configuración personalizada del widget proporcionada. Null si la interfaz de usuario de configuración personalizada no está disponible.

configurationContributionId: string

Valor de propiedad

string

configurationContributionRelativeId

Identificador relativo de la contribución subyacente que define la interfaz de usuario de configuración personalizada del widget proporcionada. Null si la interfaz de usuario de configuración personalizada no está disponible.

configurationContributionRelativeId: string

Valor de propiedad

string

configurationRequired

Indica si el widget requiere configuración antes de agregarse al panel.

configurationRequired: boolean

Valor de propiedad

boolean

contentUri

Uri del contenido del widget que se va a cargar desde .

contentUri: string

Valor de propiedad

string

contributionId

Identificador de la contribución subyacente que define el Widget proporcionado.

contributionId: string

Valor de propiedad

string

defaultSettings

Configuración predeterminada opcional que se va a copiar en la configuración del widget.

defaultSettings: string

Valor de propiedad

string

description

Información de resumen que describe el widget.

description: string

Valor de propiedad

string

isEnabled

La tienda de aplicaciones puede deshabilitar los widgets. Necesitaremos controlar correctamente para: - persistencia (Permitir): solicitudes (etiqueta como deshabilitadas y proporcionar contexto)

isEnabled: boolean

Valor de propiedad

boolean

isNameConfigurable

Opt-out boolean que indica si el widget admite la configuración de nombre o título del widget. Los widgets que ignoran el nombre deben establecerlo en false en el manifiesto.

isNameConfigurable: boolean

Valor de propiedad

boolean

isVisibleFromCatalog

Opt-out boolean que indica si el widget está oculto en el catálogo. Normalmente, esto se usa para permitir que los desarrolladores deshabiliten la creación de un widget en desuso. Un widget debe tener un estado predeterminado funcional o tener una experiencia de configuración para que sea visible desde el catálogo.

isVisibleFromCatalog: boolean

Valor de propiedad

boolean

keywords

Palabras clave asociadas a este widget, no filtrables e invisibles

keywords: string[]

Valor de propiedad

string[]

lightboxOptions

Propiedades de participación para personalizar la presentación del widget en un cuadro de diálogo "lightbox".

lightboxOptions: LightboxOptions

Valor de propiedad

LightboxOptions

loadingImageUrl

Recurso para una imagen de marcador de posición de carga en el panel

loadingImageUrl: string

Valor de propiedad

string

name

Nombre orientado al usuario del tipo de widget. Cada widget debe usar un valor único aquí.

name: string

Valor de propiedad

string

publisherName

Nombre del publicador de este tipo de widget.

publisherName: string

Valor de propiedad

string

supportedScopes

Contrato de datos necesario para que el widget funcione y funcione en su contenedor.

supportedScopes: WidgetScope[]

Valor de propiedad

WidgetScope[]

tags

Etiquetas asociadas a este widget, visibles en cada widget y filtrables.

tags: string[]

Valor de propiedad

string[]

targets

Identificadores de destino de contribución

targets: string[]

Valor de propiedad

string[]

typeId

En desuso: identificador localmente único para desarrolladores de este tipo de widget. ContributionId proporciona un identificador único global para los tipos de widget.

typeId: string

Valor de propiedad

string