Einstieg

Installieren

Sie können unsere KI-gestützte Einrichtung verwenden, um das Plugin zu installieren. Fügen Sie die Capgo-Fähigkeiten zu Ihrem KI-Tool hinzu, indem Sie die folgende Befehlszeile verwenden:

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

Verwenden Sie dann die folgende Anfrage:

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

Wenn Sie die manuelle Einrichtung bevorzugen, installieren Sie das Plugin, indem Sie die folgenden Befehle ausführen und die Plattform-spezifischen Anweisungen unten befolgen:

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

Importieren

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

API Übersicht

checkPermissions

Berechtigung überprüfen, um Push-Benachrichtigungen zu empfangen.

Aktivieren AndroidDieser 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.

Auf Android, muss diese Methode 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 auf Android und iOS. true In die Zwischenablage kopieren

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

await FirebaseMessaging.isSupported();

getToken

Registriere die App, um Push-Benachrichtigungen zu empfangen. Rückgabetoken, das zur Sendung von Push-Nachrichten an diese Messaging-Instanz verwendet werden kann.

Dieser Methode wird auch die FCM-Automatik wieder aktiviert.

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

await FirebaseMessaging.getToken();

deleteToken

Lösche das FCM-Token und registriere die App nicht mehr, 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

Erhalte eine Liste der 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-Geräten wird der Datenfeld der FCM-Benachrichtigung NICHT mitgeliefert.

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

await FirebaseMessaging.getDeliveredNotifications();

removeDeliveredNotifications

Benennen Sie bestimmte Benachrichtigungen aus der Benachrichtigungsanzeige entfernen.

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

await FirebaseMessaging.removeDeliveredNotifications({} as RemoveDeliveredNotificationsOptions);

removeAllDeliveredNotifications

Alle Benachrichtigungen aus der Benachrichtigungsanzeige 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

Abonnieren Sie sich im Hintergrund auf einen Thema.

Nur für Android und iOS verfügbar.

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

await FirebaseMessaging.subscribeToTopic({} as SubscribeToTopicOptions);

unsubscribeFromTopic

Abonnieren Sie sich im Hintergrund von einem Thema.

Nur für Android und iOS verfügbar.

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

await FirebaseMessaging.unsubscribeFromTopic({} as UnsubscribeFromTopicOptions);

createChannel

Erstelle eine Benachrichtigungschannel.

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

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

await FirebaseMessaging.createChannel({} as CreateChannelOptions);

deleteChannel

Lösche ein Benachrichtigungschannel.

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

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

await FirebaseMessaging.deleteChannel({} as DeleteChannelOptions);

listChannels

Liste die verfügbaren Benachrichtigungschannels.

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 Empfangen des Token-Ereignisses auf.

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

Quelle der Wahrheit

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

Weitergehen von Getting Started

Wenn Sie das Plugin verwenden Einstieg um einen Planungsbereich und API-Operationen zu planen und ihn mit API-Übersicht für die Implementierungsdetails in der API-Übersicht Einführung für die Implementierungsdetails in der Einführung API-Schlüssel für die Implementierungsdetails in den API-Schlüsseln Geräte für die Implementierungsdetails in Geräten und Bundles für die Implementierungsdetails in Bundles.