WidgetMetadata interface

套件:

azure-devops-extension-api

描述儀錶板小工具的貢獻型資訊。

屬性

allowedSizes	小工具支援的大小。
analyticsServiceRequired	選擇加入布爾值，指出小工具是否需要 Analytics Service 運作。 如果無法使用 Analytics Service，則要求分析服務的 Widget 會從目錄中隱藏。
catalogIconUrl	Widget 目錄中圖標的資源。
catalogInfoUrl	加入加入URL字串，指向小工具資訊。 如果省略，預設為擴充功能市集 URL
configurationContributionId	定義所提供 Widget 自定義組態 UI 的基礎參與標識碼。 如果無法使用自定義組態 UI，則為 Null。
configurationContributionRelativeId	定義所提供 Widget 自定義組態 UI 之基礎貢獻的相對標識碼。 如果無法使用自定義組態 UI，則為 Null。
configurationRequired	指出小工具是否需要設定，才能新增至儀錶板。
contentUri	要從載入之小工具內容的URI。
contributionId	定義所提供 Widget 之基礎貢獻的標識碼。
defaultSettings	要複製到小工具設定的選擇性預設設定。
description	描述小工具的摘要資訊。
isEnabled	應用程式市集可以停用小工具。 我們需要正常處理： - 持續性 （允許） - 要求 （已停用標記，並提供內容）
isNameConfigurable	退出退出布爾值，指出小工具是否支援小工具名稱/標題組態。 忽略名稱的小工具應該在指令清單中將它設定為 false。
isVisibleFromCatalog	退出布爾值，指出小工具是否隱藏在目錄中。 通常，這可用來讓開發人員停用建立已被取代的小工具。 小工具必須具有功能默認狀態，或具有組態體驗，才能從目錄顯示。
keywords	與此小工具相關聯的關鍵詞，不可篩選且不可見
lightboxOptions	加入加入屬性，以在 [lightbox] 對話框中自定義小工具簡報。
loadingImageUrl	儀錶板上載入佔位元影像的資源
name	小工具類型的使用者面向名稱。 每個小工具都必須在這裡使用唯一值。
publisherName	這類小工具的發行者名稱。
supportedScopes	小工具運作及在其容器中運作所需的數據合約。
tags	與這個小工具相關聯的標籤，每個小工具上都可見且可篩選。
targets	貢獻目標標識碼
typeId	已被取代：這種小工具本機唯一的開發人員對應標識碼。 ContributionId 提供小工具類型的全域唯一標識碼。

屬性詳細資料

allowedSizes

小工具支援的大小。

allowedSizes: WidgetSize[]

屬性值

WidgetSize[]

analyticsServiceRequired

選擇加入布爾值，指出小工具是否需要 Analytics Service 運作。 如果無法使用 Analytics Service，則要求分析服務的 Widget 會從目錄中隱藏。

analyticsServiceRequired: boolean

屬性值

boolean

catalogIconUrl

Widget 目錄中圖標的資源。

catalogIconUrl: string

屬性值

string

catalogInfoUrl

加入加入URL字串，指向小工具資訊。 如果省略，預設為擴充功能市集 URL

catalogInfoUrl: string

屬性值

string

configurationContributionId

定義所提供 Widget 自定義組態 UI 的基礎參與標識碼。 如果無法使用自定義組態 UI，則為 Null。

configurationContributionId: string

屬性值

string

configurationContributionRelativeId

定義所提供 Widget 自定義組態 UI 之基礎貢獻的相對標識碼。 如果無法使用自定義組態 UI，則為 Null。

configurationContributionRelativeId: string

屬性值

string

configurationRequired

指出小工具是否需要設定，才能新增至儀錶板。

configurationRequired: boolean

屬性值

boolean

contentUri

要從載入之小工具內容的URI。

contentUri: string

屬性值

string

contributionId

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

contributionId: string

屬性值

string

defaultSettings

要複製到小工具設定的選擇性預設設定。

defaultSettings: string

屬性值

string

description

描述小工具的摘要資訊。

description: string

屬性值

string

isEnabled

應用程式市集可以停用小工具。 我們需要正常處理： - 持續性 （允許） - 要求 （已停用標記，並提供內容）

isEnabled: boolean

屬性值

boolean

isNameConfigurable

退出退出布爾值，指出小工具是否支援小工具名稱/標題組態。 忽略名稱的小工具應該在指令清單中將它設定為 false。

isNameConfigurable: boolean

屬性值

boolean

isVisibleFromCatalog

退出布爾值，指出小工具是否隱藏在目錄中。 通常，這可用來讓開發人員停用建立已被取代的小工具。 小工具必須具有功能默認狀態，或具有組態體驗，才能從目錄顯示。

isVisibleFromCatalog: boolean

屬性值

boolean

keywords

與此小工具相關聯的關鍵詞，不可篩選且不可見

keywords: string[]

屬性值

string[]

lightboxOptions

加入加入屬性，以在 [lightbox] 對話框中自定義小工具簡報。

lightboxOptions: LightboxOptions

屬性值

LightboxOptions

loadingImageUrl

儀錶板上載入佔位元影像的資源

loadingImageUrl: string

屬性值

string

name

小工具類型的使用者面向名稱。 每個小工具都必須在這裡使用唯一值。

name: string

屬性值

string

publisherName

這類小工具的發行者名稱。

publisherName: string

屬性值

string

supportedScopes

小工具運作及在其容器中運作所需的數據合約。

supportedScopes: WidgetScope[]

屬性值

WidgetScope[]

tags

與這個小工具相關聯的標籤，每個小工具上都可見且可篩選。

tags: string[]

屬性值

string[]

targets

貢獻目標標識碼

targets: string[]

屬性值

string[]

typeId

已被取代：這種小工具本機唯一的開發人員對應標識碼。 ContributionId 提供小工具類型的全域唯一標識碼。

typeId: string

屬性值

string