firebase-config/dev.gitlive.firebase.remoteconfig/FirebaseRemoteConfig

FirebaseRemoteConfig

actual class FirebaseRemoteConfig(source)

expect class FirebaseRemoteConfig(source)

Entry point for the Firebase Remote Config API.

Callers should first get the singleton object using Firebase.remoteConfig, and then call operations on that singleton object. The singleton contains the complete set of Remote Config parameter values available to your app. The singleton also stores values fetched from the Remote Config server until they are made available for use with a call to activate.

actual class FirebaseRemoteConfig(source)

actual class FirebaseRemoteConfig(source)

actual class FirebaseRemoteConfig(source)

Properties

actual val all: Map<String, FirebaseRemoteConfigValue>

expect val all: Map<String, FirebaseRemoteConfigValue>

Returns a Map of Firebase Remote Config key value pairs.

actual val all: Map<String, FirebaseRemoteConfigValue>

actual val all: Map<String, FirebaseRemoteConfigValue>

actual val all: Map<String, FirebaseRemoteConfigValue>

val FirebaseRemoteConfig.android: FirebaseRemoteConfig

val FirebaseRemoteConfig.android: FirebaseRemoteConfig

actual val info: FirebaseRemoteConfigInfo

expect val info: FirebaseRemoteConfigInfo

Returns the state of this FirebaseRemoteConfig instance as a FirebaseRemoteConfigInfo.

actual val info: FirebaseRemoteConfigInfo

actual val info: FirebaseRemoteConfigInfo

actual val info: FirebaseRemoteConfigInfo

val FirebaseRemoteConfig.ios: FIRRemoteConfig

val FirebaseRemoteConfig.js: RemoteConfig

Functions

actual suspend fun activate(): Boolean

expect suspend fun activate(): Boolean

Asynchronously activates the most recently fetched configs, so that the fetched key value pairs take effect.

actual suspend fun activate(): Boolean

actual suspend fun activate(): Boolean

actual suspend fun activate(): Boolean

ensureInitialized

actual suspend fun ensureInitialized()

expect suspend fun ensureInitialized()

Ensures the last activated config are available to the app.

actual suspend fun ensureInitialized()

actual suspend fun ensureInitialized()

actual suspend fun ensureInitialized()

actual suspend fun fetch(minimumFetchInterval: Duration?)

expect suspend fun fetch(minimumFetchInterval: Duration? = null)

Starts fetching configs, adhering to the specified minimum fetch interval.

actual suspend fun fetch(minimumFetchInterval: Duration?)

actual suspend fun fetch(minimumFetchInterval: Duration?)

actual suspend fun fetch(minimumFetchInterval: Duration?)

suspend fun FirebaseRemoteConfig.~~fetch~~(minimumFetchIntervalInSeconds: Long)

fetchAndActivate

actual suspend fun fetchAndActivate(): Boolean

expect suspend fun fetchAndActivate(): Boolean

Asynchronously fetches and then activates the fetched configs.

actual suspend fun fetchAndActivate(): Boolean

actual suspend fun fetchAndActivate(): Boolean

actual suspend fun fetchAndActivate(): Boolean

inline operator fun <T> FirebaseRemoteConfig.get(key: String): T

getKeysByPrefix

actual fun getKeysByPrefix(prefix: String): Set<String>

expect fun getKeysByPrefix(prefix: String): Set<String>

Returns a Set of all Firebase Remote Config parameter keys with the given prefix.

actual fun getKeysByPrefix(prefix: String): Set<String>

actual fun getKeysByPrefix(prefix: String): Set<String>

actual fun getKeysByPrefix(prefix: String): Set<String>

actual fun getValue(key: String): FirebaseRemoteConfigValue

expect fun getValue(key: String): FirebaseRemoteConfigValue

Returns the parameter value for the given key as a FirebaseRemoteConfigValue.

actual fun getValue(key: String): FirebaseRemoteConfigValue

actual fun getValue(key: String): FirebaseRemoteConfigValue

actual fun getValue(key: String): FirebaseRemoteConfigValue

actual suspend fun reset()

expect suspend fun reset()

Deletes all activated, fetched and defaults configs and resets all Firebase Remote Config settings.

actual suspend fun reset()

actual suspend fun reset()

actual suspend fun reset()

actual suspend fun setDefaults(vararg defaults: Pair<String, Any?>)

expect suspend fun setDefaults(vararg defaults: Pair<String, Any?>)

Asynchronously sets default configs using the given Map.

actual suspend fun setDefaults(vararg defaults: Pair<String, Any?>)

actual suspend fun setDefaults(vararg defaults: Pair<String, Any?>)

actual suspend fun setDefaults(vararg defaults: Pair<String, Any?>)

actual suspend fun settings(init: FirebaseRemoteConfigSettings.() -> Unit)

expect suspend fun settings(init: FirebaseRemoteConfigSettings.() -> Unit)

Asynchronously changes the settings for this FirebaseRemoteConfig instance.

actual suspend fun settings(init: FirebaseRemoteConfigSettings.() -> Unit)

actual suspend fun settings(init: FirebaseRemoteConfigSettings.() -> Unit)

actual suspend fun settings(init: FirebaseRemoteConfigSettings.() -> Unit)