@twilio/flex-sdk
    Preparing search index...

    Interface ClientOptions

    Options for configuring the Flex SDK client.

    interface ClientOptions {
        accountConfig: AccountConfigOptions;
        appName: string;
        appVersion: string;
        logger: LoggerOptions;
        origin?: string;
        region: string;
        regionNonFlex?: string;
        session: SessionOptions;
        taskRouterOptions?: TaskRouterOptions;
        telemetryOptions?: TelemetryOptions;
        voiceOptions?: VoiceOptions;
        worker?: Supervisor;
        workspace?: Workspace;
    }
    Index

    Properties

    accountConfig appName appVersion logger origin? region regionNonFlex? session taskRouterOptions? telemetryOptions? voiceOptions? worker? workspace?

    Properties

    accountConfig: AccountConfigOptions

    Account config related options

    appName: string

    Name of the app that is using Flex SDK, e.g. "My Custom App"

    appVersion: string

    Version of the app that is using Flex SDK, e.g. "2.3"

    logger: LoggerOptions

    Logger related options

    origin?: string

    Type of the app using SDK, e.g. "mobile", "web" or "headless". "headless" is used by default

    region: string

    Twilio Region ID, e.g. "us1", "ie1" etc

    regionNonFlex?: string

    region value to use for non-Flex apis

    session: SessionOptions

    Session related options

    taskRouterOptions?: TaskRouterOptions

    TaskRouter-related options

    telemetryOptions?: TelemetryOptions

    By default FlexSDK collects usage information that gets used for improving the SDK and providing better support.

    voiceOptions?: VoiceOptions

    Voice related options

    worker?: Supervisor
    workspace?: Workspace

    Settings

    Member Visibility

    On This Page

    Properties