com.google.firebase.remoteconfig

Interfaces

ConfigUpdateListener

Event listener interface for real-time Remote Config updates.

ConfigUpdateListenerRegistration

Listener registration returned by addOnConfigUpdateListener.

FirebaseRemoteConfigInfo

Wraps the current state of the FirebaseRemoteConfig singleton object.

FirebaseRemoteConfigValue

Wrapper for a Remote Config parameter value, with methods to get it as different types.

Classes

ConfigUpdate

Information about the updated config passed to onUpdate.

FirebaseRemoteConfig

Entry point for the Firebase Remote Config API.

FirebaseRemoteConfigSettings

Wraps the settings for FirebaseRemoteConfig operations.

FirebaseRemoteConfigSettings.Builder

Builder for a FirebaseRemoteConfigSettings.

Exceptions

FirebaseRemoteConfigClientException

A Firebase Remote Config internal issue that isn't caused by an interaction with the Firebase Remote Config server.

FirebaseRemoteConfigException

Base class for FirebaseRemoteConfig exceptions.

FirebaseRemoteConfigFetchThrottledException

An exception thrown when a fetch call is throttled.

FirebaseRemoteConfigServerException

A Firebase Remote Config internal issue caused by an interaction with the Firebase Remote Config server.

Enums

Top-level functions summary

Extension functions summary

operator FirebaseRemoteConfigValue

See FirebaseRemoteConfig#getValue

FirebaseRemoteConfig

Returns the FirebaseRemoteConfig instance of a given FirebaseApp.

Extension properties summary

Flow<ConfigUpdate>

Starts listening for config updates from the Remote Config backend and emits ConfigUpdates via a Flow.

FirebaseRemoteConfig

Returns the FirebaseRemoteConfig instance of the default FirebaseApp.

Top-level functions

Extension functions

get

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

See FirebaseRemoteConfig#getValue

remoteConfig

fun Firebase.remoteConfig(app: FirebaseApp): FirebaseRemoteConfig

Returns the FirebaseRemoteConfig instance of a given FirebaseApp.

Extension properties

configUpdates

val FirebaseRemoteConfig.configUpdatesFlow<ConfigUpdate>

Starts listening for config updates from the Remote Config backend and emits ConfigUpdates via a Flow. See FirebaseRemoteConfig.addOnConfigUpdateListener for more information.

  • When the returned flow starts being collected, an ConfigUpdateListener will be attached.

  • When the flow completes, the listener will be removed. If there are no attached listeners, the connection to the Remote Config backend will be closed.

remoteConfig

val Firebase.remoteConfigFirebaseRemoteConfig

Returns the FirebaseRemoteConfig instance of the default FirebaseApp.