WidgetStatusHelper class
Metody
| Failure(string, boolean, boolean) | metoda hermetyzacji wyniku niepowodzenia dla operacji ładowania widżetu (ładowanie, ponowne ładowanie, openLightbox itp.) |
| Success(string) | metoda hermetyzacji pomyślnego wyniku operacji ładowania widżetu (ładowanie, ponowne ładowanie, openLightbox itp.) |
| Unconfigured() | metoda hermetyzacji wyniku operacji ładowania widżetu, która powoduje, że widżet jest w stanie nieskonfigurowanym. |
Szczegóły metody
Failure(string, boolean, boolean)
metoda hermetyzacji wyniku niepowodzenia dla operacji ładowania widżetu (ładowanie, ponowne ładowanie, openLightbox itp.)
static function Failure(message: string, isUserVisible?: boolean, isRichText?: boolean): Promise<WidgetStatus>Parametry
- message
-
string
komunikat do wyświetlenia w ramach środowiska błędu widżetu.
- isUserVisible
-
boolean
wskazuje, czy komunikat powinien być wyświetlany użytkownikowi, czy ogólny komunikat o błędzie. Wartość domyślna to true.
- isRichText
-
boolean
wskazuje, czy komunikat jest kodem HTML, który może być renderowany jako zaawansowane środowisko. Wartość domyślna to false. Tylko zaufane rozszerzenia mogą ustawić tę wartość na true. W przypadku wszystkich widżetów innych firm przekazujących tę wartość jako true zostanie ona zignorowana.
Zwraca
Promise<WidgetStatus>
promise hermetyzuje stan operacji ładowania widżetu.
Success(string)
metoda hermetyzacji pomyślnego wyniku operacji ładowania widżetu (ładowanie, ponowne ładowanie, openLightbox itp.)
static function Success(state?: string): Promise<WidgetStatus>Parametry
- state
-
string
wszelkie informacje o stanie, które mają zostać przekazane do inicjatora wywołania ładowania.
Zwraca
Promise<WidgetStatus>
promise hermetyzuje stan operacji ładowania widżetu.
Unconfigured()
metoda hermetyzacji wyniku operacji ładowania widżetu, która powoduje, że widżet jest w stanie nieskonfigurowanym.
static function Unconfigured(): Promise<WidgetStatus>Zwraca
Promise<WidgetStatus>
promise hermetyzuje stan operacji ładowania widżetu.