WidgetStatusHelper class
メソッド
| Failure(string, boolean, boolean) | ウィジェットの読み込み操作(load、reload、openLightboxなど)の失敗した結果をカプセル化する方法 |
| Success(string) | ウィジェットの読み込み操作(ロード、リロード、openLightboxなど)の成功した結果をカプセル化するメソッド |
| Unconfigured() | ウィジェットが未構成状態になるウィジェットの読み込み操作の結果をカプセル化する方法。 |
メソッドの詳細
Failure(string, boolean, boolean)
ウィジェットの読み込み操作(load、reload、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>
ウィジェットの読み込み操作のステータスをカプセル化する Promise です。
Success(string)
ウィジェットの読み込み操作(ロード、リロード、openLightboxなど)の成功した結果をカプセル化するメソッド
static function Success(state?: string): Promise<WidgetStatus>パラメーター
- state
-
string
読み込み呼び出しのイニシエーターに渡される状態情報。
戻り値
Promise<WidgetStatus>
ウィジェットの読み込み操作のステータスをカプセル化する Promise です。
Unconfigured()
ウィジェットが未構成状態になるウィジェットの読み込み操作の結果をカプセル化する方法。
static function Unconfigured(): Promise<WidgetStatus>戻り値
Promise<WidgetStatus>
ウィジェットの読み込み操作のステータスをカプセル化する Promise です。