firebase-config/com.google.firebase.remoteconfig/FirebaseRemoteConfig

FirebaseRemoteConfig

actual class FirebaseRemoteConfig(source)

The entry point of Firebase Remote Config, as the Android SDK's com.google.firebase.remoteconfig.FirebaseRemoteConfig.

actual class FirebaseRemoteConfig(source)

expect class FirebaseRemoteConfig(source)

The entry point of Firebase Remote Config, as the Android SDK's com.google.firebase.remoteconfig.FirebaseRemoteConfig.

actual class FirebaseRemoteConfig(source)

Types

Companion

actual object Companion

expect object Companion

actual object Companion

Properties

all

actual val all: Map<String, FirebaseRemoteConfigValue>

All active values, keyed by parameter name.

actual val all: Map<String, FirebaseRemoteConfigValue>

The active values: the defaults, overridden by the activated remote values (the iOS SDK keeps them per source).

expect val all: Map<String, FirebaseRemoteConfigValue>

All active values, keyed by parameter name.

actual val all: Map<String, FirebaseRemoteConfigValue>

All active values, keyed by parameter name.

actual val all: Map<String, FirebaseRemoteConfigValue>

All active values, keyed by parameter name.

configUpdates

val FirebaseRemoteConfig.configUpdates: Flow<ConfigUpdate>

Real-time config updates as a Flow; each emission means the backend has a newer config to fetch and activate.

info

actual val info: FirebaseRemoteConfigInfo

The state of the most recent fetch and the current settings.

actual val info: FirebaseRemoteConfigInfo

The state of the most recent fetch and the current settings.

expect val info: FirebaseRemoteConfigInfo

The state of the most recent fetch and the current settings.

actual val info: FirebaseRemoteConfigInfo

The state of the most recent fetch and the current settings.

actual val info: FirebaseRemoteConfigInfo

The state of the most recent fetch and the current settings.

ios

val ios: FIRRemoteConfig

The underlying Firebase iOS SDK object.

val js: RemoteConfig

The underlying Firebase JS SDK object.

val js: RemoteConfig

The underlying Firebase JS SDK object.

Functions

activate

actual fun activate(): Task<Boolean>

Makes the most recently fetched config available to the getters; true if it changed the active config.

actual fun activate(): Task<Boolean>

Makes the most recently fetched config available to the getters; true if it changed the active config.

expect fun activate(): Task<Boolean>

Makes the most recently fetched config available to the getters; true if it changed the active config.

actual fun activate(): Task<Boolean>

Makes the most recently fetched config available to the getters; true if it changed the active config.

actual fun activate(): Task<Boolean>

Makes the most recently fetched config available to the getters; true if it changed the active config.

addOnConfigUpdateListener

actual fun addOnConfigUpdateListener(listener: ConfigUpdateListener): ConfigUpdateListenerRegistration

Starts listening for real-time config updates; ConfigUpdateListenerRegistration.remove stops them.

actual fun addOnConfigUpdateListener(listener: ConfigUpdateListener): ConfigUpdateListenerRegistration

Starts listening for real-time config updates; ConfigUpdateListenerRegistration.remove stops them.

expect fun addOnConfigUpdateListener(listener: ConfigUpdateListener): ConfigUpdateListenerRegistration

Starts listening for real-time config updates; ConfigUpdateListenerRegistration.remove stops them.

actual fun addOnConfigUpdateListener(listener: ConfigUpdateListener): ConfigUpdateListenerRegistration

Starts listening for real-time config updates; ConfigUpdateListenerRegistration.remove stops them.

actual fun addOnConfigUpdateListener(listener: ConfigUpdateListener): ConfigUpdateListenerRegistration

Starts listening for real-time config updates; ConfigUpdateListenerRegistration.remove stops them.

ensureInitialized

actual fun ensureInitialized(): Task<FirebaseRemoteConfigInfo>

Completes with the FirebaseRemoteConfigInfo once the config has been loaded from disk.

actual fun ensureInitialized(): Task<FirebaseRemoteConfigInfo>

Completes with the FirebaseRemoteConfigInfo once the config has been loaded from disk.

expect fun ensureInitialized(): Task<FirebaseRemoteConfigInfo>

Completes with the FirebaseRemoteConfigInfo once the config has been loaded from disk.

actual fun ensureInitialized(): Task<FirebaseRemoteConfigInfo>

Completes with the FirebaseRemoteConfigInfo once the config has been loaded from disk.

actual fun ensureInitialized(): Task<FirebaseRemoteConfigInfo>

Completes with the FirebaseRemoteConfigInfo once the config has been loaded from disk.

equals

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

fetch

actual fun fetch(): Task<Nothing?>

Fetches config from the backend, honouring the configured minimum fetch interval.

actual fun fetch(minimumFetchIntervalInSeconds: Long): Task<Nothing?>

Fetches config from the backend, if the cached config is older than minimumFetchIntervalInSeconds.

actual fun fetch(): Task<Nothing?>

Fetches config from the backend, honouring the configured minimum fetch interval.

actual fun fetch(minimumFetchIntervalInSeconds: Long): Task<Nothing?>

Fetches config from the backend, if the cached config is older than minimumFetchIntervalInSeconds.

expect fun fetch(): Task<Nothing?>

Fetches config from the backend, honouring the configured minimum fetch interval.

expect fun fetch(minimumFetchIntervalInSeconds: Long): Task<Nothing?>

Fetches config from the backend, if the cached config is older than minimumFetchIntervalInSeconds.

actual fun fetch(): Task<Nothing?>

The JS SDK has no per-call interval: this is the same as fetch.

actual fun fetch(minimumFetchIntervalInSeconds: Long): Task<Nothing?>

Fetches config from the backend, if the cached config is older than minimumFetchIntervalInSeconds.

actual fun fetch(): Task<Nothing?>

The JS SDK has no per-call interval: this is the same as fetch.

actual fun fetch(minimumFetchIntervalInSeconds: Long): Task<Nothing?>

Fetches config from the backend, if the cached config is older than minimumFetchIntervalInSeconds.

fetchAndActivate

actual fun fetchAndActivate(): Task<Boolean>

fetch followed by activate; true if the fetched config changed the active config.

actual fun fetchAndActivate(): Task<Boolean>

fetch followed by activate; true if the fetched config changed the active config.

expect fun fetchAndActivate(): Task<Boolean>

fetch followed by activate; true if the fetched config changed the active config.

actual fun fetchAndActivate(): Task<Boolean>

fetch followed by activate; true if the fetched config changed the active config.

actual fun fetchAndActivate(): Task<Boolean>

fetch followed by activate; true if the fetched config changed the active config.

get

operator fun FirebaseRemoteConfig.get(key: String): FirebaseRemoteConfigValue

The active value of key; see FirebaseRemoteConfig.getValue.

getBoolean

actual fun getBoolean(key: String): Boolean

The active value of key as a boolean, or DEFAULT_VALUE_FOR_BOOLEAN.

actual fun getBoolean(key: String): Boolean

The active value of key as a boolean, or DEFAULT_VALUE_FOR_BOOLEAN.

expect fun getBoolean(key: String): Boolean

The active value of key as a boolean, or DEFAULT_VALUE_FOR_BOOLEAN.

actual fun getBoolean(key: String): Boolean

The active value of key as a boolean, or DEFAULT_VALUE_FOR_BOOLEAN.

actual fun getBoolean(key: String): Boolean

The active value of key as a boolean, or DEFAULT_VALUE_FOR_BOOLEAN.

getDouble

actual fun getDouble(key: String): Double

The active value of key as a double, or DEFAULT_VALUE_FOR_DOUBLE.

actual fun getDouble(key: String): Double

The active value of key as a double, or DEFAULT_VALUE_FOR_DOUBLE.

expect fun getDouble(key: String): Double

The active value of key as a double, or DEFAULT_VALUE_FOR_DOUBLE.

actual fun getDouble(key: String): Double

The active value of key as a double, or DEFAULT_VALUE_FOR_DOUBLE.

actual fun getDouble(key: String): Double

The active value of key as a double, or DEFAULT_VALUE_FOR_DOUBLE.

getKeysByPrefix

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

The active keys starting with prefix.

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

The iOS SDK's keysWithPrefix only looks at the active config, so the defaults are included like the Android SDK does.

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

The active keys starting with prefix.

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

The active keys starting with prefix.

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

The active keys starting with prefix.

getLong

actual fun getLong(key: String): Long

The active value of key as a long, or DEFAULT_VALUE_FOR_LONG.

actual fun getLong(key: String): Long

The active value of key as a long, or DEFAULT_VALUE_FOR_LONG.

expect fun getLong(key: String): Long

The active value of key as a long, or DEFAULT_VALUE_FOR_LONG.

actual fun getLong(key: String): Long

The active value of key as a long, or DEFAULT_VALUE_FOR_LONG.

actual fun getLong(key: String): Long

The active value of key as a long, or DEFAULT_VALUE_FOR_LONG.

getString

actual fun getString(key: String): String

The active value of key as a string, or DEFAULT_VALUE_FOR_STRING.

actual fun getString(key: String): String

The active value of key as a string, or DEFAULT_VALUE_FOR_STRING.

expect fun getString(key: String): String

The active value of key as a string, or DEFAULT_VALUE_FOR_STRING.

actual fun getString(key: String): String

The active value of key as a string, or DEFAULT_VALUE_FOR_STRING.

actual fun getString(key: String): String

The active value of key as a string, or DEFAULT_VALUE_FOR_STRING.

getValue

actual fun getValue(key: String): FirebaseRemoteConfigValue

The active value of key.

actual fun getValue(key: String): FirebaseRemoteConfigValue

The active value of key.

expect fun getValue(key: String): FirebaseRemoteConfigValue

The active value of key.

actual fun getValue(key: String): FirebaseRemoteConfigValue

The active value of key.

actual fun getValue(key: String): FirebaseRemoteConfigValue

The active value of key.

hashCode

open override fun hashCode(): Int

reset

actual fun reset(): Task<Nothing?>

Clears the fetched, active and default config and the settings. The Apple and JS SDKs expose no way to drop the activated values, so there only the defaults are cleared and the settings restored.

actual fun reset(): Task<Nothing?>

The iOS SDK has no reset: the defaults are cleared and the settings restored, but the activated values stay, as the SDK exposes no way to drop them.

expect fun reset(): Task<Nothing?>

Clears the fetched, active and default config and the settings. The Apple and JS SDKs expose no way to drop the activated values, so there only the defaults are cleared and the settings restored.

actual fun reset(): Task<Nothing?>

The JS SDK has no reset: the defaults are cleared and the settings restored, but the activated values stay, as the SDK exposes no way to drop them.

actual fun reset(): Task<Nothing?>

The JS SDK has no reset: the defaults are cleared and the settings restored, but the activated values stay, as the SDK exposes no way to drop them.

setConfigSettingsAsync

actual fun setConfigSettingsAsync(settings: FirebaseRemoteConfigSettings): Task<Nothing?>

Applies settings.

actual fun setConfigSettingsAsync(settings: FirebaseRemoteConfigSettings): Task<Nothing?>

Applies settings.

expect fun setConfigSettingsAsync(settings: FirebaseRemoteConfigSettings): Task<Nothing?>

Applies settings.

actual fun setConfigSettingsAsync(settings: FirebaseRemoteConfigSettings): Task<Nothing?>

Applies settings.

actual fun setConfigSettingsAsync(settings: FirebaseRemoteConfigSettings): Task<Nothing?>

Applies settings.

setCustomSignals

actual fun setCustomSignals(customSignals: CustomSignals): Task<Nothing?>

Sets the custom signals sent with fetches, which the backend can target conditions on; a null value removes a signal.

actual fun setCustomSignals(customSignals: CustomSignals): Task<Nothing?>

Sets the custom signals sent with fetches, which the backend can target conditions on; a null value removes a signal.

expect fun setCustomSignals(customSignals: CustomSignals): Task<Nothing?>

Sets the custom signals sent with fetches, which the backend can target conditions on; a null value removes a signal.

actual fun setCustomSignals(customSignals: CustomSignals): Task<Nothing?>

Sets the custom signals sent with fetches, which the backend can target conditions on; a null value removes a signal.

actual fun setCustomSignals(customSignals: CustomSignals): Task<Nothing?>

Sets the custom signals sent with fetches, which the backend can target conditions on; a null value removes a signal.

setDefaultsAsync

actual fun ~~setDefaultsAsync~~(resourceId: Int): Task<Nothing?>

Android-only: reads the defaults from an XML resource.

actual fun setDefaultsAsync(defaults: Map<String, Any?>): Task<Nothing?>