configcat-kotlin-client/com.configcat/ConfigCatOptions

ConfigCatOptions

class ConfigCatOptions(source)

Configuration options for ConfigCatClient.

Constructors

ConfigCatOptions

fun ConfigCatOptions()

Properties

baseUrl

var baseUrl: String? = null

The base ConfigCat CDN url.

configCache

var configCache: ConfigCache?

The cache implementation used to cache the downloaded configurations.

dataGovernance

var dataGovernance: DataGovernance

Default: DataGovernance.GLOBAL. Set this parameter to be in sync with the Data Governance preference on the Dashboard. (Only Organization Admins have access)

defaultUser

var defaultUser: ConfigCatUser? = null

The default user, used as fallback when there's no user parameter is passed to the ConfigCatClient.getValue method.

flagOverrides

var flagOverrides: FlagOverrides.() -> Unit? = null

Feature flag and setting overrides.

hooks

var hooks: Hooks

Hooks for events fired by ConfigCatClient.

httpEngine

var httpEngine: HttpClientEngine? = null

The underlying Ktor HTTP engine used to fetch the latest configuration.

httpProxy

var httpProxy: ProxyConfig? = null

Proxy configuration for the HTTP engine.

logger

var logger: Logger

The internal logger implementation. The default logger writes the messages with println.

logLevel

var logLevel: LogLevel

Default: LogLevel.WARNING. The internal log level.

offline

var offline: Boolean = false

Indicates whether the SDK should be initialized in offline mode or not.

pollingMode

var pollingMode: PollingMode

The polling mode.

requestTimeout

var requestTimeout: Duration

Default: 30s. The maximum wait time for an HTTP response.