WidgetMetadata interface

Paket:

azure-devops-extension-api

Beitragsbasierte Informationen zur Beschreibung von Dashboard-Widgets.

Eigenschaften

allowedSizes	Vom Widget unterstützte Größen.
analyticsServiceRequired	Opt-In vom Typ Boolean, der angibt, ob das Widget die Funktion des Analysediensts erfordert. Widgets, die den Analysedienst erfordern, werden im Katalog ausgeblendet, wenn der Analysedienst nicht verfügbar ist.
catalogIconUrl	Ressource für ein Symbol im Widgetkatalog.
catalogInfoUrl	Anmelde-URL-Zeichenfolge, die auf Widgetinformationen verweist. Standardeinstellung für die Erweiterungs-Marketplace-URL, wenn diese nicht angegeben wird
configurationContributionId	Die ID des zugrunde liegenden Beitrags, der die bereitgestellte benutzerdefinierte Widget-Konfigurationsbenutzeroberfläche definiert. Null, wenn benutzerdefinierte Konfigurations-UI nicht verfügbar ist.
configurationContributionRelativeId	Die relative ID des zugrunde liegenden Beitrags, der die bereitgestellte benutzerdefinierte Widget-Konfigurationsbenutzeroberfläche definiert. Null, wenn benutzerdefinierte Konfigurations-UI nicht verfügbar ist.
configurationRequired	Gibt an, ob für das Widget eine Konfiguration erforderlich ist, bevor sie dem Dashboard hinzugefügt wird.
contentUri	URI für den Widgetinhalt, aus dem geladen werden soll.
contributionId	Die ID des zugrunde liegenden Beitrags, der das angegebene Widget definiert.
defaultSettings	Optionale Standardeinstellungen, die in Widgeteinstellungen kopiert werden sollen.
description	Zusammenfassungsinformationen zur Beschreibung des Widgets.
isEnabled	Widgets können vom App Store deaktiviert werden. Wir müssen ordnungsgemäß behandeln für: - Persistenz (Zulassen) – Anforderungen (Tag als deaktiviert und Kontext bereitstellen)
isNameConfigurable	Boolescher Opt-out-Wert, der angibt, ob das Widget die Konfiguration von Widget-Name/-Titel unterstützt. Widgets, die den Namen ignorieren, sollten ihn im Manifest auf "false" festlegen.
isVisibleFromCatalog	Abmelden vom Typ Boolean, der angibt, ob das Widget im Katalog ausgeblendet ist. Dies wird häufig verwendet, um Entwicklern das Deaktivieren der Erstellung eines veralteten Widgets zu ermöglichen. Ein Widget muss über einen funktionalen Standardzustand verfügen oder über eine Konfigurationsoberfläche verfügen, um im Katalog sichtbar zu sein.
keywords	Diesem Widget zugeordnete Schlüsselwörter, nicht filterbar und unsichtbar
lightboxOptions	Opt-In-Eigenschaften zum Anpassen der Widgetpräsentation in einem Dialogfeld "Lightbox".
loadingImageUrl	Ressource für ein Ladeplatzhalterbild auf dem Dashboard
name	Benutzername des Widgettyps. Jedes Widget muss hier einen eindeutigen Wert verwenden.
publisherName	Herausgebername dieser Art von Widget.
supportedScopes	Datenvertrag erforderlich, damit das Widget funktioniert und in seinem Container funktioniert.
tags	Tags, die diesem Widget zugeordnet sind und für jedes Widget sichtbar sind und gefiltert werden können.
targets	Ziel-IDs für Beiträge
typeId	Veraltet: lokal eindeutige Entwickler-ID dieser Art von Widget. "ContributionId" stellt einen global eindeutigen Bezeichner für Widgettypen bereit.

Details zur Eigenschaft

allowedSizes

Vom Widget unterstützte Größen.

allowedSizes: WidgetSize[]

Eigenschaftswert

WidgetSize[]

analyticsServiceRequired

Opt-In vom Typ Boolean, der angibt, ob das Widget die Funktion des Analysediensts erfordert. Widgets, die den Analysedienst erfordern, werden im Katalog ausgeblendet, wenn der Analysedienst nicht verfügbar ist.

analyticsServiceRequired: boolean

Eigenschaftswert

boolean

catalogIconUrl

Ressource für ein Symbol im Widgetkatalog.

catalogIconUrl: string

Eigenschaftswert

string

catalogInfoUrl

Anmelde-URL-Zeichenfolge, die auf Widgetinformationen verweist. Standardeinstellung für die Erweiterungs-Marketplace-URL, wenn diese nicht angegeben wird

catalogInfoUrl: string

Eigenschaftswert

string

configurationContributionId

Die ID des zugrunde liegenden Beitrags, der die bereitgestellte benutzerdefinierte Widget-Konfigurationsbenutzeroberfläche definiert. Null, wenn benutzerdefinierte Konfigurations-UI nicht verfügbar ist.

configurationContributionId: string

Eigenschaftswert

string

configurationContributionRelativeId

Die relative ID des zugrunde liegenden Beitrags, der die bereitgestellte benutzerdefinierte Widget-Konfigurationsbenutzeroberfläche definiert. Null, wenn benutzerdefinierte Konfigurations-UI nicht verfügbar ist.

configurationContributionRelativeId: string

Eigenschaftswert

string

configurationRequired

Gibt an, ob für das Widget eine Konfiguration erforderlich ist, bevor sie dem Dashboard hinzugefügt wird.

configurationRequired: boolean

Eigenschaftswert

boolean

contentUri

URI für den Widgetinhalt, aus dem geladen werden soll.

contentUri: string

Eigenschaftswert

string

contributionId

Die ID des zugrunde liegenden Beitrags, der das angegebene Widget definiert.

contributionId: string

Eigenschaftswert

string

defaultSettings

Optionale Standardeinstellungen, die in Widgeteinstellungen kopiert werden sollen.

defaultSettings: string

Eigenschaftswert

string

description

Zusammenfassungsinformationen zur Beschreibung des Widgets.

description: string

Eigenschaftswert

string

isEnabled

Widgets können vom App Store deaktiviert werden. Wir müssen ordnungsgemäß behandeln für: - Persistenz (Zulassen) – Anforderungen (Tag als deaktiviert und Kontext bereitstellen)

isEnabled: boolean

Eigenschaftswert

boolean

isNameConfigurable

Boolescher Opt-out-Wert, der angibt, ob das Widget die Konfiguration von Widget-Name/-Titel unterstützt. Widgets, die den Namen ignorieren, sollten ihn im Manifest auf "false" festlegen.

isNameConfigurable: boolean

Eigenschaftswert

boolean

isVisibleFromCatalog

Abmelden vom Typ Boolean, der angibt, ob das Widget im Katalog ausgeblendet ist. Dies wird häufig verwendet, um Entwicklern das Deaktivieren der Erstellung eines veralteten Widgets zu ermöglichen. Ein Widget muss über einen funktionalen Standardzustand verfügen oder über eine Konfigurationsoberfläche verfügen, um im Katalog sichtbar zu sein.

isVisibleFromCatalog: boolean

Eigenschaftswert

boolean

keywords

Diesem Widget zugeordnete Schlüsselwörter, nicht filterbar und unsichtbar

keywords: string[]

Eigenschaftswert

string[]

lightboxOptions

Opt-In-Eigenschaften zum Anpassen der Widgetpräsentation in einem Dialogfeld "Lightbox".

lightboxOptions: LightboxOptions

Eigenschaftswert

LightboxOptions

loadingImageUrl

Ressource für ein Ladeplatzhalterbild auf dem Dashboard

loadingImageUrl: string

Eigenschaftswert

string

name

Benutzername des Widgettyps. Jedes Widget muss hier einen eindeutigen Wert verwenden.

name: string

Eigenschaftswert

string

publisherName

Herausgebername dieser Art von Widget.

publisherName: string

Eigenschaftswert

string

supportedScopes

Datenvertrag erforderlich, damit das Widget funktioniert und in seinem Container funktioniert.

supportedScopes: WidgetScope[]

Eigenschaftswert

WidgetScope[]

tags

Tags, die diesem Widget zugeordnet sind und für jedes Widget sichtbar sind und gefiltert werden können.

tags: string[]

Eigenschaftswert

string[]

targets

Ziel-IDs für Beiträge

targets: string[]

Eigenschaftswert

string[]

typeId

Veraltet: lokal eindeutige Entwickler-ID dieser Art von Widget. "ContributionId" stellt einen global eindeutigen Bezeichner für Widgettypen bereit.

typeId: string

Eigenschaftswert

string