Getting Started

Install

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

Import

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

API Übersicht

checkPermissions

Berechtigung zum Empfang von Push-Benachrichtigungen überprüfen.

Ermächtigt Android, diese Methode muss nur auf Android 13+ aufgerufen werden.

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

await FirebaseMessaging.checkPermissions();

requestPermissions

Erlaubnis zum Empfang von Push-Benachrichtigungen anfordern.

Eingeschaltet Android, diese Methode muss nur auf Android 13+ aufgerufen werden.

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

await FirebaseMessaging.requestPermissions();

isSupported

Überprüft, ob alle erforderlichen APIs existieren.

Immer true auf Android und iOS.

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

await FirebaseMessaging.isSupported();

getToken

Registriere die App, um Push-Benachrichtigungen zu erhalten. Gibt einen FCM-Token zurück, der zum Senden von Push-Nachrichten an diese Messaging-Instanz verwendet werden kann.

Diese Methode aktiviert auch FCM Auto-Init wieder.

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

await FirebaseMessaging.getToken();

deleteToken

Lösche den FCM-Token und deregistriere die App, um die Empfangung von Push-Benachrichtigungen zu beenden. Kann zum Beispiel aufgerufen werden, wenn ein Benutzer sich abmeldet.

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

await FirebaseMessaging.deleteToken();

getDeliveredNotifications

Erhalte eine Liste von Benachrichtigungen, die auf dem Benachrichtigungs-Bildschirm sichtbar sind.

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

Auf Android werden die Datenfeld der FCM-Benachrichtigung NICHT enthalten.

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

await FirebaseMessaging.getDeliveredNotifications();

removeDeliveredNotifications

Entfernen Sie bestimmte Benachrichtigungen vom Benachrichtigungsbildschirm.

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

await FirebaseMessaging.removeDeliveredNotifications({} as RemoveDeliveredNotificationsOptions);

removeAllDeliveredNotifications

Entfernen Sie alle Benachrichtigungen vom Benachrichtigungsbildschirm.

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

Abonnieren Sie sich für den Hintergrundthema.

Nur für Android und iOS verfügbar.

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

await FirebaseMessaging.subscribeToTopic({} as SubscribeToTopicOptions);

unsubscribeFromTopic

Hintergrundmäßig von einem Thema abgemeldet.

Nur für Android und iOS verfügbar.

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

await FirebaseMessaging.unsubscribeFromTopic({} as UnsubscribeFromTopicOptions);

createChannel

Eine Benachrichtigungschannel erstellt.

Only available for Android (SDK 26+).

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

await FirebaseMessaging.createChannel({} as CreateChannelOptions);

deleteChannel

Eine Benachrichtigungschannel löscht.

Only available for Android (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 (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 Empfang des Token-Ereignisses auf.

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

Quelle der Wahrheit

Diese Seite wurde aus dem Plugin generiert. src/definitions.ts. Wenn sich die öffentliche API im Hintergrund ändert, führen Sie die Synchronisierung erneut durch.

Weiter von Getting Started

Wenn Sie " Getting Started um ein Dashboard und API-Operationen zu planen, 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äten, und Bündel für die Implementierungsdetails in Bündeln.