提交 525969ff 作者: 刘添

更新 AndroidSDK对接说明文档.md

上级 a20755d2
## GameSDKV1.0文档接入使用 ## GameSDKV1.0文档接入使用
...@@ -4,30 +4,86 @@ ...@@ -4,30 +4,86 @@
    1 [对接说明](#sec1)     1 [对接说明](#sec1)
    2 [获取对接demo](#sec2)     2 [获取对接demo](#sec2)
               [说明](#sec2.1)
    3 [导入配置SDK资源AndroidStudio](#sec3)     3 [导入配置SDK资源AndroidStudio](#sec3)
               [导入文件](#sec3.1)
               [gradle脚本依赖](#sec3.2)
    4 [配置清单文件](#sec4)     4 [配置清单文件](#sec4)
               [清单配置说明](#sec4.1)
    5 [初始化 SDK](#sec5)     5 [初始化 SDK](#sec5)
               [SDK调用说明](#sec5.1)
               [调用示例](#sec5.2)
    6 [登录](#sec6)     6 [登录](#sec6)
               [接口说明](#sec6.1)
               [参数说明](#sec6.2)
               [调用示例](#sec6.3)
    7 [调起支付页面](#sec7)     7 [调起支付页面](#sec7)
               [调用说明](#sec7.1)
               [接口参数](#sec7.2)
               [调用示例](#sec7.3)
               [下单支付字段说明](#sec7.4)
    8 [支付回调结果](#sec8)     8 [支付回调结果](#sec8)
               [支付文档说明](#sec8.1)
    9 [角色上报](#sec9)     9 [角色上报](#sec9)
               [调用示例](#sec9.1)
               [参数字段说明](#sec9.2)
    10 [退出登录](#sec10)     10 [退出登录](#sec10)
               [接口回调说明](#sec10.1)
               [退出成功](#sec10.3)
               [退出失败](#sec10.4)
               [调用示例](#sec10.5)
    11 [退出应用](#sec11)     11 [退出应用](#sec11)
               [调用方法](#sec11.1)
               [调用示例](#sec11.1)
    12 [gradle依赖](#sec12)     12 [gradle依赖](#sec12)
    13 [apk打包](#sec13)
               [混淆说明](#sec13.1)
               [打包说明](#sec13.2)
#### 1、对接说明 <a name="sec1"></a> #### 1、对接说明 <a name="sec1"></a>
&nbsp;&nbsp; 1.1、此对接文档只适合与sdkv1.0版本。 &nbsp;&nbsp; 1.1、此对接文档只适合与sdkv1.0版本。
...@@ -40,26 +96,23 @@ ...@@ -40,26 +96,23 @@
### 2、对接demo<a name="sec2"></a> ### 2、对接demo<a name="sec2"></a>
从平台处获取对接demo,android studio版本,选择合适的版本接入。 从平台处获取对接demo,android studio版本,选择合适的版本接入。<a name="sec2.1"></a>
### 3、导入配置SDK资源Androidstudio项目<a name="sec3"></a> ### 3、导入配置SDK资源Androidstudio项目<a name="sec3"></a>
- 将GameSDK-xxx.aar文件复制到libs文件下
- 将GameSDK-xxx.aar文件复制到libs文件下<a name="sec3.1"></a>
![image.png](https://zhangsheng-1300623068.cos.ap-guangzhou.myqcloud.com/default%2F1.png) ![image.png](https://zhangsheng-1300623068.cos.ap-guangzhou.myqcloud.com/default%2F1.png)
- 在主工程build.gradle配置,如下图所示: - 在主工程build.gradle配置,如下图所示:<a name="sec3.2"></a>
![image.png](https://zhangsheng-1300623068.cos.ap-guangzhou.myqcloud.com/default%2F2.png) ![image.png](https://zhangsheng-1300623068.cos.ap-guangzhou.myqcloud.com/default%2F2.png)
### 4、配置清单文件(具体请参考demo)<a name="sec4"></a> ### 4、配置清单文件(具体请参考demo)<a name="sec4"></a>
1、参考demo中的清单文件配置,主要分为权限配置、sdk所需的组件配置,meta信息配置。(权限部分SDK已经适配,访问文件权限,Android10网络访问权限,安装适配等均已适配,但不包含所有设备) 1、参考demo中的清单文件配置,主要分为权限配置、sdk所需的组件配置,meta信息配置。(权限部分SDK已经适配,访问文件权限,Android10网络访问权限,安装适配等均已适配,但不包含所有设备)<a name="sec4.1"></a>
2.sdk 的代码已经经过混淆,请勿混淆sdk的代码
3、打包apk签名机制需要勾选V1、V2签名
4、sdk代码已经经过混淆,请不要再次混淆sdk代码,demo会贴出SDK混淆代码,可复制到自己混淆中(具体请参考demo)
> **参数说明**: > **参数说明**:
...@@ -81,11 +134,11 @@ ...@@ -81,11 +134,11 @@
### 5、初始化SDK<a name="sec5"></a> ### 5、初始化SDK<a name="sec5"></a>
1、sdk初始化操作方法,最先调用,需要在主线程调用,最好游戏主界面activity中调用。此方法的可多次调用用于获得sdk全局管理器。 1、sdk初始化操作方法,最先调用,需要在主线程调用,最好游戏主界面activity中调用。此方法的可多次调用用于获得sdk全局管理器。<a name="sec5.1"></a>
2、调用示例:在游戏主界面activity的onCreate方法中调用 2、调用示例:在游戏主界面activity的onCreate方法中调用
> **调用示例**: > **调用示例**:<a name="sec5.2"></a>
``` ```
...@@ -97,12 +150,13 @@ ...@@ -97,12 +150,13 @@
} }
``` ```
### 6、登录<a name="sec6"></a> ### 6、登录<a name="sec6"></a>
1、添加登录回调监听 1、添加登录回调监听<a name="sec6.1"></a>
``` ```
public void addLoginListener(OnLoginListener onLoginListener) public void addLoginListener(OnLoginListener onLoginListener)
``` ```
- 说明:在登陆前必须注册登陆回调监听,用于接收登陆结果,登录成功返回token - 说明:在登陆前必须注册登陆回调监听,用于接收登陆结果,登录成功返回token
#### 参数说明<a name="sec6.2"></a>
| 参数 | 说明| | 参数 | 说明|
| :-------- | -------------: | | :-------- | -------------: |
...@@ -155,7 +209,7 @@ void loginError(Object data); ...@@ -155,7 +209,7 @@ void loginError(Object data);
#### 调用示例 #### 调用示例<a name="sec6.3"></a>
``` ```
GameSdk.getInstance().addLoginListener(this, new OnLoginListener() { GameSdk.getInstance().addLoginListener(this, new OnLoginListener() {
...@@ -176,7 +230,7 @@ void loginError(Object data); ...@@ -176,7 +230,7 @@ void loginError(Object data);
### 7、调起支付页面<a name="sec7"></a> ### 7、调起支付页面<a name="sec7"></a>
1、调起支付页面方法 1、调起支付页面方法<a name="sec7.1"></a>
``` ```
...@@ -184,7 +238,7 @@ public void showPay(CustomPayParam payParam, OnPaymentListener paymentListener) ...@@ -184,7 +238,7 @@ public void showPay(CustomPayParam payParam, OnPaymentListener paymentListener)
``` ```
### 接口参数 ### 接口参数<a name="sec7.2"></a>
| 参数 | 说明 | | 参数 | 说明 |
|:----|-----:| |:----|-----:|
...@@ -192,7 +246,7 @@ public void showPay(CustomPayParam payParam, OnPaymentListener paymentListener) ...@@ -192,7 +246,7 @@ public void showPay(CustomPayParam payParam, OnPaymentListener paymentListener)
|paymentListener|回调接口| |paymentListener|回调接口|
#### 调用示例 #### 调用示例<a name="sec7.3"></a>
``` ```
...@@ -234,7 +288,7 @@ public void showPay(CustomPayParam payParam, OnPaymentListener paymentListener) ...@@ -234,7 +288,7 @@ public void showPay(CustomPayParam payParam, OnPaymentListener paymentListener)
``` ```
#### 下单支付字段说明 #### 下单支付字段说明<a name="sec7.4"></a>
| 名称 | 类型 | 是否必须 | 说明 | | 名称 | 类型 | 是否必须 | 说明 |
...@@ -259,11 +313,11 @@ public void showPay(CustomPayParam payParam, OnPaymentListener paymentListener) ...@@ -259,11 +313,11 @@ public void showPay(CustomPayParam payParam, OnPaymentListener paymentListener)
### 8、支付回调通知<a name="sec8"></a> ### 8、支付回调通知<a name="sec8"></a>
1.1、支付回调通知请参考对接文档H5 SDK 对接文档-v1.0、服务端接入2.3 1.1、支付回调通知请参考对接文档H5 SDK 对接文档-v1.0、服务端接入2.3<a name="sec8.1"></a>
### 9、角色上报<a name="sec9"></a> ### 9、角色上报<a name="sec9"></a>
#### 1.1、调用示例 #### 调用示例<a name="sec9.1"></a>
``` ```
GameInfoSetting setting=new GameInfoSetting(); GameInfoSetting setting=new GameInfoSetting();
...@@ -294,7 +348,7 @@ public void showPay(CustomPayParam payParam, OnPaymentListener paymentListener) ...@@ -294,7 +348,7 @@ public void showPay(CustomPayParam payParam, OnPaymentListener paymentListener)
``` ```
#### 1.2、 角色上报字段说明 #### 参数字段说明<a name="sec9.2"></a>
| 名称 | 类型 | 是否必须| 默认值 | | 名称 | 类型 | 是否必须| 默认值 |
|:--------| -------------:| -------------------:|-------------:| |:--------| -------------:| -------------------:|-------------:|
...@@ -313,7 +367,7 @@ public void showPay(CustomPayParam payParam, OnPaymentListener paymentListener) ...@@ -313,7 +367,7 @@ public void showPay(CustomPayParam payParam, OnPaymentListener paymentListener)
### 10、退出登录<a name="sec9"></a> ### 10、退出登录<a name="sec9"></a>
#### 1.1、添加登出回调监听 #### 添加登出回调监听<a name="sec10.1"></a>
``` ```
public void addLogoutListener(OnLogoutListener onLogoutListener) public void addLogoutListener(OnLogoutListener onLogoutListener)
...@@ -328,13 +382,9 @@ public void addLogoutListener(OnLogoutListener onLogoutListener) ...@@ -328,13 +382,9 @@ public void addLogoutListener(OnLogoutListener onLogoutListener)
4、退出登录成功并返回所有信息与code状态 4、退出登录成功并返回所有信息与code状态
#### 参数说明
| 参数 | 说明 |
| :-------- | ----: |
| OnLogoutListener | 退出登陆回调接口 |
#### 退出登录成功 #### 退出登录成功<a name="sec10.3"></a>
``` ```
public void logoutSuccess(String s); public void logoutSuccess(String s);
...@@ -342,13 +392,13 @@ public void logoutSuccess(String s); ...@@ -342,13 +392,13 @@ public void logoutSuccess(String s);
``` ```
#### 退出登录失败 #### 退出登录失败<a name="sec10.4"></a>
``` ```
public void logoutError(String msg); public void logoutError(String msg);
``` ```
#### 调用示例 #### 调用示例<a name="sec10.5"></a>
``` ```
GameSdk.getInstance().addLogoutListener(new OnLogoutListener() { GameSdk.getInstance().addLogoutListener(new OnLogoutListener() {
...@@ -370,20 +420,15 @@ public void logoutError(String msg); ...@@ -370,20 +420,15 @@ public void logoutError(String msg);
1、添加退出回调监听 1、添加退出回调监听
#### 调用示例 #### 调用方法<a name="sec11.1"></a>
``` ```
public void exitApp(ExitAppListener listener) public void exitApp(ExitAppListener listener)
``` ```
1、退出应用程序弹出提示框。 1、退出应用程序弹出提示框。
2、 参数类说明:ExitAppListener需要实现exitApp()方法:
| 参数 | 说明 | #### 调用示例<a name="sec11.2"></a>
| :-------- | ----: |
| ExitAppListener | 退出应用回调接口 |
#### 调用示例
``` ```
@Override @Override
...@@ -395,7 +440,7 @@ public void exitApp(ExitAppListener listener) ...@@ -395,7 +440,7 @@ public void exitApp(ExitAppListener listener)
``` ```
- 说明:onBackPressed方法调用 - 说明:onBackPressed方法调用
### 12 demo依赖说明<a name="sec12"></a> ### 12 gradle依赖说明<a name="sec12"></a>
1、打包arr依Glide库需要在主工程中添加依赖 1、打包arr依Glide库需要在主工程中添加依赖
...@@ -403,4 +448,13 @@ public void exitApp(ExitAppListener listener) ...@@ -403,4 +448,13 @@ public void exitApp(ExitAppListener listener)
api 'com.github.bumptech.glide:glide:4.11.0' api 'com.github.bumptech.glide:glide:4.11.0'
``` ```
\ No newline at end of file
### 13 apk打包<a name="sec13"></a>
1.sdk 的代码已经经过混淆,请勿混淆sdk的代码<a name="sec13.1"></a>
2、打包apk签名机制需要勾选V1、V2签名<a name="sec13.2"></a>
3、sdk代码已经经过混淆,请不要再次混淆sdk代码,demo会贴出SDK混淆代码,可复制到自己混淆中(具体请参考demo)
\ No newline at end of file
Markdown 格式
0%
您添加了 0 到此讨论。请谨慎行事。
请先完成此评论的编辑!
注册 或者 后发表评论