Security News
Node.js EOL Versions CVE Dubbed the "Worst CVE of the Year" by Security Experts
Critics call the Node.js EOL CVE a misuse of the system, sparking debate over CVE standards and the growing noise in vulnerability databases.
@capacitor-firebase/remote-config
Advanced tools
Unofficial Capacitor plugin for Firebase Remote Config.1
npm install @capacitor-firebase/remote-config firebase
npx cap sync
Add Firebase to your project if you haven't already (Android / iOS / Web).
Google Analytics is required for the conditional targeting of app instances to user properties and audiences. Make sure that you install the Capacitor Firebase Analytics plugin in your project.
This plugin will use the following project variables (defined in your app’s variables.gradle
file):
$firebaseConfigVersion
version of com.google.firebase:firebase-config
(default: 21.3.0
)No configuration required for this plugin.
A working example can be found here: robingenz/capacitor-firebase-plugin-demo
The following starter templates are available:
import { FirebaseRemoteConfig } from '@capacitor-firebase/remote-config';
const activate = async () => {
await FirebaseRemoteConfig.activate();
};
const fetchAndActivate = async () => {
await FirebaseRemoteConfig.fetchAndActivate();
};
const fetchConfig = async () => {
await FirebaseRemoteConfig.fetchConfig({
minimumFetchIntervalInSeconds: 1200,
});
};
const getBoolean = async () => {
const { value } = await FirebaseRemoteConfig.getBoolean({
key: 'is_sale',
});
return value;
};
const getNumber = async () => {
const { value } = await FirebaseRemoteConfig.getNumber({
key: 'upcoming_maintenance',
});
return value;
};
const getString = async () => {
const { value } = await FirebaseRemoteConfig.getString({
key: 'license_key',
});
return value;
};
const setSettings = async () => {
await FirebaseRemoteConfig.setSettings({
fetchTimeoutInSeconds: 10,
minimumFetchIntervalInSeconds: 0,
});
};
const addConfigUpdateListener = async () => {
const callbackId = await FirebaseRemoteConfig.addConfigUpdateListener(
(event, error) => {
if (error) {
console.error(error);
} else {
console.log(event);
}
}
);
return callbackId;
};
const removeConfigUpdateListener = async (callbackId: string) => {
await FirebaseRemoteConfig.removeConfigUpdateListener({
callbackId,
});
};
const removeAllListeners = async () => {
await FirebaseRemoteConfig.removeAllListeners();
};
activate()
fetchAndActivate()
fetchConfig(...)
getBoolean(...)
getNumber(...)
getString(...)
setMinimumFetchInterval(...)
setSettings(...)
addConfigUpdateListener(...)
removeConfigUpdateListener(...)
removeAllListeners()
activate() => Promise<void>
Make the last fetched configuration available to the getters.
Since: 1.3.0
fetchAndActivate() => Promise<void>
Perform fetch and activate operations.
Since: 1.3.0
fetchConfig(options?: FetchConfigOptions | undefined) => Promise<void>
Fetch and cache configuration from the Remote Config service.
Param | Type |
---|---|
options | FetchConfigOptions |
Since: 1.3.0
getBoolean(options: GetBooleanOptions) => Promise<GetBooleanResult>
Get the value for the given key as a boolean.
Param | Type |
---|---|
options | GetOptions |
Returns: Promise<GetBooleanResult>
Since: 1.3.0
getNumber(options: GetNumberOptions) => Promise<GetNumberResult>
Get the value for the given key as a number.
Param | Type |
---|---|
options | GetOptions |
Returns: Promise<GetNumberResult>
Since: 1.3.0
getString(options: GetStringOptions) => Promise<GetStringResult>
Get the value for the given key as a string.
Param | Type |
---|---|
options | GetOptions |
Returns: Promise<GetStringResult>
Since: 1.3.0
setMinimumFetchInterval(options: SetMinimumFetchIntervalOptions) => Promise<void>
Set the minimum fetch interval.
Only available for Web.
Param | Type |
---|---|
options | SetMinimumFetchIntervalOptions |
Since: 1.3.0
setSettings(options: SetSettingsOptions) => Promise<void>
Set the remote config settings.
On Android, the settings values are persisted in SharedPreferences.
Param | Type |
---|---|
options | SetSettingsOptions |
Since: 6.2.0
addConfigUpdateListener(callback: AddConfigUpdateListenerOptionsCallback) => Promise<CallbackId>
Add a listener for the config update event.
Only available for Android and iOS.
Param | Type |
---|---|
callback | AddConfigUpdateListenerOptionsCallback |
Returns: Promise<string>
Since: 5.4.0
removeConfigUpdateListener(options: RemoveConfigUpdateListenerOptions) => Promise<void>
Remove a listener for the config update event.
Only available for Android and iOS.
Param | Type |
---|---|
options | RemoveConfigUpdateListenerOptions |
Since: 5.4.0
removeAllListeners() => Promise<void>
Remove all listeners for this plugin.
Since: 5.4.0
Prop | Type | Description | Default | Since |
---|---|---|---|---|
minimumFetchIntervalInSeconds | number | Define the maximum age in seconds of an entry in the config cache before it is considered stale. During development, it's recommended to set a relatively low minimum fetch interval. Only available for Android and iOS. | 43200 | 1.3.0 |
Prop | Type | Description | Since |
---|---|---|---|
value | boolean | The value for the given key as a boolean. | 1.3.0 |
source | GetValueSource | Indicates at which source this value came from. Only available for Android and iOS. | 1.3.0 |
Prop | Type | Description | Since |
---|---|---|---|
key | string | The key of the value to get. | 1.3.0 |
Prop | Type | Description | Since |
---|---|---|---|
value | number | The value for the given key as a number. | 1.3.0 |
source | GetValueSource | Indicates at which source this value came from. Only available for Android and iOS. | 1.3.0 |
Prop | Type | Description | Since |
---|---|---|---|
value | string | The value for the given key as a string. | 1.3.0 |
source | GetValueSource | Indicates at which source this value came from. Only available for Android and iOS. | 1.3.0 |
Prop | Type | Description | Default | Since |
---|---|---|---|---|
minimumFetchIntervalInSeconds | number | Define the maximum age in seconds of an entry in the config cache before it is considered stale. During development, it's recommended to set a relatively low minimum fetch interval. | 43200 | 1.3.0 |
Prop | Type | Description | Default | Since |
---|---|---|---|---|
fetchTimeoutInSeconds | number | Defines the maximum amount of milliseconds to wait for a response when fetching configuration from the Remote Config server. | 60 | 6.2.0 |
minimumFetchIntervalInSeconds | number | Define the maximum age in seconds of an entry in the config cache before it is considered stale. During development, it's recommended to set a relatively low minimum fetch interval. | 43200 | 6.2.0 |
Prop | Type | Description | Since |
---|---|---|---|
updatedKeys | string[] | Parameter keys whose values have been updated from the currently activated values. | 5.4.0 |
Prop | Type | Description | Since |
---|---|---|---|
id | CallbackId | The id of the listener to remove. | 5.4.0 |
(event: AddConfigUpdateListenerOptionsCallbackEvent | null, error: any): void
string
Members | Value | Description | Since |
---|---|---|---|
Static | 0 | Indicates that the value returned is the static default value. | 1.3.0 |
Default | 1 | Indicates that the value returned was retrieved from the defaults set by the client. | 1.3.0 |
Remote | 2 | Indicates that the value returned was retrieved from the Firebase Remote Config Server. | 1.3.0 |
See CHANGELOG.md.
See LICENSE.
This project is not affiliated with, endorsed by, sponsored by, or approved by Google LLC or any of their affiliates or subsidiaries. ↩
FAQs
Capacitor plugin for Firebase Remote Config.
The npm package @capacitor-firebase/remote-config receives a total of 7,657 weekly downloads. As such, @capacitor-firebase/remote-config popularity was classified as popular.
We found that @capacitor-firebase/remote-config demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 0 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
Critics call the Node.js EOL CVE a misuse of the system, sparking debate over CVE standards and the growing noise in vulnerability databases.
Security News
cURL and Go security teams are publicly rejecting CVSS as flawed for assessing vulnerabilities and are calling for more accurate, context-aware approaches.
Security News
Bun 1.2 enhances its JavaScript runtime with 90% Node.js compatibility, built-in S3 and Postgres support, HTML Imports, and faster, cloud-first performance.