Kotlin Multiplatform SDK Reference
Getting started
1. Install the ConfigCat SDK
val configcatVersion: String by project
kotlin {
sourceSets {
val commonMain by getting {
dependencies {
implementation("com.configcat:configcat-kotlin-client:configcatVersion")
}
}
}
}
2. Import the ConfigCat SDK
import com.configcat.*
3. Create the ConfigCat client with your SDK Key
import com.configcat.*
suspend fun main() {
val client = ConfigCatClient("#YOUR-SDK-KEY#")
}
4. Get your setting value
import com.configcat.*
suspend fun main() {
val client = ConfigCatClient("#YOUR-SDK-KEY#")
val isMyAwesomeFeatureEnabled = client.getValue("isMyAwesomeFeatureEnabled", false)
if (isMyAwesomeFeatureEnabled) {
doTheNewThing()
} else {
doTheOldThing()
}
}
5. Close the client on application exit
You can safely shut down all clients at once or individually and release all associated resources on application exit.
ConfigCatClient.closeAll() // closes all clients
client.close() // closes a specific client
Setting up the ConfigCat Client
ConfigCat Client is responsible for:
- managing the communication between your application and ConfigCat servers.
- caching your setting values and feature flags.
- serving values quickly in a failsafe way.
ConfigCatClient(<sdkKey>)
returns a client with default options.
Customizing the ConfigCat Client
To customize the SDK's behavior, you can pass an additional ConfigCatOptions.() -> Unit
parameter
to the ConfigCatClient()
method where the ConfigCatOptions
class is used to set up the ConfigCat Client.
import com.configcat.*
import kotlin.time.Duration.Companion.seconds
val client = ConfigCatClient("#YOUR-SDK-KEY#") {
pollingMode = autoPoll()
logLevel = LogLevel.INFO
requestTimeout = 10.seconds
}
These are the available options on the ConfigCatOptions
class:
Properties | Type | Description |
---|---|---|
dataGovernance | DataGovernance | Optional, defaults to DataGovernance.GLOBAL . Describes the location of your feature flag and setting data within the ConfigCat CDN. This parameter needs to be in sync with your Data Governance preferences. More about Data Governance. Available options: DataGovernance.GLOBAL , DataGovernance.EU_ONLY . |
baseUrl | String | Optional, sets the CDN base url (forward proxy, dedicated subscription) from where the SDK will download the config JSON. |
requestTimeout | Duration | Optional, defaults to 30s . Sets the underlying HTTP client's request timeout. More about HTTP Timeout. |
configCache | ConfigCache | Optional, sets a custom cache implementation for the client. More about cache. |
pollingMode | PollingMode | Optional, sets the polling mode for the client. More about polling modes. |
logger | Logger | Optional, sets the internal logger. More about logging. |
logLevel | LogLevel | Optional, defaults to LogLevel.WARNING . Sets the internal log level. More about logging. |
flagOverrides | (FlagOverrides.() -> Unit)? | Optional, sets the local feature flag & setting overrides. More about feature flag overrides. |
httpEngine | HttpClientEngine? | Optional, sets the underlying Ktor HTTP engine. More about HTTP engines. |
httpProxy | ProxyConfig? | Optional, sets up the HTTP proxy for the underlying Ktor HTTP engine. More about HTTP proxy. |
defaultUser | ConfigCatUser? | Optional, sets the default user. More about default user. |
offline | Bool | Optional, defaults to false . Indicates whether the SDK should be initialized in offline mode. More about offline mode. |
hooks | Hooks | Optional, used to subscribe events that the SDK sends in specific scenarios. More about hooks. |
We strongly recommend you to use the ConfigCatClient
as a Singleton object in your application.
The ConfigCatClient(sdkKey: <sdkKey>)
method constructs singleton client instances for your SDK keys.
These clients can be closed all at once with the ConfigCatClient.closeAll()
method or individually with client.close()
.
Anatomy of getValue()
Parameters | Description |
---|---|
key | REQUIRED. Setting-specific key. Set on ConfigCat Dashboard for each setting. |
defaultValue | REQUIRED. This value will be returned in case of an error. |
user | Optional, User Object. Essential when using Targeting. Read more about Targeting. |
val value = client.getValue(
key = "keyOfMySetting",
defaultValue = false,
user = ConfigCatUser(identifier = "#USER-IDENTIFIER#"), // Optional User Object
)
It is important to provide an argument for the defaultValue
parameter, specifically for the T
generic type parameter,
that matches the type of the feature flag or setting you are evaluating. Please refer to the following table for the corresponding types.
Setting type mapping
Setting Kind | Type parameter T |
---|---|
On/Off Toggle | Boolean / Boolean? |
Text | String / String? |
Whole Number | Integer / Integer? |
Decimal Number | Double / Double? |
In addition to the types mentioned above, you also have the option to use the getAnyValue
method, where the defaultValue
parameter can be any value (including null
) regardless of the setting kind.
It's important to note that providing any other type for the type parameter will result in an IllegalArgumentException
.
If you specify an allowed type but it mismatches the setting kind, an error message will be logged and defaultValue
will be returned.
When relying on type inference and not explicitly specifying the type parameter, be mindful of potential type mismatch issues, especially with number types.
For example, client.getValue("keyOfMyDecimalSetting", 0)
will return defaultValue
(0
) instead of the actual value of the decimal setting because
the compiler infers the type as Integer
instead of Double
, that is, the call is equivalent to client.getValue<Integer>("keyOfMyDecimalSetting", 0)
,
which is a type mismatch.
To correctly evaluate a decimal setting, you should use:
var value = client.getValue("keyOfMyDecimalSetting", 0.0);
Anatomy of getValueDetails()
getValueDetails()
is similar to getValue()
but instead of returning the evaluated value only, it gives more detailed information about the evaluation result.
Parameters | Description |
---|---|
key | REQUIRED. Setting-specific key. Set on ConfigCat Dashboard for each setting. |
defaultValue | REQUIRED. This value will be returned in case of an error. |
user | Optional, User Object. Essential when using Targeting. Read more about Targeting. |
val details = client.getValueDetails(
key = "keyOfMySetting",
defaultValue = false,
user = ConfigCatUser(identifier = "#USER-IDENTIFIER#"), // Optional User Object
)
It is important to provide an argument for the defaultValue
parameter, specifically for the T
generic type parameter,
that matches the type of the feature flag or setting you are evaluating. Please refer to this table for the corresponding types.
The details result contains the following information:
Field | Type | Description |
---|---|---|
value | Boolean / String / Int / Double | The evaluated value of the feature flag or setting. |
key | String | The key of the evaluated feature flag or setting. |
isDefaultValue | Boolean | True when the default value passed to getValueDetails() is returned due to an error. |
error | String? | In case of an error, this property contains the error message. |
user | ConfigCatUser? | The User Object that was used for evaluation. |
matchedPercentageOption | PercentageOption? | The Percentage Option (if any) that was used to select the evaluated value. |
matchedTargetingRule | TargetingRule? | The Targeting Rule (if any) that matched during the evaluation and was used to return the evaluated value. |
fetchTimeUnixMilliseconds | Long | The last download time of the current config in unix milliseconds format. |
User Object
The User Object is essential if you'd like to use ConfigCat's Targeting feature.
val user = ConfigCatUser(identifier = "#UNIQUE-USER-IDENTIFIER#")
val user = ConfigCatUser(identifier = "[email protected]")
Customized User Object creation
Argument | Description |
---|---|
identifier | REQUIRED. Unique identifier of a user in your application. Can be any value, even an email address. |
email | Optional parameter for easier Targeting Rule definitions. |
country | Optional parameter for easier Targeting Rule definitions. |
custom | Optional map for custom attributes of a user for advanced Targeting Rule definitions. e.g. User role, Subscription type. |
val user = ConfigCatUser(
identifier = "#UNIQUE-USER-IDENTIFIER#",
email = "[email protected]",
country = "United Kingdom",
custom = mapOf(
"SubscriptionType" to "Pro",
"UserRole" to "Admin"
)
)
The custom
map also allows attribute values other than String
values:
val user = ConfigCatUser(
identifier = "#UNIQUE-USER-IDENTIFIER#",
email = "[email protected]",
country = "United Kingdom",
custom = mapOf(
"Rating" to 4.5,
"RegisteredAt" to DateTime.fromString("2023-11-22T12:34:56.999Z"),
"Roles" to arrayOf("Role1", "Role2")
)
)
User Object Attribute Types
All comparators support String
values as User Object attribute (in some cases they need to be provided in a specific format though, see below), but some of them also support other types of values. It depends on the comparator how the values will be handled. The following rules apply:
Text-based comparators (EQUALS, IS ONE OF, etc.)
- accept
String
values, - all other values are automatically converted to
String
(a warning will be logged but evaluation will continue as normal).
SemVer-based comparators (IS ONE OF, <, >=, etc.)
- accept
String
values containing a properly formatted, valid semver value, - all other values are considered invalid (a warning will be logged and the currently evaluated Targeting Rule will be skipped).
Number-based comparators (=, <, >=, etc.)
- accept
Double
values and all other numeric values which can safely be converted toDouble
, - accept
String
values containing a properly formatted, validDouble
value, - all other values are considered invalid (a warning will be logged and the currently evaluated Targeting Rule will be skipped).
Date time-based comparators (BEFORE / AFTER)
- accept
com.soywiz.klock.DateTime
values, which are automatically converted to a second-based Unix timestamp, - accept
Double
values representing a second-based Unix timestamp and all other numeric values which can safely be converted toDouble
, - accept
String
values containing a properly formatted, validDouble
value, - all other values are considered invalid (a warning will be logged and the currently evaluated Targeting Rule will be skipped).
String array-based comparators (ARRAY CONTAINS ANY OF / ARRAY NOT CONTAINS ANY OF)
- accept lists or array of
String
, - accept
String
values containing a valid JSON string which can be deserialized to an array ofString
, - all other values are considered invalid (a warning will be logged and the currently evaluated Targeting Rule will be skipped).
Default user
There's an option to set a default User Object that will be used at feature flag and setting evaluation. It can be useful when your application has a single user only, or rarely switches users.
You can set the default User Object either on SDK initialization:
val client = ConfigCatClient("#YOUR-SDK-KEY#") {
defaultUser = ConfigCatUser(identifier = "[email protected]")
}
or with the setDefaultUser()
method of the ConfigCat client.
client.setDefaultUser(ConfigCatUser(identifier = "[email protected]"))
Whenever the getValue()
, getValueDetails()
, or getAllValues()
methods are called without an explicit user
parameter, the SDK will automatically use the default user as a User Object.
val user = ConfigCatUser(identifier = "[email protected]")
client.setDefaultUser(user)
// The default user will be used at the evaluation process.
val value = client.getValue("keyOfMySetting", false)
When the user
parameter is specified on the requesting method, it takes precedence over the default user.
val user = ConfigCatUser(identifier = "[email protected]")
client.setDefaultUser(user)
val otherUser = ConfigCatUser(identifier = "[email protected]")
// otherUser will be used at the evaluation process.
val value = await client.getValue("keyOfMySetting", false, otherUser)
For deleting the default user, you can do the following:
client.clearDefaultUser()
Polling Modes
The ConfigCat SDK supports 3 different polling mechanisms to acquire the setting values from ConfigCat. After latest setting values are downloaded, they are stored in the internal cache, then all getValue()
calls are served from there. With the following polling modes, you can customize the SDK to best fit to your application's lifecycle.
More about polling modes.
Auto polling (default)
The ConfigCat SDK downloads the latest values and stores them automatically every 60 seconds.
Use the the pollingInterval
option parameter of the autoPoll()
to change the polling interval.
import com.configcat.*
import kotlin.time.Duration.Companion.seconds
val client = ConfigCatClient("#YOUR-SDK-KEY#") {
pollingMode = autoPoll {
pollingInterval = 100.seconds
}
}
Available options:
Option Parameter | Description | Default |
---|---|---|
pollingInterval | Polling interval. | 60.seconds |
maxInitWaitTime | Maximum waiting time between the client initialization and the first config acquisition in seconds. | 5.seconds |
Lazy loading
When calling getValue()
, the ConfigCat SDK downloads the latest setting values if they are not present or expired in the cache. In this case getValue()
will return the setting value after the cache is updated.
Use the cacheRefreshInterval
option parameter of the lazyLoad()
to set cache lifetime.
import com.configcat.*
import kotlin.time.Duration.Companion.seconds
val client = ConfigCatClient("#YOUR-SDK-KEY#") {
pollingMode = lazyLoad {
cacheRefreshInterval = 100.seconds
}
}
Available options:
Parameter | Description | Default |
---|---|---|
cacheRefreshInterval | Cache TTL. | 60.seconds |
Manual polling
Manual polling gives you full control over when the config JSON
(with the setting values) is downloaded. ConfigCat SDK will not update them automatically. Calling forceRefresh()
is your application's responsibility.
val client = ConfigCatClient("#YOUR-SDK-KEY#") {
pollingMode = manualPoll()
}
client.forceRefresh()
getValue()
returnsdefaultValue
if the cache is empty. CallforceRefresh()
to update the cache.
Hooks
With the following hooks you can subscribe to particular events fired by the SDK:
-
onClientReady(ClientCacheState)
: This event is sent when the SDK reaches the ready state. If the SDK is set up to use lazy loading or manual polling, it's considered ready right after syncing up with the config cache. If it's using auto polling, the ready state is reached when the SDK has a valid config JSON loaded into memory either from cache or from HTTP. If the config couldn't be loaded neither from cache nor from HTTP theonClientReady
event fires when the auto polling'smaxInitWaitTime
is reached. -
onConfigChanged(Map<String, Setting>)
: This event is sent when the SDK loads a valid config JSON into memory from cache, and each subsequent time when the loaded config JSON changes via HTTP. -
onFlagEvaluated(EvaluationDetails)
: This event is sent each time when the SDK evaluates a feature flag or setting. The event sends the same evaluation details that you would get fromgetValueDetails()
. -
onError(String)
: This event is sent when an error occurs within the ConfigCat SDK.
You can subscribe to these events either on SDK initialization:
val client = ConfigCatClient("#YOUR-SDK-KEY#") {
hooks.addOnFlagEvaluated { details ->
/* handle the event */
}
}
or with the hooks
property of the ConfigCat client:
client.hooks.addOnFlagEvaluated { details ->
/* handle the event */
}
Online / Offline mode
In cases when you'd want to prevent the SDK from making HTTP calls, you can put it in offline mode:
client.setOffline()
In offline mode, the SDK won't initiate HTTP requests and will work only from its cache.
To put the SDK back in online mode, you can do the following:
client.setOnline()
With
client.isOffline
you can check whether the SDK is in offline mode.
Flag Overrides
With flag overrides you can overwrite the feature flags & settings downloaded from the ConfigCat CDN with local values. Moreover, you can specify how the overrides should apply over the downloaded values. The following 3 behaviours are supported:
-
Local only (
OverrideBehavior.LOCAL_ONLY
): When evaluating values, the SDK will not use feature flags & settings from the ConfigCat CDN, but it will use all feature flags & settings that are loaded from local-override sources. -
Local over remote (
OverrideBehavior.LOCAL_OVER_REMOTE
): When evaluating values, the SDK will use all feature flags & settings that are downloaded from the ConfigCat CDN, plus all feature flags & settings that are loaded from local-override sources. If a feature flag or a setting is defined both in the downloaded and the local-override source then the local-override version will take precedence. -
Remote over local (
OverrideBehavior.REMOTE_OVER_LOCAL
): When evaluating values, the SDK will use all feature flags & settings that are downloaded from the ConfigCat CDN, plus all feature flags & settings that are loaded from local-override sources. If a feature flag or a setting is defined both in the downloaded and the local-override source then the downloaded version will take precedence.
Map
You can set up the SDK to load your feature flag & setting overrides from a Map<String, Any>
.
val client = ConfigCatClient("localhost") {
flagOverrides = {
behavior = OverrideBehavior.LOCAL_ONLY
dataSource = OverrideDataSource.map(
mapOf(
"enabledFeature" to true,
"disabledFeature" to false,
"intSetting" to 5,
"doubleSetting" to 3.14,
"stringSetting" to "test"
)
)
}
}
Config
You can set up the SDK to load your feature flag & setting overrides from a Config
.
val client = ConfigCatClient("localhost") {
flagOverrides = {
behavior = OverrideBehavior.LOCAL_ONLY
dataSource = OverrideDataSource.config(
config = Config(
preferences = Preferences(baseUrl = "test", salt = "test-salt"),
settings = mapOf(
"noRuleOverride" to Setting(
1,
"",
null,
null,
SettingsValue(stringValue = "noRule"),
"myVariationId"
),
"ruleOverride" to Setting(
1,
"",
null,
arrayOf(
TargetingRule(
conditions = arrayOf(
Condition(
UserCondition("Identifier", 2, stringArrayValue = arrayOf("@test1")),
null,
null
)
),
null,
ServedValue(
SettingsValue(stringValue = "ruleMatch"),
"ruleVariationId"
)
)
),
SettingsValue(stringValue = "noMatch"),
"myVariationId"
),
"percentageOverride" to Setting(
1,
"",
arrayOf(
PercentageOption(75, SettingsValue(stringValue = "A"), "percentageAVariationID"),
PercentageOption(25, SettingsValue(stringValue = "B"), "percentageAVariationID")
),
emptyArray(),
SettingsValue(stringValue = "noMatch"),
"myVariationId"
)
)
)
)
}
}
getAllKeys()
You can query the keys of each feature flag and setting with the getAllKeys()
method.
val client = ConfigCatClient("#YOUR-SDK-KEY#")
val keys = client.getAllKeys()
getAllValues()
Evaluates and returns the values of all feature flags and settings. Passing a User Object is optional.
val client = ConfigCatClient("#YOUR-SDK-KEY#")
val settingValues = client.getAllValues()
// invoke with User Object
val user = ConfigCatUser(identifier = "#UNIQUE-USER-IDENTIFIER#")
val settingValuesTargeting = client.getAllValues(user)
Cache
The SDK uses platform specific caching to store the downloaded config JSON
.
These are the storage locations by platform:
- Android:
SharedPreferences
. It has a dependency onandroid.content.Context
, so it won't be enabled by default, but it can be explicitly set by providing an appropriateContext
. (Here is an example) - iOS / macOS / tvOS / watchOS:
NSUserDefaults
. - JS (browser only): Browser
localStorage
. - On other platforms the SDK uses a memory-only cache.
If you want to turn off the default behavior, you can set the SDK's cache to null
or to your own cache implementation.
val client = ConfigCatClient("#YOUR-SDK-KEY#") {
configCache = null
}
Custom Cache
The ConfigCat SDK stores the downloaded config data in a local cache to minimize network traffic and enhance client performance.
If you prefer to use your own cache solution, such as an external or distributed cache in your system,
you can implement the ConfigCache
interface
and set the configCache
parameter in the setup callback of ConfigCatClient
.
This allows you to seamlessly integrate ConfigCat with your existing caching infrastructure.
class MyCustomCache : ConfigCache {
override suspend fun read(key: String): String? {
// here you have to return with the cached value
}
override suspend fun write(key: String, value: String) {
// here you have to store the new value in the cache
}
}
Then use your custom cache implementation:
val client = ConfigCatClient("#YOUR-SDK-KEY#") {
configCache = MyCustomCache()
}
The Kotlin SDK supports shared caching. You can read more about this feature and the required minimum SDK versions here.
HTTP Engine
The ConfigCat SDK internally uses Ktor to download the latest config JSON over HTTP. For each platform the SDK includes a specific HTTP engine:
- Android / JVM:
ktor-client-okhttp
- macOS / iOS / tvOS / watchOS:
ktor-client-darwin
- JavaScript / Node.js:
ktor-client-js
- Windows / Linux: It is possible to use Ktor's Curl engine.
You can set/override the HTTP engine like the following:
// this example sets up the SDK to use the Curl engine for HTTP communication.
import com.configcat.*
import io.ktor.client.engine.curl.*
val client = ConfigCatClient("#YOUR-SDK-KEY#") {
httpEngine = Curl.create {
// additional engine setup
}
}
HTTP Timeout
You can set the maximum wait time for a ConfigCat HTTP response.
import com.configcat.*
import kotlin.time.Duration.Companion.seconds
val client = ConfigCatClient("#YOUR-SDK-KEY#") {
requestTimeout = 10.seconds
}
The default request timeout is 30 seconds.
HTTP Proxy
If your application runs behind a proxy you can do the following:
val client = ConfigCatClient("#YOUR-SDK-KEY#") {
httpProxy = ProxyBuilder.http("http://proxy-server:1234/")
}
You can check the availability of the proxy configuration in specific HTTP engines here.
Force refresh
Call the forceRefresh()
method on the client to download the latest config JSON and update the cache.
Logging
The default logger used by the SDK is simply using println()
to log messages, but you can override it with your custom logger implementation via the logger
client option. The custom implementation must satisfy the Logger interface.
class MyCustomLogger: Logger {
override fun error(message: String) {
// write the error logs
}
override fun error(message: String, throwable: Throwable) {
// write the error logs
}
override fun warning(message: String) {
// write the warning logs
}
override fun info(message: String) {
// write the info logs
}
override fun debug(message: String) {
// write the debug logs
}
}
Then you can use your custom logger implementation at the SDK's initialization:
val client = ConfigCatClient("#YOUR-SDK-KEY#") {
logger = MyCustomLogger()
}
You can change the verbosity of the logs by passing a logLevel
parameter to the client options.
val client = ConfigCatClient("#YOUR-SDK-KEY#") {
logLevel = LogLevel.INFO
}
Available log levels:
Level | Description |
---|---|
OFF | Turn the logging off. |
ERROR | Only error level events are logged. |
WARNING | Default. Errors and Warnings are logged. |
INFO | Errors, Warnings and feature flag evaluation is logged. |
DEBUG | All of the above plus debug info is logged. Debug logs can be different for other SDKs. |
Info level logging helps to inspect how a feature flag was evaluated:
[INFO] 2022-01-20T18:22:02.313703 ConfigCat - [5000] Evaluating 'isPOCFeatureEnabled' for User '{"Identifier":"<SOME USERID>","Email":"[email protected]","Country":"US","SubscriptionType":"Pro","Role":"Admin","version":"1.0.0"}'
Evaluating targeting rules and applying the first match if any:
- IF User.Email CONTAINS ANY OF ['@something.com'] THEN 'False' => no match
- IF User.Email CONTAINS ANY OF ['@example.com'] THEN 'True' => MATCH, applying rule
Returning 'True'.
Sensitive information handling
The frontend/mobile SDKs are running in your users' browsers/devices. The SDK is downloading a config JSON file from ConfigCat's CDN servers. The URL path for this config JSON file contains your SDK key, so the SDK key and the content of your config JSON file (feature flag keys, feature flag values, Targeting Rules, % rules) can be visible to your users. In ConfigCat, all SDK keys are read-only. They only allow downloading your config JSON files, but nobody can make any changes with them in your ConfigCat account.
If you do not want to expose the SDK key or the content of the config JSON file, we recommend using the SDK in your backend components only. You can always create a backend endpoint using the ConfigCat SDK that can evaluate feature flags for a specific user, and call that backend endpoint from your frontend/mobile applications.
Also, we recommend using confidential targeting comparators in the Targeting Rules of those feature flags that are used in the frontend/mobile SDKs.
Sample Apps
Check out our Sample Applications how they use the ConfigCat SDK