提交 397df885 作者: 刘添

更新 AndroidSDK对接说明文档.md

上级 e8ea336b
## GameSDKV1.0文档接入使用
## GameSDKV1.0文档接入使用 ## GameSDKV1.0文档接入使用
[目录](#sec1) [目录](#sec1)
    1 [获取参数](#sec1)     1 [对接说明](#sec1)
    2 [获取对接demo](#sec2)     2 [获取对接demo](#sec2)
...@@ -22,32 +23,18 @@ ...@@ -22,32 +23,18 @@
    10 [退出应用](#sec10)     10 [退出应用](#sec10)
#### 说明 #### 1、对接说明 <a name="sec1"></a>
此对接文档只适合与sdkv1.0版本。 1、此对接文档只适合与sdkv1.0版本。
所有SDK功能在GameSDK类中,可通过初始化获取改类对象,后续所有更新功能都调用这个类中方法完成
文档中所有GameSDK指SDK初始化获得的对象
### 1、获取参数<a name="sec1"></a> 2、所有SDK功能在GameSDK类中,可通过初始化获取改类对象,后续所有更新功能都调用这个类中方法完成
从平台,获取一下参数,用于对接,填入清单文件对应的meta信息里
3、文档中所有GameSDK指SDK初始化获得的对象
4、game_secret可参考服务端对接文档、服务端接入2.1接口规则签名说明<a name="sec1.1"></a>
### 2、对接demo<a name="sec2"></a>
| 参数名 | 说明 |
|:--------| -------------:|
| app_id | 对接游戏ID |
| app_key | 渠道值 |
| version_code | 安装包版本 |
```
<meta-data
android:name="app_id"
android:value="149" />
<meta-data
android:name="app_key"
android:value="xxxxxxxxxxxx" />
<meta-data
android:name="version_code"
android:value="1" />
```
### 2、获取对接demo<a name="sec2"></a>
从平台处获取对接demo,android studio版本,选择合适的版本接入。 从平台处获取对接demo,android studio版本,选择合适的版本接入。
### 3、导入配置SDK资源Androidstudio项目<a name="sec3"></a> ### 3、导入配置SDK资源Androidstudio项目<a name="sec3"></a>
...@@ -60,15 +47,42 @@ ...@@ -60,15 +47,42 @@
![image.png](https://upload-images.jianshu.io/upload_images/6624077-e04f6ff77f568a03.png?imageMogr2/auto-orient/strip%7CimageView2/2/w/1240) ![image.png](https://upload-images.jianshu.io/upload_images/6624077-e04f6ff77f568a03.png?imageMogr2/auto-orient/strip%7CimageView2/2/w/1240)
### 4、配置清单文件(具体请参考demo)<a name="sec4"></a> ### 4、配置清单文件(具体请参考demo)<a name="sec4"></a>
1、参考demo中的清单文件配置,主要分为权限配置、sdk所需的组件配置,meta信息配置。(权限部分SDK已经适配,访问文件权限,Android10网络访问权限,安装适配等均已适配,但不包含所有设备) 1、参考demo中的清单文件配置,主要分为权限配置、sdk所需的组件配置,meta信息配置。(权限部分SDK已经适配,访问文件权限,Android10网络访问权限,安装适配等均已适配,但不包含所有设备)
2.sdk 的代码已经经过混淆,请勿混淆sdk的代码 2.sdk 的代码已经经过混淆,请勿混淆sdk的代码
3、打包apk签名机制需要勾选V1、V2签名 3、打包apk签名机制需要勾选V1、V2签名
说明:
sdk代码已经经过混淆,请不要再次混淆sdk代码,demo会贴出SDK混淆代码,可复制到自己混淆中(具体请参考demo) 4、sdk代码已经经过混淆,请不要再次混淆sdk代码,demo会贴出SDK混淆代码,可复制到自己混淆中(具体请参考demo)
> **参数说明**:
| 参数名 | 说明 |
|:--------| -------------:|
| game_id | 对接游戏ID |
| game_secret | 服务端签名 |
```
<meta-data
android:name="game_id"
android:value="149" />
<meta-data
android:name="game_secret"
android:value="xxxxxxxxxxxx" />
```
### 5、初始化SDK<a name="sec5"></a> ### 5、初始化SDK<a name="sec5"></a>
- 说明:sdk初始化操作方法,最先调用,需要在主线程调用,最好游戏主界面activity中调用。此方法的可多次调用用于获得sdk全局管理器。
- 调用示例:在游戏主界面activity的onCreate方法中调用 1、sdk初始化操作方法,最先调用,需要在主线程调用,最好游戏主界面activity中调用。此方法的可多次调用用于获得sdk全局管理器。
2、调用示例:在游戏主界面activity的onCreate方法中调用
> **调用示例**:
``` ```
...@@ -85,7 +99,6 @@ sdk代码已经经过混淆,请不要再次混淆sdk代码,demo会贴出SDK ...@@ -85,7 +99,6 @@ sdk代码已经经过混淆,请不要再次混淆sdk代码,demo会贴出SDK
public void addLoginListener(OnLoginListener onLoginListener) public void addLoginListener(OnLoginListener onLoginListener)
``` ```
- 说明:在登陆前必须注册登陆回调监听,用于接收登陆结果,登录成功返回token - 说明:在登陆前必须注册登陆回调监听,用于接收登陆结果,登录成功返回token
- 参数:
| 参数 | 说明| | 参数 | 说明|
...@@ -94,30 +107,56 @@ public void addLoginListener(OnLoginListener onLoginListener) ...@@ -94,30 +107,56 @@ public void addLoginListener(OnLoginListener onLoginListener)
- 参数类说明:OnLoginListener需要实现两个方法: - 参数类说明:OnLoginListener需要实现两个方法:
登录成功 > **登录成功**:
``` ```
void loginSuccess(Object data); void loginSuccess(Object data);
``` ```
登录失败 > **登录失败**:
``` ```
void loginError(Object data); void loginError(Object data);
``` ```
Object中包含:
| 参数 | 说明| > **登录成功返回参数**:
| :-------- | -------------: |
| token | 登录成功返回token |
| 参数 | 类型 | 说明 |
| :-------- | -------------: | -------------: |
| status_code | int| 状态码、1成功 |
| data| object | 返回数据 |
| message| String| 描述信息 |
| data| object | 返回数据 |
| &nbsp;&nbsp;&nbsp;&nbsp;&nbsp; data | object | 返回数据 |
| &nbsp;&nbsp;&nbsp;&nbsp;&nbsp; member_id | String | 用户Id |
| &nbsp;&nbsp;&nbsp;&nbsp;&nbsp; player_id | String | 玩家ID |
| &nbsp;&nbsp;&nbsp;&nbsp;&nbsp; username | String | 用户名 |
| &nbsp;&nbsp;&nbsp;&nbsp;&nbsp; user_token | String | token |
| &nbsp;&nbsp;&nbsp;&nbsp;&nbsp; avatar | String | 用户头像 |
| &nbsp;&nbsp;&nbsp;&nbsp;&nbsp; mobile | String | 手机号 |
| &nbsp;&nbsp;&nbsp;&nbsp;&nbsp; has_identify | boolean | 是否实名 |
| &nbsp;&nbsp;&nbsp;&nbsp;&nbsp; need_identification | String | 1强制实名,2需要实名但不强制,3不需要实名 |
| &nbsp;&nbsp;&nbsp;&nbsp;&nbsp; has_mobile | boolean | 是否绑定手机 |
- 调用示例
> **登录失败返回参数**:
| 参数 | 类型 | 说明 |
| :-------- | -------------: | -------------: |
| status_code | int| 状态码、1成功 |
| data| object | 返回数据 |
| message| String| 描述信息 |
| data| object | 返回数据 |
> **调用示例**:
``` ```
GameSdk.getInstance().addLoginListener(this, new OnLoginListener() { GameSdk.getInstance().addLoginListener(this, new OnLoginListener() {
@Override @Override
...@@ -139,13 +178,12 @@ Object中包含: ...@@ -139,13 +178,12 @@ Object中包含:
### 7、调起支付页面<a name="sec7"></a> ### 7、调起支付页面<a name="sec7"></a>
1、调起支付页面 1、调起支付页面方法
``` ```
public void showPay(CustomPayParam payParam, OnPaymentListener paymentListener) public void showPay(CustomPayParam payParam, OnPaymentListener paymentListener)
``` ```
- 说明:调用此方法进入支付页面 > **参数**:
参数:
| 参数 | 说明 | | 参数 | 说明 |
|:----|-----:| |:----|-----:|
...@@ -190,9 +228,9 @@ public void showPay(CustomPayParam payParam, OnPaymentListener paymentListener) ...@@ -190,9 +228,9 @@ public void showPay(CustomPayParam payParam, OnPaymentListener paymentListener)
} }
}); });
``` ```
### 下单支付字段说明 ##### 下单支付字段说明
1、order对象参数说明 > **参数说明**:
| 名称|类型 | 是否必须| 默认值 | 备注| | 名称|类型 | 是否必须| 默认值 | 备注|
...@@ -215,10 +253,12 @@ public void showPay(CustomPayParam payParam, OnPaymentListener paymentListener) ...@@ -215,10 +253,12 @@ public void showPay(CustomPayParam payParam, OnPaymentListener paymentListener)
| role_id | string | 非必须 | | 角色ID | | role_id | string | 非必须 | | 角色ID |
### 8、角色上报<a name="sec8"></a> ### 8、角色上报<a name="sec8"></a>
> **调用示例**:
``` ```
GameInfoSetting setting=new GameInfoSetting(); GameInfoSetting setting=new GameInfoSetting();
setting.setCp_account("w55231582254"); setting.setCp_account("w55231582254");
setting.setMember_id("11");
GameRoleInfo roleInfo=new GameRoleInfo(); GameRoleInfo roleInfo=new GameRoleInfo();
roleInfo.setCombat_num("25564"); roleInfo.setCombat_num("25564");
roleInfo.setCp_role_id("24139308336038973450"); roleInfo.setCp_role_id("24139308336038973450");
...@@ -243,12 +283,12 @@ public void showPay(CustomPayParam payParam, OnPaymentListener paymentListener) ...@@ -243,12 +283,12 @@ public void showPay(CustomPayParam payParam, OnPaymentListener paymentListener)
} }
}); });
``` ```
### 角色上报字段说明 ##### 角色上报字段说明
> **参数说明**:
| 名称 | 类型 | 是否必须| 默认值 | 备注| | 名称 | 类型 | 是否必须| 默认值 | 备注|
|:--------| -------------:| -------------------:|-------------:|-------------:| |:--------| -------------:| -------------------:|-------------:|-------------:|
| member_id | number | 非必须 | | 账号ID |
| role{} | object | 非必须 | | 角色信息 | | role{} | object | 非必须 | | 角色信息 |
| event | String | 非必须 | | 事件类型,online: 角色登录, create: 创建角色,level_up: 提升等级,offline: 角色退出,other: 其他,delete: 删除角色 | | event | String | 非必须 | | 事件类型,online: 角色登录, create: 创建角色,level_up: 提升等级,offline: 角色退出,other: 其他,delete: 删除角色 |
| server_id | string | 非必须 | | 区服ID | | server_id | string | 非必须 | | 区服ID |
...@@ -267,35 +307,35 @@ public void showPay(CustomPayParam payParam, OnPaymentListener paymentListener) ...@@ -267,35 +307,35 @@ public void showPay(CustomPayParam payParam, OnPaymentListener paymentListener)
``` ```
public void addLogoutListener(OnLogoutListener onLogoutListener) public void addLogoutListener(OnLogoutListener onLogoutListener)
``` ```
- 说明:在退出登陆前必须注册退出登陆回调监听,用于接收退出登陆,或者登陆过期的退出登陆结果。 1、在退出登陆前必须注册退出登陆回调监听,用于接收退出登陆,或者登陆过期的退出登陆结果。
2、 参数类说明:OnLogoutListener需要实现两个方法:
3、 退出登陆成功:
4、退出登录成功并返回所有信息与code状态
> **参数说明**:
| 参数 | 说明 | | 参数 | 说明 |
| :-------- | ----: | | :-------- | ----: |
| OnLogoutListener | 退出登陆回调接口 | | OnLogoutListener | 退出登陆回调接口 |
> **退出登录成功**:
- 参数类说明:OnLogoutListener需要实现两个方法:
- 退出登陆成功:
``` ```
public void logoutSuccess(String s); public void logoutSuccess(String s);
``` ```
- 退出登陆失败 > **退出登录失败**:
``` ```
public void logoutError(String msg); public void logoutError(String msg);
``` ```
> **调用示例**:
- 说明:退出登录成功并返回所有信息与code状态 >
使用示例
``` ```
GameSdk.getInstance().addLogoutListener(new OnLogoutListener() { GameSdk.getInstance().addLogoutListener(new OnLogoutListener() {
...@@ -313,28 +353,22 @@ public void logoutError(String msg); ...@@ -313,28 +353,22 @@ public void logoutError(String msg);
- 说明:在需要退出登陆时可调用此方法,注意此方法为退出,并不会调出登陆界面 - 说明:在需要退出登陆时可调用此方法,注意此方法为退出,并不会调出登陆界面
### 10、退出应用弹框<a name="sec10"></a> ### 10、退出应用弹框<a name="sec10"></a>
1、添加退出回调监听 1、添加退出回调监听
> **调用示例**:
``` ```
public void exitApp(ExitAppListener listener) public void exitApp(ExitAppListener listener)
``` ```
- 说明:退出应用程序弹出提示框。 1、退出应用程序弹出提示框。
2、 参数类说明:ExitAppListener需要实现exitApp()方法:
| 参数 | 说明 | | 参数 | 说明 |
| :-------- | ----: | | :-------- | ----: |
| ExitAppListener | 退出应用回调接口 | | ExitAppListener | 退出应用回调接口 |
- 参数类说明:ExitAppListener需要实现一个方法:
- 退出登陆成功:
```
public void exitApp(String s);
```
使用示例 > **调用示例**:
``` ```
@Override @Override
public void onBackPressed() { public void onBackPressed() {
......
Markdown 格式
0%
您添加了 0 到此讨论。请谨慎行事。
请先完成此评论的编辑!
注册 或者 后发表评论