WidgetMetadata interface

Pacote:

azure-devops-extension-api

Informações baseadas em contribuições que descrevem os widgets do painel.

Propriedades

allowedSizes	Tamanhos suportados pelo Widget.
analyticsServiceRequired	Booleano de aceitação que indica se o widget requer que o Serviço de Análise funcione. Os widgets que requerem o serviço de análise ficam ocultos do catálogo se o Serviço de análise não estiver disponível.
catalogIconUrl	Recurso para um ícone no catálogo de widgets.
catalogInfoUrl	Opt-in URL string apontando para as informações do widget. Padrão para URL do marketplace de extensão se omitido
configurationContributionId	A id da contribuição subjacente que define a interface do usuário de configuração personalizada do Widget fornecida. Nulo se a interface do usuário de configuração personalizada não estiver disponível.
configurationContributionRelativeId	A id relativa da contribuição subjacente que define a interface do usuário de configuração personalizada do Widget fornecida. Nulo se a interface do usuário de configuração personalizada não estiver disponível.
configurationRequired	Indica se o widget requer configuração antes de ser adicionado ao painel.
contentUri	Uri para o conteúdo do widget a ser carregado do .
contributionId	O id da contribuição subjacente que define o Widget fornecido.
defaultSettings	Configurações padrão opcionais a serem copiadas nas configurações do widget.
description	Informações resumidas que descrevem o widget.
isEnabled	Os widgets podem ser desativados pela loja de aplicativos. Precisaremos lidar graciosamente para: - persistência (Permitir) - Solicitações (marcar como desativado e fornecer contexto)
isNameConfigurable	Opt-out boolean que indica se o widget suporta a configuração de nome/título do widget. Os widgets que ignoram o nome devem defini-lo como false no manifesto.
isVisibleFromCatalog	Opt-out boolean indicando se o widget está oculto do catálogo. Geralmente, isso é usado para permitir que os desenvolvedores desativem a criação de um widget preterido. Um widget deve ter um estado padrão funcional, ou ter uma experiência de configuração, para ser visível a partir do catálogo.
keywords	Palavras-chave associadas a este widget, não filtráveis e invisíveis
lightboxOptions	Opt-in propriedades para personalizar a apresentação do widget em uma caixa de diálogo "lightbox".
loadingImageUrl	Recurso para carregar uma imagem de espaço reservado no painel
name	Nome voltado para o usuário do tipo de widget. Cada widget deve usar um valor exclusivo aqui.
publisherName	Nome do editor deste tipo de widget.
supportedScopes	Contrato de dados necessário para que o widget funcione e funcione em seu contêiner.
tags	Tags associadas a este widget, visíveis em cada widget e filtráveis.
targets	IDs de destino de contribuição
typeId	Preterido: id voltado para o desenvolvedor exclusivo localmente desse tipo de widget. ContributionId fornece um identificador global exclusivo para tipos de widget.

Detalhes de Propriedade

allowedSizes

Tamanhos suportados pelo Widget.

allowedSizes: WidgetSize[]

Valor de Propriedade

WidgetSize[]

analyticsServiceRequired

Booleano de aceitação que indica se o widget requer que o Serviço de Análise funcione. Os widgets que requerem o serviço de análise ficam ocultos do catálogo se o Serviço de análise não estiver disponível.

analyticsServiceRequired: boolean

Valor de Propriedade

boolean

catalogIconUrl

Recurso para um ícone no catálogo de widgets.

catalogIconUrl: string

Valor de Propriedade

string

catalogInfoUrl

Opt-in URL string apontando para as informações do widget. Padrão para URL do marketplace de extensão se omitido

catalogInfoUrl: string

Valor de Propriedade

string

configurationContributionId

A id da contribuição subjacente que define a interface do usuário de configuração personalizada do Widget fornecida. Nulo se a interface do usuário de configuração personalizada não estiver disponível.

configurationContributionId: string

Valor de Propriedade

string

configurationContributionRelativeId

A id relativa da contribuição subjacente que define a interface do usuário de configuração personalizada do Widget fornecida. Nulo se a interface do usuário de configuração personalizada não estiver disponível.

configurationContributionRelativeId: string

Valor de Propriedade

string

configurationRequired

Indica se o widget requer configuração antes de ser adicionado ao painel.

configurationRequired: boolean

Valor de Propriedade

boolean

contentUri

Uri para o conteúdo do widget a ser carregado do .

contentUri: string

Valor de Propriedade

string

contributionId

O id da contribuição subjacente que define o Widget fornecido.

contributionId: string

Valor de Propriedade

string

defaultSettings

Configurações padrão opcionais a serem copiadas nas configurações do widget.

defaultSettings: string

Valor de Propriedade

string

description

Informações resumidas que descrevem o widget.

description: string

Valor de Propriedade

string

isEnabled

Os widgets podem ser desativados pela loja de aplicativos. Precisaremos lidar graciosamente para: - persistência (Permitir) - Solicitações (marcar como desativado e fornecer contexto)

isEnabled: boolean

Valor de Propriedade

boolean

isNameConfigurable

Opt-out boolean que indica se o widget suporta a configuração de nome/título do widget. Os widgets que ignoram o nome devem defini-lo como false no manifesto.

isNameConfigurable: boolean

Valor de Propriedade

boolean

isVisibleFromCatalog

Opt-out boolean indicando se o widget está oculto do catálogo. Geralmente, isso é usado para permitir que os desenvolvedores desativem a criação de um widget preterido. Um widget deve ter um estado padrão funcional, ou ter uma experiência de configuração, para ser visível a partir do catálogo.

isVisibleFromCatalog: boolean

Valor de Propriedade

boolean

keywords

Palavras-chave associadas a este widget, não filtráveis e invisíveis

keywords: string[]

Valor de Propriedade

string[]

lightboxOptions

Opt-in propriedades para personalizar a apresentação do widget em uma caixa de diálogo "lightbox".

lightboxOptions: LightboxOptions

Valor de Propriedade

LightboxOptions

loadingImageUrl

Recurso para carregar uma imagem de espaço reservado no painel

loadingImageUrl: string

Valor de Propriedade

string

name

Nome voltado para o usuário do tipo de widget. Cada widget deve usar um valor exclusivo aqui.

name: string

Valor de Propriedade

string

publisherName

Nome do editor deste tipo de widget.

publisherName: string

Valor de Propriedade

string

supportedScopes

Contrato de dados necessário para que o widget funcione e funcione em seu contêiner.

supportedScopes: WidgetScope[]

Valor de Propriedade

WidgetScope[]

tags

Tags associadas a este widget, visíveis em cada widget e filtráveis.

tags: string[]

Valor de Propriedade

string[]

targets

IDs de destino de contribuição

targets: string[]

Valor de Propriedade

string[]

typeId

Preterido: id voltado para o desenvolvedor exclusivo localmente desse tipo de widget. ContributionId fornece um identificador global exclusivo para tipos de widget.

typeId: string

Valor de Propriedade

string