FlexError
The FlexError class is an extension of a normal JavaScript Error class, with added context. This class includes more info on errors to help pinpoint problems and consolidate the Flex UI API. You can learn more about troubleshooting Flex UI here
exports.FlexErrorType: "app" | "chatSDK" | "syncSDK" | "taskrouterSDK" | "voiceSDK"#
FlexError types
Properties:
app: "app"Errors originating from Flex UI
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
exports.FlexErrorSeverity: "user" | "normal" | "severe"#
FlexError severity
Properties:
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)
type: FlexErrorType#
type, indicating what part of the FlexUI caused the issue, the library itself or any of the sdks
logs: string#
gets you the logs associated with this Flex error.
logLine: string#
Represents log line
content: FlexErrorContents#
Flex content
sessionData: FlexError.SessionData#
Session data
time: Date#
Date when the error has been triggered
logManagerTimestamp: string | undefined#
Timestamp related with the latest relevant log
exports.ConfigErrorKeys: "accountSid" | "sso"#
Configuration error keys
Properties:
accountSid: "accountSid"accountSid missing from configuration
sso: "sso"sso configuration missing
exports.ValidationErrorKeys: "accountSid" | "sso" | "untrustedDomain"#
Validation error keys
Properties:
accountSid: "accountSid"failed to determine the account sid
sso: "sso"failed to determine sso configuration
untrustedDomain: "untrustedDomain"domain not allowlisted
exports.BrowserErrorKeys: "windowClosed" | "popupBlocked" | "noWindowOpener" | "redirecting"#
Browser error keys
Properties:
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
exports.ClientErrorKeys: "loginWindowOpenedFromLoginWindow" | "metaNoReferrerMissing"#
Client error keys
Properties:
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