@capacitor-firebase/app¶

Unofficial Capacitor plugin for Firebase App.¹

Installation¶

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

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

Android¶

Variables¶

This plugin will use the following project variables (defined in your app’s variables.gradle file):

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

Configuration¶

No configuration required for this plugin.

Demo¶

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

Usage¶

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

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

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

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

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

Changelog¶

See CHANGELOG.md.

License¶

See LICENSE.

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