Flutter应用评价插件appsonair_flutter_appremark的使用

Flutter应用评价插件appsonair_flutter_appremark的使用

⚠️ 重要提示 ⚠️

该插件目前处于预生产阶段。虽然插件本身完全可用，但其集成的支持服务尚未在生产环境中上线。敬请期待更新，我们会尽快将服务带入生产环境！

如何工作？

该SDK用于提交应用程序备注（无论是bug/问题还是任何建议/反馈）。

AppsOnAir提供了一种服务，通过摇晃设备来截取应用程序的屏幕截图，从而监控您的问题或应用程序建议/改进。

当您摇晃设备时，它会自动截取应用程序的屏幕截图。用户可以修改这些应用程序截图，以突出特定的问题或任何应用程序增强的建议。

用户可以选择关闭摇晃手势。他们也可以手动打开“添加备注”屏幕。

最低要求

• Android Gradle 插件 (AGP): 版本 8.0.2 或更高
• Kotlin: 版本 1.7.10 或更高
• Gradle: 版本 8.0 或更高

Android设置

在应用程序的AndroidManifest.xml文件中的<application>标签下添加元数据。

<application>
    ...
    <meta-data
        android:name="appId"
        android:value="********-****-****-****-************" />
</application>

在setting.gradle中添加以下代码：

pluginManagement {
    ...
    repositories {
        google()
        mavenCentral()
        gradlePluginPortal()
        maven { url 'https://jitpack.io' }
    }
}

在根级别的build.gradle中添加以下代码：

allprojects {
    repositories {
        google()
        mavenCentral()
        maven { url 'https://jitpack.io' }
    }
}

在启动器活动中添加以下代码，因为Flutter正在阻止SDK捕获当前屏幕。

class MainActivity : FlutterActivity(){
    override fun getRenderMode(): RenderMode {
        return RenderMode.texture
    }
}

要求

最低部署目标: 12.0

iOS设置

在应用程序的Info.plist文件中添加APIKey。

<key>AppsOnAirAPIKey</key>
<string>XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX</string>

如何获取APIKey，请参阅此链接

此pod需要照片权限。请在您的Info.plist文件中添加以下使用描述：

<key>NSPhotoLibraryUsageDescription</key>
<string>$(PRODUCT_NAME) 需要权限从图库中选择图片以进行应用程序备注功能。</string>

示例

按照以下步骤使用默认主题通过摇晃手势添加备注。

[@override](/user/override)
void initState() {
  super.initState();
  Future.delayed(const Duration(milliseconds: 100), () async {
    await AppRemarkService.initialize(context);
  });
}

按照以下步骤使用自定义主题通过摇晃手势添加备注。

在这里，用户可以根据他们的应用程序主题自定义“添加备注”屏幕的主题，通过传递包含用户主题数据键值对的Map。

用户必须将给定的键传递到“options”。使用“options”，SDK将设置“添加备注”屏幕的主题。

确保键与以下相同。

AppRemarkService.initialize(
    context, 
    options: {
        'pageBackgroundColor': '#FFC0CB',
        'descriptionMaxLength': 25,
    });

默认情况下，“shakeGestureEnable”设置为true，允许设备在摇晃时捕获当前屏幕。如果为false，则设备摇晃的自动捕获屏幕将被禁用。

AppRemarkService.initialize(
    context,
    shakeGestureEnable: false,
);

按照以下步骤手动打开“添加备注”屏幕。

AppRemarkService.addRemark(context);

按照以下步骤发送您自定义的有效负载，以便保存以监控您的应用程序。

用户必须将用户附加的元数据键值对传递为Map。

AppRemarkService.addRemark(
    context,
    extraPayload: {
        'title' : 'Initial Demo',
        'isFromIndia' : true
    });

完整示例代码

import 'package:appsonair_flutter_appremark/app_remark_service.dart';
import 'package:flutter/material.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(
      debugShowCheckedModeBanner: false,
      home: Scaffold(
        appBar: AppBar(
          title: const Text('Plugin example app'),
        ),
        body: const DemoApp(),
      ),
    );
  }
}

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

  [@override](/user/override)
  State<DemoApp> createState() => _DemoAppState();
}

class _DemoAppState extends State<DemoApp> {
  [@override](/user/override)
  void initState() {
    super.initState();
    Future.delayed(const Duration(milliseconds: 100), () async {
      await AppRemarkService.initialize(context, options: {
        "pageBackgroundColor": "#70d20f",
        "appBarBackgroundColor": "#70d20f",
        "descriptionLabelText": "Add description here.",
        "appBarTitleColor": "#FFFFFF",
        "remarkTypeLabelText": "Add Remark.",
        "descriptionHintText": "Add description.",
        "descriptionMaxLength": 120,
        "buttonText": "Submit Remark",
        "buttonTextColor": "#000000",
        "labelColor": "#FFFFFF",
        "buttonBackgroundColor": "#FFFFFF",
        "inputTextColor": "#000000",
        "hintColor": "#000000",
        "appBarTitleText": "Feedback"
      });
    });
  }

  [@override](/user/override)
  Widget build(BuildContext context) {
    return Scaffold(
      backgroundColor: Colors.amber.shade100,
      body: Center(
        child: ElevatedButton(
          onPressed: () async {
            // 打开"添加备注"屏幕
            await AppRemarkService.addRemark(context);
          },
          child: const Text('Add Remark'),
        ),
      ),
    );
  }
}