WidgetResponse interface

Paket:

azure-devops-extension-api

Antwort von RestAPI beim Speichern und Bearbeiten des Widgets

Extends

Widget

Geerbte Eigenschaften

allowedSizes	Bezieht sich auf die zulässigen Größen für das Widget. Diese wird aufgefüllt, wenn der Benutzer das Widget konfigurieren möchte.
areSettingsBlockedForUser	Read-Only Eigenschaft vom Dashboarddienst aus. Gibt an, ob Einstellungen für den aktuellen Benutzer blockiert sind.
artifactId	Bezieht sich auf den eindeutigen Bezeichner eines Featureartefakts. Wird zum Anheften und Aufheben eines bestimmten Artefakts verwendet.
configurationContributionId
configurationContributionRelativeId
contentUri
contributionId	Die ID des zugrunde liegenden Beitrags, der die angegebene Widgetkonfiguration definiert.
dashboard	Optionale partielle Dashboard Inhalte, um den Austausch von ETag-Versionen auf Dashboard-Ebene gegen APIs auf Widgetebene zu unterstützen
eTag
id
isEnabled
isNameConfigurable
lightboxOptions
loadingImageUrl
name
position
settings
settingsVersion
size
typeId
url

Geerbte Eigenschaftsdetails

allowedSizes

Bezieht sich auf die zulässigen Größen für das Widget. Diese wird aufgefüllt, wenn der Benutzer das Widget konfigurieren möchte.

allowedSizes: WidgetSize[]

Eigenschaftswert

WidgetSize[]

Geerbt vonWidget.allowedSizes

areSettingsBlockedForUser

Read-Only Eigenschaft vom Dashboarddienst aus. Gibt an, ob Einstellungen für den aktuellen Benutzer blockiert sind.

areSettingsBlockedForUser: boolean

Eigenschaftswert

boolean

Geerbt vonWidget.areSettingsBlockedForUser

artifactId

Bezieht sich auf den eindeutigen Bezeichner eines Featureartefakts. Wird zum Anheften und Aufheben eines bestimmten Artefakts verwendet.

artifactId: string

Eigenschaftswert

string

Geerbt vonWidget.artifactId

configurationContributionId

configurationContributionId: string

Eigenschaftswert

string

Geerbt vonWidget.configurationContributionId

configurationContributionRelativeId

configurationContributionRelativeId: string

Eigenschaftswert

string

Geerbt vonWidget.configurationContributionRelativeId

contentUri

contentUri: string

Eigenschaftswert

string

Geerbt vonWidget.contentUri

contributionId

Die ID des zugrunde liegenden Beitrags, der die angegebene Widgetkonfiguration definiert.

contributionId: string

Eigenschaftswert

string

Geerbt vonWidget.contributionId

dashboard

Optionale partielle Dashboard Inhalte, um den Austausch von ETag-Versionen auf Dashboard-Ebene gegen APIs auf Widgetebene zu unterstützen

dashboard: Dashboard

Eigenschaftswert

Dashboard

Geerbt vonWidget.Dashboard

eTag

eTag: string

Eigenschaftswert

string

Geerbt vonWidget.eTag

id

id: string

Eigenschaftswert

string

Geerbt vonWidget.id

isEnabled

isEnabled: boolean

Eigenschaftswert

boolean

Geerbt vonWidget.isEnabled

isNameConfigurable

isNameConfigurable: boolean

Eigenschaftswert

boolean

Geerbt vonWidget.isNameConfigurable

lightboxOptions

lightboxOptions: LightboxOptions

Eigenschaftswert

LightboxOptions

Geerbt vonWidget.lightboxOptions

loadingImageUrl

loadingImageUrl: string

Eigenschaftswert

string

Geerbt vonWidget.loadingImageUrl

name

name: string

Eigenschaftswert

string

Geerbt vonWidget.name

position

position: WidgetPosition

Eigenschaftswert

WidgetPosition

Geerbt vonWidget.position

settings

settings: string

Eigenschaftswert

string

Geerbt vonWidget.settings

settingsVersion

settingsVersion: SemanticVersion

Eigenschaftswert

SemanticVersion

Geerbt vonWidget.settingsVersion

size

size: WidgetSize

Eigenschaftswert

WidgetSize

Geerbt vonWidget.size

typeId

typeId: string

Eigenschaftswert

string

Geerbt vonWidget.typeId

url

url: string

Eigenschaftswert

string

Geerbt vonWidget.url