periodic_alarm 0.0.41⧉

Getting Started

Android installation steps

In your android/app/build.gradle, make sure you have the following config:

android {
  compileSdkVersion 33
  [...]
  defaultConfig {
    [...]
    multiDexEnabled true
  }
}

After that, add the following to your AndroidManifest.xml within the <manifest></manifest> tags:

<uses-permission android:name="android.permission.RECEIVE_BOOT_COMPLETED"/>
<uses-permission android:name="android.permission.WAKE_LOCK"/>
<!-- For apps with targetSDK=31 (Android 12) -->
<uses-permission android:name="android.permission.SCHEDULE_EXACT_ALARM"/>

Next, within the <application></application> tags, add:

<service
    android:name="dev.fluttercommunity.plus.androidalarmmanager.AlarmService"
    android:permission="android.permission.BIND_JOB_SERVICE"
    android:exported="false"/>
<receiver
    android:name="dev.fluttercommunity.plus.androidalarmmanager.AlarmBroadcastReceiver"
    android:exported="false"/>
<receiver
    android:name="dev.fluttercommunity.plus.androidalarmmanager.RebootBroadcastReceiver"
    android:enabled="false"
    android:exported="false">
    <intent-filter>
        <action android:name="android.intent.action.BOOT_COMPLETED" />
    </intent-filter>
</receiver>

Finally, add your audio asset(s) to your project like usual.

How to use

Add to your pubspec.yaml:

flutter pub add periodic_alarm

First, you have to initialize the periodic_alarm service in your main function:

await PeriodicAlarm.init()

Then, you have to define your alarm settings:

final alarmSettings = AlarmSettings(
  id: id,
  dateTime: dateTime,
  assetAudioPath: 'assets/alarm.mp3',
  loopAudio: true,
  fadeDuration: 3.0,
  notificationTitle: 'This is the title',
  notificationBody: 'This is the body',
  enableNotificationOnKill: true,
  monday: true,
  tuesday : true,
  wednesday : true,
  thursday : true,
  friday : true,
  saturday : true,
  sunday : true,
  active : true,

);

And finally set the alarm:

await PeriodicAlarm.setOneAlarm(alarmModel: alarmModel)