react-native-firebase / remote-config/lib/modular
remote-config/lib/modular
CustomSignals
Defined in: remote-config/lib/modular/index.d.ts:251
Defines the type for representing custom signals and their values. The values in CustomSignals must be one of the following types: string, number, or null. There are additional limitations on key and value length, for a full description see [https://firebase.google.com/docs/remote-config/parameters?template_type=client#custom_signal_conditions] Failing to stay within these limitations will result in a silent API failure with only a warning in device logs
LastFetchStatus
constLastFetchStatus:LastFetchStatusInterface
Defined in: remote-config/lib/modular/index.d.ts:37
ValueSource
constValueSource:ValueSourceInterface
Defined in: remote-config/lib/modular/index.d.ts:38
activate()
activate(
remoteConfig):Promise<boolean>
Defined in: remote-config/lib/modular/index.d.ts:53
Returns a Boolean which resolves to true if the current call activated the fetched configs.
ensureInitialized()
ensureInitialized(
remoteConfig):Promise<void>
Defined in: remote-config/lib/modular/index.d.ts:60
Ensures the last activated config are available to the getters.
fetch()
fetch(
remoteConfig,expirationDurationSeconds?):Promise<void>
Defined in: remote-config/lib/modular/index.d.ts:185
Fetches parameter values for your app.
fetchAndActivate()
fetchAndActivate(
remoteConfig):Promise<boolean>
Defined in: remote-config/lib/modular/index.d.ts:68
Performs a fetch and returns a Boolean which resolves to true if the current call activated the fetched configs.
fetchConfig()
fetchConfig(
remoteConfig):Promise<void>
Defined in: remote-config/lib/modular/index.d.ts:75
Fetches and caches configuration from the Remote Config service.
fetchTimeMillis()
fetchTimeMillis(
remoteConfig):number
Defined in: remote-config/lib/modular/index.d.ts:141
Indicates the default value in milliseconds to abandon a pending fetch request made to the Remote Config server. Defaults to 60000 (One minute).
getAll()
getAll(
remoteConfig):ConfigValues
Defined in: remote-config/lib/modular/index.d.ts:82
Gets all config.
getBoolean()
getBoolean(
remoteConfig,key):boolean
Defined in: remote-config/lib/modular/index.d.ts:90
Gets the value for the given key as a boolean.
getNumber()
getNumber(
remoteConfig,key):number
Defined in: remote-config/lib/modular/index.d.ts:98
Gets the value for the given key as a number.
getRemoteConfig()
getRemoteConfig(
app?):Module
Defined in: remote-config/lib/modular/index.d.ts:45
Returns a RemoteConfig instance for the given app.
getString()
getString(
remoteConfig,key):string
Defined in: remote-config/lib/modular/index.d.ts:106
Gets the value for the given key as a string.
getValue()
getValue(
remoteConfig,key):ConfigValue
Defined in: remote-config/lib/modular/index.d.ts:114
Gets the value for the given key
isSupported()
isSupported():
Promise<boolean>
Defined in: remote-config/lib/modular/index.d.ts:133
Checks two different things.
- Check if IndexedDB exists in the browser environment.
- Check if the current browser context allows IndexedDB open() calls.
lastFetchStatus()
lastFetchStatus(
remoteConfig):LastFetchStatusType
Defined in: remote-config/lib/modular/index.d.ts:156
The status of the latest Remote RemoteConfig fetch action.
onConfigUpdate()
onConfigUpdate(
remoteConfig,observer):Unsubscribe
Defined in: remote-config/lib/modular/index.d.ts:226
Starts listening for real-time config updates from the Remote Config backend and automatically fetches updates from the Remote Config backend when they are available.
Remarks
If a connection to the Remote Config backend is not already open, calling this method will open it. Multiple listeners can be added by calling this method again, but subsequent calls re-use the same connection to the backend.
The list of updated keys passed to the callback will include all keys not currently active, and the config update process fetches the new config but does not automatically activate it for you. Typically you will activate the config in your callback to use the new values.
onConfigUpdated()
onConfigUpdated(
remoteConfig,callback): () =>void
Defined in: remote-config/lib/modular/index.d.ts:239
Registers a listener to changes in the configuration.
reset()
reset(
remoteConfig):Promise<void>
Defined in: remote-config/lib/modular/index.d.ts:165
Deletes all activated, fetched and defaults configs and resets all Firebase Remote Config settings. Android only. iOS does not reset anything.
setConfigSettings()
setConfigSettings(
remoteConfig,settings):Promise<void>
Defined in: remote-config/lib/modular/index.d.ts:174
Set the Remote RemoteConfig settings, currently able to set
fetchTimeMillis & minimumFetchIntervalMillis
setCustomSignals()
setCustomSignals(
remoteConfig,customSignals):Promise<void>
Defined in: remote-config/lib/modular/index.d.ts:262
Sets the custom signals for the app instance.
setDefaults()
setDefaults(
remoteConfig,defaults):Promise<void>
Defined in: remote-config/lib/modular/index.d.ts:196
Fetches parameter values for your app.
setDefaultsFromResource()
setDefaultsFromResource(
remoteConfig,resourceName):Promise<null>
Defined in: remote-config/lib/modular/index.d.ts:204
Fetches parameter values for your app.
setLogLevel()
setLogLevel(
remoteConfig,logLevel):RemoteConfigLogLevel
Defined in: remote-config/lib/modular/index.d.ts:122
Defines the log level to use.
settings()
settings(
remoteConfig):ConfigSettings
Defined in: remote-config/lib/modular/index.d.ts:149
Returns a ConfigSettings object which provides the properties minimumFetchIntervalMillis and fetchTimeMillis if they have been set
using setConfigSettings({ fetchTimeMillis: number, minimumFetchIntervalMillis: number }).