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