WidgetMetadata interface

Paket:

azure-devops-extension-api

Bidragsbaserad information som beskriver Dashboard Widgets.

Egenskaper

allowedSizes	Storlekar som stöds av widgeten.
analyticsServiceRequired	Opt-in boolesk som anger om widgeten kräver att Analytics-tjänsten fungerar. Widgetar som kräver analystjänsten döljs från katalogen om analystjänsten inte är tillgänglig.
catalogIconUrl	Resurs för en ikon i widgetkatalogen.
catalogInfoUrl	URL-sträng för anmälan som pekar på widgetinformation. Standardvärdet är URL:en för marknadsplatsen för tillägg om den utelämnas
configurationContributionId	ID:t för det underliggande bidraget som definierar det angivna användargränssnittet för anpassad konfiguration av widgeten. Null om användargränssnittet för anpassad konfiguration inte är tillgängligt.
configurationContributionRelativeId	Det relativa ID:t för det underliggande bidraget som definierar det angivna användargränssnittet för anpassad konfiguration av widgeten. Null om användargränssnittet för anpassad konfiguration inte är tillgängligt.
configurationRequired	Anger om widgeten kräver konfiguration innan den läggs till på instrumentpanelen.
contentUri	URI för widgetinnehållet som ska läsas in från .
contributionId	ID:t för det underliggande bidraget som definierar den angivna widgeten.
defaultSettings	Valfria standardinställningar som ska kopieras till widgetinställningar.
description	Sammanfattande information som beskriver widgeten.
isEnabled	Widgets kan inaktiveras av appbutiken. Vi måste hantera följande på ett smidigt sätt: – beständighet (Tillåt) – Begäranden (Tagga som inaktiverat och ge kontext)
isNameConfigurable	Avanmäl dig booleskt som anger om widgeten stöder konfiguration av widgetnamn/titel. Widgetar som ignorerar namnet ska ange det till false i manifestet.
isVisibleFromCatalog	Avanmäl dig booleskt som anger om widgeten är dold från katalogen. Vanligtvis används detta för att tillåta utvecklare att inaktivera skapandet av en föråldrad widget. En widget måste ha ett funktionellt standardtillstånd eller ha en konfigurationsupplevelse för att visas i katalogen.
keywords	Nyckelord som är associerade med den här widgeten, icke-filtrerbara och osynliga
lightboxOptions	Opt-in-egenskaper för att anpassa widgetpresentationer i en "lightbox"-dialogruta.
loadingImageUrl	Resurs för en platshållarbild för inläsning på instrumentpanelen
name	Användarriktat namn på widgettypen. Varje widget måste använda ett unikt värde här.
publisherName	Utgivare: Namnet på den här typen av widget.
supportedScopes	Datakontrakt som krävs för att widgeten ska fungera och fungera i containern.
tags	Taggar som är associerade med den här widgeten, synliga på varje widget och filtrerbara.
targets	Mål-ID:n för bidrag
typeId	Inaktuell: lokalt unikt utvecklarriktat ID för den här typen av widget. ContributionId tillhandahåller en globalt unik identifierare för widgettyper.

Egenskapsinformation

allowedSizes

Storlekar som stöds av widgeten.

allowedSizes: WidgetSize[]

Egenskapsvärde

WidgetSize[]

analyticsServiceRequired

Opt-in boolesk som anger om widgeten kräver att Analytics-tjänsten fungerar. Widgetar som kräver analystjänsten döljs från katalogen om analystjänsten inte är tillgänglig.

analyticsServiceRequired: boolean

Egenskapsvärde

boolean

catalogIconUrl

Resurs för en ikon i widgetkatalogen.

catalogIconUrl: string

Egenskapsvärde

string

catalogInfoUrl

URL-sträng för anmälan som pekar på widgetinformation. Standardvärdet är URL:en för marknadsplatsen för tillägg om den utelämnas

catalogInfoUrl: string

Egenskapsvärde

string

configurationContributionId

ID:t för det underliggande bidraget som definierar det angivna användargränssnittet för anpassad konfiguration av widgeten. Null om användargränssnittet för anpassad konfiguration inte är tillgängligt.

configurationContributionId: string

Egenskapsvärde

string

configurationContributionRelativeId

Det relativa ID:t för det underliggande bidraget som definierar det angivna användargränssnittet för anpassad konfiguration av widgeten. Null om användargränssnittet för anpassad konfiguration inte är tillgängligt.

configurationContributionRelativeId: string

Egenskapsvärde

string

configurationRequired

Anger om widgeten kräver konfiguration innan den läggs till på instrumentpanelen.

configurationRequired: boolean

Egenskapsvärde

boolean

contentUri

URI för widgetinnehållet som ska läsas in från .

contentUri: string

Egenskapsvärde

string

contributionId

ID:t för det underliggande bidraget som definierar den angivna widgeten.

contributionId: string

Egenskapsvärde

string

defaultSettings

Valfria standardinställningar som ska kopieras till widgetinställningar.

defaultSettings: string

Egenskapsvärde

string

description

Sammanfattande information som beskriver widgeten.

description: string

Egenskapsvärde

string

isEnabled

Widgets kan inaktiveras av appbutiken. Vi måste hantera följande på ett smidigt sätt: – beständighet (Tillåt) – Begäranden (Tagga som inaktiverat och ge kontext)

isEnabled: boolean

Egenskapsvärde

boolean

isNameConfigurable

Avanmäl dig booleskt som anger om widgeten stöder konfiguration av widgetnamn/titel. Widgetar som ignorerar namnet ska ange det till false i manifestet.

isNameConfigurable: boolean

Egenskapsvärde

boolean

isVisibleFromCatalog

Avanmäl dig booleskt som anger om widgeten är dold från katalogen. Vanligtvis används detta för att tillåta utvecklare att inaktivera skapandet av en föråldrad widget. En widget måste ha ett funktionellt standardtillstånd eller ha en konfigurationsupplevelse för att visas i katalogen.

isVisibleFromCatalog: boolean

Egenskapsvärde

boolean

keywords

Nyckelord som är associerade med den här widgeten, icke-filtrerbara och osynliga

keywords: string[]

Egenskapsvärde

string[]

lightboxOptions

Opt-in-egenskaper för att anpassa widgetpresentationer i en "lightbox"-dialogruta.

lightboxOptions: LightboxOptions

Egenskapsvärde

LightboxOptions

loadingImageUrl

Resurs för en platshållarbild för inläsning på instrumentpanelen

loadingImageUrl: string

Egenskapsvärde

string

name

Användarriktat namn på widgettypen. Varje widget måste använda ett unikt värde här.

name: string

Egenskapsvärde

string

publisherName

Utgivare: Namnet på den här typen av widget.

publisherName: string

Egenskapsvärde

string

supportedScopes

Datakontrakt som krävs för att widgeten ska fungera och fungera i containern.

supportedScopes: WidgetScope[]

Egenskapsvärde

WidgetScope[]

tags

Taggar som är associerade med den här widgeten, synliga på varje widget och filtrerbara.

tags: string[]

Egenskapsvärde

string[]

targets

Mål-ID:n för bidrag

targets: string[]

Egenskapsvärde

string[]

typeId

Inaktuell: lokalt unikt utvecklarriktat ID för den här typen av widget. ContributionId tillhandahåller en globalt unik identifierare för widgettyper.

typeId: string

Egenskapsvärde

string