WidgetStatusHelper class
Methoden
| Failure(string, boolean, boolean) | Methode zum Einkapseln eines fehlgeschlagenen Ergebnisses für einen Widget-Ladevorgang (Laden, Neuladen, OpenLightbox usw.) |
| Success(string) | Methode zum Einkapseln eines erfolgreichen Ergebnisses für einen Widget-Ladevorgang (Laden, Neuladen, OpenLightbox usw.) |
| Unconfigured() | -Methode, um ein Ergebnis für einen Widget-Ladevorgang zu kapseln, der dazu führt, dass sich das Widget in einem nicht konfigurierten Zustand befindet. |
Details zur Methode
Failure(string, boolean, boolean)
Methode zum Einkapseln eines fehlgeschlagenen Ergebnisses für einen Widget-Ladevorgang (Laden, Neuladen, OpenLightbox usw.)
static function Failure(message: string, isUserVisible?: boolean, isRichText?: boolean): Promise<WidgetStatus>
Parameter
- message
-
string
Meldung, die als Teil in der Widget-Fehlererfahrung angezeigt werden soll.
- isUserVisible
-
boolean
Gibt an, ob die Meldung dem Benutzer angezeigt werden soll oder ob eine generische Fehlermeldung angezeigt werden soll. Die Standardeinstellung ist „true“.
- isRichText
-
boolean
Gibt an, ob es sich bei der Nachricht um einen HTML-Code handelt, der als Rich-Erlebnis gerendert werden kann. Der Standardwert ist „false“. Nur vertrauenswürdige Erweiterungen dürfen dies auf true setzen. Für alle Widgets von Drittanbietern, die diesen Wert als wahr übergeben, wird er ignoriert.
Gibt zurück
Promise<WidgetStatus>
Versprechen, das den Status der Ladevorgänge des Widgets kapselt.
Success(string)
Methode zum Einkapseln eines erfolgreichen Ergebnisses für einen Widget-Ladevorgang (Laden, Neuladen, OpenLightbox usw.)
static function Success(state?: string): Promise<WidgetStatus>
Parameter
- state
-
string
Alle Statusinformationen, die an den Initiator des Ladeaufrufs übergeben werden sollen.
Gibt zurück
Promise<WidgetStatus>
Versprechen, das den Status der Ladevorgänge des Widgets kapselt.
Unconfigured()
-Methode, um ein Ergebnis für einen Widget-Ladevorgang zu kapseln, der dazu führt, dass sich das Widget in einem nicht konfigurierten Zustand befindet.
static function Unconfigured(): Promise<WidgetStatus>
Gibt zurück
Promise<WidgetStatus>
Versprechen, das den Status der Ladevorgänge des Widgets kapselt.