firebase-config/io.github.corneloaie.firebase.remoteconfig/FirebaseRemoteConfig

FirebaseRemoteConfig

class FirebaseRemoteConfig(source)

Entry point for the Firebase Remote Config API.

Properties

val all: Map<String, FirebaseRemoteConfigValue>

Returns a map of Firebase Remote Config key value pairs.

val FirebaseRemoteConfig.android: FirebaseRemoteConfig

The underlying Firebase Android SDK object.

val compat: FirebaseRemoteConfig

The Android-SDK-shaped com.google.firebase.remoteconfig.FirebaseRemoteConfig this wraps.

val info: FirebaseRemoteConfigInfo

Returns the state of this FirebaseRemoteConfig instance.

val FirebaseRemoteConfig.ios: FIRRemoteConfig

The underlying Firebase iOS SDK object.

val FirebaseRemoteConfig.js: RemoteConfig

The underlying Firebase JS SDK object.

val FirebaseRemoteConfig.js: RemoteConfig

The underlying Firebase JS SDK object.

Functions

suspend fun activate(): Boolean

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

ensureInitialized

suspend fun ensureInitialized()

Ensures the last activated config is available to the getters.

open operator override fun equals(other: Any?): Boolean

suspend fun fetch(minimumFetchInterval: Duration? = null)

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

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

fetchAndActivate

suspend fun fetchAndActivate(): Boolean

Asynchronously fetches and then activates the fetched configs.

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

getKeysByPrefix

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

Returns the set of parameter keys that start with the given prefix.

fun getValue(key: String): FirebaseRemoteConfigValue

Returns the parameter value for the given key.

open override fun hashCode(): Int

suspend fun reset()

Deletes all activated, fetched and defaults configs and resets the settings. On Apple and JS the activated values stay, as those SDKs expose no way to drop them: only the defaults are cleared and the settings restored.

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

Asynchronously sets default configs using the given map.

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

Asynchronously changes the settings for this FirebaseRemoteConfig instance.

open override fun toString(): String