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

Firebase メッセージング Capacitor プラグイン

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

インストール

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を使用する

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ネイティブビルドのために。

FAQ

Firebase Messaging プラグインのFAQ

Firebase Messaging プラグインを Capacitor アプリにどのようにインストールするか?

「bun add @capgo/capacitor-firebase-messaging」 (または「npm install @capgo/capacitor-firebase-messaging」) を実行し、次に「bunx cap sync」を実行して iOS と Android プロジェクトがネイティブ code を取得するようにします。次に、@capgo/capacitor-firebase-messaging をアプリの code からインポートします。

React、Vue、Angular と @capgo/capacitor-firebase-messaging はどのように関係しているか?

Yes. Firebase Messaging is a Capacitor package, so it works with any web framework that runs inside Capacitor, including Ionic, React, Vue, Angular, Svelte and plain JavaScript.

どの Capacitor バージョンが @capgo/capacitor-firebase-messaging をサポートするか?

Capgo plugins follow Capacitor's major version: use the plugin major version that matches your Capacitor major version (for example plugin v8 with Capacitor 8). The compatibility table in the GitHub README lists the maintained versions.

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

Yes. The source code is public on GitHub at https://github.com/Cap-go/capacitor-firebase/tree/main/packages/messaging and the package is free to install from npm. Bug reports and pull requests are welcome.

code が Firebase Messaging を使用している場合、App Store のレビューなしで code をアップデートできますか?

プラグインをインストールまたはアップグレードすると、ネイティブ code が変更されるため、ストアビルドが必要になります。その後、JavaScript、HTML、CSS の変更がプラグインを呼び出す場合、Capgo のライブアップデートで即時配信できます。

Firebaseメッセージングの変更をアプリレビューの待たずに配信

プラグインがストアにビルドされたら、Capgoライブアップデートは、ユーザーにJavaScript、HTML、CSSの変更を数分でプッシュします。

Capgoで始めます