시작하기

설치

Capgo의 AI-Assisted Setup을 사용하여 플러그인을 설치할 수 있습니다. 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 Setup을 선호한다면, 플러그인을 설치하기 위해 다음 명령어를 실행하고 아래의 플랫폼별 지침을 따르세요:

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

수입

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

API 개요

checkPermissions

푸시 알림을 받을 수 있는 권한을 확인하세요.

켜기 안드로이드이 메서드는 안드로이드 13 이상에서만 호출해야 합니다.

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

await FirebaseMessaging.checkPermissions();

requestPermissions

푸시 알림을 받을 수 있도록 권한을 요청합니다.

Android Android 13 이상에서만 이 메서드를 호출해야 합니다.클립보드에 복사

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

await FirebaseMessaging.requestPermissions();

isSupported

클립보드에 복사

토큰을 가져오는 섹션 true __CAPGO_KEEP_0__

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

await FirebaseMessaging.isSupported();

getToken

푸시 알림을 받기 위해 앱을 등록하세요. FCM 토큰을 반환하여 푸시 메시지를 해당 메시징 인스턴스로 전송할 수 있습니다.

이 메서드는 또한 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 알림의 데이터 필드가 포함되지 않습니다.

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

await FirebaseMessaging.getDeliveredNotifications();

removeDeliveredNotifications

특정 알림을 알림 화면에서 제거합니다.

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

await FirebaseMessaging.removeDeliveredNotifications({} as RemoveDeliveredNotificationsOptions);

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({} as SubscribeToTopicOptions);

unsubscribeFromTopic

배경에서 주제에 구독 해제합니다.

Android 및 iOS에서만 사용 가능합니다.

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

await FirebaseMessaging.unsubscribeFromTopic({} as UnsubscribeFromTopicOptions);

createChannel

알림 채널을 생성합니다.

Android (SDK 26+)에서만 사용 가능합니다.

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

await FirebaseMessaging.createChannel({} as CreateChannelOptions);

deleteChannel

알림 채널을 삭제합니다.

Android (SDK 26+)에서만 사용 가능합니다.

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

await FirebaseMessaging.deleteChannel({} as DeleteChannelOptions);

listChannels

사용 가능한 알림 채널 목록을 표시합니다.

SDK Android에서만 지원(SDK 26+)입니다.

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.ts공개 API이 업스트림에서 변경될 때 다시 싱크를 실행하세요.

Getting Started에서 계속하기

만약에 시작하기 API와의 연결을 위해 대시보드와 API 운영을 계획하세요. API 개요 API 개요에서 구현 세부 정보를 참조하세요. 소개 소개에서 구현 세부 정보를 참조하세요. API 키 API 키에서 구현 세부 정보를 참조하세요. 장치 장치에서 구현 세부 정보를 참조하세요. 배포 배포에서 구현 세부 정보를 참조하세요.