IWidget interface

套件:

azure-devops-extension-api

所有小部件都實現了這個接口

屬性

disableWidgetForStakeholders	架構會呼叫此方法，以判斷是否應該針對具有利害關係人授權的使用者停用小工具
lightbox	在燈箱模式下執行小工具
listen	收聽主持人的信息
load	小工具會使用提供的設定以及伺服器端呼叫來完成其轉譯體驗。 未來，小部件預計將在等待調用完成時提供加載體驗。 在此之前，小部件主機將提供加載體驗
onDashboardLoaded	Widget 會管理初始載入不需要但完整 Widget 體驗所需的任何作業。
preload	小工具會使用提供的設定以及它們可能擁有的任何快取資料來繪製互動式狀態。 小部件不應進行網絡調用。

屬性詳細資料

disableWidgetForStakeholders

架構會呼叫此方法，以判斷是否應該針對具有利害關係人授權的使用者停用小工具

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

屬性值

(widgetSettings: WidgetSettings) => Promise<boolean>

lightbox

在燈箱模式下執行小工具

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

屬性值

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

listen

收聽主持人的信息

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

屬性值

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

load

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

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

屬性值

(widgetSettings: WidgetSettings) => Promise<WidgetStatus>

onDashboardLoaded

Widget 會管理初始載入不需要但完整 Widget 體驗所需的任何作業。

onDashboardLoaded?: () => void

屬性值

() => void

preload

小工具會使用提供的設定以及它們可能擁有的任何快取資料來繪製互動式狀態。 小部件不應進行網絡調用。

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

屬性值

(widgetSettings: WidgetSettings) => Promise<WidgetStatus>