Mulai
Copy sebuah prompt pengaturan dengan langkah instalasi dan panduan markdown lengkap untuk plugin ini.
Set up this Capacitor plugin in the project.
Use the package manager already used by the project.
Install these package(s): `@capgo/capacitor-firebase-messaging`
Run the required Capacitor sync/update step after installation.
Read this markdown guide for the full setup steps: https://raw.githubusercontent.com/Cap-go/website/refs/heads/main/apps/docs/src/content/docs/docs/plugins/firebase-messaging/getting-started.mdx
Use that guide for platform-specific steps, native file edits, permissions, config changes, imports, and usage setup.
If that guide references other docs pages, read them too.
Instalasi
Section berjudul āInstalasiāAnda dapat menggunakan Setup Bantuan AI kami untuk menginstal plugin. Tambahkan Capgo kemampuan ke alat AI Anda menggunakan perintah berikut:
npx skills add https://github.com/Cap-go/capgo-skills --skill capacitor-pluginsLalu gunakan prompt berikut:
Use the `capacitor-plugins` skill from `Cap-go/capgo-skills` to install the `@capgo/capacitor-firebase-messaging` plugin in my project.Jika Anda lebih suka Setup Manual, instal plugin dengan menjalankan perintah-perintah berikut dan ikuti instruksi spesifik platform di bawah ini:
bun add @capgo/capacitor-firebase-messagingbunx cap syncimport { FirebaseMessaging } from '@capgo/capacitor-firebase-messaging';API Pengantar
Judul bagian āAPI PengantarācheckPermissions
Judul bagian ācheckPermissionsāPeriksa izin untuk menerima notifikasi push.
Aktif Android, metode ini hanya perlu dipanggil pada Android 13+.
import { FirebaseMessaging } from '@capgo/capacitor-firebase-messaging';
await FirebaseMessaging.checkPermissions();requestPermissions
Judul bagian ārequestPermissionsāMinta izin untuk menerima notifikasi push.
Pada AndroidMetode ini hanya perlu dipanggil pada Android 13+.
import { FirebaseMessaging } from '@capgo/capacitor-firebase-messaging';
await FirebaseMessaging.requestPermissions();isSupported
Bab berjudul āisSupportedāMengecek apakah semua API yang dibutuhkan ada.
Selalu mengembalikan true pada Android dan iOS.
import { FirebaseMessaging } from '@capgo/capacitor-firebase-messaging';
await FirebaseMessaging.isSupported();getToken
Bab berjudul āgetTokenāMendaftarkan aplikasi untuk menerima notifikasi push. Mengembalikan token FCM yang dapat digunakan untuk mengirim pesan push ke instance Messaging tersebut.
Metode ini juga mengaktifkan ulang FCM auto-init.
import { FirebaseMessaging } from '@capgo/capacitor-firebase-messaging';
await FirebaseMessaging.getToken();deleteToken
Bagian berjudul ādeleteTokenāHapus token FCM dan daftarkan aplikasi untuk menghentikan penerimaan notifikasi push. Dapat dipanggil, misalnya, ketika pengguna keluar dari akun.
import { FirebaseMessaging } from '@capgo/capacitor-firebase-messaging';
await FirebaseMessaging.deleteToken();getDeliveredNotifications
Bagian berjudul āgetDeliveredNotificationsāDapatkan daftar notifikasi yang terlihat di layar notifikasi.
Catatan: Ini akan mengembalikan semua notifikasi yang disampaikan, termasuk notifikasi lokal, dan bukan hanya notifikasi FCM.
Pada Android, bidang data notifikasi FCM tidak akan termasuk.
import { FirebaseMessaging } from '@capgo/capacitor-firebase-messaging';
await FirebaseMessaging.getDeliveredNotifications();removeDeliveredNotifications
Bagian berjudul āremoveDeliveredNotificationsāHapus notifikasi tertentu dari layar notifikasi.
import { FirebaseMessaging } from '@capgo/capacitor-firebase-messaging';
await FirebaseMessaging.removeDeliveredNotifications({} as RemoveDeliveredNotificationsOptions);removeAllDeliveredNotifications
Bagian berjudul āremoveAllDeliveredNotificationsāHapus semua notifikasi dari layar notifikasi.
Perlu diingat: Ini akan menghapus semua notifikasi yang telah terkirim, termasuk notifikasi lokal, dan bukan hanya notifikasi FCM.
import { FirebaseMessaging } from '@capgo/capacitor-firebase-messaging';
await FirebaseMessaging.removeAllDeliveredNotifications();subscribeToTopic
Bagian berjudul āsubscribeToTopicāMengikuti topik di latar belakang.
Hanya tersedia untuk Android dan iOS.
import { FirebaseMessaging } from '@capgo/capacitor-firebase-messaging';
await FirebaseMessaging.subscribeToTopic({} as SubscribeToTopicOptions);unsubscribeFromTopic
Bagian berjudul āunsubscribeFromTopicāMenghentikan pengikutan topik di latar belakang.
Hanya tersedia untuk Android dan iOS.
import { FirebaseMessaging } from '@capgo/capacitor-firebase-messaging';
await FirebaseMessaging.unsubscribeFromTopic({} as UnsubscribeFromTopicOptions);createChannel
Bagian berjudul ācreateChannelāBuat saluran peringatan.
Hanya tersedia untuk Android (SDK 26+).
import { FirebaseMessaging } from '@capgo/capacitor-firebase-messaging';
await FirebaseMessaging.createChannel({} as CreateChannelOptions);deleteChannel
Bagian berjudul ādeleteChannelāHapus saluran peringatan.
Hanya tersedia untuk Android (SDK 26+).
import { FirebaseMessaging } from '@capgo/capacitor-firebase-messaging';
await FirebaseMessaging.deleteChannel({} as DeleteChannelOptions);listChannels
Bagian berjudul ālistChannelsāTampilkan saluran peringatan yang tersedia.
Hanya tersedia untuk Android (SDK 26+).
import { FirebaseMessaging } from '@capgo/capacitor-firebase-messaging';
await FirebaseMessaging.listChannels();Referensi Tipe
Referensi TipePermissionStatus
Status Izinexport interface PermissionStatus { /** * @since 0.2.2 */ receive: PermissionState;}IsSupportedResult
Section titled āIsSupportedResultāexport interface IsSupportedResult { /** * @since 0.3.1 */ isSupported: boolean;}GetTokenOptions
Section titled ā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
Section titled āGetTokenResultāexport interface GetTokenResult { /** * @since 0.2.2 */ token: string;}GetDeliveredNotificationsResult
Section titled āGetDeliveredNotificationsResultāexport interface GetDeliveredNotificationsResult { /** * @since 0.2.2 */ notifications: Notification[];}RemoveDeliveredNotificationsOptions
Section titled āRemoveDeliveredNotificationsOptionsāexport interface RemoveDeliveredNotificationsOptions { /** * @since 0.4.0 */ notifications: Notification[];}SubscribeToTopicOptions
Bagian berjudul āSubscribeToTopicOptionsāexport interface SubscribeToTopicOptions { /** * The name of the topic to subscribe. * * @since 0.2.2 */ topic: string;}UnsubscribeFromTopicOptions
Bagian berjudul āUnsubscribeFromTopicOptionsāexport interface UnsubscribeFromTopicOptions { /** * The name of the topic to unsubscribe from. * * @since 0.2.2 */ topic: string;}CreateChannelOptions
Bagian berjudul āCreateChannelOptionsāexport type CreateChannelOptions = Channel;DeleteChannelOptions
Bagian berjudul āDeleteChannelOptionsāexport interface DeleteChannelOptions { /** * The channel identifier. * * @since 1.4.0 */ id: string;}ListChannelsResult
Bagian berjudul āListChannelsResultāexport interface ListChannelsResult { channels: Channel[];}TokenReceivedListener
Bagian berjudul āTokenReceivedListenerāPanggilan balik untuk menerima event token yang diterima.
export type TokenReceivedListener = (event: TokenReceivedEvent) => void;Sumber Kebenaran
Bagian berjudul āSumber KebenaranāHalaman ini dihasilkan dari pluginās src/definitions.tsRe-run sinkronisasi ketika publik API berubah di atas.
Teruskan dari Getting Started
Bagian berjudul āTeruskan dari Getting StartedāJika Anda menggunakan Getting Started untuk merencanakan dashboard dan API operasi, hubungkannya dengan API Overview untuk detail implementasi di API Ringkasan, Pendahuluan untuk detail implementasi di Pendahuluan, API Kunci untuk detail implementasi di API Kunci, Perangkat untuk detail implementasi di Perangkat, dan Paket untuk detail implementasi di Paket.