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>