WidgetMetadata interface

Csomag:

azure-devops-extension-api

Az irányítópult-vezérlőket leíró hozzájáruláson alapuló információk.

Tulajdonságok

allowedSizes	A widget által támogatott méretek.
analyticsServiceRequired	Logikai logikai feliratkozás, amely azt jelzi, hogy a widget működéséhez szükség van-e az Analytics szolgáltatásra. Az elemzési szolgáltatást igénylő widgetek el vannak rejtve a katalógusból, ha az Analytics szolgáltatás nem érhető el.
catalogIconUrl	A widgetkatalógusban található ikon erőforrása.
catalogInfoUrl	Opt-in URL-karakterlánc, amely a widget információira mutat. Alapértelmezés szerint a bővítmény piactéri URL-címe, ha nincs megadva
configurationContributionId	A mögöttes hozzájárulás azonosítója, amely meghatározza a megadott widget egyéni konfigurációs felhasználói felületét. Null, ha az egyéni konfigurációs felhasználói felület nem érhető el.
configurationContributionRelativeId	A mögöttes hozzájárulás relatív azonosítója, amely meghatározza a megadott widget egyéni konfigurációs felhasználói felületét. Null, ha az egyéni konfigurációs felhasználói felület nem érhető el.
configurationRequired	Azt jelzi, hogy a widget konfigurációt igényel-e az irányítópulthoz való hozzáadás előtt.
contentUri	A modul tartalmának URI-ja, amelyet a .
contributionId	A mögöttes hozzájárulás azonosítója, amely meghatározza a megadott widgetet.
defaultSettings	Opcionális alapértelmezett beállítások a widget beállításaiba másolhatók.
description	A widgetet leíró összefoglaló információk.
isEnabled	A widgeteket az alkalmazásbolt letilthatja. Elegánsan kell kezelnünk a következőket: - perzisztencia (engedélyezés) - kérések (címkézés letiltottként, és kontextus megadása)
isNameConfigurable	Leiratkozási logikai érték, amely azt jelzi, hogy a widget támogatja-e a widget nevének/címének konfigurálását. A nevet figyelmen kívül hagyó widgeteknek false (hamis) értékre kell állítaniuk a jegyzékfájlban.
isVisibleFromCatalog	Leiratkozási logikai érték, amely jelzi, hogy a widget el van-e rejtve a katalógusból. Általában ezt arra használják, hogy a fejlesztők letilthassák az elavult widgetek létrehozását. A widgeteknek alapértelmezett működési állapottal vagy konfigurációs felülettel kell rendelkezniük ahhoz, hogy láthatók legyenek a katalógusból.
keywords	A widgethez társított kulcsszavak, nem szűrhető és láthatatlan
lightboxOptions	Opciós tulajdonságok a widget megjelenítésének testreszabásához egy "átvilágítódoboz" párbeszédablakban.
loadingImageUrl	Erőforrás egy betöltési helyőrző képhez az irányítópulton
name	A widget típusának felhasználóhoz néző neve. Itt minden widgetnek egyedi értéket kell használnia.
publisherName	Közzétevő Az ilyen típusú widget neve.
supportedScopes	A widget működéséhez és a tárolójában való működéshez szükséges adatszerződés.
tags	A widgethez társított címkék, amelyek minden widgeten láthatók és szűrhetők.
targets	Hozzájárulási célazonosítók
typeId	Elavult: az ilyen típusú widgetek helyileg egyedi fejlesztői azonosítója. A ContributionId globálisan egyedi azonosítót biztosít a widget típusokhoz.

Tulajdonság adatai

allowedSizes

A widget által támogatott méretek.

allowedSizes: WidgetSize[]

Tulajdonság értéke

WidgetSize[]

analyticsServiceRequired

Logikai logikai feliratkozás, amely azt jelzi, hogy a widget működéséhez szükség van-e az Analytics szolgáltatásra. Az elemzési szolgáltatást igénylő widgetek el vannak rejtve a katalógusból, ha az Analytics szolgáltatás nem érhető el.

analyticsServiceRequired: boolean

Tulajdonság értéke

boolean

catalogIconUrl

A widgetkatalógusban található ikon erőforrása.

catalogIconUrl: string

Tulajdonság értéke

string

catalogInfoUrl

Opt-in URL-karakterlánc, amely a widget információira mutat. Alapértelmezés szerint a bővítmény piactéri URL-címe, ha nincs megadva

catalogInfoUrl: string

Tulajdonság értéke

string

configurationContributionId

A mögöttes hozzájárulás azonosítója, amely meghatározza a megadott widget egyéni konfigurációs felhasználói felületét. Null, ha az egyéni konfigurációs felhasználói felület nem érhető el.

configurationContributionId: string

Tulajdonság értéke

string

configurationContributionRelativeId

A mögöttes hozzájárulás relatív azonosítója, amely meghatározza a megadott widget egyéni konfigurációs felhasználói felületét. Null, ha az egyéni konfigurációs felhasználói felület nem érhető el.

configurationContributionRelativeId: string

Tulajdonság értéke

string

configurationRequired

Azt jelzi, hogy a widget konfigurációt igényel-e az irányítópulthoz való hozzáadás előtt.

configurationRequired: boolean

Tulajdonság értéke

boolean

contentUri

A modul tartalmának URI-ja, amelyet a .

contentUri: string

Tulajdonság értéke

string

contributionId

A mögöttes hozzájárulás azonosítója, amely meghatározza a megadott widgetet.

contributionId: string

Tulajdonság értéke

string

defaultSettings

Opcionális alapértelmezett beállítások a widget beállításaiba másolhatók.

defaultSettings: string

Tulajdonság értéke

string

description

A widgetet leíró összefoglaló információk.

description: string

Tulajdonság értéke

string

isEnabled

A widgeteket az alkalmazásbolt letilthatja. Elegánsan kell kezelnünk a következőket: - perzisztencia (engedélyezés) - kérések (címkézés letiltottként, és kontextus megadása)

isEnabled: boolean

Tulajdonság értéke

boolean

isNameConfigurable

Leiratkozási logikai érték, amely azt jelzi, hogy a widget támogatja-e a widget nevének/címének konfigurálását. A nevet figyelmen kívül hagyó widgeteknek false (hamis) értékre kell állítaniuk a jegyzékfájlban.

isNameConfigurable: boolean

Tulajdonság értéke

boolean

isVisibleFromCatalog

Leiratkozási logikai érték, amely jelzi, hogy a widget el van-e rejtve a katalógusból. Általában ezt arra használják, hogy a fejlesztők letilthassák az elavult widgetek létrehozását. A widgeteknek alapértelmezett működési állapottal vagy konfigurációs felülettel kell rendelkezniük ahhoz, hogy láthatók legyenek a katalógusból.

isVisibleFromCatalog: boolean

Tulajdonság értéke

boolean

keywords

A widgethez társított kulcsszavak, nem szűrhető és láthatatlan

keywords: string[]

Tulajdonság értéke

string[]

lightboxOptions

Opciós tulajdonságok a widget megjelenítésének testreszabásához egy "átvilágítódoboz" párbeszédablakban.

lightboxOptions: LightboxOptions

Tulajdonság értéke

LightboxOptions

loadingImageUrl

Erőforrás egy betöltési helyőrző képhez az irányítópulton

loadingImageUrl: string

Tulajdonság értéke

string

name

A widget típusának felhasználóhoz néző neve. Itt minden widgetnek egyedi értéket kell használnia.

name: string

Tulajdonság értéke

string

publisherName

Közzétevő Az ilyen típusú widget neve.

publisherName: string

Tulajdonság értéke

string

supportedScopes

A widget működéséhez és a tárolójában való működéshez szükséges adatszerződés.

supportedScopes: WidgetScope[]

Tulajdonság értéke

WidgetScope[]

tags

A widgethez társított címkék, amelyek minden widgeten láthatók és szűrhetők.

tags: string[]

Tulajdonság értéke

string[]

targets

Hozzájárulási célazonosítók

targets: string[]

Tulajdonság értéke

string[]

typeId

Elavult: az ilyen típusú widgetek helyileg egyedi fejlesztői azonosítója. A ContributionId globálisan egyedi azonosítót biztosít a widget típusokhoz.

typeId: string

Tulajdonság értéke

string