WidgetStatusHelper class
Méthodes
| Failure(string, boolean, boolean) | méthode pour encapsuler un résultat ayant échoué pour une opération de chargement de widget (chargement, rechargement, openLightbox, etc.) |
| Success(string) | méthode pour encapsuler un résultat réussi pour une opération de chargement de widget (chargement, rechargement, openLightbox, etc.) |
| Unconfigured() | méthode pour encapsuler un résultat pour une opération de chargement de widget qui entraîne l’état non configuré du widget. |
Détails de la méthode
Failure(string, boolean, boolean)
méthode pour encapsuler un résultat ayant échoué pour une opération de chargement de widget (chargement, rechargement, openLightbox, etc.)
static function Failure(message: string, isUserVisible?: boolean, isRichText?: boolean): Promise<WidgetStatus>Paramètres
- message
-
string
message à afficher dans l’expérience d’erreur du widget.
- isUserVisible
-
boolean
indique si le message doit être affiché à l’utilisateur ou s’il s’agit d’un message d’erreur générique. La valeur par défaut est true.
- isRichText
-
boolean
indique si le message est un code html qui peut être rendu en tant qu’expérience enrichie. La valeur par défaut est false. Seules les extensions approuvées sont autorisées à définir cette valeur sur true. Pour tous les widgets tiers qui passent cette valeur comme true, elle est ignorée.
Retours
Promise<WidgetStatus>
promesse encapsulant le status 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 (chargement, rechargement, openLightbox, etc.)
static function Success(state?: string): Promise<WidgetStatus>Paramètres
- state
-
string
toutes les informations d’état à transmettre à l’initiateur de l’appel de chargement.
Retours
Promise<WidgetStatus>
promesse encapsulant le status des opérations de chargement du widget.
Unconfigured()
méthode pour encapsuler un résultat pour une opération de chargement de widget qui entraîne l’état non configuré du widget.
static function Unconfigured(): Promise<WidgetStatus>Retours
Promise<WidgetStatus>
promesse encapsulant le status des opérations de chargement du widget.