WidgetMetadata interface

Balíček:

azure-devops-extension-api

Informace založené na příspěvcích popisující widgety řídicího panelu

Vlastnosti

allowedSizes	Velikosti podporované widgetem.
analyticsServiceRequired	Logická hodnota výslovného souhlasu, která označuje, zda widget vyžaduje ke svému fungování službu Analytics. Widgety vyžadující analytickou službu jsou v katalogu skryty, pokud není analytická služba k dispozici.
catalogIconUrl	Zdroj pro ikonu v katalogu widgetů.
catalogInfoUrl	Řetězec adresy URL pro přihlášení odkazující na informace o widgetu. Výchozí hodnota je adresa URL tržiště rozšíření, pokud je vynechána.
configurationContributionId	ID základního příspěvku definující dodané uživatelské rozhraní vlastní konfigurace widgetu. Null, pokud není k dispozici uživatelské rozhraní vlastní konfigurace.
configurationContributionRelativeId	Relativní id podkladového příspěvku definující zadané uživatelské rozhraní vlastní konfigurace widgetu. Null, pokud není k dispozici uživatelské rozhraní vlastní konfigurace.
configurationRequired	Označuje, zda widget vyžaduje konfiguraci před přidáním na řídicí panel.
contentUri	Identifikátor URI pro obsah widgetu, který má být načten z rozhraní .
contributionId	ID podkladového příspěvku definující dodaný widget.
defaultSettings	Volitelná výchozí nastavení, která lze zkopírovat do nastavení widgetu.
description	Souhrnné informace popisující widget.
isEnabled	Widgety mohou být zakázány v obchodě s aplikacemi. Budeme muset řádně zvládnout pro: - trvalost (Povolit) - Požadavky (Označit jako zakázané a poskytnout kontext)
isNameConfigurable	Booleovská hodnota pro odhlášení, která označuje, zda widget podporuje konfiguraci názvu/názvu widgetu. Widgety, které ignorují název, by jej měly v manifestu nastavit na false.
isVisibleFromCatalog	Booleovská hodnota pro odhlášení označující, zda je widget v katalogu skrytý. Běžně se používá k tomu, aby vývojáři mohli zakázat vytváření zastaralého widgetu. Widget musí mít výchozí funkční stav nebo musí mít konfigurační prostředí, aby byl viditelný v katalogu.
keywords	Klíčová slova spojená s tímto widgetem, nefiltrovatelná a neviditelná
lightboxOptions	Přihlásit vlastnosti pro přizpůsobení prezentace widgetu v dialogovém okně "lightbox".
loadingImageUrl	Zdroj pro načtení zástupného obrázku na řídicí panel
name	Uživatelské jméno typu widgetu. Každý widget zde musí používat jedinečnou hodnotu.
publisherName	Vydavatel Název tohoto typu widgetu.
supportedScopes	Kontrakt dat je vyžadován pro fungování widgetu v jeho kontejneru.
tags	Značky spojené s tímto widgetem, viditelné na každém widgetu a filtrovatelné.
targets	ID cílů příspěvků
typeId	Zastaralé: místně jedinečné ID tohoto druhu widgetu pro vývojáře. ContributionId poskytuje globálně jedinečný identifikátor pro typy widgetů.

Podrobnosti vlastnosti

allowedSizes

Velikosti podporované widgetem.

allowedSizes: WidgetSize[]

Hodnota vlastnosti

WidgetSize[]

analyticsServiceRequired

Logická hodnota výslovného souhlasu, která označuje, zda widget vyžaduje ke svému fungování službu Analytics. Widgety vyžadující analytickou službu jsou v katalogu skryty, pokud není analytická služba k dispozici.

analyticsServiceRequired: boolean

Hodnota vlastnosti

boolean

catalogIconUrl

Zdroj pro ikonu v katalogu widgetů.

catalogIconUrl: string

Hodnota vlastnosti

string

catalogInfoUrl

Řetězec adresy URL pro přihlášení odkazující na informace o widgetu. Výchozí hodnota je adresa URL tržiště rozšíření, pokud je vynechána.

catalogInfoUrl: string

Hodnota vlastnosti

string

configurationContributionId

ID základního příspěvku definující dodané uživatelské rozhraní vlastní konfigurace widgetu. Null, pokud není k dispozici uživatelské rozhraní vlastní konfigurace.

configurationContributionId: string

Hodnota vlastnosti

string

configurationContributionRelativeId

Relativní id podkladového příspěvku definující zadané uživatelské rozhraní vlastní konfigurace widgetu. Null, pokud není k dispozici uživatelské rozhraní vlastní konfigurace.

configurationContributionRelativeId: string

Hodnota vlastnosti

string

configurationRequired

Označuje, zda widget vyžaduje konfiguraci před přidáním na řídicí panel.

configurationRequired: boolean

Hodnota vlastnosti

boolean

contentUri

Identifikátor URI pro obsah widgetu, který má být načten z rozhraní .

contentUri: string

Hodnota vlastnosti

string

contributionId

ID podkladového příspěvku definující dodaný widget.

contributionId: string

Hodnota vlastnosti

string

defaultSettings

Volitelná výchozí nastavení, která lze zkopírovat do nastavení widgetu.

defaultSettings: string

Hodnota vlastnosti

string

description

Souhrnné informace popisující widget.

description: string

Hodnota vlastnosti

string

isEnabled

Widgety mohou být zakázány v obchodě s aplikacemi. Budeme muset řádně zvládnout pro: - trvalost (Povolit) - Požadavky (Označit jako zakázané a poskytnout kontext)

isEnabled: boolean

Hodnota vlastnosti

boolean

isNameConfigurable

Booleovská hodnota pro odhlášení, která označuje, zda widget podporuje konfiguraci názvu/názvu widgetu. Widgety, které ignorují název, by jej měly v manifestu nastavit na false.

isNameConfigurable: boolean

Hodnota vlastnosti

boolean

isVisibleFromCatalog

Booleovská hodnota pro odhlášení označující, zda je widget v katalogu skrytý. Běžně se používá k tomu, aby vývojáři mohli zakázat vytváření zastaralého widgetu. Widget musí mít výchozí funkční stav nebo musí mít konfigurační prostředí, aby byl viditelný v katalogu.

isVisibleFromCatalog: boolean

Hodnota vlastnosti

boolean

keywords

Klíčová slova spojená s tímto widgetem, nefiltrovatelná a neviditelná

keywords: string[]

Hodnota vlastnosti

string[]

lightboxOptions

Přihlásit vlastnosti pro přizpůsobení prezentace widgetu v dialogovém okně "lightbox".

lightboxOptions: LightboxOptions

Hodnota vlastnosti

LightboxOptions

loadingImageUrl

Zdroj pro načtení zástupného obrázku na řídicí panel

loadingImageUrl: string

Hodnota vlastnosti

string

name

Uživatelské jméno typu widgetu. Každý widget zde musí používat jedinečnou hodnotu.

name: string

Hodnota vlastnosti

string

publisherName

Vydavatel Název tohoto typu widgetu.

publisherName: string

Hodnota vlastnosti

string

supportedScopes

Kontrakt dat je vyžadován pro fungování widgetu v jeho kontejneru.

supportedScopes: WidgetScope[]

Hodnota vlastnosti

WidgetScope[]

tags

Značky spojené s tímto widgetem, viditelné na každém widgetu a filtrovatelné.

tags: string[]

Hodnota vlastnosti

string[]

targets

ID cílů příspěvků

targets: string[]

Hodnota vlastnosti

string[]

typeId

Zastaralé: místně jedinečné ID tohoto druhu widgetu pro vývojáře. ContributionId poskytuje globálně jedinečný identifikátor pro typy widgetů.

typeId: string

Hodnota vlastnosti

string