smartalarm_alarm_manager

Description:

smartalarm alarm manager

android_alarm_manager #

Deprecation Notice #
This plugin has been replaced by the Flutter Community Plus
Plugins version,
android_alarm_manager_plus.
No further updates are planned to this plugin, and we encourage all users to
migrate to the Plus version.
Critical fixes (e.g., for any security incidents) will be provided through the
end of 2021, at which point this package will be marked as discontinued.


A Flutter plugin for accessing the Android AlarmManager service, and running
Dart code in the background when alarms fire.
Getting Started #
After importing this plugin to your project as usual, 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"/>
copied to clipboard
Next, within the <application></application> tags, add:
<service
android:name="io.flutter.plugins.androidalarmmanager.AlarmService"
android:permission="android.permission.BIND_JOB_SERVICE"
android:exported="false"/>
<receiver
android:name="io.flutter.plugins.androidalarmmanager.AlarmBroadcastReceiver"
android:exported="false"/>
<receiver
android:name="io.flutter.plugins.androidalarmmanager.RebootBroadcastReceiver"
android:enabled="false">
<intent-filter>
<action android:name="android.intent.action.BOOT_COMPLETED"/>
</intent-filter>
</receiver>

copied to clipboard
Then in Dart code add:
import 'package:android_alarm_manager/smartalarm_alarm_manager.dart';

void printHello() {
final DateTime now = DateTime.now();
final int isolateId = Isolate.current.hashCode;
print("[$now] Hello, world! isolate=${isolateId} function='$printHello'");
}

main() async {
final int helloAlarmID = 0;
await AndroidAlarmManager.initialize();
runApp(...);
await AndroidAlarmManager.periodic(const Duration(minutes: 1), helloAlarmID, printHello);
}
copied to clipboard
printHello will then run (roughly) every minute, even if the main app ends. However, printHello
will not run in the same isolate as the main application. Unlike threads, isolates do not share
memory and communication between isolates must be done via message passing (see more documentation on
isolates here).
Using other plugins in alarm callbacks #
If alarm callbacks will need access to other Flutter plugins, including the
alarm manager plugin itself, it may be necessary to inform the background service how
to initialize plugins depending on which Flutter Android embedding the application is
using.
Flutter Android Embedding V1 #
For the Flutter Android Embedding V1, the background service must be provided a
callback to register plugins with the background isolate. This is done by giving
the AlarmService a callback to call the application's onCreate method. See the example's
Application overrides.
In particular, its Application class is as follows:
public class Application extends FlutterApplication implements PluginRegistrantCallback {
@Override
public void onCreate() {
super.onCreate();
AlarmService.setPluginRegistrant(this);
}

@Override
public void registerWith(PluginRegistry registry) {
GeneratedPluginRegistrant.registerWith(registry);
}
}
copied to clipboard
Which must be reflected in the application's AndroidManifest.xml. E.g.:
<application
android:name=".Application"
...
copied to clipboard
Note: Not calling AlarmService.setPluginRegistrant will result in an exception being
thrown when an alarm eventually fires.
Flutter Android Embedding V2 #
For the Flutter Android Embedding V2, plugins are registered with the background
isolate via reflection so AlarmService.setPluginRegistrant does not need to be
called.
For help getting started with Flutter, view our online
documentation.
For help on editing plugin code, view the documentation.