firebase::remote_config

Firebase Remote Config API.

Summary

Firebase Remote Config is a cloud service that lets you change the appearance and behavior of your app without requiring users to download an app update.

Enumerations

ConfigSetting{
  kConfigSettingDeveloperMode
}		enum
Keys of API settings.
FetchFailureReason{
  kFetchFailureReasonInvalid,
  kFetchFailureReasonThrottled,
  kFetchFailureReasonError
}		enum
Describes the most recent fetch failure.
LastFetchStatus{
  kLastFetchStatusSuccess,
  kLastFetchStatusFailure,
  kLastFetchStatusPending
}		enum
Describes the most recent fetch request status.
RemoteConfigErrorenum
Describes the error codes returned by Remote Config.
ValueSource{
  kValueSourceStaticValue,
  kValueSourceRemoteValue,
  kValueSourceDefaultValue
}		enum
Describes the source a config value was retrieved from.

Classes

firebase::remote_config::ConfigUpdateListenerRegistration

Calling Remove stops the listener from receiving config updates and unregisters itself.

firebase::remote_config::RemoteConfig

Entry point for the Firebase C++ SDK for Remote Config.

Structs

firebase::remote_config::ConfigInfo

Describes the state of the most recent Fetch() call.

firebase::remote_config::ConfigKeyValue

Describes a mapping of a key to a string value.

firebase::remote_config::ConfigKeyValueVariant

Describes a mapping of a key to a value of any type.

firebase::remote_config::ConfigSettings

Configurations for Remote Config behavior.

firebase::remote_config::ConfigUpdate

Information about the updated config.

firebase::remote_config::ValueInfo

Describes a retrieved value.

Enumerations

ConfigSetting

ConfigSetting

Keys of API settings.

See also:SetConfigSettingSee also:GetConfigSetting

Properties
kConfigSettingDeveloperMode

Set the value associated with this key to "1" to enable developer mode (i.e disable throttling) and "0" to disable.

FetchFailureReason

FetchFailureReason

Describes the most recent fetch failure.

Properties
kFetchFailureReasonError

The most recent fetch failed for an unknown reason.

kFetchFailureReasonInvalid

The fetch has not yet failed.

kFetchFailureReasonThrottled

The most recent fetch failed because it was throttled by the server.

(You are sending too many fetch requests in too short a time.)

LastFetchStatus

LastFetchStatus

Describes the most recent fetch request status.

Properties
kLastFetchStatusFailure

The most recent fetch request failed.

kLastFetchStatusPending

The most recent fetch is still in progress.

kLastFetchStatusSuccess

The most recent fetch was a success, and its data is ready to be applied, if you have not already done so.

RemoteConfigError

RemoteConfigError

Describes the error codes returned by Remote Config.

ValueSource

ValueSource

Describes the source a config value was retrieved from.

Properties
kValueSourceDefaultValue

The value was not specified, so the specified default value was returned instead.

kValueSourceRemoteValue

The value was found in the remote data store, and returned.

kValueSourceStaticValue

The value was not specified and no default was specified, so a static value (0 for numeric values, an empty string for strings) was returned.

Except as otherwise noted, the content of this page is licensed under theCreative Commons Attribution 4.0 License, and code samples are licensed under theApache 2.0 License. For details, see theGoogle Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.

Last updated 2023-05-04 UTC.