Support

SDK 集成指南

Tracup SDK 集成指南

一、获取 API_KEY 以及项目 pKey

  1. 获取API_KEY

    ​可以通过登录 Tracup 点击右上角头像 信息凭证中获取参数的值:

snapshot_1497836836344.png

  1. 获取 pkey

    通过项目中的设置中的基本信息可以查看 pKey:

snapshot_1497836846012.png

二、在工程中引用 Tracup SDK library:

有两种方式可以集成我们的sdk:

  1. 通过gradle引用集成;

  2. 通过引用Tracup library的Module;

方法一:通过gradle 引用:

  1. 添加以下代码到project下的build.gradle文件中:
maven { url "https://raw.githubusercontent.com/Pgyer/mvn_tracup/master" }

snapshot_1497836860808.png

  1. 然后在module下的build.gradle文件中添加依赖即可:
compile 'com.tracup:library:1.0.5'

snapshot_1497836873650.png

方法二:通过引用Tracup library的Module;

下载Tracup Library 工程:https://github.com/Pgyer/TracupDemo

  1. Android Studio 中导入 library Module:

snapshot_1497836926618.png

  1. 选择SDK 中library Module。导入项目是可以自定义Module name。

snapshot_1497836993014.png

  1. 导入成功以后会显示在左侧的项目列表中:

snapshot_1497837002596.png

  1. 然后在module下的build.gradle文件中添加依赖即可:

注意:compile project(':library')//这里的名称与您导入module的名称一致

snapshot_1497837073014.png

  1. 重新构建,完成导入。

三、在工程中使用 Tracup 摇一摇的功能:

1.在 application 中集成:

​ 1.使用默认设置:

public class MyApplication extends Application {
Tracup tracup;
@Override
public void onCreate() {
    super.onCreate();
    tracup = new Tracup.Builder(this, {你的 API_KEY}, {你的 pKey})
            .build();
 }
}

​ 2.自定义设置

public class MyApplication extends Application {
Tracup tracup;
@Override
public void onCreate() {
    super.onCreate();
    tracup = new Tracup.Builder(this, {你的 API_KEY}, {你的 pKey})
            .setShouldPlaySounds(false) // 摇一摇截图音乐开关设置 (默认是 false)
            .setEmailFiledRequied(true) // 反馈页面邮箱字段知否必须填写设置 (默认是 false)
            .setEmailFiledVisibility(false) // 反馈页面邮箱UI是否显示,如果邮箱设置为必须填写时,此设置无线。(默认是 true)
            .setShakingThreshold(500) // 摇一摇灵敏度设置,数值越小,越灵敏,必须大于 0。(默认是350)
            .setIntroMessageenabled(false) // 提示反馈信息是否自动提示设置。默认应用启动一分钟以后显示提示(默认是 true)
            .build();
 }
}

2.在 AndroidManifest.xml配置

注意修改 android:name=".MyApplication"此处的名字对应上面继承 Application 的类名

<application
    android:name=".MyApplication"
    android:icon="@mipmap/ic_launcher"
    android:label="@string/app_name"
    android:roundIcon="@mipmap/ic_launcher_round"
    android:theme="@style/AppTheme">
</application>

3.提示信息回调方法:

Tracup.showIntrMessage(activity);//参数类型是Activity