WidgetStatusHelper class
Méthodes
| Failure(string, boolean, boolean) | méthode d’encapsulation d’un résultat d’échec pour une opération de chargement de widget (load, reload, openLightbox, etc.) |
| Success(string) | méthode pour encapsuler un résultat réussi pour une opération de chargement de widget (load, reload, openLightbox, etc.) |
| Unconfigured() | Méthode permettant d’encapsuler le résultat d’une opération de chargement de widget qui entraîne l’absence de configuration du widget. |
Détails de la méthode
Failure(string, boolean, boolean)
méthode d’encapsulation d’un résultat d’échec pour une opération de chargement de widget (load, reload, openLightbox, etc.)
static function Failure(message: string, isUserVisible?: boolean, isRichText?: boolean): Promise<WidgetStatus>Paramètres
- message
-
string
message à afficher dans le cadre de l’expérience d’erreur du widget.
- isUserVisible
-
boolean
Indique si le message doit être affiché à l’utilisateur ou si un message d’erreur générique doit être affiché. La valeur par défaut est true.
- isRichText
-
boolean
Indique s’il s’agit d’un message HTML qui peut être rendu sous la forme d’une expérience enrichie. La valeur par défaut est false. Seules les extensions de confiance sont autorisées à définir cette valeur à true. Pour tout widget tiers passant cette valeur comme vraie, elle sera ignorée.
Retours
Promise<WidgetStatus>
promesse encapsulant l’état des opérations de chargement du widget.
Success(string)
méthode pour encapsuler un résultat réussi pour une opération de chargement de widget (load, reload, openLightbox, etc.)
static function Success(state?: string): Promise<WidgetStatus>Paramètres
- state
-
string
toute information d’état à transmettre à l’initiateur de l’appel de chargement.
Retours
Promise<WidgetStatus>
promesse encapsulant l’état des opérations de chargement du widget.
Unconfigured()
Méthode permettant d’encapsuler le résultat d’une opération de chargement de widget qui entraîne l’absence de configuration du widget.
static function Unconfigured(): Promise<WidgetStatus>Retours
Promise<WidgetStatus>
promesse encapsulant l’état des opérations de chargement du widget.