WidgetStatusHelper class
Methoden
Failure(string, boolean, boolean) | -Methode zum Kapseln eines fehlgeschlagenen Ergebnisses für einen Widgetladevorgang (laden, neu laden, openLightbox usw.) |
Success(string) | -Methode zum Kapseln eines erfolgreichen Ergebnisses für einen Widgetladevorgang (laden, neu laden, openLightbox usw.) |
Unconfigured() | -Methode zum Kapseln eines Ergebnisses für einen Widgetladevorgang, der dazu führt, dass sich das Widget in einem nicht konfigurierten Zustand befindet. |
Details zur Methode
Failure(string, boolean, boolean)
-Methode zum Kapseln eines fehlgeschlagenen Ergebnisses für einen Widgetladevorgang (laden, neu laden, openLightbox usw.)
static function Failure(message: string, isUserVisible?: boolean, isRichText?: boolean): Promise<WidgetStatus>
Parameter
- message
-
string
Meldung, die als Teil der Widgetfehlererfahrung angezeigt werden soll.
- isUserVisible
-
boolean
gibt an, ob die Meldung für den Benutzer oder eine generische Fehlermeldung angezeigt werden soll. Der Standardwert ist TRUE.
- isRichText
-
boolean
gibt an, ob es sich bei der Nachricht um einen HTML-Code handelt, der als umfangreiche Benutzeroberfläche gerendert werden kann. Der Standardwert ist „false“. Nur vertrauenswürdige Erweiterungen dürfen dies auf true festlegen. Bei Drittanbieterwidgets, die diesen Wert als true übergeben, wird er ignoriert.
Gibt zurück
Promise<WidgetStatus>
versprechen, die status der Widgetladevorgänge zu kapseln.
Success(string)
-Methode zum Kapseln eines erfolgreichen Ergebnisses für einen Widgetladevorgang (laden, neu laden, openLightbox usw.)
static function Success(state?: string): Promise<WidgetStatus>
Parameter
- state
-
string
alle Zustandsinformationen, die an den Initiator des Ladeaufrufs übergeben werden sollen.
Gibt zurück
Promise<WidgetStatus>
versprechen, die status der Widgetladevorgänge zu kapseln.
Unconfigured()
-Methode zum Kapseln eines Ergebnisses für einen Widgetladevorgang, 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, die status der Widgetladevorgänge zu kapseln.