Lompat ke konten utama

Firebase Messaging plugin Capacitor

Plugin Capacitor untuk Firebase Cloud Messaging (FCM)

Instal

bun add @capgo/capacitor-firebase-messaging bunx cap sync
npm, pnpm, atau yarn
  • npm install @capgo/capacitor-firebase-messaging
  • pnpm add @capgo/capacitor-firebase-messaging
  • yarn add @capgo/capacitor-firebase-messaging

Panduan

Cara menggunakan Firebase Messaging di Capacitor

Menggunakan @capgo/capacitor-firebase-messaging

Plugin Capacitor untuk Firebase Cloud Messaging (FCM).

Instal

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

bunx cap sync menyalin code native plugin ke dalam proyek native Anda. Jalankan lagi setelah setiap upgrade plugin.

Impor

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

Sekilas tentang API

Metode Deskripsi
checkPermissions Cek izin untuk menerima push notifications.
requestPermissions Minta izin untuk menerima push notifications.
isSupported Checks if all required APIs exist.
getToken Daftarkan aplikasi untuk menerima push notifications. Mengembalikan FCM token yang dapat digunakan untuk mengirim pesan push ke instance Messaging tersebut.
deleteToken Hapus token FCM dan unregister aplikasi untuk menghentikan push notifications. Bisa dipanggil, misalnya, saat user sign out.
getDeliveredNotifications Dapatkan daftar notifikasi yang muncul di layar notifikasi.
removeDeliveredNotifications Hapus notifikasi tertentu dari layar notifikasi.
removeAllDeliveredNotifications Hapus semua notifikasi dari layar notifikasi.
subscribeToTopic Berlangganan topik di background.
unsubscribeFromTopic Berhenti berlangganan topik di background.
createChannel Buat channel notifikasi.
deleteChannel Hapus channel notifikasi.
listChannels Lihat daftar channel notifikasi yang tersedia.

Contoh

checkPermissions()

Cek izin untuk menerima push notification.

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

const result = await FirebaseMessaging.checkPermissions();
console.log(result);

requestPermissions()

Minta izin untuk menerima push notification.

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

const result = await FirebaseMessaging.requestPermissions();
console.log(result);

isSupported()

Cek apakah semua API yang diperlukan tersedia.

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

const result = await FirebaseMessaging.isSupported();
console.log(result);

getToken()

Daftarkan aplikasi untuk menerima push notification. Mengembalikan FCM token yang bisa digunakan untuk mengirim pesan push ke instance Messaging tersebut.

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

const result = await FirebaseMessaging.getToken();
// The result holds sensitive values: use it without logging it.

deleteToken()

Hapus token FCM dan unregister aplikasi untuk menghentikan push notifications. Bisa dipanggil, misalnya, saat user sign out.

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

await FirebaseMessaging.deleteToken();

getDeliveredNotifications()

Dapatkan daftar notifikasi yang muncul di layar notifikasi.

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

const result = await FirebaseMessaging.getDeliveredNotifications();
console.log(result);

Tabel di atas mencantumkan 13 metode inti. Helper listener, versi, dan kontrak lengkap setiap metode didokumentasikan di repositori GitHub.

Dengarkan event

addListener mengembalikan sebuah handle. Panggil handle.remove() saat screen di-unmount, atau FirebaseMessaging.removeAllListeners() untuk menghapus semua listener.

Referensi lengkap

Lanjutkan dari Menggunakan @capgo/capacitor-firebase-messaging

Jika Anda menggunakan Menggunakan @capgo/capacitor-firebase-messaging untuk merencanakan pekerjaan plugin native, hubungkan dengan Direktori Plugin Capgo untuk alur kerja produk di Direktori Plugin Capgo, Plugin Capacitor oleh Capgo untuk detail implementasi di Capacitor Plugins oleh Capgo, Menambahkan atau Memperbarui Plugin untuk detail implementasi di Adding or Updating Plugins, Alternatif Plugin Ionic Enterprise untuk alur kerja produk di alternatif Ionic Enterprise Plugin, dan Capgo Native Build untuk workflow produk di Capgo Native Builds.

FAQ

FAQ plugin Firebase Messaging

Bagaimana cara install plugin Firebase Messaging di aplikasi Capacitor?

Jalankan "bun add @capgo/capacitor-firebase-messaging" (atau "npm install @capgo/capacitor-firebase-messaging"), lalu jalankan "bunx cap sync" agar proyek iOS dan Android mendeteksi code native. Import dari "@capgo/capacitor-firebase-messaging" di dalam code aplikasi Anda.

Apakah @capgo/capacitor-firebase-messaging bisa digunakan dengan React, Vue, dan Angular?

Ya. Firebase Messaging adalah package Capacitor, jadi bisa digunakan dengan framework web apa pun yang berjalan di dalam Capacitor, termasuk Ionic, React, Vue, Angular, Svelte, dan JavaScript murni.

Versi Capacitor mana yang didukung oleh @capgo/capacitor-firebase-messaging?

Plugin Capgo mengikuti versi major Capacitor: gunakan versi major plugin yang cocok dengan versi major Capacitor Anda (misalnya plugin v8 dengan Capacitor 8). Tabel kompatibilitas di README GitHub mencantumkan versi yang di-maintain.

Apakah @capgo/capacitor-firebase-messaging gratis dan open source?

Ya. Source code bersifat publik di GitHub pada https://github.com/Cap-go/capacitor-firebase/tree/main/packages/messaging dan package ini gratis untuk diinstall dari npm. Bug report dan pull request sangat kami terima.

Bisakah saya update code yang menggunakan Firebase Messaging tanpa review App Store?

Install atau upgrade plugin akan mengubah code native, sehingga butuh build store baru. Setelah itu, perubahan JavaScript, HTML, dan CSS yang memanggil plugin tersebut bisa langsung dikirim via Capgo live updates.

Deploy perubahan Firebase Messaging tanpa menunggu review aplikasi

Setelah plugin ada di build store Anda, Capgo live updates mengirim perubahan JavaScript, HTML, dan CSS ke pengguna dalam hitungan menit.

Mulai dengan Capgo