Flutter集成CarrotQuest服务插件flutter_carrotquest_plugin的使用

Flutter集成CarrotQuest服务插件flutter_carrotquest_plugin的使用

简介

flutter_carrotquest 是一个用于在 Flutter 应用中集成 Carrot Quest 服务的插件，支持 Android 和 iOS 平台。

实现步骤

Android

在 build.gradle 文件中进行以下配置：

android {
    
    defaultConfig {
        ...
        minSdkVersion 21
        ...
    }
    ...
    packagingOptions {
        exclude 'META-INF/*.kotlin_module'
    }
    ...
}

iOS

iOS 平台上无需额外配置。

使用步骤

1. 导入插件

在 Dart 文件中导入插件：

import 'package:flutter_carrotquest/flutter_carrotquest_plugin.dart';

2. 初始化 CarrotQuest

通过 Carrot.setup 方法初始化插件，并传入 apiKey 和 appId：

await Carrot.setup(apiKey: 'your apiKey', appId: 'your appId')
        .catchError((onError) => print(onError));

3. 设置调试模式（仅限 Android）

如果需要启用调试模式，可以调用以下方法：

await Carrot.setDebug()
        .catchError((onError) => print(onError));

4. 用户认证（仅限 Android）

通过 Carrot.auth 方法对用户进行身份验证：

await Carrot.auth(userId: 'your userId', userAuthKey: 'your userAuthKey')
        .catchError((onError) => print(onError));

5. 停止 CarrotQuest 服务（仅限 Android）

如果需要停止 CarrotQuest 服务，可以调用以下方法：

await Carrot.deinit()
        .catchError((onError) => print(onError));

6. 打开聊天窗口

通过 Carrot.openChat 方法打开聊天窗口：

await Carrot.openChat()
        .catchError((onError) => print(onError));

7. 设置 FCM Token（仅限 iOS）

在 iOS 上设置 Firebase Cloud Messaging (FCM) Token：

await Carrot.setToken('your fcmToken')
        .catchError((onError) => print(onError));

8. 设置用户属性

通过 Carrot.setUserProperty 方法设置用户的自定义属性：

await Carrot.setUserProperty({'age':'28'})
        .catchError((onError) => print(onError));

9. 跟踪事件

通过 Carrot.trackEvent 方法跟踪特定事件：

await Carrot.trackEvent('your eventName', eventParams: '{"your eventKey":"your eventValue"}')
        .catchError((onError) => print(onError));

完整示例代码

以下是一个完整的示例代码，展示如何在 Flutter 应用中集成 flutter_carrotquest_plugin：

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

import 'package:flutter_carrotquest/flutter_carrotquest.dart';

void main() {
  runApp(MyApp());
}

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

class _MyAppState extends State<MyApp> {
  [@override](/user/override)
  void initState() {
    super.initState();
    initPlatformState();
  }

  Future<void> initPlatformState() async {
    // 初始化 CarrotQuest
    await Carrot.setup(apiKey: 'your apiKey', appId: 'your appId')
        .catchError((onError) => print(onError));

    // 设置调试模式（仅限 Android）
    // await Carrot.setDebug().catchError((onError) => print(onError));

    // 用户认证（仅限 Android）
    // await Carrot.auth(userId: 'your userId', userAuthKey: 'your userAuthKey')
    //     .catchError((onError) => print(onError));

    // 打开聊天窗口
    await Carrot.openChat().catchError((onError) => print(onError));

    // 设置用户属性
    await Carrot.setUserProperty({'age': '28'})
        .catchError((onError) => print(onError));

    // 跟踪事件
    await Carrot.trackEvent('eventDemo', eventParams: '{"eventKey":"eventValue"}')
        .catchError((onError) => print(onError));
  }

  [@override](/user/override)
  Widget build(BuildContext context) {
    return MaterialApp(
      home: Scaffold(
        appBar: AppBar(
          title: const Text('CarrotQuest 插件示例'),
        ),
        body: Center(
          child: Text('CarrotQuest 初始化完成！'),
        ),
      ),
    );
  }
}