Getting Started

Install

Capgoの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.

Manualセットアップを使用する場合は、以下のコマンドを実行してプラグインをインストールし、以下のプラットフォーム固有の指示に従ってください。

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

インポート

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

API オーバーウィュー

checkPermissions

プッシュ通知を受信するためのパーミッションを確認する

オン Androidこのメソッドは、Android 13以上で実行する必要があります。

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

await FirebaseMessaging.checkPermissions();

requestPermissions

プッシュ通知を受信するための許可を求めます。

On AndroidAndroid 13 以降の場合、このメソッドは呼び出す必要があります。

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

await FirebaseMessaging.requestPermissions();

isSupported

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

常に true Android と iOS で返されます。

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

await FirebaseMessaging.isSupported();

getToken

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

このメソッドは、FCMの自動初期化も再有効にします。

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

await FirebaseMessaging.getToken();

deleteToken

FCMトークンを削除してアプリをアンレジストレして、プッシュ通知を受信しなくなります。 ユーザーがログアウトしたときなどに呼び出すことができます。

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

await FirebaseMessaging.deleteToken();

getDeliveredNotifications

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

注: このメソッドは、すべての通知を返します。ローカル通知やFCM通知だけではなくて、すべての通知を返します。

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

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

await FirebaseMessaging.getDeliveredNotifications();

removeDeliveredNotifications

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

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

await FirebaseMessaging.removeDeliveredNotifications({} as RemoveDeliveredNotificationsOptions);

removeAllDeliveredNotifications

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

注意: この機能は、ローカル通知だけでなく、すべての通知を削除します。

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

await FirebaseMessaging.removeAllDeliveredNotifications();

subscribeToTopic

トピックにバックグラウンドでサブスクライブします。

AndroidおよびiOSのみで利用可能です。

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

await FirebaseMessaging.subscribeToTopic({} as SubscribeToTopicOptions);

unsubscribeFromTopic

バックグラウンドでトピックからアンサブスクライブします。

AndroidおよびiOSのみで利用可能です。

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

await FirebaseMessaging.unsubscribeFromTopic({} as UnsubscribeFromTopicOptions);

createChannel

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

Android 26以上で利用可能です (SDK)

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

await FirebaseMessaging.createChannel({} as CreateChannelOptions);

deleteChannel

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

Android 26以上で利用可能です (SDK)

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

await FirebaseMessaging.deleteChannel({} as DeleteChannelOptions);

listChannels

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

Android 26以上で利用可能です (SDK)

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

await FirebaseMessaging.listChannels();

型リファレンス

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

トークン受信イベントを受信したときに呼び出されるコールバック

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

真実の源

このページはプラグインの src/definitions.tsAPI の公開変更時に再度同期を実行してください。

始めから始める

Capacitor を使用している場合 始めから始めます Capgoを計画するダッシュボードとAPIの運用を接続する APIの概要 APIの概要の実装詳細について 導入 導入の実装詳細について APIのキー APIのキーに関する実装詳細について デバイス デバイス Bundles バンドル