@twilio/flex-ui/src/core/Errors.d.ts

Twilio Flex UI

import { FlexError, FlexErrorContents } from "../FlexError";
/**
 * Flex Errors
 *
 * @category Flex Errors
 */
/**
 * Configuration error keys
 *
 * @category Flex Errors
 * @ignore
 * @enum {"accountSid" | "sso"} ConfigErrorKeys
 * @property {"accountSid"} accountSid accountSid missing from configuration
 * @property {"sso"} sso sso configuration missing
 * @memberof FlexError
 */
export declare enum ConfigErrorKeys {
    accountSid = "accountSid",
    sso = "sso"
}
/**
 * Error thrown by configuration / setup validation
 * @category Flex Errors
 * @ignore
 * @class ConfigError
 * @extends Error
 * @param {FlexError.ConfigError.ConfigErrorKeys} key error key
 * @private
 */
export declare class ConfigError extends FlexError {
    key: ConfigErrorKeys;
    constructor(key: ConfigErrorKeys);
}
/**
 * Validation error keys
 *
 * @category Flex Errors
 * @ignore
 * @enum {"accountSid" | "sso" | "untrustedDomain"} ValidationErrorKeys
 * @property {"accountSid"} accountSid failed to determine the account sid
 * @property {"sso"} sso failed to determine sso configuration
 * @property {"untrustedDomain"} untrustedDomain domain not allowlisted
 * @memberof FlexError
 */
export declare enum ValidationErrorKeys {
    accountSid = "accountSid",
    sso = "sso",
    untrustedDomain = "untrustedDomain",
    invalidCertificate = "invalidCertificate"
}
/**
 * Error thrown by user configuration / setup validation
 * @category Flex Errors
 * @ignore
 * @class ValidationError
 * @extends FlexError
 * @param {FlexError.ValidationError.ValidationErrorKeys} key error key
 * @private
 */
export declare class ValidationError extends FlexError {
    key: ValidationErrorKeys;
    constructor(key: ValidationErrorKeys, contents?: FlexErrorContents);
}
/**
 * Browser error keys
 *
 * @category Flex Errors
 * @ignore
 * @enum {"windowClosed" | "popupBlocked" | "noWindowOpener" | "redirecting"} BrowserErrorKeys
 * @property {"windowClosed"} windowClosed user closed the login window
 * @property {"popupBlocked"} popupBlocked popup was blocked by browser
 * @property {"noWindowOpener"} noWindowOpener login window has no window.opener set
 * @property {"redirecting"} redirecting browser is being redirected
 * @memberof FlexError
 */
export declare enum BrowserErrorKeys {
    windowClosed = "windowClosed",
    popupBlocked = "popupBlocked",
    noWindowOpener = "noWindowOpener",
    redirecting = "redirecting"
}
/**
 * Error that is thrown if there is something problem with web browser.
 * @category Flex Errors
 * @ignore
 * @class FlexError.BrowserError
 * @extends FlexError
 * @param {FlexError.BrowserErrorKeys} key error key
 * @private
 */
export declare class BrowserError extends FlexError {
    key: BrowserErrorKeys;
    constructor(key: BrowserErrorKeys, contents?: FlexErrorContents);
}
/**
 * Error that is throw if there is some internal problem with Flex.
 * @category Flex Errors
 * @ignore
 * @class FlexError.InternalError
 * @extends FlexError
 * @private
 */
export declare class InternalError extends FlexError {
    constructor(message?: string, contents?: FlexErrorContents);
}
/**
 * Client error keys
 *
 * @category Flex Errors
 * @ignore
 * @enum {"loginWindowOpenedFromLoginWindow" | "metaNoReferrerMissing"} FlexError.ClientErrorKeys
 * @property {"loginWindowOpenedFromLoginWindow"} loginWindowOpenedFromLoginWindow new login window opened from login window
 * @property {"metaNoReferrerMissing"} metaNoReferrerMissing element meta with attributes name="referrer" content="no-referrer" is missing from document head section
 * @memberof FlexError
 */
export declare enum ClientErrorKeys {
    loginWindowOpenedFromLoginWindow = "loginWindowOpenedFromLoginWindow",
    metaNoReferrerMissing = "metaNoReferrerMissing"
}
/**
 * Error that is thrown if there is some problem with customization code.
 * @category Flex Errors
 * @ignore
 * @class FlexError.ClientError
 * @extends FlexError
 * @param {FlexError.ClientError.ClientErrorKeys} key error key
 * @private
 */
export declare class ClientError extends FlexError {
    key: ClientErrorKeys;
    constructor(key: ClientErrorKeys, customMessage?: string, contents?: FlexErrorContents);
}