スタートガイド

インストール

AIアシストによるセットアップでプラグインをインストールできます。以下のコマンドを使用して、お使いのAIツールに Capgo のスキルを追加してください：

npx skills add https://github.com/Cap-go/capgo-skills --skill capacitor-plugins

次に、以下のプロンプトを使用します：

Use the `capacitor-plugins` skill from `Cap-go/capgo-skills` to install the `@capgo/capacitor-firebase-messaging` plugin in my project.

手動セットアップを希望する場合は、以下のコマンドを実行してプラグインをインストールし、下記のプラットフォーム別の手順に従ってください：

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

インポート

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

クイックスタート

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

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

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

よくある落とし穴

• 権限：呼び出し checkPermissions() その後 requestPermissions() 必要に応じて。
• リスナー: 画面がアンマウントされたらハンドルを削除します。
• 信頼できる情報源: 信頼 src/definitions.ts GitHub リポジトリ内。

API の概要

checkPermissions

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

オンラインに Androidでは, このメソッドは Android 13 以降でのみ呼び出す必要があります。

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

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

requestPermissions

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

オンラインに Androidでは, このメソッドは Android 13 以降でのみ呼び出す必要があります。

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

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

isSupported

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

常に返します true Android と iOS で。

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

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

getToken

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

このメソッドは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

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

注意: これはFCM通知だけでなく、ローカル通知を含むすべての配信済み通知を返します。

Androidの場合、FCM通知のdataフィールドは含まれません。

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

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

removeDeliveredNotifications

通知画面から特定の通知を削除します。

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

await FirebaseMessaging.removeDeliveredNotifications({ notifications: [] });

removeAllDeliveredNotifications

通知画面からすべての通知を削除します。

注意: これはFCM通知だけでなく、ローカル通知を含むすべての配信済み通知を削除します。

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

await FirebaseMessaging.removeAllDeliveredNotifications();

subscribeToTopic

バックグラウンドでトピックを購読します。

Android と iOS でのみ利用できます。

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

await FirebaseMessaging.subscribeToTopic({ topic: 'topic' });

unsubscribeFromTopic

バックグラウンドでトピックの購読を解除します。

Android と iOS でのみ利用できます。

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

await FirebaseMessaging.unsubscribeFromTopic({ topic: 'topic' });

createChannel

通知チャンネルを作成します。

Android のみ利用可能（SDK 26以降）。

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

await FirebaseMessaging.createChannel({
  id: 'id-123',
  name: 'example',
});

deleteChannel

通知チャンネルを削除します。

Android のみ利用可能（SDK 26以降）。

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

await FirebaseMessaging.deleteChannel({ id: 'id-123' });

listChannels

利用可能な通知チャンネルを一覧表示します。

Android のみ利用可能（SDK 26以降）。

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

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

型リファレンス

PermissionStatus

export interface PermissionStatus {
  /**
   * @since 0.2.2
   */
  receive: PermissionState;
}

IsSupportedResult

export interface IsSupportedResult {
  /**
   * @since 0.3.1
   */
  isSupported: boolean;
}

GetTokenOptions

export interface GetTokenOptions {
  /**
   * Your VAPID public key, which is required to retrieve the current registration token on the web.
   *
   * Only available for Web.
   */
  vapidKey?: string;
  /**
   * The service worker registration for receiving push messaging.
   * If the registration is not provided explicitly, you need to have a `firebase-messaging-sw.js` at your root location.
   *
   * Only available for Web.
   */
  serviceWorkerRegistration?: ServiceWorkerRegistration;
}

GetTokenResult

export interface GetTokenResult {
  /**
   * @since 0.2.2
   */
  token: string;
}

GetDeliveredNotificationsResult

export interface GetDeliveredNotificationsResult {
  /**
   * @since 0.2.2
   */
  notifications: Notification[];
}

RemoveDeliveredNotificationsOptions

export interface RemoveDeliveredNotificationsOptions {
  /**
   * @since 0.4.0
   */
  notifications: Notification[];
}

SubscribeToTopicOptions

export interface SubscribeToTopicOptions {
  /**
   * The name of the topic to subscribe.
   *
   * @since 0.2.2
   */
  topic: string;
}

UnsubscribeFromTopicOptions

export interface UnsubscribeFromTopicOptions {
  /**
   * The name of the topic to unsubscribe from.
   *
   * @since 0.2.2
   */
  topic: string;
}

CreateChannelOptions

export type CreateChannelOptions = Channel;

DeleteChannelOptions

export interface DeleteChannelOptions {
  /**
   * The channel identifier.
   *
   * @since 1.4.0
   */
  id: string;
}

ListChannelsResult

export interface ListChannelsResult {
  channels: Channel[];
}

TokenReceivedListener

token received イベントを受け取るコールバック。

export type TokenReceivedListener = (event: TokenReceivedEvent) => void;

Source of Truth

このページはプラグインの src/definitions.tsから生成されています。upstream で公開 API が変更されたら、再度 sync を実行してください。

Getting Startedの続きを進める

使用している場合 スタートガイド ダッシュボードと API の運用を計画するには、これを次と連携させます API の概要 「API の概要」の実装の詳細については、 はじめに 「はじめに」における実装の詳細については、 API キー API Keys の実装の詳細については、 デバイス Devices の実装詳細については、および Bundle Bundlesの実装詳細については