Also: Google
Play services
public class FirebaseRemoteConfig extends Object
Entry point for the Firebase Remote Config (FRC) API.
Callers should first get the singleton object using
getInstance()
, and then call operations on that singleton object. The singleton
contains the complete set of FRC parameter values available to your app. The singleton also
stores values fetched from the FRC Server until they are made available for use with a call
to
activate()
.
Constant Summary
boolean | DEFAULT_VALUE_FOR_BOOLEAN | The static default boolean value for any given key. |
double | DEFAULT_VALUE_FOR_DOUBLE | The static default double value for any given key. |
long | DEFAULT_VALUE_FOR_LONG | The static default long value for any given key. |
String | DEFAULT_VALUE_FOR_STRING | The static default string value for any given key. |
int | LAST_FETCH_STATUS_FAILURE | Indicates that the most recent attempt to fetch parameter values from the Firebase Remote Config Server has failed. |
int | LAST_FETCH_STATUS_NO_FETCH_YET | Indicates that the FirebaseRemoteConfig singleton object has not yet attempted to fetch parameter values from the Firebase Remote Config Server. |
int | LAST_FETCH_STATUS_SUCCESS | Indicates that the most recent fetch of parameter values from the Firebase Remote Config Server was completed successfully. |
int | LAST_FETCH_STATUS_THROTTLED | Indicates that the most recent attempt to fetch parameter values from the Firebase Remote Config Server was throttled. |
int | VALUE_SOURCE_DEFAULT | Indicates that the value returned was retrieved from the defaults set by the client. |
int | VALUE_SOURCE_REMOTE | Indicates that the value returned was retrieved from the Firebase Remote Config Server. |
int | VALUE_SOURCE_STATIC | Indicates that the value returned is the static default value. |
Field Summary
public static final byte[] | DEFAULT_VALUE_FOR_BYTE_ARRAY | The static default byte array value for any given key. |
Public Method Summary
Task<Boolean> |
activate()
Asynchronously activates the most recently fetched configs, so that the fetched
key value pairs take effect.
|
boolean |
activateFetched()
This method was deprecated. Use
activate() instead.
|
Task<FirebaseRemoteConfigInfo> |
ensureInitialized()
Returns a
Task
representing the initialization status of this Firebase Remote Config instance.
|
Task<Void> |
fetch(long minimumFetchIntervalInSeconds)
Starts fetching configs, adhering to the specified minimum fetch interval.
|
Task<Void> |
fetch()
Starts fetching configs, adhering to the default minimum fetch interval.
|
Task<Boolean> |
fetchAndActivate()
Asynchronously fetches and then activates the fetched configs.
|
Map<String, FirebaseRemoteConfigValue> | |
boolean | |
byte[] | |
double | |
FirebaseRemoteConfigInfo |
getInfo()
Returns the state of this
FirebaseRemoteConfig instance as a
FirebaseRemoteConfigInfo .
|
static FirebaseRemoteConfig |
getInstance()
Returns a singleton instance of Firebase Remote Config.
|
static FirebaseRemoteConfig |
getInstance(FirebaseApp
app)
Returns an instance of Firebase Remote Config for the given
FirebaseApp .
|
Set<String> |
getKeysByPrefix(String prefix)
Returns a
Set of all
Firebase Remote Config parameter keys with the given prefix.
|
long |