Flutter Firebase Cloud Messaging管理插件fcm_channels_manager的使用

Flutter Firebase Cloud Messaging管理插件fcm_channels_manager的使用

插件介绍

fcm_channels_manager 是一个用于在 Android 上创建和管理通知通道的 Flutter 包。它支持 Android 8.0 (API level 26) 及以上版本。

• 功能
  • 创建新的通知通道。
  • 获取已注册的所有通知通道。
  • 删除已注册的通知通道。

安装

在您的 Flutter 项目 pubspec.yaml 文件中添加以下依赖项：

dependencies:
  fcm_channels_manager: <最新版本>

在您的库文件中添加以下导入：

import 'package:fcm_channels_manager/fcm_channels_manager.dart';

使用示例

1. 创建新通道

成功注册通道后返回成功消息。

final result = await FcmChannelsManager().registerChannel(
  id: "1001",
  name: "Feedback notification",
  description: "Receive new feedback and system's notification",
  importance: NotificationImportance.importanceHight,
  visibility: NotificationVisibility.public,
  bubbles: true,
  vibration: true,
  sound: true,
  badge: true,
);

• 通知重要性级别

• 通知可见性

2. 获取所有注册的通道

获取所有注册的通道及其基本信息：id、name、description、importance。可以检查重要性级别并处理业务逻辑。

final channels = await FcmChannelsManager().getChannels();

3. 删除一个通道

删除已注册的通道，并返回删除成功的消息。

final result = await FcmChannelsManager().unregisterChannel('1001');

4. 提供应用程序通知设置

更新 .providesAppNotificationSettings 并返回成功状态。该函数应在请求通知权限后调用（使用 firebase_messaging）。

FcmChannelsManager()
  .providesAppNotificationSettings()
  .then((value) => log('Permission status: $value'));

示例代码

import 'package:flutter/material.dart';
import 'dart:async';
import 'package:fcm_channels_manager/fcm_channels_manager.dart';

void main() {
  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> with WidgetsBindingObserver {
  final _fcmChannelsManagerPlugin = FcmChannelsManager();
  List<NotificationChannel> _channels = List.from([]);

  [@override](/user/override)
  void initState() {
    super.initState();
    WidgetsBinding.instance.addPostFrameCallback((_) {
      initChannels();
    });

    WidgetsBinding.instance.addObserver(this);
  }

  [@override](/user/override)
  void dispose() {
    WidgetsBinding.instance.removeObserver(this);
    super.dispose();
  }

  [@override](/user/override)
  void didChangeAppLifecycleState(AppLifecycleState state) {
    if (state == AppLifecycleState.resumed) {
      _getChannels();
    }
  }

  Future<void> _getChannels() async {
    _channels = await _fcmChannelsManagerPlugin.getChannels();
    setState(() {});
  }

  // Platform messages are asynchronous, so we initialize in an async method.
  Future<void> initChannels() async {
    // If the widget was removed from the tree while the asynchronous platform
    // message was in flight, we want to discard the reply rather than calling
    // setState to update our non-existent appearance.
    final List<Map<String, dynamic>> _mockData = [
      {
        'id': '1001',
        'name': 'Social notification',
        'description': 'Social notification',
        'importance': NotificationImportance.importanceHight,
      },
      {
        'id': '1002',
        'name': 'Message notification',
        'description': 'Message notification',
        'importance': NotificationImportance.importanceDefault,
      },
      {
        'id': '1003',
        'name': 'System notification',
        'description': 'Admin notification',
        'importance': NotificationImportance.importanceLow,
      },
      {
        'id': '1004',
        'name': 'Report notification',
        'description': 'User report notification',
        'importance': NotificationImportance.importanceMin,
      }
    ];
    for (var channel in _mockData) {
      await _fcmChannelsManagerPlugin.registerChannel(
        id: channel['id'],
        name: channel['name'],
        description: channel['description'],
        importance: channel['importance'],
      );
    }
    _getChannels();
  }

  Future<void> unRegisterFirst() async {
    await _fcmChannelsManagerPlugin.unregisterChannel('1001');
    _getChannels();
  }

  [@override](/user/override)
  Widget build(BuildContext context) {
    return MaterialApp(
      home: Scaffold(
        appBar: AppBar(
          title: const Text('Plugin example app'),
        ),
        body: Column(
          children: [
            ListView.builder(
              itemBuilder: (_, index) {
                final channel = _channels[index];
                return Row(
                  mainAxisAlignment: MainAxisAlignment.spaceBetween,
                  children: [
                    Expanded(
                      child: Column(
                        crossAxisAlignment: CrossAxisAlignment.start,
                        children: [
                          Text(
                            channel.name,
                            style: const TextStyle(
                              fontWeight: FontWeight.w700,
                              fontSize: 16,
                            ),
                          ),
                          Text(channel.importance.toString()),
                        ],
                      ),
                    ),
                    Switch(
                      value:
                          channel.importance != NotificationImportance.disabled,
                      onChanged: (_) {},
                    )
                  ],
                );
              },
              shrinkWrap: true,
              itemCount: _channels.length,
            ),
            const SizedBox(height: 10),
            const Divider(),
            const SizedBox(height: 10),
            ElevatedButton(
              onPressed: () {
                unRegisterFirst();
              },
              child: const Text('Unregister channel 1001'),
            ),
          ],
        ),
      ),
    );
  }
}