<#import "/ftl/spring.ftl" as spring/> <@mdp.mdp_index_common/> <@mdp.mdp_index_top/>
应用反馈

移动警务开放平台为开发者提供意见反馈SDK,已封装好操作界面,开发者只需简单的配置即可让应用拥有意见反馈、反馈回复、BUG追踪的功能, 同时SDK也可以自动抓取并上报应用异常、崩溃时的日志,让开发者快速定位问题。 可以解决目前大多数开放平台缺少统一、方便的BUG、意见反馈入口现状。

功能概述

1、图文意见反馈:用户可以通过SDK提交文字+图片的意见反馈,文字支持最多2000字,图片最多支持9张;

2、反馈历史:在SDK中可以查看历史反馈信息;

3、回复:用户可以在已反馈的信息中与开发者进行交流;

4、自动采集、上报:当集成意见反馈SDK的应用发生异常、崩溃情况时,

SDK会自动采集当时的运行环境、硬件数据、异常日志,并将数据发送至开发者的个人中心,便于开发者定位问题、快速修复。

集成方式

应用反馈集成方式分为两种:界面SDK集成和接口Library集成。

界面SDK集成(推荐)

1、 SDK 引入

在需要使用SDK的Model的build.gradle里申明如下:

repositories {
    flatDir {
        dirs 'libs'
    }
}

然后在dependencies中引入相应的SDK包。

dependencies {
    compile fileTree(dir: 'libs', include: ['*.jar'])
    compile(name:'FeedBackSdk_V1.0.4', ext:'aar')
    compile 'com.squareup.retrofit2:retrofit:2.2.0'
    compile 'com.squareup.retrofit2:converter-gson:2.2.0'
    compile 'com.squareup.okhttp3:logging-interceptor:3.6.0'
    compile 'com.github.bumptech.glide:glide:3.7.0'
}

2、 SDK 初始化

在项目Application的onCreate方法中初始化SDK并配置相关信息

FBConfig.Builder builder = new FBConfig.Builder(getApplicationContext())
        .setUseAutoUploadExcetpion(true)//是否自动上传异常
        .setFeedbackServerBaseUrl("url")//反馈地址
        .setFileDownloadUrl("url")//文件下载地址
        .setFileUploadUrl("url");//文件上传地址
	.setFileServerUserId("fileUserId")//文件上传文件用户id
	.setFileServerUsersecret("Usersecret")//用户秘钥

FeedBackManager.getInstance().setConfig(builder.build());
FeedBackManager.getInstance().init(getApplicationContext());

注:所有地址必须以"/"结尾。fileServerUserId和fileServerUsersecret请向管理员索取。


3、 启动SDK反馈界面

在需要使用反馈SDK的界面使用显式意图启动界面

Intent intent = new Intent(this, PublishFeedBackActivity.class);
startActivity(intent);

注: SDK默认读取当前程序的包名来获取反馈列表与进行反馈,如有特殊要求可以使用以下代码指定新的包名:

intent.putExtra(PublishFeedBackActivity.PACKAGE_NAME,"packageName");


4、 设置用户信息(必须)

在第三方app完成登陆时,需要设置用户信息

FeedBackManager.getInstance().setUserInfo("yourUserId","yourUserName");

注:

1、FeedBackSdk-Vx.x.x.aar包中已经在AndroidManifest中对所需的权限进行声明,如:

<uses-permission android:name="android.permission.INTERNET" />
<uses-permission android:name="android.permission.READ_PHONE_STATE" />
<uses-permission android:name="android.permission.READ_EXTERNAL_STORAGE" />
<uses-permission android:name="android.permission.WRITE_EXTERNAL_STORAGE" />
<uses-permission android:name="android.permission.ACCESS_NETWORK_STATE" />

2、Activity已经在aar的AndroidManifest进行了注册,开发者不要多次进行注册。

3、关于程序主题设置。

推荐让程序继承 "Theme.AppCompat.Light.NoActionBar",如:

<!-- Base application theme. -->
<style name="AppTheme" parent="Theme.AppCompat.Light.NoActionBar">
    <!-- Customize your theme here. -->
    <item name="colorPrimary">@color/colorPrimary
    <item name="colorPrimaryDark">@color/colorPrimaryDark
    <item name="colorAccent">@color/colorAccent
    <item name="android:textColorPrimary">@color/white
    <item name="android:windowBackground">@color/white
</style>

具体可以根据自己的项目需要进行详细的配置。

接口Library集成

运行管理SDK功能如下:

模块 功能 对应角色
运行管理SDK 获取推荐反馈建议、手动提交BUG、意见反馈 普通警员
意见反馈回复 NA
意见反馈列表 NA
意见反馈回复列表 NA

运行管理SDK使用时,首先需要在自定义的Application文件中设置初始化相关的参数, 如意见反馈地址、文件服务器地址、上下文运行环境Context以及用户信息。

示例代码入下:

1、 Library集成

将feedback_lib.jar放到相应model的libs目录下

2、 初始化信息配置(必需)

public class MyApplication extends Application {
    @Override
    public void onCreate() {
        super.onCreate();
        initSdk();
    }
    private void initSdk() {
        FBConfig.Builder builder = new FBConfig.Builder(getApplicationContext())
	        .setUseAutoUploadExcetpion(true)
	        .setFeedbackServerBaseUrl("http://192.168.22.193:8030/mdp/feedback/sdkContorl/")
	        .setFileDownloadUrl("http://dfs.test.safecenter.com/download/")
		.setFileServerUserId("fileUserId")//文件上传文件用户id
	        .setFileServerUsersecret("Usersecret")//用户秘钥
	        .setFileUploadUrl("http://dfs.test.safecenter.com/upload/");
	FeedBackManager.getInstance().setConfig(builder.build());
	FeedBackManager.getInstance().init(getApplicationContext());
    }
}

2、设置用户信息(必需)

在第三方app完成登陆时,需要设置用户信息

FeedBackManager.getInstance().setUserInfo("yourUserId","yourUserName");

配置完相关信息,然后就可以调用SDK提供的接口。

接口说明

配置完相关信息,然后就可以调用SDK提供的接口。

1、获取意见类比反馈意见接口

  • type:类别,传入"FEEDBACK"即可
  • callback:获取反馈类型信息的回调
FeedBackManager.getInstance().getFeedBackType("FEEDBACK",callback);

2、手动提交BUG、意见反馈接口

  • userId:反馈人ID
  • username:反馈人姓名
  • content:反馈信息描述
  • type:0错误报告,1想法意见
  • phoneNumber:反馈人手机号码
  • photos:图片列表
  • packageName:包名
  • options:类比反馈意见
  • callback:提交反馈信息的回调
FeedBackManager.getInstance()
	.commitFeedBack(userId,userName,content,type,phoneNumber,photos,pkgString,options,callBack);

3、意见反馈回复接口

  • replySourceType:回复来源(SDK、应用中心、开放平台)
  • feedBackId:被回复意见反馈ID
  • content:回复内容
  • content:回复内容
  • replyUserID:回复人ID
  • replyUserName:回复人姓名
  • callback:回复接口回调
FeedBackManager.getInstance()
	.reply(replySourceType, feedBackId, content, replyUserId, replyUserName, callback);

4、意见反馈列表接口

  • userId:当前登录用户ID
  • startTime:下拉刷新时间戳
  • endTime:加载更多时间戳
  • packageName:包名
  • callback:回调接口
FeedBackManager.getInstance()
	.getAllFeedBacks(userId, startTime, endTime, packageName,callback);

5、意见反馈回复列表

  • feedbackId:意见反馈ID
  • startTime:下拉刷新时间戳
  • endTime:加载更多时间戳
  • callback:回调接口
FeedBackManager.getInstance()
	.listReply(feedBackId,startTime,endTime,callback);
<@mdp.mdp_index_bottom/>