Class

FlexError

FlexError

Provides an abstraction on top of the standard Error

Extends

  • Error

Members

"windowClosed" | "popupBlocked" | "noWindowOpener" | "redirecting"

# static exports.BrowserErrorKeys

Browser error keys
Properties:
Name Type Description
windowClosed "windowClosed" user closed the login window
popupBlocked "popupBlocked" popup was blocked by browser
noWindowOpener "noWindowOpener" login window has no window.opener set
redirecting "redirecting" browser is being redirected
"loginWindowOpenedFromLoginWindow" | "metaNoReferrerMissing"

# static exports.ClientErrorKeys

Client error keys
Properties:
Name Type Description
loginWindowOpenedFromLoginWindow "loginWindowOpenedFromLoginWindow" new login window opened from login window
metaNoReferrerMissing "metaNoReferrerMissing" element meta with attributes name="referrer" content="no-referrer" is missing from document head section
"accountSid" | "sso"

# static exports.ConfigErrorKeys

Configuration error keys
Properties:
Name Type Description
accountSid "accountSid" accountSid missing from configuration
sso "sso" sso configuration missing
"user" | "normal" | "severe"

# static exports.FlexErrorSeverity

FlexError severity
Properties:
Name Type Description
user "user" Errors originating from denial to user request, not actual error
normal "normal" Normal error condition
severe "severe" Severe error condition (some system hard down)
"app" | "chatSDK" | "syncSDK" | "taskrouterSDK" | "voiceSDK"

# static exports.FlexErrorType

FlexError types
Properties:
Name Type Description
app "app" Errors originating from the app itself
chatSDK "chatSDK" Errors originating from Chat SDK
syncSDK "syncSDK" Errors originating from Sync SDK
taskrouterSDK "taskrouterSDK" Errors originating from Taskrouter SDK
flexSDK "flexSDK" Errors originating from Flex SDK
voiceSDK "voiceSDK" Errors originating from Voice SDK
"accountSid" | "sso" | "untrustedDomain"

# static exports.ValidationErrorKeys

Validation error keys
Properties:
Name Type Description
accountSid "accountSid" failed to determine the account sid
sso "sso" failed to determine sso configuration
untrustedDomain "untrustedDomain" domain not allowlisted
FlexError.FlexErrorContents

# content

Flex content
string

# logLine

Represents log line
string

# logManagerTimestamp

Timestamp related with the latest relevant log
string

# logs

gets you the logs associated with this Flex error.
FlexError.SessionData

# sessionData

Session data
Date

# time

Date when the error has been triggered
FlexError.exports.FlexErrorType

# type

type, indicating what part of the FlexUI caused the issue, the library itself or any of the sdks

Type Definitions

# FlexErrorContents

Flex Error Content
Properties:
Name Type Attributes Description
type FlexError.exports.FlexErrorType <optional>
 Type of the error
wrappedError Error <optional>
 The original error
plugin FlexError.PluginInfo <optional>
 Information about the plugin where the error occured (if applicable)
context string <optional>
 Error context, including theme customizations
description string <optional>
 Longer and more verbose description of the error than message property, possibly with variable metadata
severity FlexError.exports.FlexErrorSeverity <optional>
 Severity level of the error

# PluginInfo

Information about the plugin
Properties:
Name Type Attributes Description
name string <optional>
 Name of the plugin
version string <optional>
 Version of the plugin

# SessionData

Information about the session where the error occured
Properties:
Name Type Attributes Description
config Config <optional>
 Session configuration
reactVersion string <optional>
 React version
bundleType string <optional>
 Bundle type