WidgetStatusHelper class

包:

azure-devops-extension-api

方法

Failure(string, boolean, boolean)	方法封装小组件加载操作的失败结果， (加载、重新加载、openLightbox 等)
Success(string)	方法封装小组件加载操作的成功结果， (加载、重新加载、openLightbox 等)
Unconfigured()	方法封装导致小组件处于未配置状态的小组件加载操作的结果。

方法详细信息

Failure(string, boolean, boolean)

方法封装小组件加载操作的失败结果， (加载、重新加载、openLightbox 等)

static function Failure(message: string, isUserVisible?: boolean, isRichText?: boolean): Promise<WidgetStatus>

参数

message

string

消息显示为小组件错误体验中的一部分。

isUserVisible

boolean

指示是应向用户显示消息还是显示一般错误消息。 默认为 true。

isRichText

boolean

指示消息是否是可以呈现为丰富体验的 html。 默认为 false。 仅允许受信任的扩展将此设置为 true。 对于传递此值为 true 的任何第三方小组件，将忽略该值。

返回

Promise<WidgetStatus>

承诺封装小组件加载操作的状态。

Success(string)

方法封装小组件加载操作的成功结果， (加载、重新加载、openLightbox 等)

static function Success(state?: string): Promise<WidgetStatus>

参数

state

string

要传递给加载调用的发起方的任何状态信息。

返回

Promise<WidgetStatus>

承诺封装小组件加载操作的状态。

Unconfigured()

方法封装导致小组件处于未配置状态的小组件加载操作的结果。

static function Unconfigured(): Promise<WidgetStatus>

返回

Promise<WidgetStatus>

承诺封装小组件加载操作的状态。