@capgo/capacitor-alarm
Capacitor Alarm Plugin interface for managing native OS alarms.
Overview
Section titled “Overview”Capacitor Alarm Plugin interface for managing native OS alarms.
Core Capabilities
Section titled “Core Capabilities”createAlarm- Create a native OS alarm using the platform clock app. On Android this uses the Alarm Clock intent; on iOS this uses AlarmKit if available (iOS 16+).openAlarms- Open the platform’s native alarm list UI, if available.getOSInfo- Get information about the OS and capabilities.requestPermissions- Request relevant permissions for alarm usage on the platform. On Android, may route to settings for exact alarms.
Public API
Section titled “Public API”| Method | Description |
|---|---|
createAlarm | Create a native OS alarm using the platform clock app. On Android this uses the Alarm Clock intent; on iOS this uses AlarmKit if available (iOS 16+). |
openAlarms | Open the platform’s native alarm list UI, if available. |
getOSInfo | Get information about the OS and capabilities. |
requestPermissions | Request relevant permissions for alarm usage on the platform. On Android, may route to settings for exact alarms. |
checkPermissions | Check the current permission state for native alarm access without triggering UI. On iOS this reports AlarmKit readiness; on Android it reports capability details. |
getPluginVersion | Get the native Capacitor plugin version. |
getAlarms | Get a list of alarms scheduled by this app. On iOS 26+, returns alarms from AlarmKit. On Android, this is not supported as the system does not provide an API to query alarms. |
Source Of Truth
Section titled “Source Of Truth”This reference is synced from src/definitions.ts in capacitor-alarm.
Keep going from @capgo/capacitor-alarm
Section titled “Keep going from @capgo/capacitor-alarm”If you are using @capgo/capacitor-alarm to plan native plugin work, connect it with Using @capgo/capacitor-alarm for the native capability in Using @capgo/capacitor-alarm, Capgo Plugin Directory for the product workflow in Capgo Plugin Directory, Capacitor Plugins by Capgo for the implementation detail in Capacitor Plugins by Capgo, Adding or Updating Plugins for the implementation detail in Adding or Updating Plugins, and Ionic Enterprise Plugin Alternatives for the product workflow in Ionic Enterprise Plugin Alternatives.