Skip to content

@capgo/capacitor-rich-notifications

Local notifications with Android channels, progress layouts, action buttons, scheduling, and iOS interruption levels.

@capgo/capacitor-rich-notifications shows polished local notifications from your Capacitor app. It does not register for remote push. Use @capgo/capacitor-notifications for Capgo-managed FCM and APNs delivery.

  • checkPermission - Check local notification permission status.
  • requestPermission - Request local notification permission.
  • createChannel - Create an Android notification channel.
  • createChannelGroup - Create an Android channel group.
MethodDescription
checkPermissionCheck local notification permission status.
requestPermissionRequest local notification permission.
createChannelCreate an Android notification channel.
createChannelGroupCreate an Android channel group.
deleteChannelDelete an Android notification channel.
displayDisplay a local notification immediately.
scheduleSchedule a local notification for later.
cancelCancel one notification by id.
cancelAllCancel every notification managed by this plugin.
getDisplayedList notifications shown in the shade or center.
getPendingList scheduled notifications not yet shown.
getInitialNotificationReturn the notification that opened the app, if any.
setBadgeSet the app icon badge count on iOS.
registerActionsRegister a reusable action category.
getPluginVersionReturns the platform implementation version marker.
addListenerListen for press and dismiss events.

This reference is synced from src/definitions.ts in capacitor-rich-notifications.

Keep going from @capgo/capacitor-rich-notifications

Section titled “Keep going from @capgo/capacitor-rich-notifications”

If you are using @capgo/capacitor-rich-notifications in your Capacitor app, connect it with Using @capgo/capacitor-rich-notifications for the SEO tutorial and related Capgo plugin docs.