Firebase Messaging Capacitor プラグイン

@capgo/capacitor-firebase-messaging の使用方法

Firebase Cloud Messaging (FCM) 用の Capacitor プラグイン

インストール

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

bunx cap sync プラグインのネイティブ code をネイティブプロジェクトにコピーします。プラグインをアップグレードするたびに再度実行してください。

インポート

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

API の概要

実装例

checkPermissions()

プッシュ通知の受信許可を確認します。

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

const result = await FirebaseMessaging.checkPermissions();
console.log(result);

requestPermissions()

プッシュ通知の受信許可をリクエストします。

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

const result = await FirebaseMessaging.requestPermissions();
console.log(result);

isSupported()

必要なAPIがすべて存在するか確認します。

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

const result = await FirebaseMessaging.isSupported();
console.log(result);

getToken()

プッシュ通知を受信するためにアプリを登録します。このMessagingインスタンスへのプッシュメッセージ送信に使用できるFCMトークンを返します。

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

const result = await FirebaseMessaging.getToken();
// The result holds sensitive values: use it without logging it.

deleteToken()

FCMトークンを削除してアプリの登録を解除し、プッシュ通知の受信を停止します。ユーザーのサインアウト時などに呼び出せます。

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

await FirebaseMessaging.deleteToken();

getDeliveredNotifications()

通知画面に表示されている通知の一覧を取得します。

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

const result = await FirebaseMessaging.getDeliveredNotifications();
console.log(result);

上記の表には13個のコアメソッドが記載されています。リスナーやバージョンのヘルパー、各メソッドの詳細な仕様については、以下に記載されています。 GitHub リポジトリ.

イベントをリッスンする

addListener ハンドルを返します。次に、 handle.remove() 画面がアンマウントされるとき、または FirebaseMessaging.removeAllListeners() すべてのリスナーを解除します。

リファレンス全文

• GitHub リポジトリ
• ドキュメント
• API リファレンス

@capgo/capacitor-firebase-messaging の使用方法へ進む

以下を使用している場合： @capgo/capacitor-firebase-messaging の使用 ネイティブプラグインの作業を計画するには、それを以下と連携させる Capgo プラグインディレクトリ Capgo プラグインディレクトリでのプロダクトワークフロー向けに、 Capgo による Capacitor プラグイン Capgo による Capacitor プラグインの実装詳細については、 プラグインの追加・更新 プラグインの追加・更新における実装詳細については、 Ionic Enterprise プラグインの代替案 Ionic Enterprise プラグインの代替案のプロダクトワークフロー、および Capgo Native Build Capgo Native Builds のプロダクトワークフローについて。