Flutter推送通知插件notificare_push_lib的使用

Flutter推送通知插件notificare_push_lib的使用

简介

notificare-push-lib-flutter 是官方提供的Flutter插件，用于在Flutter应用程序中实现Notificare平台的强大智能通知功能。通过该插件，开发者可以轻松集成推送通知、地理位置服务、应用内消息等功能。

完整示例Demo

以下是一个完整的示例代码，展示了如何在Flutter项目中使用 notificare_push_lib 插件来实现推送通知功能。该示例包括了初始化、设备注册、接收通知事件、处理深链接等常见操作。

1. 添加依赖

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

dependencies:
  flutter:
    sdk: flutter
  notificare_push_lib: ^<latest_version>
  permission_handler: ^<latest_version>  # 用于处理权限请求

2. 初始化和配置

在 main.dart 文件中，编写如下代码来初始化 Notificare 并处理各种事件：

import 'package:flutter/material.dart';
import 'dart:async';
import 'dart:io' show Platform;

import 'package:notificare_push_lib/notificare_push_lib.dart';
import 'package:notificare_push_lib/notificare_models.dart';
import 'package:notificare_push_lib/notificare_events.dart';
import 'package:permission_handler/permission_handler.dart';

void main() => runApp(MyApp());

class MyApp extends StatefulWidget {
  [@override](/user/override)
  _MyAppState createState() => _MyAppState();
}

class _MyAppState extends State<MyApp> {

  final NotificarePushLib notificare = NotificarePushLib();

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

    // 启动 Notificare
    print("Launching...");
    notificare.launch();

    // 监听 Notificare 事件
    notificare.onEventReceived.listen((NotificareEvent event) async {
      switch (event.name) {
        case "ready": {
          // 应用程序已准备好
          NotificareReadyEvent readyEvent = event.data as NotificareReadyEvent;
          print("Application is Ready: " + readyEvent.application.name!);

          // 注册设备以接收推送通知
          await notificare.registerForNotifications();

          // 注册设备信息（用户ID和用户名）
          await _registerDevice("1234567890", "Joel Oliveira");

          // 获取收件箱中的通知
          List inbox = await _fetchInbox();

          // 检查是否启用了远程通知
          if (await notificare.isRemoteNotificationsEnabled()) {
            print("Remote Notifications Enabled");
          }

          // 检查是否启用了允许的UI
          if (await notificare.isAllowedUIEnabled()) {
            print("Allowed UI Enabled");
          }

          // 如果收件箱中有通知，可以进行处理
          if (inbox.isNotEmpty) {
            // 可以选择展示收件箱中的第一条通知
            // notificare.presentInboxItem(inbox[0]);

            // 或者标记为已读
            // await notificare.markAsRead(inbox[0]);
          }

          // 如果是Android设备，请求位置权限并启动位置更新
          if (Platform.isAndroid) {
            try {
              final permission = await Permission.location.request();
              if (permission == PermissionStatus.granted) {
                notificare.startLocationUpdates().then((_) {
                  print("location updates started");
                });
              }
            } catch (err) {
              // 处理错误
            }
          } else {
            notificare.startLocationUpdates();
          }
        }
        break;

        case "urlOpened": {
          // 处理打开的URL（深链接）
          NotificareUrlOpenedEvent urlOpenedEvent = event.data as NotificareUrlOpenedEvent;
          print("URL: " + urlOpenedEvent.url);
        }
        break;

        case "deviceRegistered": {
          // 设备已成功注册
          NotificareDeviceRegisteredEvent deviceRegisteredEvent = event.data as NotificareDeviceRegisteredEvent;
          print("Device: " + deviceRegisteredEvent.device.deviceID!);

          // 获取通知设置、标签、首选语言等信息
          await _fetchNotificationSettings();
          await _fetchTags();
          await _addTag("tag_flutter");
          await _fetchPreferredLanguage();
        }
        break;

        case "remoteNotificationReceivedInBackground": {
          // 在后台接收到远程通知
          NotificareRemoteNotificationReceivedInBackgroundEvent remoteNotificationReceivedInBackgroundEvent = event.data as NotificareRemoteNotificationReceivedInBackgroundEvent;
          print("Notification: " + remoteNotificationReceivedInBackgroundEvent.notification.message!);

          // 展示通知
          notificare.presentNotification(remoteNotificationReceivedInBackgroundEvent.notification);
        }
        break;

        case "remoteNotificationReceivedInForeground": {
          // 在前台接收到远程通知
          NotificareRemoteNotificationReceivedInForegroundEvent remoteNotificationReceivedInForegroundEvent = event.data as NotificareRemoteNotificationReceivedInForegroundEvent;
          print("Notification: " + remoteNotificationReceivedInForegroundEvent.notification.message!);
        }
        break;

        // 其他事件处理...
      }
    });

    // 初始化平台状态
    initPlatformState();
  }

  // 平台消息是异步的，因此我们在这里初始化
  Future<void> initPlatformState() async {
    if (!mounted) return;
  }

  // 获取通知设置
  Future<void> _fetchNotificationSettings() async {
    NotificareNotificationSettings settings = await notificare.fetchNotificationSettings();
    print("Settings: " + settings.toJson().toString());
  }

  // 获取首选语言
  Future<void> _fetchPreferredLanguage() async {
    String? preferredLanguage = await notificare.fetchPreferredLanguage();
    print("Preferred Language: " + preferredLanguage.toString());
  }

  // 注册设备
  Future<void> _registerDevice(String userID, String userName) async {
    NotificareDevice response = await notificare.registerDevice(userID, userName);
    print("Register Device: " + response.toJson().toString());
  }

  // 获取标签
  Future<void> _fetchTags() async {
    List tags = await notificare.fetchTags();
    print("Tags: " + tags.toString());
  }

  // 添加标签
  Future<void> _addTag(String tag) async {
    try {
      await notificare.addTag(tag);
      print("Added Tag: " + tag);
    } catch (e) {
      print("Failed to add Tag: " + tag);
    }
  }

  // 获取收件箱中的通知
  Future<List> _fetchInbox() async {
    List response = await notificare.fetchInbox();
    print("Inbox: " + response.toString());
    return response;
  }

  // 获取资产（如图片、视频等）
  Future<void> _fetchAssets(String group) async {
    List response = await notificare.fetchAssets(group);
    print("Assets: " + response.toString());

    if (response != null && response.length > 0) {
      response.forEach((asset) {
        // 处理每个资产
      });
    }
  }

  // 检查是否启用了远程通知
  Future<void> _isRemoteNotificationsEnabled() async {
    bool status = await notificare.isRemoteNotificationsEnabled();
    if (status) {
      print("Remote Notifications are enabled");
    }
  }

  [@override](/user/override)
  Widget build(BuildContext context) {
    return MaterialApp(
      home: Scaffold(
        appBar: AppBar(
          title: const Text('Plugin example app'),
        ),
        body: Center(
          child: Text('Running...'),
        ),
      ),
    );
  }
}