Freigeben über


WidgetResponse interface

Antwort von RestAPI beim Speichern und Bearbeiten des Widgets

Extends

Geerbte Eigenschaften

allowedSizes

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

areSettingsBlockedForUser

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

artifactId

Bezieht sich auf einen eindeutigen Bezeichner eines Featureartefaktes. Wird zum Anheften und Lösen eines bestimmten Artefakts verwendet.

configurationContributionId
configurationContributionRelativeId
contentUri
contributionId

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

dashboard

Optionaler Teildashboardinhalt zur Unterstützung des Austauschs von Version ETag auf Dashboardebene für APIs auf Widgetebene

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. Dies wird aufgefüllt, wenn der Benutzer das Widget konfigurieren möchte

allowedSizes: WidgetSize[]

Eigenschaftswert

Geerbt vonWidget.allowedSizes

areSettingsBlockedForUser

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

areSettingsBlockedForUser: boolean

Eigenschaftswert

boolean

Geerbt vonWidget.areSettingsBlockedForUser-

artifactId

Bezieht sich auf einen eindeutigen Bezeichner eines Featureartefaktes. Wird zum Anheften und Lösen 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

vonWidget.contentUri geerbt

contributionId

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

contributionId: string

Eigenschaftswert

string

Geerbt vonWidget.contributionId

dashboard

Optionaler Teildashboardinhalt zur Unterstützung des Austauschs von Version ETag auf Dashboardebene für APIs auf Widgetebene

dashboard: Dashboard

Eigenschaftswert

vonWidget.dashboard geerbt

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

vonWidget.lightboxOptions geerbt

loadingImageUrl

loadingImageUrl: string

Eigenschaftswert

string

geerbt vonWidget.loadingImageUrl

name

name: string

Eigenschaftswert

string

geerbt vonWidget.name

position

position: WidgetPosition

Eigenschaftswert

Geerbt vonWidget.position

settings

settings: string

Eigenschaftswert

string

VonWidget.settings geerbt

settingsVersion

settingsVersion: SemanticVersion

Eigenschaftswert

Geerbt vonWidget.settingsVersion

size

size: WidgetSize

Eigenschaftswert

vonWidget.size geerbt

typeId

typeId: string

Eigenschaftswert

string

geerbt vonWidget.typeId

url

url: string

Eigenschaftswert

string

vonWidget.url geerbt