WidgetStatusHelper class
メソッド
| 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>
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 は、ウィジェットの読み込み操作の状態をカプセル化します。