Flutter自定义通知插件mc_custom_notification的使用

mc_custom_notification 是一个强大的Flutter插件，用于在Android平台上创建和管理自定义通知。本文将介绍如何安装和使用该插件，并提供完整的示例代码。

安装

首先，在您的 pubspec.yaml 文件中添加 mc_custom_notification 依赖：

dependencies:
  flutter:
    sdk: flutter
  mc_custom_notification: ^latest_version

然后运行以下命令来安装插件：

flutter pub get

初始化库

在应用程序启动时初始化插件：

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

void main() async {
  WidgetsFlutterBinding.ensureInitialized();

  McCustomNotification().initialize(
    onClick: (payload) {
      // 处理通知点击事件
    },
  );

  runApp(MyApp());
}

使用示例

显示来电通知

import 'package:mc_custom_notification/mc_custom_notification.dart';

Future<void> showCallNotification() async {
  await McCustomNotification().showNotificationCall(
    model: NotificationCall(
      id: 1,
      tag: 'tag1',
      title: 'New Notification',
      body: 'This is the body of the notification',
      image: "https://vpsserver.meta-code-ye.com/files/image?name=IMG-20240314-WA0007.jpg",
      payload: {'id': 55, "name": "ali"},
      groupKey: "call",
      onAccepted: (payload) {
        // 接受来电时的操作
      },
      onDenied: () {
        // 拒绝来电时的操作
      },
    ),
  );
}

显示通话通知

import 'package:mc_custom_notification/mc_custom_notification.dart';

Future<void> showCallingNotification() async {
  await McCustomNotification().showNotificationCalling(
    model: NotificationCalling(
      id: 52,
      tag: 'tag18',
      title: 'Normal notification ',
      body: 'This is the body of the notification',
      payload: {'id': 55, "name": "ali"},
      groupKey: "normal53",
      onEndCall: (payload) {
        // 结束通话时的操作
      },
    ),
  );
}

显示消息通知（带InBox）

import 'package:mc_custom_notification/mc_custom_notification.dart';

Future<void> showMessageWithInboxNotification() async {
  List<String> names = ['younas', 'ali', 'mohammed', 'ahmed', 'salh'];
  List<String> dis = [
    'nice to meet you',
    'hellow man',
    'how are you',
    'I need Vs code',
    'no thanks its work'
  ];

  for (int x = 0; x < names.length; x++) {
    await McCustomNotification().showNotificationMessage(
      model: NotificationMessage(
        useInbox: true,
        id: 11 + x,
        tag: 'tag111$x',
        title: names[x],
        body: dis[x],
        payload: {'id': 55, "name": "ali"},
        groupKey: "chat55214",
        isVibration: true,
        onRead: (payload) {
          // 阅读消息时的操作
        },
        onReply: (payload) {
          // 回复消息时的操作
        },
      ),
    );
  }
}

发送Firebase通知

发送给单个用户

import 'package:mc_custom_notification/mc_custom_notification.dart';

Future<void> sendNotificationToUser(String token) async {
  await McCustomNotification().sendNotification(
    token: token,
    model: NotificationModel(
      title: "younas ali",
      body: "hello how are you",
      id: 150,
      image: "https://vpsserver.meta-code-ye.com/files/image?name=IMG-20240314-WA0007.jpg",
      payload: {"id": 1, "name": "younas"},
    ),
  );
}

发送给多个用户

import 'package:mc_custom_notification/mc_custom_notification.dart';

Future<void> sendNotificationToMultipleUsers() async {
  await McCustomNotification().sendNotificationToAll(
    topics: "'meta' in topics || 'code' in topics ||'allUsers' in topics",
    model: NotificationModel(
      title: "younas ali",
      body: "hello how are you",
      groupKey: 'normal_notification',
      id: 150,
      image: "https://vpsserver.meta-code-ye.com/files/image?name=IMG-20240314-WA0007.jpg",
      payload: {"id": 1, "name": "younas"},
    ),
  );
}

Firebase背景通知处理

import 'package:firebase_messaging/firebase_messaging.dart';
import 'package:mc_custom_notification/mc_custom_notification.dart';

Future<void> handleBackgroundMessage(RemoteMessage message) async {
  var payloadData = message.data;
  var model = NotificationModel.fromMap(payloadData);
  await McCustomNotification().showNotificationMessage(
    model: NotificationMessage(
      id: 1,
      tag: message.notification?.android?.tag,
      title: model.title,
      body: model.body,
      image: model.image,
      payload: model.payload,
      onRead: (payload) {
        // 阅读消息时的操作
      },
      onReply: (payload) {
        // 回复消息时的操作
      },
    ),
  );
}

void main() async {
  WidgetsFlutterBinding.ensureInitialized();
  await Firebase.initializeApp();
  FirebaseMessaging.onBackgroundMessage(handleBackgroundMessage);

  runApp(MyApp());
}

全部通知操作

显示所有通知

import 'package:mc_custom_notification/mc_custom_notification.dart';
import 'package:fluttertoast/fluttertoast.dart';

Future<void> showAllNotifications() async {
  var notifications = await McCustomNotification().getAllNotificcations();
  Fluttertoast.showToast(
    msg: notifications.toString(),
    toastLength: Toast.LENGTH_LONG,
    gravity: ToastGravity.CENTER,
    timeInSecForIosWeb: 1,
    backgroundColor: Colors.red,
    textColor: Colors.white,
    fontSize: 16.0,
  );
}

取消所有通知

import 'package:mc_custom_notification/mc_custom_notification.dart';

void cancelAllNotifications() {
  McCustomNotification().cancelAllNotifications();
}

取消特定通知

import 'package:mc_custom_notification/mc_custom_notification.dart';

void cancelSpecificNotification() {
  McCustomNotification().cancelNotification(id: 555, tag: "tag55");
}

以上是 mc_custom_notification 插件的基本使用方法和示例代码。更多详细信息请参考官方文档和GitHub仓库。希望这些内容能帮助您快速上手并实现所需功能。