Skip to main content
Capgo logo
← Back To Plugins

Complete Tutorial: Using @capgo/capacitor-alarm for iOS and Android Mobile Apps

The @capgo/capacitor-alarm package provides native alarm functionality for your Capacitor mobile applications on iOS and Android. This comprehensive tutorial will guide you through integrating alarm features into your iOS and Android mobile apps built with Capacitor or Cordova, enabling cross-platform mobile app development with native capabilities.

What is Capacitor?

Capacitor is Ionic's modern native runtime that enables developers to build native iOS apps, Android apps, and Progressive Web Apps from a single codebase. Unlike older Cordova-based mobile development, Capacitor provides direct access to native iOS and Android APIs, making it the ideal choice for building production-ready mobile applications. This Capacitor plugin brings alarm capabilities to both iOS and Android mobile platforms.

Why Use alarm in Your Capacitor Mobile App?

The @capgo/capacitor-alarm plugin enables your iOS and Android mobile applications to leverage native alarm functionality without writing platform-specific code. This Capacitor plugin provides a unified JavaScript API that works seamlessly on both iOS and Android mobile devices, making it perfect for cross-platform mobile app development.

Benefits for iOS and Android mobile applications:

  • Native alarm performance on iOS and Android devices
  • Unified API for both iOS and Android mobile platforms
  • No need for separate native iOS or Android code
  • Works with Capacitor and Cordova mobile frameworks
  • Full TypeScript support for mobile app development
  • Seamless integration with existing Capacitor mobile apps

locale: en

Using @capgo/capacitor-alarm

The @capgo/capacitor-alarm package allows you to schedule native alarms and notifications even when your app is closed. Here is a tutorial on how to use this package.

Installation

To install the package, run the following command:

npm install @capgo/capacitor-alarm
npx cap sync

Configuration

Android Setup

Add the following permissions to your AndroidManifest.xml:

<uses-permission android:name="android.permission.SCHEDULE_EXACT_ALARM" />
<uses-permission android:name="android.permission.USE_EXACT_ALARM" />

Usage

Schedule an Alarm

import { CapacitorAlarm } from '@capgo/capacitor-alarm';

await CapacitorAlarm.schedule({
  id: 1,
  title: 'Alarm Title',
  message: 'Alarm Message',
  triggerTime: new Date(Date.now() + 60000), // 1 minute from now
});

Cancel an Alarm

import { CapacitorAlarm } from '@capgo/capacitor-alarm';

await CapacitorAlarm.cancel({ id: 1 });

Get All Scheduled Alarms

import { CapacitorAlarm } from '@capgo/capacitor-alarm';

const alarms = await CapacitorAlarm.getAll();
console.log('Scheduled alarms:', alarms);

That's it! You have successfully integrated native alarms into your Capacitor app.

Platform-Specific Notes for iOS and Android

iOS Mobile Platform

  • Compatible with iOS 10.0+ mobile devices (iPhone and iPad)
  • Uses native iOS APIs for alarm functionality
  • Optimized performance on iOS mobile platform
  • Full support for latest iOS versions

Android Mobile Platform

  • Compatible with Android 5.0 (API 21)+ mobile devices
  • Uses native Android APIs for alarm functionality
  • Works across all Android device manufacturers
  • Optimized for Android mobile platform

Capacitor vs Cordova for Mobile Development

While this alarm plugin works with both Capacitor and Cordova mobile frameworks, Capacitor offers significant advantages for iOS and Android mobile app development:

  • Modern Architecture: Better performance on iOS and Android mobile platforms
  • Direct Native Access: Easier integration with iOS and Android native APIs
  • Improved Tooling: Superior development experience for mobile apps
  • Active Development: Regular updates for iOS and Android compatibility
  • Better Documentation: Comprehensive guides for mobile app development

Conclusion

You have successfully integrated @capgo/capacitor-alarm into your Capacitor mobile application for iOS and Android. This plugin provides native alarm capabilities for both iOS and Android mobile platforms, enabling professional mobile app development with a unified codebase.

For detailed API documentation and advanced alarm features for mobile app development, visit the GitHub repository.

Whether you're building native iOS apps, Android mobile applications, or cross-platform Capacitor mobile apps, this alarm plugin provides the native capabilities you need for professional mobile app development on iOS and Android platforms.