Flutter集成Promise功能插件promize_sdk的使用

Flutter集成Promise功能插件promize_sdk的使用

Promize SDK 是一个数据收集SDK，提供了简单的方法来收集用户的数据和兴趣。

概述

App SDK 提供了发送事务性消息和触发事件的方法。其他方法帮助你保存有关人员的信息、最常访问的页面和事件。

开始使用

首先，在 Promize控制台 注册账户。

然后在你的 pubspec.yaml 文件中添加 promize_sdk 依赖：

dependencies:
  promize_sdk: ^latest_version

确保升级你的 Dart SDK 到 >=2.12.4：

sdk: ">=2.12.4 <4.0.0"

此外，该SDK使用了FCM，你需要在项目中设置Firebase。请参阅 文档 获取更多信息。

初始化

初始化SDK时需要调用 initialize 方法：

final _promizeSdkPlugin = PromizeSdk.instance;

@override
void initState() {
  super.initState();
  WidgetsBinding.instance.addPostFrameCallback((_) async {
    await _promizeSdkPlugin.initialize(
      apiKey: 'your_api_key',
      siteId: 'your_site_id',
      baseUrl: 'your_base_url',
      pushEnabled: true, // 是否接收通知
      appVersion: 'your_app_version', // 可选参数
    );
  });
}

身份验证

登录或注册用户时需要添加用户信息：

final user = User(
  name: "name",
  email: "mail@gmail.com",
  userId: "44",
  data: {
    "type": "user",
    "premium": true,
  },
);

_promizeSdkPlugin.createUser(user: user);

更新用户信息

你可以通过以下方式更新用户信息：

_promizeSdkPlugin.updateUser(user: user);

更新设备令牌

为了使用Firebase Cloud Messaging，你需要在 onTokenChangedCallback 中调用 updateDeviceToken 方法：

messaging.onTokenRefresh.listen((newToken) {
  _promizeSdkPlugin.updateDeviceToken(
    deviceToken: newToken,
  );
});

保存设备令牌

你也可以通过调用 saveDeviceToken 方法来保存设备令牌：

_promizeSdkPlugin.saveDeviceToken(
  deviceToken: "your_device_token",
);

登出

当用户从应用中登出时，需要调用 logout 方法以清除用户数据：

_promizeSdkPlugin.logout();

添加事件

在注册用户后，可以在应用的任何地方添加事件，只需调用 addEvent 并传递所需的所有参数：

_promizeSdkPlugin.addEvent(
  eventName: "test Event",
  eventType: EventType.event,
  eventData: {"first_collectd": "data"},
);

通知跟踪

如果你想跟踪系统发送的通知活动，需要在通知点击回调中调用 trackNotificationActivity 方法：

在后台接收通知

@pragma('vm:entry-point')
Future<void> _firebaseMessagingBackgroundHandler(RemoteMessage message) async {
  final _promizeSdkPlugin = PromizeSdk.instance;
  await _promizeSdkPlugin.initialize(
    apiKey: '{your-api-key}',
    siteId: '{your-site-id}',
    baseUrl: '{your-base-url}',
    pushEnabled: true,
    appVersion: '0.0.1',
  );
  _promizeSdkPlugin.trackNotificationActivity(
    activityType: NotificationAction.received,
    data: message.data,
  );
}

在前台接收通知

FirebaseMessaging.onMessage.listen((RemoteMessage message) {
  _promizeSdkPlugin.trackNotificationActivity(
    activityType: NotificationAction.received,
    data: message.data,
  );

  if (message.notification != null) {
    print('Message also contained a notification: ${message.notification?.title ?? ''} - ${message.notification?.body ?? ''}');
  }
  Alert.instance.showNotification(
    context,
    message.notification?.title,
    message.notification?.body,
    () {
      _promizeSdkPlugin.trackNotificationActivity(
        activityType: NotificationAction.clicked,
        data: message.data,
      );
    },
  );
});

当通知点击且应用在后台时

FirebaseMessaging.onMessageOpenedApp.listen((RemoteMessage message) {
  _promizeSdkPlugin.trackNotificationActivity(
    activityType: NotificationAction.clicked,
    data: message.data,
  );
});