IWidgetConfiguration interface

套件:

azure-devops-extension-api

Widget作者會針對其設定實作此介面。

屬性

listen	收聽主持人的信息
load	由主機呼叫以設定小工具組態，該組態使用與小工具共用的設定來完成其轉譯體驗。
onSave	當使用者按一下「儲存」按鈕時，由主機呼叫。 Widget 作者應視需要執行驗證。 如果準備好儲存，請使用 WidgetHelpers.WidgetConfigurationSave.Valid（） 從配置中傳回小組件的序列化自訂設定。 如果自訂設定無效，因此尚未準備好儲存，請使用 WidgetHelpers.WidgetConfigurationSave.Invalid（） 通知主機停止儲存。
onSaveComplete	（選用）當配置準備好儲存時，由主機呼叫 （當使用者按一下配置面板上的儲存按鈕時）

屬性詳細資料

listen

收聽主持人的信息

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

屬性值

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

load

由主機呼叫以設定小工具組態，該組態使用與小工具共用的設定來完成其轉譯體驗。

load: (widgetSettings: WidgetSettings, widgetConfigurationContext: IWidgetConfigurationContext) => Promise<WidgetStatus>

屬性值

(widgetSettings: WidgetSettings, widgetConfigurationContext: IWidgetConfigurationContext) => Promise<WidgetStatus>

onSave

當使用者按一下「儲存」按鈕時，由主機呼叫。 Widget 作者應視需要執行驗證。 如果準備好儲存，請使用 WidgetHelpers.WidgetConfigurationSave.Valid（） 從配置中傳回小組件的序列化自訂設定。 如果自訂設定無效，因此尚未準備好儲存，請使用 WidgetHelpers.WidgetConfigurationSave.Invalid（） 通知主機停止儲存。

onSave: () => Promise<SaveStatus>

屬性值

() => Promise<SaveStatus>

onSaveComplete

（選用）當配置準備好儲存時，由主機呼叫 （當使用者按一下配置面板上的儲存按鈕時）

onSaveComplete?: () => void

屬性值

() => void