WidgetMetadata interface

Pacchetto:

azure-devops-extension-api

Informazioni basate sui contributi che descrivono i widget del dashboard.

Proprietà

allowedSizes	Dimensioni supportate dal widget.
analyticsServiceRequired	Boolean di consenso esplicito che indica se il widget richiede il funzionamento del servizio di analisi. I widget che richiedono il servizio di analisi sono nascosti dal catalogo se il servizio di analisi non è disponibile.
catalogIconUrl	Risorsa per un'icona nel catalogo dei widget.
catalogInfoUrl	Stringa url di consenso esplicito che punta alle informazioni sul widget. Per impostazione predefinita, l'URL del Marketplace delle estensioni viene omesso
configurationContributionId	ID del contributo sottostante che definisce l'interfaccia utente di configurazione personalizzata del widget fornita. Null se l'interfaccia utente di configurazione personalizzata non è disponibile.
configurationContributionRelativeId	ID relativo del contributo sottostante che definisce l'interfaccia utente di configurazione personalizzata del widget fornita. Null se l'interfaccia utente di configurazione personalizzata non è disponibile.
configurationRequired	Indica se il widget richiede la configurazione prima di essere aggiunto al dashboard.
contentUri	Uri per il contenuto del widget da caricare da .
contributionId	ID del contributo sottostante che definisce il widget fornito.
defaultSettings	Impostazioni predefinite facoltative da copiare nelle impostazioni del widget.
description	Informazioni di riepilogo che descrivono il widget.
isEnabled	I widget possono essere disabilitati dall'App Store. Sarà necessario gestire correttamente per: - persistenza (consenti) - Richieste (tag disabilitate e fornire contesto)
isNameConfigurable	Boolean di rifiuto esplicito che indica se il widget supporta la configurazione del nome/titolo del widget. I widget che ignorano il nome devono impostarlo su false nel manifesto.
isVisibleFromCatalog	Boolean di rifiuto esplicito che indica se il widget è nascosto dal catalogo. In genere, viene usato per consentire agli sviluppatori di disabilitare la creazione di un widget deprecato. Un widget deve avere uno stato predefinito funzionale o avere un'esperienza di configurazione per essere visibile dal catalogo.
keywords	Parole chiave associate a questo widget, non filtrabili e invisibili
lightboxOptions	Proprietà di consenso esplicito per la personalizzazione della presentazione del widget in una finestra di dialogo "lightbox".
loadingImageUrl	Risorsa per un'immagine segnaposto di caricamento nel dashboard
name	Nome dell'utente del tipo di widget. Ogni widget deve usare un valore univoco qui.
publisherName	Nome editore di questo tipo di widget.
supportedScopes	Contratto dati necessario per il funzionamento del widget e per il funzionamento nel relativo contenitore.
tags	Tag associati a questo widget, visibili in ogni widget e filtrabili.
targets	ID destinazione contributi
typeId	Deprecato: ID univoco per sviluppatori locale di questo tipo di widget. ContributionId fornisce un identificatore univoco globale per i tipi di widget.

Dettagli proprietà

allowedSizes

Dimensioni supportate dal widget.

allowedSizes: WidgetSize[]

Valore della proprietà

WidgetSize[]

analyticsServiceRequired

Boolean di consenso esplicito che indica se il widget richiede il funzionamento del servizio di analisi. I widget che richiedono il servizio di analisi sono nascosti dal catalogo se il servizio di analisi non è disponibile.

analyticsServiceRequired: boolean

Valore della proprietà

boolean

catalogIconUrl

Risorsa per un'icona nel catalogo dei widget.

catalogIconUrl: string

Valore della proprietà

string

catalogInfoUrl

Stringa url di consenso esplicito che punta alle informazioni sul widget. Per impostazione predefinita, l'URL del Marketplace delle estensioni viene omesso

catalogInfoUrl: string

Valore della proprietà

string

configurationContributionId

ID del contributo sottostante che definisce l'interfaccia utente di configurazione personalizzata del widget fornita. Null se l'interfaccia utente di configurazione personalizzata non è disponibile.

configurationContributionId: string

Valore della proprietà

string

configurationContributionRelativeId

ID relativo del contributo sottostante che definisce l'interfaccia utente di configurazione personalizzata del widget fornita. Null se l'interfaccia utente di configurazione personalizzata non è disponibile.

configurationContributionRelativeId: string

Valore della proprietà

string

configurationRequired

Indica se il widget richiede la configurazione prima di essere aggiunto al dashboard.

configurationRequired: boolean

Valore della proprietà

boolean

contentUri

Uri per il contenuto del widget da caricare da .

contentUri: string

Valore della proprietà

string

contributionId

ID del contributo sottostante che definisce il widget fornito.

contributionId: string

Valore della proprietà

string

defaultSettings

Impostazioni predefinite facoltative da copiare nelle impostazioni del widget.

defaultSettings: string

Valore della proprietà

string

description

Informazioni di riepilogo che descrivono il widget.

description: string

Valore della proprietà

string

isEnabled

I widget possono essere disabilitati dall'App Store. Sarà necessario gestire correttamente per: - persistenza (consenti) - Richieste (tag disabilitate e fornire contesto)

isEnabled: boolean

Valore della proprietà

boolean

isNameConfigurable

Boolean di rifiuto esplicito che indica se il widget supporta la configurazione del nome/titolo del widget. I widget che ignorano il nome devono impostarlo su false nel manifesto.

isNameConfigurable: boolean

Valore della proprietà

boolean

isVisibleFromCatalog

Boolean di rifiuto esplicito che indica se il widget è nascosto dal catalogo. In genere, viene usato per consentire agli sviluppatori di disabilitare la creazione di un widget deprecato. Un widget deve avere uno stato predefinito funzionale o avere un'esperienza di configurazione per essere visibile dal catalogo.

isVisibleFromCatalog: boolean

Valore della proprietà

boolean

keywords

Parole chiave associate a questo widget, non filtrabili e invisibili

keywords: string[]

Valore della proprietà

string[]

lightboxOptions

Proprietà di consenso esplicito per la personalizzazione della presentazione del widget in una finestra di dialogo "lightbox".

lightboxOptions: LightboxOptions

Valore della proprietà

LightboxOptions

loadingImageUrl

Risorsa per un'immagine segnaposto di caricamento nel dashboard

loadingImageUrl: string

Valore della proprietà

string

name

Nome dell'utente del tipo di widget. Ogni widget deve usare un valore univoco qui.

name: string

Valore della proprietà

string

publisherName

Nome editore di questo tipo di widget.

publisherName: string

Valore della proprietà

string

supportedScopes

Contratto dati necessario per il funzionamento del widget e per il funzionamento nel relativo contenitore.

supportedScopes: WidgetScope[]

Valore della proprietà

WidgetScope[]

tags

Tag associati a questo widget, visibili in ogni widget e filtrabili.

tags: string[]

Valore della proprietà

string[]

targets

ID destinazione contributi

targets: string[]

Valore della proprietà

string[]

typeId

Deprecato: ID univoco per sviluppatori locale di questo tipo di widget. ContributionId fornisce un identificatore univoco globale per i tipi di widget.

typeId: string

Valore della proprietà

string