Flutter用户反馈插件zonkafeedback_sdk的使用

Flutter用户反馈插件zonkafeedback_sdk的使用

Zonka Feedback Flutter SDK

Zonka Feedback Flutter SDK需要以下条件：

• Zonka Feedback账户：一个活跃的Zonka Feedback账户。
• SDK Token：获取你想要实现的调查的SDK令牌。

1. 创建一个Zonka Feedback账户。
2. 创建一个新的调查，包含所需的问题。
3. 导航到“分发”菜单 → “内嵌应用”标签。
4. 启用开关以查看你的SDK令牌。

以下是将SDK集成到应用程序中的步骤：

1. 学习更多关于创建调查的信息，请访问Zonka Feedback帮助文档。

最小要求

• Flutter：版本 3.0.0 或更高。
• Android：
  • CompileSdk 版本：34 或更高。
  • Android Gradle 插件：8.1.0 或更高。
• iOS：iOS 14 或更高。

安装

在您的 pubspec.yaml 文件中添加 Zonka Feedback SDK 作为依赖项：

dependencies:
  zonkafeedback_sdk: <latest_version>

配置

iOS配置

在您的 Info.plist 文件中添加以下片段：

  <key>NSAppTransportSecurity</key>
  <dict>
    <key>NSAllowsArbitraryLoads</key>
    <true/>
  </dict>

初始化

在您的应用程序主文件（例如 lib/main.dart）中初始化 SDK：

import 'package:zonkafeedback_sdk/zonkafeedback_sdk.dart';

class _ZonkaFeedBackSurveyState extends State<ZonkaFeedBackSurvey> with WidgetsBindingObserver {
  [@override](/user/override)
  void initState() {
    super.initState();
    WidgetsBinding.instance.addObserver(this);
    ZFSurvey().init(
      token: '{{SDK_TOKEN}}', // 替换为您的SDK令牌
      zfRegion: '{{REGION}}', // 选项：US, EU, IN
      context: context,
      displayType: 'popup', // 显示类型：popup或slide-up
      displayHeight: 1, // 显示高度，默认值为1
    );
  }

  [@override](/user/override)
  void didChangeAppLifecycleState(AppLifecycleState state) {
    ZFSurvey().sendAppLifecycleState(state);
    super.didChangeAppLifecycleState(state);
  }
}

调查显示配置选项

要配置调查的显示类型，请使用以下选项与 displayType：

• popup：在屏幕中心显示调查弹窗。
• slide-up：显示调查为底部滑出窗口。

要配置调查的显示高度，请传递值给 displayHeight： 值应在 1 到 2 之间。如果没有传递，则默认值为 1。

设置

要配置并启动调查在您的应用程序中：

import 'package:zonkafeedback_sdk/zonkafeedback_sdk.dart';

ZFSurvey().startSurvey();

可选参数

1. 发送设备详情 发送设备详情（操作系统、版本、IP地址、设备类型）与响应一起。默认启用。

ZFSurvey().sendDeviceDetails(true);

1. 发送自定义属性 添加额外数据（例如屏幕名称、订单ID）到响应。

Map<String, String> properties = {
  'property1': 'value1',
  'property2': 'value2',
};

ZFSurvey().sendCustomAttributes(properties);

认证登录访客

通过传递用户的详细信息（姓名、电子邮件、手机号码或唯一ID）来识别用户：

Map<String, dynamic> properties = {
  'contact_name': 'Robin James',
  'contact_email': 'robin@example.com',
  'contact_uniqueId': '1XJ2',
  'contact_mobile': '+14234XXXX',
};

ZFSurvey().userInfo(properties);

清除访客属性

清除退出时的数据：

ZFSurvey().clear();

示例代码

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

void main() {
  WidgetsFlutterBinding.ensureInitialized();
  runApp(const MyApp());
}

class MyApp extends StatefulWidget {
  const MyApp({super.key});

  [@override](/user/override)
  State<MyApp> createState() => _MyAppState();
}

class _MyAppState extends State<MyApp> {
  [@override](/user/override)
  Widget build(BuildContext context) {
    return MaterialApp(
      home: ZonkaFeedBackSurvey(),
    );
  }
}

class ZonkaFeedBackSurvey extends StatefulWidget {
  const ZonkaFeedBackSurvey({super.key});

  [@override](/user/override)
  State<ZonkaFeedBackSurvey> createState() => _ZonkaFeedBackSurveyState();
}

class _ZonkaFeedBackSurveyState extends State<ZonkaFeedBackSurvey>
    with WidgetsBindingObserver {
  [@override](/user/override)
  void initState() {
    ZFSurvey().init(
        token: '6M1Sol',
        zfRegion: 'IN',
        context: context,
        displayType: 'popup',
        displayHeight: 1.5);
    WidgetsBinding.instance.addObserver(this);
    super.initState();
  }

  [@override](/user/override)
  void dispose() {
    WidgetsBinding.instance.removeObserver(this);
    super.dispose();
  }

  [@override](/user/override)
  void didChangeAppLifecycleState(AppLifecycleState state) {
    ZFSurvey().sendAppLifecycleState(state);
    super.didChangeAppLifecycleState(state);
  }

  [@override](/user/override)
  Widget build(BuildContext context) {
    return Scaffold(
      body: Column(
        mainAxisAlignment: MainAxisAlignment.center,
        children: [
          Container(
            alignment: Alignment.center,
            child: ElevatedButton(
              onPressed: () {
                Map&lt;String, dynamic&gt; properties = {
                  'contact_name': 'Robin James',
                  'contact_email': 'manavgarg@example.com',
                  'contact_uniqueId': 'fhebfkebd',
                };

                ZFSurvey()
                    .sendDeviceDetails(true)
                    .sendCustomAttributes(properties)
                    .startSurvey();
              },
              style: ElevatedButton.styleFrom(
                backgroundColor: Colors.blue,
              ),
              child: const Text(
                'START SURVEY',
                style: TextStyle(color: Colors.white),
              ),
            ),
          ),
          SizedBox(
            height: 20,
          ),
          Container(
            alignment: Alignment.center,
            child: ElevatedButton(
              onPressed: () {
                ZFSurvey().clear();
              },
              style: ElevatedButton.styleFrom(
                backgroundColor: Colors.blue,
              ),
              child: const Text(
                'CLEAR VALUES',
                style: TextStyle(color: Colors.white),
              ),
            ),
          ),
        ],
      ),
    );
  }
}