Flutter UI组件库插件flan的使用

Flan 是一个本地通知插件，用于 Flutter。它允许发送系统通知。

Flan 目前处于非常早期的开发阶段，并且是为了支持另一个项目而编写的。因此，它目前只支持 iOS 并且只允许使用日历触发器来安排通知。

示例应用主要功能正常运行。它可以让你请求权限并添加通知。请注意，iOS 不会在应用程序处于前台时显示通知。

最低支持的 iOS 版本为 15.0。

安装

flutter pub add flan

使用

Flan 暴露了以下接口：

import 'package:flan/models/notification_authorization_options.dart';
import 'package:flan/models/notification_content.dart';

abstract interface class Flan {
  /// 获取当前的通知设置。
  ///
  /// 返回一个包含当前通知设置的 Future。
  Future<Map<String, dynamic>> getNotificationSettingsAsync();

  /// 请求用户授权以发送指定类型的通知。
  ///
  /// [options] 指定了应用程序想要发送的通知类型。每个选项都是一个 NotificationAuthorizationOptions 实例。选项不能重复指定。
  ///
  /// 返回一个在请求过程完成后完成的 Future。
  Future<void> requestAuthorizationAsync(
    List<NotificationAuthorizationOptions> options,
  );

  /// 在指定的 [target] 时间安排通知。
  ///
  /// [id] 是通知的唯一标识符。
  /// [target] 指定了通知的送达时间。
  /// [content] 包含通知的详细信息，如标题和正文。
  /// [repeats] 表示通知是否应重复，默认为 `false`。
  ///
  /// 返回一个在通知成功安排后完成的 Future。
  Future<void> scheduleNotificationAsync(
    String id,
    DateTime target,
    NotificationContent content, {
    bool repeats = false,
  });

  /// 取消具有指定 [ids] 的通知。
  ///
  /// [ids] 是一个包含要取消的通知唯一标识符的可迭代对象。
  ///
  /// 返回一个在通知成功取消后完成的 Future。
  Future<void> cancelNotificationsAsync(Iterable<String> ids);

  /// 获取所有已安排的通知列表。
  ///
  /// 返回一个包含所有已安排的通知的 Future。
  Future<List<Map<String, dynamic>>> getScheduledNotificationsAsync();
}

要使用它，创建一个 FlanMethodChannel 类的实例。令牌只是一个任意的对象：

Object token = Object();
Flan flan = FlanMethodChannel(token: token);

示例代码

import 'package:flan/flan.dart';
import 'package:flutter/material.dart';
import 'package:get_it/get_it.dart';
import 'package:ksuid/ksuid.dart';

void main() {
  GetIt.instance.registerSingleton<FlanApi>(FlanPlatformApi());
  runApp(const FlanExampleApp());
}

class FlanExampleApp extends StatefulWidget {
  const FlanExampleApp({super.key});

  [@override](/user/override)
  State<FlanExampleApp> createState() => _FlanExampleAppState();
}

class _FlanExampleAppState extends State<FlanExampleApp> {
  static final FlanApi _flan = GetIt.instance<FlanApi>();

  bool? authorized;

  [@override](/user/override)
  void initState() {
    super.initState();
  }

  [@override](/user/override)
  Widget build(BuildContext context) {
    return MaterialApp(
      home: Scaffold(
        appBar: AppBar(
          title: const Text('Flan 示例应用'),
        ),
        body: Center(
          child: Column(
            spacing: 8,
            children: [
              Text('授权状态: ${authorized ?? '未知'}'),
              OutlinedButton(
                child: const Text('请求通知授权'),
                onPressed: () async {
                  var result = await _flan.requestAuthorizationAsync(
                    [
                      NotificationAuthorizationOptions.alert,
                    ],
                  );
                  setState(() => authorized = result);
                },
              ),
              OutlinedButton(
                child: const Text('安排 10 秒后的通知'),
                onPressed: () async {
                  DateTime target = DateTime.now().add(Duration(seconds: 10));
                  NotificationContent content = NotificationContent(
                    title: '来自 Flan 的示例通知',
                    body: '来自 Flan 的问候！',
                  );

                  await _flan.scheduleNotificationAsync(
                    KSUID.generate().asString,
                    target,
                    content,
                    repeats: false,
                  );
                },
              ),
              OutlinedButton(
                child: const Text('打印通知设置'),
                onPressed: () async =>
                    _flan.getNotificationSettingsAsync().then(print),
              )
            ],
          ),
        ),
      ),
    );
  }
}