WidgetMetadata interface

Pakket:

azure-devops-extension-api

Informatie op basis van bijdragen die dashboardwidgets beschrijven.

Eigenschappen

allowedSizes	Grootten die worden ondersteund door de widget.
analyticsServiceRequired	Opt-in booleaanse waarde die aangeeft of voor de widget de Analytics-service is vereist om te functioneren. Widgets waarvoor de analyseservice is vereist, worden verborgen in de catalogus als de Analytics-service niet beschikbaar is.
catalogIconUrl	Resource voor een pictogram in de widgetcatalogus.
catalogInfoUrl	Tekenreeks voor opt-in-URL die verwijst naar widgetgegevens. Standaardwaarde voor marketplace-URL voor extensies indien weggelaten
configurationContributionId	De id van de onderliggende bijdrage die de opgegeven aangepaste widgetconfiguratiegebruikersinterface definieert. Null als de aangepaste gebruikersinterface voor configuratie niet beschikbaar is.
configurationContributionRelativeId	De relatieve id van de onderliggende bijdrage die de opgegeven aangepaste widgetconfiguratiegebruikersinterface definieert. Null als de aangepaste gebruikersinterface voor configuratie niet beschikbaar is.
configurationRequired	Geeft aan of de widget configuratie vereist voordat deze aan het dashboard wordt toegevoegd.
contentUri	Uri voor de widgetinhoud die moet worden geladen vanuit .
contributionId	De id van de onderliggende bijdrage die de opgegeven widget definieert.
defaultSettings	Optionele standaardinstellingen die moeten worden gekopieerd naar widgetinstellingen.
description	Samenvattingsinformatie over de widget.
isEnabled	Widgets kunnen worden uitgeschakeld door de App Store. We moeten probleemloos omgaan met: - persistentie (toestaan) - Aanvragen (tag als uitgeschakeld en context bieden)
isNameConfigurable	Opt-out booleaanse waarde die aangeeft of de widget ondersteuning biedt voor widgetnaam/titelconfiguratie. Widgets die de naam negeren, moeten deze instellen op onwaar in het manifest.
isVisibleFromCatalog	Opt-out booleaanse waarde die aangeeft of de widget verborgen is in de catalogus. Dit wordt meestal gebruikt om ontwikkelaars in staat te stellen het maken van een afgeschafte widget uit te schakelen. Een widget moet een functionele standaardstatus hebben of een configuratie-ervaring hebben om zichtbaar te zijn in de catalogus.
keywords	Trefwoorden die zijn gekoppeld aan deze widget, niet-filterbaar en onzichtbaar
lightboxOptions	Opt-in eigenschappen voor het aanpassen van widgetpresentatie in een 'lightbox'-dialoogvenster.
loadingImageUrl	Resource voor het laden van een afbeelding van een tijdelijke aanduiding op het dashboard
name	Gebruikersnaam van het widgettype. Elke widget moet hier een unieke waarde gebruiken.
publisherName	Naam van uitgever van dit soort widget.
supportedScopes	Het gegevenscontract dat nodig is om de widget te laten functioneren en in de container te kunnen werken.
tags	Tags die zijn gekoppeld aan deze widget, zichtbaar voor elke widget en filterbaar.
targets	Doel-id's voor bijdragen
typeId	Afgeschaft: lokaal unieke id voor ontwikkelaars van dit soort widget. ContributionId biedt een globaal unieke id voor widgettypen.

Eigenschapdetails

allowedSizes

Grootten die worden ondersteund door de widget.

allowedSizes: WidgetSize[]

Waarde van eigenschap

WidgetSize[]

analyticsServiceRequired

Opt-in booleaanse waarde die aangeeft of voor de widget de Analytics-service is vereist om te functioneren. Widgets waarvoor de analyseservice is vereist, worden verborgen in de catalogus als de Analytics-service niet beschikbaar is.

analyticsServiceRequired: boolean

Waarde van eigenschap

boolean

catalogIconUrl

Resource voor een pictogram in de widgetcatalogus.

catalogIconUrl: string

Waarde van eigenschap

string

catalogInfoUrl

Tekenreeks voor opt-in-URL die verwijst naar widgetgegevens. Standaardwaarde voor marketplace-URL voor extensies indien weggelaten

catalogInfoUrl: string

Waarde van eigenschap

string

configurationContributionId

De id van de onderliggende bijdrage die de opgegeven aangepaste widgetconfiguratiegebruikersinterface definieert. Null als de aangepaste gebruikersinterface voor configuratie niet beschikbaar is.

configurationContributionId: string

Waarde van eigenschap

string

configurationContributionRelativeId

De relatieve id van de onderliggende bijdrage die de opgegeven aangepaste widgetconfiguratiegebruikersinterface definieert. Null als de aangepaste gebruikersinterface voor configuratie niet beschikbaar is.

configurationContributionRelativeId: string

Waarde van eigenschap

string

configurationRequired

Geeft aan of de widget configuratie vereist voordat deze aan het dashboard wordt toegevoegd.

configurationRequired: boolean

Waarde van eigenschap

boolean

contentUri

Uri voor de widgetinhoud die moet worden geladen vanuit .

contentUri: string

Waarde van eigenschap

string

contributionId

De id van de onderliggende bijdrage die de opgegeven widget definieert.

contributionId: string

Waarde van eigenschap

string

defaultSettings

Optionele standaardinstellingen die moeten worden gekopieerd naar widgetinstellingen.

defaultSettings: string

Waarde van eigenschap

string

description

Samenvattingsinformatie over de widget.

description: string

Waarde van eigenschap

string

isEnabled

Widgets kunnen worden uitgeschakeld door de App Store. We moeten probleemloos omgaan met: - persistentie (toestaan) - Aanvragen (tag als uitgeschakeld en context bieden)

isEnabled: boolean

Waarde van eigenschap

boolean

isNameConfigurable

Opt-out booleaanse waarde die aangeeft of de widget ondersteuning biedt voor widgetnaam/titelconfiguratie. Widgets die de naam negeren, moeten deze instellen op onwaar in het manifest.

isNameConfigurable: boolean

Waarde van eigenschap

boolean

isVisibleFromCatalog

Opt-out booleaanse waarde die aangeeft of de widget verborgen is in de catalogus. Dit wordt meestal gebruikt om ontwikkelaars in staat te stellen het maken van een afgeschafte widget uit te schakelen. Een widget moet een functionele standaardstatus hebben of een configuratie-ervaring hebben om zichtbaar te zijn in de catalogus.

isVisibleFromCatalog: boolean

Waarde van eigenschap

boolean

keywords

Trefwoorden die zijn gekoppeld aan deze widget, niet-filterbaar en onzichtbaar

keywords: string[]

Waarde van eigenschap

string[]

lightboxOptions

Opt-in eigenschappen voor het aanpassen van widgetpresentatie in een 'lightbox'-dialoogvenster.

lightboxOptions: LightboxOptions

Waarde van eigenschap

LightboxOptions

loadingImageUrl

Resource voor het laden van een afbeelding van een tijdelijke aanduiding op het dashboard

loadingImageUrl: string

Waarde van eigenschap

string

name

Gebruikersnaam van het widgettype. Elke widget moet hier een unieke waarde gebruiken.

name: string

Waarde van eigenschap

string

publisherName

Naam van uitgever van dit soort widget.

publisherName: string

Waarde van eigenschap

string

supportedScopes

Het gegevenscontract dat nodig is om de widget te laten functioneren en in de container te kunnen werken.

supportedScopes: WidgetScope[]

Waarde van eigenschap

WidgetScope[]

tags

Tags die zijn gekoppeld aan deze widget, zichtbaar voor elke widget en filterbaar.

tags: string[]

Waarde van eigenschap

string[]

targets

Doel-id's voor bijdragen

targets: string[]

Waarde van eigenschap

string[]

typeId

Afgeschaft: lokaal unieke id voor ontwikkelaars van dit soort widget. ContributionId biedt een globaal unieke id voor widgettypen.

typeId: string

Waarde van eigenschap

string