Flutter用户反馈插件trackco_feedback_sdk的使用

本README描述了该插件的使用方法。如果您将此插件发布到pub.dev，则此README的内容将成为您的插件主页上的内容。

有关如何编写良好的插件README的指南，请参阅编写插件页面。

关于开发插件的一般信息，请参阅Dart指南中的创建包和Flutter指南中的开发包和插件。

App示例

App示例位于文件夹（trackco-feedback-example）中

App de exemplo está dentro da pasta (trackco-feedback-example)

安装

在pubspec.yaml文件中添加以下依赖项：

dependencies:
  trackco_feedback_sdk: ^版本号

然后运行以下命令以获取依赖项：

flutter pub get

方法

在使用SDK之前，请确保您已经拥有Track.co账户的organizationId和apiToken。

初始化 (init)

init方法用于初始化SDK所需的实例。必须在使用其他方法之前调用此方法。建议在应用程序启动时执行。

var sdk = TrackcoFeedbackSdk();

sdk.init(
  organizationId: '您的organizationId', // 替换为您的Track.co组织ID
  apiToken: '您的apiToken', // 替换为您的Track.co API令牌
);

生成链接 (generateLink)

generateLink方法用于生成调查链接，可以在应用内的webview中使用。

sdk.generateLink(CreateLinkListPayload(
  surveyId: '调查ID', // 替换为您要使用的调查ID
  distributionName: '分发名称', // 替换为您要使用的分发名称
  shortenedLink: true, // 是否生成短链接
  async: false, // 是否异步生成链接
  callbackUrl: '', // 回调URL（可选）
  importLines: [
    ImportLine(
      name: 'Track Co',
      cpf: '99999999999',
      email: 'email@track.co',
    ),
  ].map((e) => e.toJson()).toList(),
));

显示对话框 (display)

display方法用于渲染一个带有webview的对话框，指向之前生成的链接。

sdk.display(context); // context 是当前的BuildContext

获取链接 (getLink)

getLink方法返回之前生成的链接，允许您以任何方式在应用内使用它。

var link = sdk.getLink();
print('生成的链接是: $link');

完整示例代码

以下是一个完整的示例代码，展示了如何使用trackco_feedback_sdk插件。

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

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

class MyApp extends StatelessWidget {
  [@override](/user/override)
  Widget build(BuildContext context) {
    return MaterialApp(
      home: FeedbackExamplePage(),
    );
  }
}

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

class _FeedbackExamplePageState extends State<FeedbackExamplePage> {
  TrackcoFeedbackSdk sdk = TrackcoFeedbackSdk();

  [@override](/user/override)
  void initState() {
    super.initState();
    // 初始化SDK
    sdk.init(
      organizationId: '您的organizationId',
      apiToken: '您的apiToken',
    );
  }

  Future<void> _showSurveyDialog() async {
    try {
      // 生成调查链接
      await sdk.generateLink(CreateLinkListPayload(
        surveyId: '调查ID',
        distributionName: '分发名称',
        shortenedLink: true,
        async: false,
        callbackUrl: '',
        importLines: [
          ImportLine(
            name: 'Track Co',
            cpf: '99999999999',
            email: 'email@track.co',
          ),
        ].map((e) => e.toJson()).toList(),
      ));

      // 显示包含webview的对话框
      sdk.display(context);
    } catch (e) {
      print('发生错误: $e');
    }
  }

  [@override](/user/override)
  Widget build(BuildContext context) {
    return Scaffold(
      appBar: AppBar(
        title: Text('Track.co反馈插件示例'),
      ),
      body: Center(
        child: ElevatedButton(
          onPressed: _showSurveyDialog,
          child: Text('显示调查'),
        ),
      ),
    );
  }
}