lizhihui

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

...@@ -103,7 +103,7 @@ ...@@ -103,7 +103,7 @@
103 ### 2、功能接口 (注意:以下所有接口都必须在 SDK 初始化完成之后才能调用) ### 103 ### 2、功能接口 (注意:以下所有接口都必须在 SDK 初始化完成之后才能调用) ###
104 104
105 105
106 -#### 2.1、继承 PoolSDKApplication(必接) #### 106 +#### 2.1、继承 PoolSDKApplication(必接)
107 107
108 游戏工程如果没有Application,请在 AndroidManifest.xml 中添加SDK的Application,如下所示: 108 游戏工程如果没有Application,请在 AndroidManifest.xml 中添加SDK的Application,如下所示:
109 109
...@@ -122,7 +122,7 @@ ...@@ -122,7 +122,7 @@
122 } 122 }
123 } 123 }
124 ``` 124 ```
125 -#### 2.2、初始化接口(必接) #### 125 +#### 2.2、初始化接口(必接)
126 接口说明: 126 接口说明:
127 首先在程序开始的地方调用 SDK 的初始化 init 方法,并设 置 Activity 对像和初始化完成回调 127 首先在程序开始的地方调用 SDK 的初始化 init 方法,并设 置 Activity 对像和初始化完成回调
128 监听(在初始化失败情况下不 再调用其它 SDK 接口方法) 128 监听(在初始化失败情况下不 再调用其它 SDK 接口方法)
...@@ -130,7 +130,7 @@ ...@@ -130,7 +130,7 @@
130 2.2.1、方法定义 130 2.2.1、方法定义
131 public static void init(final Activity activity,final PoolSDKCallBackListener callBackListener) 131 public static void init(final Activity activity,final PoolSDKCallBackListener callBackListener)
132 132
133 -#### 2.2.2、参数说明 #### 133 +#### 2.2.2、参数说明
134 134
135 | 参数 | 说明 | 135 | 参数 | 说明 |
136 | ---------------- | -------------------------------- | 136 | ---------------- | -------------------------------- |
...@@ -196,19 +196,19 @@ public static void login(final String paramCustom,final PoolLoginListener poolLo ...@@ -196,19 +196,19 @@ public static void login(final String paramCustom,final PoolLoginListener poolLo
196 196
197 ``` 197 ```
198 198
199 -#### 2.4、提交角色数据接口(必接) #### 199 +#### 2.4、提交角色数据接口(必接)
200 接口说明:游戏提交角色数据接口,该接口需要在以下3中情况下调用: 200 接口说明:游戏提交角色数据接口,该接口需要在以下3中情况下调用:
201 201
202 进入游戏主场景、创建角色、角色升级 202 进入游戏主场景、创建角色、角色升级
203 203
204 **(如果游戏创建角色时没有角色名,需要在用户创建角色名时调用多一次进入游戏统计,否则用户名无法正常统计,投放测试无法通过)** 204 **(如果游戏创建角色时没有角色名,需要在用户创建角色名时调用多一次进入游戏统计,否则用户名无法正常统计,投放测试无法通过)**
205 205
206 -#### 2.4.1、方法定义 #### 206 +#### 2.4.1、方法定义
207 207
208 ```java 208 ```java
209 public static void submitRoleData(final PoolRoleInfo poolRoleInfo,final PoolRoleListener poolRoleListener) 209 public static void submitRoleData(final PoolRoleInfo poolRoleInfo,final PoolRoleListener poolRoleListener)
210 ``` 210 ```
211 -#### 2.4.2、参数说明 #### 211 +#### 2.4.2、参数说明
212 212
213 | 参数 | 说明 | 213 | 参数 | 说明 |
214 | ---------------- | ---------------- | 214 | ---------------- | ---------------- |
...@@ -268,14 +268,14 @@ public static void submitRoleData(final PoolRoleInfo poolRoleInfo,final PoolRole ...@@ -268,14 +268,14 @@ public static void submitRoleData(final PoolRoleInfo poolRoleInfo,final PoolRole
268 268
269 ``` 269 ```
270 270
271 -#### 2.5、支付接口(必接) #### 271 +#### 2.5、支付接口(必接)
272 272
273 -#### 2.5.1、方法定义 #### 273 +#### 2.5.1、方法定义
274 ```java 274 ```java
275 public static void pay(final PoolPayInfo poolPayInfo,final PoolPayListener poolPayListener) 275 public static void pay(final PoolPayInfo poolPayInfo,final PoolPayListener poolPayListener)
276 ``` 276 ```
277 277
278 -#### 2.5.2、参数说明 #### 278 +#### 2.5.2、参数说明
279 279
280 | 参数 | 说明 | 280 | 参数 | 说明 |
281 | ---------------- | ---------------- | 281 | ---------------- | ---------------- |
...@@ -338,21 +338,21 @@ public static void pay(final PoolPayInfo poolPayInfo,final PoolPayListener poolP ...@@ -338,21 +338,21 @@ public static void pay(final PoolPayInfo poolPayInfo,final PoolPayListener poolP
338 }); 338 });
339 ``` 339 ```
340 340
341 -#### 2.6、检测 SDK 是否含有用户中心接口(必接) #### 341 +#### 2.6、检测 SDK 是否含有用户中心接口(必接)
342 342
343 说明:如果接口返回为 true,表示需要游戏方在合适的界面中添加一个用户中心的按钮,点击按钮时调用文档中 2.7 的用户中心接口; 343 说明:如果接口返回为 true,表示需要游戏方在合适的界面中添加一个用户中心的按钮,点击按钮时调用文档中 2.7 的用户中心接口;
344 344
345 如果返回 false,则不做处理 345 如果返回 false,则不做处理
346 346
347 -#### 2.6.1、方法定义 #### 347 +#### 2.6.1、方法定义
348 ```java 348 ```java
349 public static boolean hasChannelCenter() 349 public static boolean hasChannelCenter()
350 ``` 350 ```
351 -#### 2.7、用户中心接口(必接) #### 351 +#### 2.7、用户中心接口(必接)
352 352
353 说明:打开渠道用户中心界面 353 说明:打开渠道用户中心界面
354 354
355 -#### 2.7.1、方法定义 #### 355 +#### 2.7.1、方法定义
356 ```java 356 ```java
357 public static void openChannelCenter() 357 public static void openChannelCenter()
358 ``` 358 ```
...@@ -372,11 +372,11 @@ public static void openChannelCenter() ...@@ -372,11 +372,11 @@ public static void openChannelCenter()
372 } 372 }
373 373
374 ``` 374 ```
375 -#### 2.8、注销登录监听接口 #### 375 +#### 2.8、注销登录监听接口
376 376
377 说明:可在游戏启动时设置注销监听事件,渠道注销成功后 SDK 会回调 onLogoutSuccess 方法通知游戏,游戏可在此处理切换账号逻辑 377 说明:可在游戏启动时设置注销监听事件,渠道注销成功后 SDK 会回调 onLogoutSuccess 方法通知游戏,游戏可在此处理切换账号逻辑
378 378
379 -#### 2.8.1、方法定义 #### 379 +#### 2.8.1、方法定义
380 380
381 ```java 381 ```java
382 public static void setLogoutCallback(final PoolLogoutListener poolLogoutListener) 382 public static void setLogoutCallback(final PoolLogoutListener poolLogoutListener)
...@@ -401,17 +401,18 @@ public static void setLogoutCallback(final PoolLogoutListener poolLogoutListener ...@@ -401,17 +401,18 @@ public static void setLogoutCallback(final PoolLogoutListener poolLogoutListener
401 }); 401 });
402 ``` 402 ```
403 403
404 -#### 2.9、退出游戏接口(必接) #### 404 +#### 2.9、退出游戏接口(必接)
405 +
405 说明:在游戏需要退出时调用,调用此接口时需先用 PoolSdkHelper.hasExitDialog() 判断 sdk 是否有退出界 406 说明:在游戏需要退出时调用,调用此接口时需先用 PoolSdkHelper.hasExitDialog() 判断 sdk 是否有退出界
406 面,为 true表示有退出界面需调用 showExitDialog()显示退出界面,为 false 时表示没有退出界面,游戏需自己处 407 面,为 true表示有退出界面需调用 showExitDialog()显示退出界面,为 false 时表示没有退出界面,游戏需自己处
407 理退出逻辑且在确认 游戏退出前调用 PoolSdkHelper.exitGame 通知 SDK 游戏要退出 (具体可参照 Demo 示例) 408 理退出逻辑且在确认 游戏退出前调用 PoolSdkHelper.exitGame 通知 SDK 游戏要退出 (具体可参照 Demo 示例)
408 409
409 -#### 2.9.1、方法定义 #### 410 +#### 2.9.1、方法定义
410 ```java 411 ```java
411 public static void showExitDialog(final PoolExitDialogListener exitDialogListener) 412 public static void showExitDialog(final PoolExitDialogListener exitDialogListener)
412 ``` 413 ```
413 414
414 -#### 2.9.2、参数说明 #### 415 +#### 2.9.2、参数说明
415 416
416 | 参数 | 说明 | 417 | 参数 | 说明 |
417 | ------------------ | ------------------------------ | 418 | ------------------ | ------------------------------ |
...@@ -565,11 +566,11 @@ public static void showExitDialog(final PoolExitDialogListener exitDialogListene ...@@ -565,11 +566,11 @@ public static void showExitDialog(final PoolExitDialogListener exitDialogListene
565 566
566 说明:该接口在游戏需要注销账号时调用,注销结果通知到PoolLogoutListener回调中,调用之前先判断是否包含此接口(hasLogout()) 567 说明:该接口在游戏需要注销账号时调用,注销结果通知到PoolLogoutListener回调中,调用之前先判断是否包含此接口(hasLogout())
567 568
568 -#### 2.15.1、方法定义 #### 569 +#### 2.15.1、方法定义
569 ```java 570 ```java
570 public static void logout(final Activity paramActivity) ; 571 public static void logout(final Activity paramActivity) ;
571 ``` 572 ```
572 -#### 2.15.2、参数说明 #### 573 +#### 2.15.2、参数说明
573 574
574 | 参数 | 说明 | 575 | 参数 | 说明 |
575 | ------------- | ---- | 576 | ------------- | ---- |
...@@ -588,12 +589,13 @@ public static void logout(final Activity paramActivity) ; ...@@ -588,12 +589,13 @@ public static void logout(final Activity paramActivity) ;
588 589
589 说明:该接口在游戏切换账号时调用,切换成功回通知到登录监听回调中,调用前请判断是否含有此接口(hasSwitchAccount()) 590 说明:该接口在游戏切换账号时调用,切换成功回通知到登录监听回调中,调用前请判断是否含有此接口(hasSwitchAccount())
590 591
591 -#### 2.16.1、方法定义 #### 592 +#### 2.16.1、方法定义
592 ```java 593 ```java
593 public static void switchAccount(final Activity paramActivity); 594 public static void switchAccount(final Activity paramActivity);
594 ``` 595 ```
595 596
596 -#### 2.16.2、参数说明 #### 597 +#### 2.16.2、参数说明
598 +
597 | 参数 | 说明 | 599 | 参数 | 说明 |
598 | ------------- | ---- | 600 | ------------- | ---- |
599 | paramActivity | 上下文 | 601 | paramActivity | 上下文 |
......