Flutter闹钟管理插件naal_alarm的使用

Flutter闹钟管理插件naal_alarm的使用

naal_alarm 是一个用于在Android平台上实现后台闹钟触发功能的Flutter插件。它允许应用程序在特定时间启动，并且可以像系统闹钟应用一样工作。

安装

首先，在 pubspec.yaml 文件中添加插件依赖：

dependencies:
  naal_alarm: ^1.0.0

或者通过命令行安装：

flutter pub add naal_alarm

初始化

在应用程序启动时，确保调用 WidgetsFlutterBinding.ensureInitialized() 并初始化闹钟插件：

void main() {
  // 确保在初始化之前绑定
  WidgetsFlutterBinding.ensureInitialized();

  // 初始化闹钟插件
  FlutterAlarmBackgroundTrigger.initialize();

  runApp(const MyApp());
}

创建实例

创建一个闹钟插件实例以便后续操作：

var alarmPlugin = FlutterAlarmBackgroundTrigger();

设置闹钟

设置一个闹钟，该闹钟将在10秒后触发。你可以选择性地指定 uid 和 payload，并且可以设置屏幕唤醒的时间：

alarmPlugin.addAlarm(
  // 必填参数：闹钟触发时间
  DateTime.now().add(Duration(seconds: 10)),

  // 可选参数：用于标识闹钟的唯一ID
  uid: "YOUR_APP_ID_TO_IDENTIFY",

  // 可选参数：额外数据
  payload: {"YOUR_EXTRA_DATA":"FOR_ALARM"},

  // 可选参数：闹钟触发时屏幕保持唤醒的时间
  screenWakeDuration: Duration(minutes: 1)
);

接收闹钟触发事件

请求权限并监听闹钟触发事件。当闹钟触发时，可以在前台或后台执行相应的操作：

alarmPlugin.requestPermission().then((isGranted) {
  if (isGranted) {
    alarmPlugin.onForegroundAlarmEventHandler((alarm) {
      // 执行你的操作，例如导航
      print(alarm.id);
    });
  }
});

其他方法

请求权限以绘制其他应用

请求用户授权以允许应用在其他应用之上绘制：

Future<bool> requestPermission();

添加闹钟

添加一个新的闹钟：

Future<AlarmItem> addAlarm(
  DateTime time, 
  {
    String? uid, 
    Map<String, dynamic>? payload, 
    Duration screenWakeDuration
  }
);

获取闹钟列表

根据不同的条件获取闹钟列表：

// 根据唯一ID获取闹钟
Future<List<AlarmItem>> getAlarmByUid(String uid);

// 获取所有已安排的闹钟
Future<List<AlarmItem>> getAllAlarms();

// 根据闹钟ID获取单个闹钟
Future<AlarmItem> getAlarm(int id);

// 根据额外数据获取闹钟
Future<List<AlarmItem>> getAlarmByPayload(Map<String, dynamic> payload);

// 根据时间获取闹钟
Future<List<AlarmItem>> getAlarmByTime(DateTime time);

删除闹钟

根据不同的条件删除闹钟：

// 根据闹钟ID删除单个闹钟
Future<void> deleteAlarm(int id);

// 根据额外数据删除多个闹钟
Future<void> deleteAlarmsByPayload(Map<String, dynamic> payload);

// 根据时间删除多个闹钟
Future<void> deleteAlarmsByTime(DateTime dateTime);

// 根据唯一ID删除多个闹钟
Future<void> deleteAlarmsByUid(String uid);

// 删除所有已安排的闹钟
Future<void> deleteAllAlarms();

示例代码

以下是一个完整的示例代码，展示了如何使用 naal_alarm 插件来管理闹钟：

import 'package:flutter/foundation.dart';
import 'package:flutter/material.dart';

import 'package:naal_alarm/flutter_alarm_background_trigger.dart';
import 'package:date_time_picker/date_time_picker.dart';
import 'package:naal_alarm_example/alarm_service.dart';

void main() {
  WidgetsFlutterBinding.ensureInitialized();

  // 初始化闹钟插件
  FlutterAlarmBackgroundTrigger.initialize();

  runApp(const MyApp());
}

class MyApp extends StatefulWidget {
  const MyApp({Key? key}) : super(key: key);

  [@override](/user/override)
  State<MyApp> createState() => _MyAppState();
}

class _MyAppState extends State<MyApp> {
  AlarmItem? _alarmItem;
  DateTime? time;
  List<AlarmItem> alarms = [];

  [@override](/user/override)
  void initState() {
    super.initState();
    reloadAlarms();
    AlarmService.instance.onForegroundAlarmEventHandler((alarmItem) {
      reloadAlarms();
    });
  }

  reloadAlarms() {
    AlarmService.instance.getAllAlarms().then((alarmsList) => setState(() {
          alarms = alarmsList;
        }));
  }

  [@override](/user/override)
  Widget build(BuildContext context) {
    return MaterialApp(
      home: Scaffold(
        appBar: AppBar(
          title: const Text('Plugin example app'),
        ),
        body: Builder(builder: (context) {
          return Center(
            child: Column(
              mainAxisAlignment: MainAxisAlignment.center,
              crossAxisAlignment: CrossAxisAlignment.center,
              children: [
                Card(
                  margin: const EdgeInsets.all(10),
                  child: Padding(
                    padding: const EdgeInsets.all(8.0),
                    child: Row(
                      children: [
                        Expanded(
                            child: DateTimePicker(
                          type: DateTimePickerType.dateTime,
                          initialValue: '',
                          firstDate: DateTime.now(),
                          lastDate: DateTime.now().add(const Duration(days: 365)),
                          dateLabelText: 'Alarm date time',
                          onChanged: (val) => setState(() {
                            time = DateTime.parse(val);
                          }),
                        )),
                        ElevatedButton(
                            onPressed: createAlarm,
                            child: const Text("Set Alarm"))
                      ],
                    ),
                  ),
                ),
                Expanded(
                  child: ListView.builder(
                    itemCount: alarms.length,
                    itemBuilder: (ctx, idx) => ((AlarmItem alarm) => ListTile(
                          title: Row(
                            children: [
                              Text(alarm.time!.toString()),
                              const SizedBox(width: 5),
                              Chip(
                                padding: EdgeInsets.zero,
                                label: Text(describeEnum(alarm.status),
                                    style: TextStyle(
                                        color: alarm.status == AlarmStatus.DONE
                                            ? Colors.black
                                            : Colors.white,
                                        fontSize: 10)),
                                backgroundColor:
                                    alarm.status == AlarmStatus.DONE
                                        ? Colors.greenAccent
                                        : Colors.redAccent,
                              )
                            ],
                          ),
                          subtitle: Text(
                              "ID: ${alarm.id}, UID: ${alarm.uid}, Payload: ${alarm.payload.toString()}"),
                          trailing: IconButton(
                              onPressed: () async {
                                await AlarmService.instance
                                    .deleteAlarm(alarm.id!);
                                reloadAlarms();
                              },
                              icon:
                                  const Icon(Icons.delete, color: Colors.red)),
                        ))(alarms[idx]),
                  ),
                )
              ],
            ),
          );
        }),
      ),
    );
  }

  void createAlarm() async {
    await AlarmService.instance
        .addAlarm(time!, uid: "TEST UID", payload: {"holy": "Moly"});
    reloadAlarms();
  }
}