Flutter调研与反馈插件survicate_sdk的使用

简介

Survicate Mobile SDK允许您从移动应用用户那里收集反馈。安装在您的应用程序中后，SDK将使您能够触发有针对性的调查，以更好地了解您的用户并收集他们对您产品的意见。

该插件由Survicate - 客户体验&调查软件维护和支持。详细的文档可以在这里查看：Flutter Survicate SDK 文档。

要求

• 使用Survicate Mobile SDK需要一个survicate.com账号。您可以在此免费创建账户：注册，或被同事邀请加入公司账户。
• 请检查iOS和Android库的要求，因为它们同样适用。

安装

要使用此插件，请在pubspec.yaml文件中添加survicate_sdk作为依赖项：

dependencies:
  survicate_sdk: ^latest_version # 替换为最新版本号

配置

Android配置

1. 在AndroidManifest.xml文件中配置您的工作区密钥（workspace key）。

   <application
       android:name=".MyApp"
   >
       <!-- ... -->
       <meta-data android:name="com.survicate.surveys.workspaceKey" android:value="YOUR_WORKSPACE_KEY"/>
   </application>
   

2. 将Survicate Maven仓库添加到位于android目录下的项目build.gradle文件中。

   allprojects {
       repositories {
           // ...
           maven { url 'https://repo.survicate.com' }
       }
   }
   

iOS配置

1. 将工作区密钥添加到Info.plist文件中。
   • 创建Survicate字典。
   • 在Survicate字典中定义WorkspaceKey字符串。
   • Info.plist文件应如下所示：
2. 在ios目录下运行pod update命令。

初始化

在应用程序中使用initializeSdk()方法初始化SDK。只调用一次，在主组件（如lib/main.dart文件）中调用。

import 'package:survicate_sdk/survicate_sdk.dart';

class _MyAppState extends State<MyApp> {
  @override
  void initState() {
    super.initState();
    SurvicateSdk.initializeSdk();
  }
}

使用示例

下面是一个完整的示例代码，展示了如何在Flutter应用中集成和使用survicate_sdk：

import 'package:flutter/material.dart';
import 'package:survicate_sdk/survicate_sdk.dart';
import 'package:survicate_sdk/user_trait.dart';

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

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

  @override
  State<MyApp> createState() => _MyAppState();
}

class _MyAppState extends State<MyApp> {
  final listener = SurvicateEventListener(
    onSurveyDisplayed: (SurveyDisplayedEvent event) {
      print('Survey displayed');
    },
    onQuestionAnswered: (QuestionAnsweredEvent event) {
      print('Question answered');
    },
    onSurveyClosed: (SurveyClosedEvent event) {
      print('Survey closed');
    },
    onSurveyCompleted: (SurveyCompletedEvent event) {
      print('Survey completed');
    },
  );

  @override
  void initState() {
    super.initState();
    // 设置工作区密钥（可选）
    SurvicateSdk.setWorkspaceKey("WORKSPACE_KEY");
    // 初始化SDK
    SurvicateSdk.initializeSdk();
    // 添加事件监听器
    SurvicateSdk.addSurvicateEventListener(listener);
  }

  @override
  void dispose() {
    // 移除事件监听器
    SurvicateSdk.removeSurvicateEventListener(listener);
    super.dispose();
  }

  @override
  Widget build(BuildContext context) {
    return MaterialApp(
      home: Scaffold(
        appBar: AppBar(
          title: const Text('Plugin example app'),
        ),
        body: Column(
          mainAxisAlignment: MainAxisAlignment.start,
          crossAxisAlignment: CrossAxisAlignment.stretch,
          children: [
            TextButton(
              child: const Text('Enter Screen: Home'),
              onPressed: () {
                SurvicateSdk.enterScreen('Home');
              },
            ),
            TextButton(
              child: const Text('Leave Screen: Home'),
              onPressed: () {
                SurvicateSdk.leaveScreen('Home');
              },
            ),
            TextButton(
              child: const Text('Invoke Event: Event'),
              onPressed: () {
                SurvicateSdk.invokeEvent('Event');
              },
            ),
            TextButton(
              child: const Text('Invoke Event with Properties: Event'),
              onPressed: () {
                Map<String, String> properties = {
                  'property1': 'value1',
                  'property2': 'value2',
                };
                SurvicateSdk.invokeEvent('Event', eventProperties: properties);
              },
            ),
            TextButton(
              child: const Text('Set User Trait'),
              onPressed: () {
                UserTrait trait = UserTrait.string('Name', 'Jane Doe');
                SurvicateSdk.setUserTrait(trait);
              },
            ),
            TextButton(
              child: const Text('Set User Traits'),
              onPressed: () {
                List<UserTrait> traits = [
                  UserTrait.string("name", "Jane Doe"),
                  UserTrait.num("age", 25),
                  UserTrait.bool("isPremium", true),
                  UserTrait.dateTime("lastLogin", DateTime.now()),
                ];
                SurvicateSdk.setUserTraits(traits);
              },
            ),
            TextButton(
              child: const Text('Reset'),
              onPressed: () {
                SurvicateSdk.reset();
              },
            ),
          ],
        ),
      ),
    );
  }
}

问题反馈

如果您遇到任何问题或有改进建议，请通过以下方式联系我们：

• 通过Intercom在应用程序内联系我们。
• 发送邮件至:hello@survicate.com

感谢您的支持和理解！

希望这个指南能帮助您顺利集成和使用survicate_sdk插件。如果有更多问题，欢迎随时提问！