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