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.