IWidgetConfiguration interface

パッケージ:

azure-devops-extension-api

ウィジェット作成者は、設定用にこのインターフェースを実装します。

プロパティ

listen	ホストからのメッセージをリッスンする
load	ウィジェット構成を設定するためにホストによって呼び出され、ウィジェットと共有されている設定を使用してレンダリング エクスペリエンスが完成します。
onSave	ユーザーが [保存] ボタンをクリックしたときにホストによって呼び出されます。 ウィジェット作成者は、必要に応じて検証を実行することが期待されます。 保存する準備ができたら、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

ユーザーが [保存] ボタンをクリックしたときにホストによって呼び出されます。 ウィジェット作成者は、必要に応じて検証を実行することが期待されます。 保存する準備ができたら、WidgetHelpers.WidgetConfigurationSave.Valid() を使用して、構成からウィジェットのシリアル化されたカスタム設定を返します。 カスタム設定が有効ではなく、保存する準備ができていない場合は、WidgetHelpers.WidgetConfigurationSave.Invalid() を使用して、ホストに保存を停止するように通知します。

onSave: () => Promise<SaveStatus>

プロパティ値

() => Promise<SaveStatus>

onSaveComplete

(オプション)構成を保存する準備ができたとき (ユーザーが構成パネルの [保存] ボタンをクリックしたとき) にホストによって呼び出されます

onSaveComplete?: () => void

プロパティ値

() => void