Firebaseβ

Improve this doc

This plugin is still in beta stage and may not work as expected. Please submit any issues to the plugin repo.

This plugin brings push notifications, analytics, event tracking, crash reporting and more from Google Firebase to your Cordova project! Android and iOS supported (including iOS 10).

Repo: https://github.com/arnesson/cordova-plugin-firebase

Installation

1. Install the Cordova and Ionic Native plugins:
   

   $ ionic cordova plugin add cordova-plugin-firebase
   $ npm install --save @ionic-native/firebase
   

2. Add this plugin to your app's module

Supported platforms

• Android
• iOS

Usage

import { Firebase } from '@ionic-native/firebase';

constructor(private firebase: Firebase) { }

...

this.firebase.getToken()
  .then(token => console.log(`The token is ${token}`)) // save the token server-side and use it to push notifications to this device
  .catch(error => console.error('Error getting token', error));

this.firebase.onTokenRefresh()
  .subscribe((token: string) => console.log(`Got a new token ${token}`));

Instance Members

getToken()

Get the device token

onTokenRefresh()

Get notified when a token is refreshed

onNotificationOpen()

Get notified when the user opens a notification

grantPermission()

Platforms:iOS 

Grant permission to receive push notifications

hasPermission()

Check permission to receive push notifications

setBadgeNumber(badgeNumber)

Set icon badge number. Set to 0 to clear the badge.

getBadgeNumber()

Get icon badge number

subscribe(topic)

Subscribe to a topic

unsubscribe(topic)

Unsubscribe from a topic

unregister()

Unregister from firebase, used to stop receiving push notifications. Call this when you logout user from your app.

logEvent(type, data)

Log an event using Analytics

logError(message)

Log an Error using FirebaseCrash

setScreenName(name)

Set the name of the current screen in Analytics

setUserId(userId)

Set a user id for use in Analytics

setUserProperty(name, value)

Set a user property for use in Analytics

fetch(cacheExpirationSeconds)

Fetch Remote Config parameter values for your app

activateFetched()

Activate the Remote Config fetched config

getValue(key, namespace)

Retrieve a Remote Config value

getByteArray(key, namespace)

Platforms:Android 

Retrieve a Remote Config byte array

getInfo()

Platforms:Android 

Get the current state of the FirebaseRemoteConfig singleton object

setConfigSettings(settings)

Platforms:Android 

Change the settings for the FirebaseRemoteConfig object’s operations

setDefaults(defaults, namespace)

Platforms:Android 

Set defaults in the Remote Config

getVerificationID(phoneNumber)

Platforms:iOS 

Sends an SMS to the user with the SMS verification code and returns the Verification ID required to sign in using phone authentication

verifyPhoneNumber(phoneNumber, timeoutDuration)

Platforms:Android 

Sends an SMS to the user with the SMS verification code and returns the Verification ID required to sign in using phone authentication

setAnalyticsCollectionEnabled(enabled)

Allows the user to enable/disable analytics collection