WidgetMetadata interface

Pacote:

azure-devops-extension-api

Informações baseadas em contribuição que descrevem widgets de painel.

Propriedades

allowedSizes	Tamanhos compatíveis com o Widget.
analyticsServiceRequired	Opt-in booleano que indica se o widget requer que o Serviço de Análise funcione. Widgets que exigem 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	Cadeia de caracteres de URL de aceitação apontando para informações de widget. O padrão será a URL do marketplace de extensões se omitida
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 de .
contributionId	A ID da contribuição subjacente que define o Widget fornecido.
defaultSettings	Configurações padrão opcionais a serem copiadas em configurações de widget.
description	Informações resumidas que descrevem o widget.
isEnabled	Os widgets podem ser desabilitados pela loja de aplicativos. Precisaremos lidar normalmente com: - persistência (Permitir) - Solicitações (Marca como desabilitada e fornecer contexto)
isNameConfigurable	Opt-out boolean que indica se o widget dá suporte à configuração de nome/título do widget. Os widgets que ignoram o nome devem defini-lo como false no manifesto.
isVisibleFromCatalog	Opt-out booleano indicando se o widget está oculto do catálogo. Normalmente, isso é usado para permitir que os desenvolvedores desabilitem 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 ficar visível no catálogo.
keywords	Palavras-chave associadas a esse widget, não filtrante e invisível
lightboxOptions	Propriedades de aceitação para personalizar a apresentação do widget em uma caixa de diálogo "lightbox".
loadingImageUrl	Recurso para uma imagem de espaço reservado de carregamento 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 desse tipo de widget.
supportedScopes	Contrato de dados necessário para que o widget funcione e funcione em seu contêiner.
tags	Marcas associadas a esse widget, visíveis em cada widget e filtradas.
targets	IDs de destino de contribuição
typeId	Preterido: id voltada para o desenvolvedor localmente exclusiva desse tipo de widget. ContributionId fornece um identificador global exclusivo para tipos de widget.

Detalhes da propriedade

allowedSizes

Tamanhos compatíveis com o Widget.

allowedSizes: WidgetSize[]

Valor da propriedade

WidgetSize[]

analyticsServiceRequired

Opt-in booleano que indica se o widget requer que o Serviço de Análise funcione. Widgets que exigem 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 da propriedade

boolean

catalogIconUrl

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

catalogIconUrl: string

Valor da propriedade

string

catalogInfoUrl

Cadeia de caracteres de URL de aceitação apontando para informações de widget. O padrão será a URL do marketplace de extensões se omitida

catalogInfoUrl: string

Valor da 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 da 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 da propriedade

string

configurationRequired

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

configurationRequired: boolean

Valor da propriedade

boolean

contentUri

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

contentUri: string

Valor da propriedade

string

contributionId

A ID da contribuição subjacente que define o Widget fornecido.

contributionId: string

Valor da propriedade

string

defaultSettings

Configurações padrão opcionais a serem copiadas em configurações de widget.

defaultSettings: string

Valor da propriedade

string

description

Informações resumidas que descrevem o widget.

description: string

Valor da propriedade

string

isEnabled

Os widgets podem ser desabilitados pela loja de aplicativos. Precisaremos lidar normalmente com: - persistência (Permitir) - Solicitações (Marca como desabilitada e fornecer contexto)

isEnabled: boolean

Valor da propriedade

boolean

isNameConfigurable

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

isNameConfigurable: boolean

Valor da propriedade

boolean

isVisibleFromCatalog

Opt-out booleano indicando se o widget está oculto do catálogo. Normalmente, isso é usado para permitir que os desenvolvedores desabilitem 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 ficar visível no catálogo.

isVisibleFromCatalog: boolean

Valor da propriedade

boolean

keywords

Palavras-chave associadas a esse widget, não filtrante e invisível

keywords: string[]

Valor da propriedade

string[]

lightboxOptions

Propriedades de aceitação para personalizar a apresentação do widget em uma caixa de diálogo "lightbox".

lightboxOptions: LightboxOptions

Valor da propriedade

LightboxOptions

loadingImageUrl

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

loadingImageUrl: string

Valor da propriedade

string

name

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

name: string

Valor da propriedade

string

publisherName

Nome do Editor desse tipo de widget.

publisherName: string

Valor da propriedade

string

supportedScopes

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

supportedScopes: WidgetScope[]

Valor da propriedade

WidgetScope[]

tags

Marcas associadas a esse widget, visíveis em cada widget e filtradas.

tags: string[]

Valor da propriedade

string[]

targets

IDs de destino de contribuição

targets: string[]

Valor da propriedade

string[]

typeId

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

typeId: string

Valor da propriedade

string