Skip to content

README.md

Latest commit

 

History

History
159 lines (97 loc) · 5.03 KB

README.md

File metadata and controls

159 lines (97 loc) · 5.03 KB

@capgo/capacitor-firebase-app

Capgo - Instant updates for Capacitor

Unofficial Capacitor plugin for Firebase App.1

Compatibility

Plugin Version Capacitor Version Status
8.x.x >=8.x.x Active support
7.x.x 7.x.x Deprecated
6.x.x 6.x.x Deprecated
5.x.x 5.x.x Deprecated
1.x.x 4.x.x Deprecated

Installation

npm install @capgo/capacitor-firebase-app firebase
npx cap sync

Add Firebase to your project if you haven't already (Android / iOS / Web).

Android

Variables

If needed, you can define the following project variable in your app’s variables.gradle file to change the default version of the dependency:

  • $firebaseCommonVersion version of com.google.firebase:firebase-common (default: 22.0.1)

This can be useful if you encounter dependency conflicts with other plugins in your project.

Configuration

No configuration required for this plugin.

Demo

A working example can be found here: robingenz/capacitor-firebase-plugin-demo

Usage

import { FirebaseApp } from '@capgo/capacitor-firebase-app';

const getName = async () => {
  const result = await FirebaseApp.getName();
};

const getOptions = async () => {
  const result = await FirebaseApp.getOptions();
};

API

getName()

getName() => Promise<GetNameResult>

Get the name for this app.

Returns: Promise<GetNameResult>

Since: 0.1.0

getOptions()

getOptions() => Promise<GetOptionsResult>

Get the configuration options for this app.

Returns: Promise<GetOptionsResult>

Since: 0.1.0

getPluginVersion()

getPluginVersion() => Promise<GetPluginVersionResult>

Get the version of this plugin.

Returns: Promise<GetPluginVersionResult>

Since: 8.0.1

Interfaces

GetNameResult

Prop Type Description Since
name string The unique name of this app. 0.1.0

GetOptionsResult

Prop Type Description Since
apiKey string API key used for authenticating requests from your app. 0.1.0
applicationId string Google App ID used to uniquely identify an instance of an app. 0.1.0
databaseUrl string The database root URL. 0.1.0
gcmSenderId string The Project Number. 0.1.0
projectId string The Google Cloud project ID. 0.1.0
storageBucket string The Google Cloud Storage bucket name. 0.1.0

GetPluginVersionResult

Prop Type Description Since
version string The semantic version of this plugin. 8.0.1

Changelog

See CHANGELOG.md.

License

See LICENSE.

Footnotes

  1. This project is not affiliated with, endorsed by, sponsored by, or approved by Google LLC or any of their affiliates or subsidiaries. ↩