public_service / public_sdk_android

Go to a project
Toggle navigation Toggle navigation pinning
1556138063
d9afd783 1 parent 92654adc

客户端文档update

Inline Side-by-side
Showing 1 changed file with 77 additions and 18 deletions
#SDK 接入文档
###1、开发环境搭建
以下是以 Eclipse 为例,在 Eclipse 环境下开发的 SDK 配置
1.1、将 SDK 压缩包中 Jar 目录下的所有 jar 包复制到游戏工程的 libs 目录下
![Alt text](https://github.com/youaiPublic/publicAndroidSDK/tree/master/publicAndroidSDK/image/image1.png)
1.2、将1.1中复制的jar包引用到游戏工程<br>
1.3、复制SDK压缩包中assets目录下的所有内容到游戏工程的assets目录，将游戏中的闪屏图片放到assets中poolsdk_splash目录 下，将assets中的poolsdk.xml中的payCallbackUrl参数配置为游戏测试的充值回调地址（注：此回调地址为测试使用，正式 环境以SDK后台配置的地址为准）
1.4、修改游戏工程的AndroidManifest.xml（可以参照复制Demo中AndroidManifest.xml文件）
1.1. 将 SDK 压缩包中 Jar 目录下的所有 jar 包复制到游戏工程的 libs 目录下
![Alt text](../image/image1.png)
1.2. 将1.1中复制的jar包引用到游戏工程
1.3. 复制SDK压缩包中assets目录下的所有内容到游戏工程的assets目录，将游戏中的闪屏图片放到assets中 poolsdk_splash目录下，将 assets中的poolsdk.xml中的payCallbackUrl参数配置为游戏测试的充值
回调地址（注：此回调地址为测试使用，正式环境以SDK后台配置的地址为准）
1.4. 修改游戏工程的AndroidManifest.xml（可以参照复制Demo中 AndroidManifest.xml文件）
①．添加声明权限：
<uses-permission android:name="android.permission.INTERNET" />
<uses-permission android:name="android.permission.WRITE_EXTERNAL_STORAGE" />
......@@ -79,11 +81,11 @@
<!-- end i9133 -->
###2、功能接口
(注意:以下所有接口都必须在 SDK 初始化完成之后才能调用)<br>
2.1、继承 PoolSDKApplication(必接) <br>
(注意:以下所有接口都必须在 SDK 初始化完成之后才能调用)
2.1、继承 PoolSDKApplication(必接)
说明:<br>
游戏工程如果没有Application,请在 AndroidManifest.xml 中添加SDK的Application,如下所示:<br>
<application android:name="com.gzyouai.publicsdk.application.PoolSDKApplication"><br>
游戏工程如果没有Application,请在 AndroidManifest.xml 中添加SDK的Application, 如下所示:
<application android:name="com.gzyouai.publicsdk.application.PoolSDKApplication">
游戏工程如果有 Application,请继承 SDK 中 PoolSDKApplication:
public class XXXXApplication extends PoolSDKApplication {
@Override
......@@ -94,11 +96,16 @@
}
2.2、初始化接口(必接)
接口说明:
首先在程序开始的地方调用 SDK 的初始化 init 方法,并设 置 Activity 对像和初始化完成回调监听(在初始化失败情况下不 再调用其它 SDK 接口方法)
首先在程序开始的地方调用 SDK 的初始化 init 方法,并设 置 Activity 对像和初始化完成回调监听(在初始化失败 情况下不 再调用其它 SDK 接口方法)
注意:要确保在 SDK 初始化成功后才可调用其它接口
2.2.1、方法定义
public static void init(final Activity activity,final PoolSDKCallBackListener callBackListener)
2.2.2、参数说明
参数 |说明
------------ | -------------
activity | Activity 对应
callBackListener | 初始化完成回调通知,需实现 poolSdkCallBack 方法
2.2.3、代码示例:
PoolSdkHelper.init(this, new PoolSDKCallBackListener() {
@Override
......@@ -122,6 +129,11 @@
2.3.1、方法定义
public static void login(final String paramCustom,final PoolLoginListener poolLoginListener)
2.3.2、参数说明
参数 |说明
------------ | -------------
paramCustom | 游戏自定义参数,可通过登录成功回调方法onLoginSuccess 中的参数PoolLoginInfo 对象的 getCustom()获取
poolLoginListener | 登录结果回调通知,需实现 onLoginSuccess 方法
2.3.3、代码示例
PoolSdkHelper.login("登录自定义字段", new PoolLoginListener() {
@Override
......@@ -130,7 +142,7 @@
String timestamp = poolLoginInfo.getTimestamp();
String serverSign = poolLoginInfo.getServerSign();
String openId = poolLoginInfo.getOpenID();
// TODO: 把以上信息发送给游戏服务端做登录校验，需要其他信息请从poolLoginInfo对象中获取
//把以上信息发送给游戏服务端做登录校验，需要其他信息请从poolLoginInfo对象中获取
System.out.println("登录成功 userType = " + userType
+ "; timestamp = " + timestamp + "; serverSign = "
+ serverSign + "; openId = " + openId);
......@@ -148,6 +160,23 @@
public static void submitRoleData(final PoolRoleInfo poolRoleInfo,
final PoolRoleListener poolRoleListener)
2.4.2、参数说明
参数 |说明
------------ | -------------
poolRoleInfo | 角色数据实体类
poolRoleListener | 角色数据提交结果回调通知,需实现
PoolRoleInfo 实体类字段说明
字段名 |说明
------------ | -------------
callType | 调用类型Type_EnterGame 登录游戏主 场景;Type_CreatRole 为创建角 色;Type_RoleUpgrade 为角色升级
roleId | 角色 Id
roleName | 角色名称
roleLevel | 角色等级
roleSex | 角色性别(1 男 0 女,如果角 色不分性别请填写 0)
serverId | 服务器 id
serverName | 服务器名称
custom | 创建角色时间(以秒为单位)
2.4.3、代码示例
/********************************************
* 以下所有字段都是必填项
......@@ -175,6 +204,25 @@
2.5.1、方法定义
public static void pay(final PoolPayInfo poolPayInfo,final PoolPayListener poolPayListener)
2.5.2、参数说明
参数 |说明
------------ | -------------
poolRoleInfo | 角色数据实体类
poolRoleListener | 角色数据提交结果回调通知,需实现
支付信息实体类(PoolPayInfo)字段说明
参数 |说明
------------ | -------------
amount | 金额(单位元,必须大于 0)
productId | 商品 ID(如果没有可以传空字符 串)
productName | 商品描述
roleid | 角色 id
rolelevel | 角色等级
roleName | 角色名称
serverId | 服务器 id
serverName | 服务器名称
exchange | 游戏币与人民币(元)的兑换比例
custom | 自定义透传参数,通过回调函数原样返回
2.5.3、代码示例
/********************************************
* 以下所有字段都是必填项
......@@ -215,7 +263,7 @@
});
2.6、检测 SDK 是否含有用户中心接口(必接)
说明:如果接口返回为 true,表示需要游戏方在合适的界面中添加一个用户中心的按钮,点击按钮时调用文档中 2.7 的用户中心接口;如果返回 false,则不做处理
说明:如果接口返回为 true,表示需要游戏方在合适的界面中添加一个用户中心的按钮,点击按钮时调用文档 中 2.7 的用户中心接口;如果返回 false,则不做处理
2.6.1、方法定义
public static boolean hasChannelCenter()
2.7、用户中心接口(必接)
......@@ -239,6 +287,10 @@
2.8.1、方法定义
public static void setLogoutCallback(final PoolLogoutListener poolLogoutListener)
2.8.2、参数说明
参数 |说明
------------ | -------------
poolLogoutListener | 账户注销成功回调监听,需实现 onLogoutSuccess 方法
2.8.3、代码示例
PoolSdkHelper.setLogoutCallback(new PoolLogoutListener() {
@Override
......@@ -249,12 +301,15 @@
}
});
2.9、退出游戏接口(必接)
说明:在游戏需要退出时调用,调用此接口时需先用 PoolSdkHelper.hasExitDialog() 判断 sdk 是否有退出界面,为 true
表示有退出界面需调用 showExitDialog()显示退出界面,为 false 时表示没有退出界面,游戏需自己处理退出逻辑且在确认
游戏退出前调用 PoolSdkHelper.exitGame 通知 SDK 游戏要退出 (具体可参照 Demo 示例)
说明:在游戏需要退出时调用,调用此接口时需先用 PoolSdkHelper.hasExitDialog() 判断 sdk 是否有退出界面, 为 true表示有退出界面需调用 showExitDialog()显示退出界面,为 false 时表示没有退出界面,游戏需自己处理退 出逻辑且在确认 游戏退出前调用 PoolSdkHelper.exitGame 通知 SDK 游戏要退出 (具体可参照 Demo 示例)
2.9.1、方法定义
public static void showExitDialog(final PoolExitDialogListener exitDialogListener)
2.9.2、参数说明
参数 |说明
------------ | -------------
exitDialogListener | 退出结果回调监听,需实现 onDialogResult 方法
2.9.3、代码示例
@Override
public boolean dispatchKeyEvent(KeyEvent pKeyEvent) {
......@@ -286,7 +341,7 @@
return super.dispatchKeyEvent(pKeyEvent);
}
2.10、Android 生命周期接口(必接)
说明:在游戏 Activity 的 onStart、onPause、onResume、 onStop、onDestroy、onRestart、onNewIntent、 onActivityResult、onConfigurationChanged 中分别调用对应的接口
说明:在游戏 Activity 的 onStart、onPause、onResume、 onStop、onDestroy、onRestart、 onNewIntent、 onActivityResult、onConfigurationChanged 中分别调用对应的接口
2.10.1、代码示例
@Override
public void onStart() {
......@@ -346,6 +401,10 @@
2.11.1、方法定义
public static void expansionInterface(final String paramCustom,final PoolExpansionListener poolExpansionListener)
2.11.2、参数说明
参数 |说明
------------ | -------------
paramCustom | 自定义参数
poolExpansionListener | 方法回调参数,实现onSuccess方法
2.12、获取渠道包标识(可选)
接口名称:PoolSdkHelper.getGameChannelId()
......@@ -365,8 +424,8 @@
3.1、进入游戏会弹出下面的登录界面,表示登录接口接入正常;
![Alt text](https://github.com/youaiPublic/publicAndroidSDK/tree/master/publicAndroidSDK/image/image5.png)
3.2、点击充值会弹出下面的界面,表示充值接口接入正常;
![Alt text](https://github.com/youaiPublic/publicAndroidSDK/tree/master/publicAndroidSDK/image/image6.png)
![text2][../image/image3.png]
3.3、点击渠道用户中心,弹出下面的界面表示该接口接入正常;
![Alt text](https://github.com/youaiPublic/publicAndroidSDK/tree/master/publicAndroidSDK/image/image7.png)
![text3][../image/image4.png]
#4、母包
4.1、接入公共 SDK 编译生成的 apk 即为打包工具使用的母包
\ No newline at end of file
......