public_service / public_sdk_android

Go to a project
Toggle navigation Toggle navigation pinning
youaiPublic
Committed by GitHub
c99801f3 1 parent 88ef5c1b

Update 公共SDK客户端接入文档.md

Inline Side-by-side
Showing 1 changed file with 131 additions and 11 deletions
...@@ -82,17 +82,17 @@ ...@@ -82,17 +82,17 @@
82 ###2、功能接口 82 ###2、功能接口
83 (注意:以下所有接口都必须在 SDK 初始化完成之后才能调用)<br> 83 (注意:以下所有接口都必须在 SDK 初始化完成之后才能调用)<br>
84 2.1、继承 PoolSDKApplication(必接) <br> 84 2.1、继承 PoolSDKApplication(必接) <br>
85 - 说明:<br> 85 + 说明:<br>
86 - 游戏工程如果没有Application,请在 AndroidManifest.xml 中添加SDK的Application,如下所示:<br> 86 + 游戏工程如果没有Application,请在 AndroidManifest.xml 中添加SDK的Application,如下所示:<br>
87 - <application android:name="com.gzyouai.publicsdk.application.PoolSDKApplication"><br> 87 + <application android:name="com.gzyouai.publicsdk.application.PoolSDKApplication"><br>
88 - 游戏工程如果有 Application,请继承 SDK 中 PoolSDKApplication: 88 + 游戏工程如果有 Application,请继承 SDK 中 PoolSDKApplication:
89 - public class XXXXApplication extends PoolSDKApplication { 89 + public class XXXXApplication extends PoolSDKApplication {
90 - @Override 90 + @Override
91 - public void onCreate() { 91 + public void onCreate() {
92 - // TODO Auto-generated method stub 92 + // TODO Auto-generated method stub
93 - super.onCreate(); 93 + super.onCreate();
94 - } 94 + }
95 - } 95 + }
96 2.2、初始化接口(必接) 96 2.2、初始化接口(必接)
97 接口说明: 97 接口说明:
98 首先在程序开始的地方调用 SDK 的初始化 init 方法,并设 置 Activity 对像和初始化完成回调监听(在初始化失败情况下不 再调用其它 SDK 接口方法) 98 首先在程序开始的地方调用 SDK 的初始化 init 方法,并设 置 Activity 对像和初始化完成回调监听(在初始化失败情况下不 再调用其它 SDK 接口方法)
...@@ -100,3 +100,123 @@ ...@@ -100,3 +100,123 @@
100 2.2.1、方法定义 100 2.2.1、方法定义
101 public static void init(final Activity activity,final PoolSDKCallBackListener callBackListener) 101 public static void init(final Activity activity,final PoolSDKCallBackListener callBackListener)
102 2.2.2、参数说明 102 2.2.2、参数说明
103 + 2.2.3、代码示例:
104 + PoolSdkHelper.init(this, new PoolSDKCallBackListener() {
105 + @Override
106 + public void poolSdkCallBack(int code, String msg) {
107 + // TODO Auto-generated method stub
108 + switch (code) {
109 + case PoolSDKCode.POOLSDK_INIT_SUCCESS://初始化成功
110 + PoolSdkLog.logInfo("游戏中POOLSDK_INIT_SUCCESS");
111 + login();
112 + break;
113 + case PoolSDKCode.POOLSDK_INIT_FAIL:
114 + break;
115 + default:
116 + break;
117 + }
118 + }
119 + });
120 +
121 + 2.3、登录接口(必接)
122 + 接口说明:游戏登录时调用
123 + 2.3.1、方法定义
124 + public static void login(final String paramCustom,final PoolLoginListener poolLoginListener)
125 + 2.3.2、参数说明
126 + 2.3.3、代码示例
127 + PoolSdkHelper.login("登录自定义字段", new PoolLoginListener() {
128 + @Override
129 + public void onLoginSuccess(PoolLoginInfo poolLoginInfo) {
130 + String userType = poolLoginInfo.getUserType();
131 + String timestamp = poolLoginInfo.getTimestamp();
132 + String serverSign = poolLoginInfo.getServerSign();
133 + String openId = poolLoginInfo.getOpenID();
134 + // TODO: 把以上信息发送给游戏服务端做登录校验，需要其他信息请从poolLoginInfo对象中获取
135 + System.out.println("登录成功 userType = " + userType
136 + + "; timestamp = " + timestamp + "; serverSign = "
137 + + serverSign + "; openId = " + openId);
138 + }
139 + @Override
140 + public void onLoginFailed(String errorMsg) {
141 + System.out.println("登录失败 = " + errorMsg);
142 + }
143 + });
144 +
145 + 2.4、提交角色数据接口(必接)
146 + 接口说明:游戏提交角色数据接口,该接口需要在以下 3 中情况下
147 + 调用:进入游戏主场景、创建角色、角色升级
148 + 2.4.1、方法定义
149 + public static void submitRoleData(final PoolRoleInfo poolRoleInfo,
150 + final PoolRoleListener poolRoleListener)
151 + 2.4.2、参数说明
152 + 2.4.3、代码示例
153 + /********************************************
154 + * 以下所有字段都是必填项
155 + */
156 + PoolRoleInfo poolRoleInfo = new PoolRoleInfo();
157 + poolRoleInfo.setRoleID("123456");
158 + poolRoleInfo.setRoleLevel("10");
159 + poolRoleInfo.setRoleSex("0");
160 + poolRoleInfo.setRoleName("我是角色名");
161 + poolRoleInfo.setServerID("1");
162 + poolRoleInfo.setServerName("我是服务器名");
163 + poolRoleInfo.setCustom("角色创建时间");
164 + poolRoleInfo.setCallType(PoolRoleInfo.Type_EnterGame);
165 + // poolRoleInfo.setCallType(PoolRoleInfo.Type_CreateRole);
166 + // poolRoleInfo.setCallType(PoolRoleInfo.Type_RoleUpgrade);
167 +
168 + PoolSdkHelper.submitRoleData(poolRoleInfo, new PoolRoleListener() {
169 + @Override
170 + public void onRoleDataSuccess(String paramCustom) {
171 + System.out.println("提交角色数据成功 = " + paramCustom);
172 + }
173 + });
174 +
175 + 2.5、支付接口(必接)
176 + 2.5.1、方法定义
177 + public static void pay(final PoolPayInfo poolPayInfo,final PoolPayListener poolPayListener)
178 + 2.5.2、参数说明
179 + 2.5.3、代码示例
180 + /********************************************
181 + * 以下所有字段都是必填项
182 + */
183 + // 设置充值金额，单位“元”
184 + poolPayInfo.setAmount("1");
185 + // 服务器id
186 + poolPayInfo.setServerID("8");
187 + // 服务器名
188 + poolPayInfo.setServerName("我是服务器名");
189 + // 角色id
190 + poolPayInfo.setRoleID("123456");
191 + // 角色名
192 + poolPayInfo.setRoleName("我是角色名");
193 + // 角色等级
194 + poolPayInfo.setRoleLevel("10");
195 + // 商品ID
196 + poolPayInfo.setProductID("1");
197 + // 商品名称
198 + poolPayInfo.setProductName("金币");
199 + // 商品描述
200 + poolPayInfo.setProductDesc("购买金币");
201 + // 兑换比例
202 + poolPayInfo.setExchange("10");
203 + // 自定义参数
204 + poolPayInfo.setCustom("我是自定义参数");
205 + // TODO Auto-generated method stub
206 + PoolSdkHelper.pay(poolPayInfo, new PoolPayListener() {
207 + @Override
208 + public void onPaySuccess(String paramCustom) {
209 + System.out.println("支付成功 = " + paramCustom);
210 + }
211 + @Override
212 + public void onPayFailed(String paramCustom, String errorMsg) {
213 + System.out.println("支付失败 = " + paramCustom + "; errorMsg = "
214 + + errorMsg);
215 + }
216 + });
217 +
218 + 2.6、检测 SDK 是否含有用户中心接口(必接)
219 + 说明:如果接口返回为 true,表示需要游戏方在合适的界面中添 加一个用户中心的按钮,点击按钮时调用文档中 2.7 的用户中心 接口;如果返回 false,则不做处理
220 + 2.6.1、方法定义
221 + public static boolean hasChannelCenter()
222 +
......