共用方式為

WidgetResponse interface

  • 參考
套件:
azure-devops-extension-api

儲存和編輯小工具時，來自 RestAPI 的回應

Extends
Widget

繼承的屬性

allowedSizes

是指小工具允許的大小。 當使用者想要設定小工具時，就會填入此專案
areSettingsBlockedForUser

從儀錶板服務 Read-Only 屬性。 指出目前用戶的設定是否遭到封鎖。
artifactId

參考功能成品的唯一標識符。 用於釘選+取消釘選特定成品。
configurationContributionId
configurationContributionRelativeId
contentUri
contributionId

定義所提供 Widget 組態之基礎貢獻的標識碼。
dashboard

選擇性的部分儀錶板內容，以支援交換小工具層級 API 的儀錶板層級版本 ETag
eTag
id
isEnabled
isNameConfigurable
lightboxOptions
loadingImageUrl
name
position
settings
settingsVersion
size
typeId
url

繼承的屬性詳細資料

allowedSizes

是指小工具允許的大小。 當使用者想要設定小工具時，就會填入此專案

allowedSizes: WidgetSize[]

屬性值

WidgetSize[]

繼承自Widget.allowedSizes

areSettingsBlockedForUser

從儀錶板服務 Read-Only 屬性。 指出目前用戶的設定是否遭到封鎖。

areSettingsBlockedForUser: boolean

屬性值

boolean

繼承自Widget.areSettingsBlockedForUser

artifactId

參考功能成品的唯一標識符。 用於釘選+取消釘選特定成品。

artifactId: string

屬性值

string

繼承自Widget.artifactId

configurationContributionId 

configurationContributionId: string

屬性值

string

繼承自Widget.configurationContributionId

configurationContributionRelativeId 

configurationContributionRelativeId: string

屬性值

string

繼承自Widget.configurationContributionRelativeId

contentUri 

contentUri: string

屬性值

string

繼承自Widget.contentUri

contributionId

定義所提供 Widget 組態之基礎貢獻的標識碼。

contributionId: string

屬性值

string

繼承自Widget.contributionId

dashboard

選擇性的部分儀錶板內容，以支援交換小工具層級 API 的儀錶板層級版本 ETag

dashboard: Dashboard

屬性值

Dashboard

繼承自Widget.dashboard

eTag 

eTag: string

屬性值

string

繼承自Widget.eTag

id 

id: string

屬性值

string

繼承自Widget.id

isEnabled 

isEnabled: boolean

屬性值

boolean

繼承自Widget.isEnabled

isNameConfigurable 

isNameConfigurable: boolean

屬性值

boolean

繼承自Widget.isNameConfigurable

lightboxOptions 

lightboxOptions: LightboxOptions

屬性值

LightboxOptions

繼承自Widget.lightboxOptions

loadingImageUrl 

loadingImageUrl: string

屬性值

string

繼承自Widget.loadingImageUrl

name 

name: string

屬性值

string

繼承自Widget.name

position 

position: WidgetPosition

屬性值

WidgetPosition

繼承自Widget.position

settings 

settings: string

屬性值

string

繼承自Widget.settings

settingsVersion 

settingsVersion: SemanticVersion

屬性值

SemanticVersion

繼承自Widget.settingsVersion

size 

size: WidgetSize

屬性值

WidgetSize

繼承自Widget.size

typeId 

typeId: string

屬性值

string

繼承自Widget.typeId

url 

url: string

屬性值

string

繼承自Widget.url