メインコンテンツへスキップ
@capgo/capacitor-firebase-messaging コミュニケーション オープンソース

Firebase Messaging Capacitor プラグイン

Firebase Cloud Messaging (FCM) 用の Capacitor plugin

インストール

bun add @capgo/capacitor-firebase-messaging bunx cap sync
npm、pnpm、または yarn
  • npm install @capgo/capacitor-firebase-messaging
  • pnpm add @capgo/capacitor-firebase-messaging
  • yarn add @capgo/capacitor-firebase-messaging

ガイド

Capacitor で Firebase Messaging を使う方法

@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 プッシュ通知の受信許可を確認します。
requestPermissions プッシュ通知の受信許可をリクエストします。
isSupported 必要なすべてのAPIが存在するか確認します。
getToken プッシュ通知を受信するためにアプリを登録します。そのMessagingインスタンスにプッシュメッセージを送信するために使用できるFCMトークンを返します。
deleteToken FCMトークンを削除してアプリの登録を解除し、プッシュ通知の受信を停止します。ユーザーのサインアウト時などに呼び出せます。
getDeliveredNotifications 通知画面に表示されている通知の一覧を取得します。
removeDeliveredNotifications 通知画面から特定の通知を削除します。
removeAllDeliveredNotifications 通知画面からすべての通知を削除します。
subscribeToTopic バックグラウンドでトピックを購読します。
unsubscribeFromTopic バックグラウンドでトピックの購読を解除します。
createChannel 通知チャンネルを作成します。
deleteChannel 通知チャンネルを削除します。
listChannels 利用可能な通知チャンネルを一覧表示します。

例

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() すべてのリスナーを解除します。

完全なリファレンス

@capgo/capacitor-firebase-messaging の使い方から続ける

使用している場合 @capgo/capacitor-firebase-messaging の使い方 ネイティブプラグインの作業を計画するには、次と連携してください: Capgo プラグインディレクトリ Capgo プラグインディレクトリのプロダクトワークフローについては、 Capgo による Capacitor プラグイン Capgo による Capacitor プラグインの実装詳細については、 プラグインの追加または更新 プラグインの追加または更新に関する実装詳細については、 Ionic Enterprise プラグインの代替案 Ionic Enterprise Plugin Alternatives のプロダクトワークフロー、および Capgo Native Build Capgo Native Builds のプロダクトワークフローについては、

よくある質問

Firebase Messaging プラグイン FAQ

Capacitor アプリに Firebase Messaging プラグインをインストールするには?

「bun add @capgo/capacitor-firebase-messaging」(または「npm install @capgo/capacitor-firebase-messaging」)を実行し、続けて「bunx cap sync」を実行して iOS と Android プロジェクトにネイティブ code を取り込みます。アプリの code で「@capgo/capacitor-firebase-messaging」からインポートしてください。

@capgo/capacitor-firebase-messaging は React、Vue、Angular で動作しますか?

はい。Firebase Messaging は Capacitor パッケージなので、Ionic、React、Vue、Angular、Svelte、素の JavaScript など、Capacitor 内で動くすべての Web フレームワークで使えます。

@capgo/capacitor-firebase-messaging はどの Capacitor バージョンをサポートしていますか?

Capgo プラグインは Capacitor のメジャーバージョンに合わせています。使用している Capacitor のメジャーバージョンに一致するプラグインのメジャーバージョンを使ってください (例: Capacitor 8 ならプラグイン v8)。GitHub の README にある互換性テーブルに、メンテナンス中のバージョンが記載されています。

@capgo/capacitor-firebase-messaging は無料かつオープンソースですか?

はい。ソース code は GitHub の https://github.com/Cap-go/capacitor-firebase/tree/main/packages/messaging で公開されており、npm から無料でインストールできます。バグ報告やプルリクエストも歓迎です。

Firebase Messaging を使っている code を、App Store の審査なしで更新できますか?

プラグインのインストールやアップグレードはネイティブの code を変更するため、新しいストアビルドが必要です。その後は、プラグインを呼び出す JavaScript、HTML、CSS の変更を Capgo Live Updates で即座に配信できます。

アプリレビューを待たずに Firebase Messaging の変更をリリース

プラグインをストア用ビルドに組み込めば、Capgo live updates で JavaScript、HTML、CSS の変更を数分でユーザーに配信できます

Capgo から始める