@capgo/capacitor-rich-notifications

Overview

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

Start with checkPermission() and the other core methods listed below.

Platform support

Platform	Support	Notes
iOS	Yes	Native
Android	Yes	Native
Web	No	Guard with Capacitor.getPlatform()

Core Capabilities

• checkPermission - Check local notification permission status.
• requestPermission - Request local notification permission.
• createChannel - Create an Android notification channel.
• createChannelGroup - Create an Android channel group.

Public API

Method	Description
checkPermission	Check local notification permission status.
requestPermission	Request local notification permission.
createChannel	Create an Android notification channel.
createChannelGroup	Create an Android channel group.
deleteChannel	Delete an Android notification channel.
display	Display a local notification immediately.
schedule	Schedule a local notification for later.
cancel	Cancel one notification by id.
cancelAll	Cancel every notification managed by this plugin.
getDisplayed	List notifications shown in the shade or center.
getPending	List scheduled notifications not yet shown.
getInitialNotification	Return the notification that opened the app, if any.
setBadge	Set the app icon badge count on iOS.
registerActions	Register a reusable action category.
getPluginVersion	Returns the platform implementation version marker.
addListener	Listen for press and dismiss events.

Source Of Truth

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

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.