IConfigurableWidget interface

參考

套件:: azure-devops-extension-api

可設定的小工具會實作這個介面

Extends: IWidget

屬性

當組態檢視變更時，小工具應該會更新其檢視。

繼承的屬性

disableWidgetForStakeholders	架構會呼叫此方法，以判斷是否應為具有專案關係人授權的使用者停用小工具
lightbox	在 Lightboxed 模式中執行小工具
listen	接聽來自主機的訊息
load	小工具會使用提供的設定，以及伺服器端呼叫來完成其轉譯體驗。未來，小工具預期會在等候呼叫完成時提供載入體驗。在此之前，小工具主機將提供載入體驗
onDashboardLoaded	小工具會管理初始載入不需要的任何作業，但對於完整的小工具體驗而言是必要的。
preload	小工具會使用所提供的設定，以及可能必須繪製互動式狀態的任何快取數據。小工具不應進行網路呼叫。

屬性詳細資料

reload

當組態檢視變更時，小工具應該會更新其檢視。

reload: (newWidgetSettings: WidgetSettings) => Promise<WidgetStatus>

屬性值

(newWidgetSettings: WidgetSettings) => Promise<WidgetStatus>

繼承的屬性詳細資料

disableWidgetForStakeholders

架構會呼叫此方法，以判斷是否應為具有專案關係人授權的使用者停用小工具

disableWidgetForStakeholders?: (widgetSettings: WidgetSettings) => Promise<boolean>

屬性值

(widgetSettings: WidgetSettings) => Promise<boolean>

繼承自IWidget.disableWidgetForStakeholders

在 Lightboxed 模式中執行小工具

lightbox?: (widgetSettings: WidgetSettings, lightboxSize: Size) => Promise<WidgetStatus>

屬性值

(widgetSettings: WidgetSettings, lightboxSize: Size) => Promise<WidgetStatus>

繼承自IWidget.lightbox

listen

接聽來自主機的訊息

listen?: (event: string, eventArgs: EventArgs<T>) => void

屬性值

(event: string, eventArgs: EventArgs<T>) => void

繼承自IWidget.listen

load

小工具會使用提供的設定，以及伺服器端呼叫來完成其轉譯體驗。未來，小工具預期會在等候呼叫完成時提供載入體驗。在此之前，小工具主機將提供載入體驗

load: (widgetSettings: WidgetSettings) => Promise<WidgetStatus>

屬性值

(widgetSettings: WidgetSettings) => Promise<WidgetStatus>

繼承自IWidget.load

onDashboardLoaded

小工具會管理初始載入不需要的任何作業，但對於完整的小工具體驗而言是必要的。

onDashboardLoaded?: () => void

屬性值

() => void

繼承自IWidget.onDashboardLoaded

preload

小工具會使用所提供的設定，以及可能必須繪製互動式狀態的任何快取數據。小工具不應進行網路呼叫。

preload: (widgetSettings: WidgetSettings) => Promise<WidgetStatus>

屬性值