IWidgetConfiguration interface

套件:

azure-devops-extension-api

小工具作者會針對其設定實作此介面。

屬性

listen	接聽來自主機的訊息
load	由主機呼叫以設定小工具組態，其會使用與小工具共用的設定來完成其轉譯體驗。
onSave	當使用者按兩下 [儲存] 按鈕時，由主機呼叫。 小工具作者應該視需要執行驗證。 如果準備好儲存，請使用 WidgetHelpers.WidgetConfigurationSave.Valid () 從 configuraton 傳回小工具的串行化自定義設定。 如果自定義設定無效，因此尚未準備好儲存，請使用 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

當使用者按兩下 [儲存] 按鈕時，由主機呼叫。 小工具作者應該視需要執行驗證。 如果準備好儲存，請使用 WidgetHelpers.WidgetConfigurationSave.Valid () 從 configuraton 傳回小工具的串行化自定義設定。 如果自定義設定無效，因此尚未準備好儲存，請使用 WidgetHelpers.WidgetConfigurationSave.Invalid () 通知主機停止儲存。

onSave: () => Promise<SaveStatus>

屬性值

() => Promise<SaveStatus>

onSaveComplete

(當使用者按兩下組態面板上的 [儲存] 按鈕時，由主機呼叫的選擇性) 設定已準備好儲存 ()

onSaveComplete?: () => void

屬性值

() => void