configcat-kotlin-client/com.configcat

Package-level declarations

Types

AutoPollConfiguration

data class AutoPollConfiguration(var pollingInterval: Duration = 60.seconds, var maxInitWaitTime: Duration = 5.seconds)

Describes the auto polling configuration.

interface ConfigCache

A cache API used to make custom cache implementations.

ConfigCatClient

interface ConfigCatClient

ConfigCat SDK client.

ConfigCatOptions

class ConfigCatOptions

Configuration options for ConfigCatClient.

class ConfigCatUser(val identifier: String, email: String? = null, country: String? = null, custom: Map<String, Any>? = null)

An object containing attributes to properly identify a given user for variation evaluation. Its only mandatory attribute is the identifier.

enum DataGovernance : Enum<DataGovernance>

Describes the location of your feature flag and setting data within the ConfigCat CDN.

EvaluationDetails

class EvaluationDetails : EvaluationDetailsBase

Additional information about flag evaluation.

EvaluationDetailsBase

open class EvaluationDetailsBase

Additional information about flag evaluation.

class Hooks

Events fired by ConfigCatClient.

LazyLoadConfiguration

data class LazyLoadConfiguration(var cacheRefreshInterval: Duration = 60.seconds)

Describes the lazy load polling configuration.

LocalStorageCache

class LocalStorageCache : ConfigCache

ConfigCache implementation that uses localStorage as persistent storage.

interface PollingMode

Describes a polling mode configuration.

SharedPreferencesCache

class SharedPreferencesCache(context: Context) : ConfigCache

ConfigCache implementation that uses SharedPreferences as persistent storage.

TypedEvaluationDetails

class TypedEvaluationDetails<T>(val key: String, val variationId: String?, val user: ConfigCatUser?, val isDefaultValue: Boolean, val error: String?, val value: T, val fetchTimeUnixMilliseconds: Long, val matchedTargetingRule: TargetingRule?, val matchedPercentageOption: PercentageOption?) : EvaluationDetailsBase

Additional information about flag evaluation.

UserDefaultsCache

class UserDefaultsCache : ConfigCache

ConfigCache implementation that uses NSUserDefaults as persistent storage.

Functions

fun autoPoll(block: AutoPollConfiguration.() -> Unit = {}): PollingMode

Creates an auto polling configuration.

ConfigCatClient

fun ConfigCatClient(sdkKey: String, block: ConfigCatOptions.() -> Unit = {}): ConfigCatClient

Creates a new or gets an already existing ConfigCatClient for the given sdkKey.

inline suspend fun <T> ConfigCatClient.getValue(key: String, defaultValue: T, user: ConfigCatUser? = null): T

Gets the value of a feature flag or setting as T identified by the given key.

getValueDetails

inline suspend fun <T> ConfigCatClient.getValueDetails(key: String, defaultValue: T, user: ConfigCatUser? = null): TypedEvaluationDetails<T>

Gets the value and evaluation details of a feature flag or setting identified by the given key.

fun lazyLoad(block: LazyLoadConfiguration.() -> Unit = {}): PollingMode

Creates a lazy load polling configuration.

fun manualPoll(): PollingMode

Creates a manual polling configuration.