Skip to main content
Capgo logo
← Back To Plugins

Using @capgo/capacitor-firebase-messaging

Capacitor plugin for Firebase Cloud Messaging (FCM).

Install

bun add @capgo/capacitor-firebase-messaging
bunx cap sync

What This Plugin Exposes

  • checkPermissions - Check permission to receive push notifications.
  • requestPermissions - Request permission to receive push notifications.
  • isSupported - Checks if all required APIs exist.
  • getToken - Register the app to receive push notifications. Returns a FCM token that can be used to send push messages to that Messaging instance.

Example Usage

checkPermissions

Check permission to receive push notifications.

import { FirebaseMessaging } from '@capgo/capacitor-firebase-messaging';

await FirebaseMessaging.checkPermissions();

requestPermissions

Request permission to receive push notifications.

import { FirebaseMessaging } from '@capgo/capacitor-firebase-messaging';

await FirebaseMessaging.requestPermissions();

isSupported

Checks if all required APIs exist.

import { FirebaseMessaging } from '@capgo/capacitor-firebase-messaging';

await FirebaseMessaging.isSupported();

getToken

Register the app to receive push notifications. Returns a FCM token that can be used to send push messages to that Messaging instance.

import { FirebaseMessaging } from '@capgo/capacitor-firebase-messaging';

await FirebaseMessaging.getToken();

Full Reference