Einstieg

Installieren

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

Importieren

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

API Übersicht

checkPermissions

Überprüfen Sie die Berechtigung zum Empfangen von Push-Benachrichtigungen.

An Android, Diese Methode muss nur auf Android 13+ aufgerufen werden.

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

await FirebaseMessaging.checkPermissions();

requestPermissions

Berechtigung zum Empfangen von Push-Benachrichtigungen anfordern.

On Android Dieser Methodenaufruf ist nur auf Android 13+ erforderlich.Zwischenablage kopieren

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

await FirebaseMessaging.requestPermissions();

isSupported

Immer wieder

auf Android und iOS. true Zwischenablage kopieren

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

await FirebaseMessaging.isSupported();

getToken

Diese Methode aktiviert auch FCM Auto-Init wieder.

Abschnitt mit dem Titel „getToken“

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

await FirebaseMessaging.getToken();

deleteToken

Löschen Sie das FCM-Token und deaktivieren Sie die Anwendung, um die Empfangung von Push-Benachrichtigungen zu stoppen. Kann zum Beispiel aufgerufen werden, wenn ein Benutzer sich abmeldet.

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

await FirebaseMessaging.deleteToken();

getDeliveredNotifications

Holen Sie sich eine Liste der Benachrichtigungen, die auf dem Benachrichtigungs-Bildschirm sichtbar sind.

Hinweis: Diese Funktion gibt alle gelieferten Benachrichtigungen zurück, einschließlich lokaler Benachrichtigungen, und nicht nur FCM-Benachrichtigungen.

Auf Android wird der Datenfeld des FCM-Benachrichtigung nicht eingeschlossen.

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

await FirebaseMessaging.getDeliveredNotifications();

removeDeliveredNotifications

Entfernen Sie bestimmte Benachrichtigungen vom Benachrichtigungs-Bildschirm.

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

await FirebaseMessaging.removeDeliveredNotifications({} as RemoveDeliveredNotificationsOptions);

removeAllDeliveredNotifications

Alle Benachrichtigungen vom Benachrichtigungs-Bildschirm entfernen.

Hinweis: Dies entfernt alle gelieferten Benachrichtigungen, einschließlich lokaler Benachrichtigungen, und nicht nur FCM-Benachrichtigungen.

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

await FirebaseMessaging.removeAllDeliveredNotifications();

subscribeToTopic

Hintergrundmäßig zum Thema abonnieren.

Nur für Android und iOS verfügbar.

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

await FirebaseMessaging.subscribeToTopic({} as SubscribeToTopicOptions);

unsubscribeFromTopic

Hintergrundmäßig vom Thema abmelden.

Nur für Android und iOS verfügbar.

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

await FirebaseMessaging.unsubscribeFromTopic({} as UnsubscribeFromTopicOptions);

createChannel

Erstellen Sie einen Benachrichtigungs-Kanal.

Nur für Android verfügbar (ab SDK 26+).

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

await FirebaseMessaging.createChannel({} as CreateChannelOptions);

deleteChannel

Löschen Sie einen Benachrichtigungs-Kanal.

Nur für Android verfügbar (ab SDK 26+).

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

await FirebaseMessaging.deleteChannel({} as DeleteChannelOptions);

listChannels

Liste der verfügbaren Benachrichtigungs-Kanäle.

Nur für Android verfügbar (ab SDK 26+).

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

await FirebaseMessaging.listChannels();

Typenreferenz

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

Ruft den Callback zum Empfangen des Token-Ereignisses auf.

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

Quelle der Wahrheit

Diese Seite wurde aus dem Plugin generiert. src/definitions.tsRe-run die Synchronisation, wenn die öffentliche API upstream geändert wird.

Weitermachen von Getting Started

Wenn Sie " Getting Started zum Planen von Dashboard und API-Operationen verwenden, verbinden Sie es mit API Übersicht für die Implementierungsdetails in API Übersicht, Einführung für die Implementierungsdetails in Einführung, API Schlüssel für die Implementierungsdetails in API Schlüssel, Geräte für die Implementierungsdetails in Geräte, und Pakete für die Implementierungsdetails in Pakete.