Interface ClientInitConfigObject

Represents the configuration object used to initialize the client.

The ClientInitConfig class provides a convenient way to configure the client by specifying various properties. These properties include all the ones in ClientConfigObject plus loggingLevel, customLoggers and disableInternalLogger.

Example

[[include:snippet_Logging.txt]]
interface ClientInitConfigObject {
    apiUrl?: Nullable<string>;
    autoReconnectMedia?: Nullable<boolean>;
    customLoggers?: Nullable<VonageLoggerJS[]> | VonageLogger[];
    disableInternalLogger?: Nullable<boolean>;
    loggingLevel?: null | LoggingLevelJS | "Verbose" | "Debug" | "Info" | "Warn" | "Error" | "Assert";
    region?: null | CoreClientConfigRegionJS | "AP" | "EU" | "US";
    rtcStatsTelemetry?: Nullable<boolean>;
    websocketPath?: Nullable<string>;
    websocketUrl?: Nullable<string>;
}

Properties

apiUrl?: Nullable<string>

The API URL of your chosen datacenter, if set overrides default from region

autoReconnectMedia?: Nullable<boolean>

Allow the sdk to automatically reconnect media when network interface changes

customLoggers?: Nullable<VonageLoggerJS[]> | VonageLogger[]

A List of custom loggers

disableInternalLogger?: Nullable<boolean>

Whether to enable the SDK internal logger

loggingLevel?: null | LoggingLevelJS | "Verbose" | "Debug" | "Info" | "Warn" | "Error" | "Assert"

The Logging Level to use

region?: null | CoreClientConfigRegionJS | "AP" | "EU" | "US"

The Vonage datacenter to use

rtcStatsTelemetry?: Nullable<boolean>

Allow users to enable RTCStats

websocketPath?: Nullable<string>

The Path component appended to the Websocket URL

websocketUrl?: Nullable<string>

The WebSocket URL of your chosen datacenter, if set overrides default from region