Edit

Share via

WidgetResponse interface

  • Reference
Package:
azure-devops-extension-api

Response from RestAPI when saving and editing Widget

Extends
Widget

Inherited Properties

allowedSizes

Refers to the allowed sizes for the widget. This gets populated when user wants to configure the widget
areSettingsBlockedForUser

Read-Only Property from Dashboard Service. Indicates if settings are blocked for the current user.
artifactId

Refers to unique identifier of a feature artifact. Used for pinning+unpinning a specific artifact.
configurationContributionId
configurationContributionRelativeId
contentUri
contributionId

The id of the underlying contribution defining the supplied Widget Configuration.
dashboard

Optional partial dashboard content, to support exchanging dashboard-level version ETag for widget-level APIs
eTag
id
isEnabled
isNameConfigurable
lightboxOptions
loadingImageUrl
name
position
settings
settingsVersion
size
typeId
url

Inherited Property Details

allowedSizes

Refers to the allowed sizes for the widget. This gets populated when user wants to configure the widget

allowedSizes: WidgetSize[]

Property Value

WidgetSize[]

Inherited From Widget.allowedSizes

areSettingsBlockedForUser

Read-Only Property from Dashboard Service. Indicates if settings are blocked for the current user.

areSettingsBlockedForUser: boolean

Property Value

boolean

Inherited From Widget.areSettingsBlockedForUser

artifactId

Refers to unique identifier of a feature artifact. Used for pinning+unpinning a specific artifact.

artifactId: string

Property Value

string

Inherited From Widget.artifactId

configurationContributionId 

configurationContributionId: string

Property Value

string

Inherited From Widget.configurationContributionId

configurationContributionRelativeId 

configurationContributionRelativeId: string

Property Value

string

Inherited From Widget.configurationContributionRelativeId

contentUri 

contentUri: string

Property Value

string

Inherited From Widget.contentUri

contributionId

The id of the underlying contribution defining the supplied Widget Configuration.

contributionId: string

Property Value

string

Inherited From Widget.contributionId

dashboard

Optional partial dashboard content, to support exchanging dashboard-level version ETag for widget-level APIs

dashboard: Dashboard

Property Value

Dashboard

Inherited From Widget.dashboard

eTag 

eTag: string

Property Value

string

Inherited From Widget.eTag

id 

id: string

Property Value

string

Inherited From Widget.id

isEnabled 

isEnabled: boolean

Property Value

boolean

Inherited From Widget.isEnabled

isNameConfigurable 

isNameConfigurable: boolean

Property Value

boolean

Inherited From Widget.isNameConfigurable

lightboxOptions 

lightboxOptions: LightboxOptions

Property Value

LightboxOptions

Inherited From Widget.lightboxOptions

loadingImageUrl 

loadingImageUrl: string

Property Value

string

Inherited From Widget.loadingImageUrl

name 

name: string

Property Value

string

Inherited From Widget.name

position 

position: WidgetPosition

Property Value

WidgetPosition

Inherited From Widget.position

settings 

settings: string

Property Value

string

Inherited From Widget.settings

settingsVersion 

settingsVersion: SemanticVersion

Property Value

SemanticVersion

Inherited From Widget.settingsVersion

size 

size: WidgetSize

Property Value

WidgetSize

Inherited From Widget.size

typeId 

typeId: string

Property Value

string

Inherited From Widget.typeId

url 

url: string

Property Value

string

Inherited From Widget.url