ガイド
CapacitorでFirebase Messagingを使用する方法
capgo/capacitor-firebase-messagingを使用する
CapacitorプラグインはFirebase Cloud Messaging (FCM)を使用します。
インストール
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 |
プッシュ通知を受信するためにアプリを登録する。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()
プッシュ通知を受信するためにアプリを登録する。FCMトークンを取得し、プッシュメッセージを送信できる。
import { FirebaseMessaging } from '@capgo/capacitor-firebase-messaging';
const result = await FirebaseMessaging.getToken();
// The result holds sensitive values: use it without logging it.
deleteToken()
プッシュ通知を受信しないようにアプリを登録を削除する。ユーザーがログアウトしたときなどに呼び出すことができる。
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_KEEP_0__ Capacitorを使用して@capgo/capacitor-firebase-messaging nativeプラグインの作業を計画し、 Capgo プラグインディレクトリ Capgo プラグインディレクトリの製品ワークフロー Capacitor Capgo Capacitor プラグインの実装詳細については、Capgo によって提供されます。 __CAPGO_KEEP_0__ プラグイン __CAPGO_KEEP_1__ プラグインの追加または更新 プラグインの追加または更新の実装詳細 Capgo 本機ビルド Capgoの製品ワークフローにおけるCapgoネイティブビルドのために。