IConfigurableWidget interface

参考

包:: azure-devops-extension-api

可配置的小组件实现此接口

Extends: IWidget

属性

更改配置视图时，小组件应更新其视图。

继承属性

disableWidgetForStakeholders	框架调用此方法以确定是否应为具有利益干系人许可证的用户禁用小组件
lightbox	在轻型装箱模式下运行小组件
listen	侦听来自主机的消息
load	小组件使用提供的设置以及服务器端调用来完成其呈现体验。将来，小组件应在等待调用完成时提供加载体验。在此之前，小组件主机将提供加载体验
onDashboardLoaded	小组件管理初始加载不需要但完整小组件体验所需的任何操作。
preload	小组件使用所提供的设置以及它们可能必须绘制交互式状态的任何缓存数据。小组件不应进行网络调用。

属性详细信息

reload

更改配置视图时，小组件应更新其视图。

reload: (newWidgetSettings: WidgetSettings) => Promise<WidgetStatus>

属性值

(newWidgetSettings: WidgetSettings) => Promise<WidgetStatus>

继承属性详细信息

disableWidgetForStakeholders

框架调用此方法以确定是否应为具有利益干系人许可证的用户禁用小组件

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

属性值

(widgetSettings: WidgetSettings) => Promise<boolean>

继承自IWidget.disableWidgetForStakeholders

在轻型装箱模式下运行小组件

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

属性值

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

继承自IWidget.lightbox

listen

侦听来自主机的消息

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

属性值

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

继承自IWidget.listen

load

小组件使用提供的设置以及服务器端调用来完成其呈现体验。将来，小组件应在等待调用完成时提供加载体验。在此之前，小组件主机将提供加载体验

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

属性值

(widgetSettings: WidgetSettings) => Promise<WidgetStatus>

继承自IWidget.load

onDashboardLoaded

小组件管理初始加载不需要但完整小组件体验所需的任何操作。

onDashboardLoaded?: () => void

属性值

() => void

继承自IWidget.onDashboardLoaded

preload

小组件使用所提供的设置以及它们可能必须绘制交互式状态的任何缓存数据。小组件不应进行网络调用。

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

属性值