IWidget interface

パッケージ:

azure-devops-extension-api

すべてのウィジェットでこのインターフェイスが実装されます

プロパティ

disableWidgetForStakeholders	フレームワークは、このメソッドを呼び出して、利害関係者ライセンスを持つユーザーに対してウィジェットを無効にする必要があるかどうかを判断します
lightbox	ライトボックス モードでウィジェットを実行する
listen	ホストからのメッセージをリッスンする
load	ウィジェットでは、提供された設定とサーバー側の呼び出しを使用して、レンダリング エクスペリエンスを完了します。 今後、ウィジェットは、呼び出しの完了を待機している間に読み込みエクスペリエンスを提供することが期待されます。 それまでは、ウィジェット ホストは読み込みエクスペリエンスを提供します
onDashboardLoaded	ウィジェットは、初期読み込みに必要ないが、完全なウィジェット エクスペリエンスに必要な操作を管理します。
preload	ウィジェットは、対話型の状態を描画するために必要なキャッシュされたデータと共に提供される設定を使用します。 ウィジェットでネットワーク呼び出しを行う必要はありません。

プロパティの詳細

disableWidgetForStakeholders

フレームワークは、このメソッドを呼び出して、利害関係者ライセンスを持つユーザーに対してウィジェットを無効にする必要があるかどうかを判断します

disableWidgetForStakeholders?: (widgetSettings: WidgetSettings) => Promise<boolean>

プロパティ値

(widgetSettings: WidgetSettings) => Promise<boolean>

lightbox

ライトボックス モードでウィジェットを実行する

lightbox?: (widgetSettings: WidgetSettings, lightboxSize: Size) => Promise<WidgetStatus>

プロパティ値

(widgetSettings: WidgetSettings, lightboxSize: Size) => Promise<WidgetStatus>

listen

ホストからのメッセージをリッスンする

listen?: (event: string, eventArgs: EventArgs<T>) => void

プロパティ値

(event: string, eventArgs: EventArgs<T>) => void

load

ウィジェットでは、提供された設定とサーバー側の呼び出しを使用して、レンダリング エクスペリエンスを完了します。 今後、ウィジェットは、呼び出しの完了を待機している間に読み込みエクスペリエンスを提供することが期待されます。 それまでは、ウィジェット ホストは読み込みエクスペリエンスを提供します

load: (widgetSettings: WidgetSettings) => Promise<WidgetStatus>

プロパティ値

(widgetSettings: WidgetSettings) => Promise<WidgetStatus>

onDashboardLoaded

ウィジェットは、初期読み込みに必要ないが、完全なウィジェット エクスペリエンスに必要な操作を管理します。

onDashboardLoaded?: () => void

プロパティ値

() => void

preload

ウィジェットは、対話型の状態を描画するために必要なキャッシュされたデータと共に提供される設定を使用します。 ウィジェットでネットワーク呼び出しを行う必要はありません。

preload: (widgetSettings: WidgetSettings) => Promise<WidgetStatus>

プロパティ値

(widgetSettings: WidgetSettings) => Promise<WidgetStatus>