Flutter互动营销插件 engagespot_sdk 的使用

Engagespot SDK for Flutter 提供了将 Engagespot 服务集成到你的 Flutter 应用程序中的功能。通过这个 SDK，你可以处理通知、标记通知为已读、注册 Firebase Cloud Messaging (FCM) 令牌，并监听实时通知事件。

安装

要在你的 Flutter 项目中使用 Engagespot SDK，请按照以下步骤操作：

1. 添加依赖项

在 pubspec.yaml 文件中添加 engagespot_sdk 依赖：

dependencies:
  engagespot_sdk: ^0.0.4

2. 安装包

在终端中运行以下命令来安装包：

flutter pub get

使用

初始化 SDK

在使用 Engagespot SDK 的任何功能之前，你需要使用 API 密钥和密钥初始化它。可以通过调用 initSdk 方法来完成：

Engagespot.initSdk(
  apiKey: 'your_api_key',
  isDebug: true, // 设置为 true 以启用调试模式
);

登录用户

使用 loginUser 方法登录用户：

Engagespot.loginUser(userId: 'user_id');

标记单个通知为已读

使用 markNotificationAsRead 方法将通知标记为已读：

bool isSuccess = await Engagespot.markNotificationAsRead(notificationID: 'notificationID');

if (isSuccess) {
  print("Notification marked as read successfully.");
} else {
  print("Failed to mark notification as read.");
}

标记所有通知为已读

使用 markAllAsRead 方法将所有通知标记为已读：

Engagespot.markAllAsRead();

删除通知

使用 deleteNotification 方法删除通知：

Engagespot.deleteNotification(notificationID: "notificationID");

删除所有通知

使用 clearAllNotification 方法删除所有通知：

Engagespot.clearAllNotification();

注册 FCM 令牌

使用 registerFCM 方法注册 FCM 令牌：

Engagespot.registerFCM('your_fcm_token');

监听通知事件

使用 listenMessage 方法监听实时通知事件。提供回调函数来处理传入的消息以及当所有通知都被标记为已读时的事件：

Engagespot.listenMessage(
  onMessage: (EsMessage es) {
    // 处理传入的消息
  }
);

获取通知

使用 getNotifications 方法检索通知。这将返回一个包含未读通知计数和通知列表的 NotificationSet 对象：

NotificationSet notificationSet = await Engagespot.getNotifications();
int unreadCount = notificationSet.unReadCount;
List<EsMessage> notifications = notificationSet.NotificationMessage;

示例 Demo

以下是一个完整的示例 Demo，展示了如何在 Flutter 应用中使用 Engagespot SDK：

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

void main() {
  WidgetsFlutterBinding.ensureInitialized();
  
  // 初始化 SDK
  Engagespot.initSdk(
    apiKey: "your_api_key",
    isDebug: true,
  );
  
  // 登录用户
  Engagespot.loginUser(userId: "user_id");

  runApp(const MainApp());
}

class MainApp extends StatelessWidget {
  const MainApp({super.key});

  [@override](/user/override)
  Widget build(BuildContext context) {
    return MaterialApp(
      home: Scaffold(
        appBar: AppBar(
          title: const Text('Engagespot Demo'),
        ),
        body: Center(
          child: Column(
            mainAxisAlignment: MainAxisAlignment.center,
            children: [
              ElevatedButton(
                onPressed: () async {
                  // 获取通知
                  NotificationSet notificationSet = await Engagespot.getNotifications();
                  int unreadCount = notificationSet.unReadCount;
                  List<EsMessage> notifications = notificationSet.NotificationMessage;

                  print("Unread Count: $unreadCount");
                  print("Notifications: $notifications");
                },
                child: const Text('Get Notifications'),
              ),
              ElevatedButton(
                onPressed: () async {
                  // 标记单个通知为已读
                  bool isSuccess = await Engagespot.markNotificationAsRead(notificationID: 'notificationID');

                  if (isSuccess) {
                    print("Notification marked as read successfully.");
                  } else {
                    print("Failed to mark notification as read.");
                  }
                },
                child: const Text('Mark Notification as Read'),
              ),
            ],
          ),
        ),
      ),
    );
  }
}