com.google.firebase.remoteconfig
Interfaces
ConfigUpdateListener | Event listener interface for real-time Remote Config updates. |
ConfigUpdateListenerRegistration | Listener registration returned by |
FirebaseRemoteConfigInfo | Wraps the current state of the |
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 |
CustomSignals | A container type to represent key/value pairs of heterogeneous types to be set as custom signals in |
CustomSignals.Builder | Builder for constructing |
FirebaseRemoteConfig | Entry point for the Firebase Remote Config API. |
FirebaseRemoteConfigSettings | Wraps the settings for |
FirebaseRemoteConfigSettings.Builder | Builder for a |
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 |
FirebaseRemoteConfigFetchThrottledException | An exception thrown when a |
FirebaseRemoteConfigServerException | A Firebase Remote Config internal issue caused by an interaction with the Firebase Remote Config server. |
Enums
Top-level functions summary
CustomSignals | customSignals(builder: CustomSignals.Builder.() -> Unit) |
FirebaseRemoteConfigSettings | remoteConfigSettings(init: FirebaseRemoteConfigSettings.Builder.() -> Unit) |
Extension functions summary
operator FirebaseRemoteConfigValue | FirebaseRemoteConfig.get(key: String) See FirebaseRemoteConfig#getValue |
FirebaseRemoteConfig | Firebase.remoteConfig(app: FirebaseApp) Returns the |
Extension properties summary
Flow<ConfigUpdate> | Starts listening for config updates from the Remote Config backend and emits |
FirebaseRemoteConfig | Returns the |
Top-level functions
remoteConfigSettings
fun remoteConfigSettings(init: FirebaseRemoteConfigSettings.Builder.() -> Unit): FirebaseRemoteConfigSettings
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.configUpdates: Flow<ConfigUpdate>
Starts listening for config updates from the Remote Config backend and emits ConfigUpdate
s 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.remoteConfig: FirebaseRemoteConfig
Returns the FirebaseRemoteConfig
instance of the default FirebaseApp
.