ConfigurationEvent class

套件:

azure-devops-extension-api

屬性

ConfigurationChange	設定已變更。 收到此事件通知時，預覽會更新，並啟用儲存按鈕。 通知此事件時預期的承載：{ data： customSettings } {customSettings} 是與小工具相關的序列化自訂設定。
ConfigurationError	組態嘗試執行 API 呼叫，但失敗。 當通知此事件時，配置不會轉譯視圖，我們會將錯誤訊息傳遞給配置主機。 通知此事件時預期的承載：{ data： string } {string} 是顯示在組態頂端的錯誤訊息。
GeneralSettingsChanged	小組件組態一般設定已變更。 通知此事件時，會更新小組件名稱或小組件大小。 通知此事件時預期的承載：{ data： { IGeneralSettings } } {generalSettings} 是包含 WidgetName 和 WidgetSize 的序列化物件

方法

Args<T>(T)

屬性詳細資料

ConfigurationChange

設定已變更。 收到此事件通知時，預覽會更新，並啟用儲存按鈕。

通知此事件時預期的承載：{ data： customSettings }

{customSettings} 是與小工具相關的序列化自訂設定。

static ConfigurationChange: string

屬性值

string

ConfigurationError

組態嘗試執行 API 呼叫，但失敗。 當通知此事件時，配置不會轉譯視圖，我們會將錯誤訊息傳遞給配置主機。

通知此事件時預期的承載：{ data： string }

{string} 是顯示在組態頂端的錯誤訊息。

static ConfigurationError: string

屬性值

string

GeneralSettingsChanged

小組件組態一般設定已變更。 通知此事件時，會更新小組件名稱或小組件大小。

通知此事件時預期的承載：{ data： { IGeneralSettings } }

{generalSettings} 是包含 WidgetName 和 WidgetSize 的序列化物件

static GeneralSettingsChanged: string

屬性值

string

方法詳細資料

Args<T>(T)

static function Args<T>(payload: T): EventArgs<T>

參數

payload

T

當我們想要通知配置時傳遞的事件參數。

傳回

EventArgs<T>