Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/capacitor-community/firebase-remote-config
https://github.com/capacitor-community/firebase-remote-config
capacitor firebase
Last synced: about 1 month ago
JSON representation
- Host: GitHub
- URL: https://github.com/capacitor-community/firebase-remote-config
- Owner: capacitor-community
- License: mit
- Created: 2020-05-28T19:27:54.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2022-03-26T23:22:40.000Z (over 2 years ago)
- Last Synced: 2024-04-28T03:32:49.473Z (8 months ago)
- Topics: capacitor, firebase
- Language: TypeScript
- Homepage:
- Size: 438 KB
- Stars: 22
- Watchers: 4
- Forks: 38
- Open Issues: 22
-
Metadata Files:
- Readme: README.md
- Contributing: .github/CONTRIBUTING.md
- License: LICENSE
- Code of conduct: .github/CODE_OF_CONDUCT.md
- Codeowners: .github/CODEOWNERS
Awesome Lists containing this project
- awesome-capacitorjs - @capacitor-community/firebase-remote-config - Capacitory community plugin for Firebase Remote Config. (Plugins / Community Plugins)
- awesome-capacitor - Remote config - A native plugin for Firebase remote config. (Community plugins)
README
# Capacitor Firebase Remote Config Plugin
Capacitory community plugin for firebase remote config.
## Maintainers
| Maintainer | GitHub | Social | Sponsoring Company |
| ------------- | ------------------------------------------- | ------------------------------------------------ | ------------------ |
| Priyank Patel | [priyankpat](https://github.com/priyankpat) | [@priyankpat\_](https://twitter.com/priyankpat_) | Ionic |
Mainteinance Status: Actively Maintained
## Installation
To use npm
```bash
npm install @capacitor-community/firebase-remote-config
```
To use yarn
```bash
yarn add @capacitor-community/firebase-remote-config
```
Sync native files
```bash
npx cap sync
```
On iOS, no further steps are needed.
On Android, register the plugin in your main activity:
```java
import com.getcapacitor.community.firebaserc.FirebaseRemoteConfig;
public class MainActivity extends BridgeActivity {
@Override
public void onCreate(Bundle savedInstanceState) {
super.onCreate(savedInstanceState);
// Initializes the Bridge
this.init(
savedInstanceState,
new ArrayList>() {
{
// Additional plugins you've installed go here
// Ex: add(TotallyAwesomePlugin.class);
add(FirebaseRemoteConfig.class);
}
}
);
}
}
```
## Configuration
Download appropriate google-services.json or GoogleService-Info.plist and place it in the correct platform app directory.
**For Android**: /android/app
**For iOS**: /ios/App/App
## Examples
[Click here](https://github.com/priyankpat/capacitor-plugins-example/tree/firebase-remote-config) for example on how to implement this plugin
You can also clone the repository
```bash
git clone https://github.com/priyankpat/capacitor-plugins-example
git checkout -b firebase-remote-config
```
## Supported methods
| Name | Android | iOS | Web |
| :------------------ | :------ | :-- | :-- |
| initializeFirebase | ❌ | ❌ | ✅ |
| setDefaultWebConfig | ❌ | ❌ | ✅ |
| initialize | ✅ | ✅ | ✅ |
| fetch | ✅ | ✅ | ✅ |
| activate | ✅ | ✅ | ✅ |
| fetchAndActivate | ✅ | ✅ | ✅ |
| getBoolean | ✅ | ✅ | ✅ |
| getByteArray | ✅ | ✅ | ✅ |
| getNumber | ✅ | ✅ | ✅ |
| getString | ✅ | ✅ | ✅ |
## Usage
```typescript
// Must import the package once to make sure the web support initializes
import "@capacitor-community/firebase-remote-config";
import { Plugins } from "@capacitor/core";
const { FirebaseRemoteConfig } = Plugins;
/**
* NOTE: Web Platform only!
* This method will initialize firebase app if not yet initialized.
* @param firebase configs - from google-service.json or GoogleService-Info.plist
* @returns void
*/
FirebaseRemoteConfig.initializeFirebase({
apiKey: "...",
authDomain: "...",
databaseURL: "...",
projectId: "...",
storageBucket: "...",
messagingSenderId: "...",
appId: "...",
measurementId: "...",
});
/**
* NOTE: Web Platform only!
* This method will set default remote config values.
* @param options - key/value params with default values
* @returns void
*/
FirebaseRemoteConfig.setDefaultWebConfig({
has_sale: false,
event_name: "clearance_event",
});
/**
* This method will configure remote config object instance and set the minimum fetch interval to allow for frequest refreshes.
* @param minimumFetchIntervalInSeconds - interval in seconds (default: 3600)
* @returns void
*/
FirebaseRemoteConfig.initialize({
minimumFetchIntervalInSeconds: 3600,
});
/**
* This method will execute fetch task to retrieve config
* @param none
* @returns void
*/
FirebaseRemoteConfig.fetch();
/**
* This method will activate the fetched values making it available for your app
* @param none
* @returns void
*/
FirebaseRemoteConfig.activate();
/**
* This method will fetch and activate the values making it available for your app
* @param none
* @returns void
*/
FirebaseRemoteConfig.fetchAndActivate();
/**
* This method will return the parameter value for a given key in boolean
* @param key - key to obtain boolean value
* @returns key - key used to obtain value
* value - boolean value for a given key
* source - Indicates that the source of value retrieved (default, remote, static)
*/
FirebaseRemoteConfig.getBoolean({
key: "bool key",
});
/**
* This method will return the parameter value for a given key in byte array
* @param key - key to obtain byte array value
* @returns key - key used to obtain value
* value - byte array value for a given key
* source - Indicates that the source of value retrieved (default, remote, static)
*/
FirebaseRemoteConfig.getByteArray({
key: "array key",
});
/**
* This method will return the parameter value for a given key in double
* @param key - key to obtain double value
* @returns key - key used to obtain value
* value - double value for a given key
* source - Indicates that the source of value retrieved (default, remote, static)
*/
FirebaseRemoteConfig.getNumber({
key: "number key",
});
/**
* This method will return the parameter value for a given key in string
* @param key - key to obtain string value
* @returns key - key used to obtain value
* value - string value for a given key
* source - Indicates that the source of value retrieved (default, remote, static)
*/
FirebaseRemoteConfig.getString({
key: "string key",
});
```