lizhihui

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

......@@ -103,7 +103,7 @@
### 2、功能接口 (注意:以下所有接口都必须在 SDK 初始化完成之后才能调用) ###
#### 2.1、继承 PoolSDKApplication(必接) ####
#### 2.1、继承 PoolSDKApplication(必接)
游戏工程如果没有Application,请在 AndroidManifest.xml 中添加SDK的Application,如下所示:
......@@ -122,7 +122,7 @@
}
}
```
#### 2.2、初始化接口(必接) ####
#### 2.2、初始化接口(必接)
接口说明:
首先在程序开始的地方调用 SDK 的初始化 init 方法,并设 置 Activity 对像和初始化完成回调
监听(在初始化失败情况下不 再调用其它 SDK 接口方法)
......@@ -130,7 +130,7 @@
2.2.1、方法定义
public static void init(final Activity activity,final PoolSDKCallBackListener callBackListener)
#### 2.2.2、参数说明 ####
#### 2.2.2、参数说明
| 参数 | 说明 |
| ---------------- | -------------------------------- |
......@@ -196,19 +196,19 @@ public static void login(final String paramCustom,final PoolLoginListener poolLo
```
#### 2.4、提交角色数据接口(必接) ####
#### 2.4、提交角色数据接口(必接)
接口说明:游戏提交角色数据接口,该接口需要在以下3中情况下调用:
进入游戏主场景、创建角色、角色升级
**(如果游戏创建角色时没有角色名,需要在用户创建角色名时调用多一次进入游戏统计,否则用户名无法正常统计,投放测试无法通过)**
#### 2.4.1、方法定义 ####
#### 2.4.1、方法定义
```java
public static void submitRoleData(final PoolRoleInfo poolRoleInfo,final PoolRoleListener poolRoleListener)
```
#### 2.4.2、参数说明 ####
#### 2.4.2、参数说明
| 参数 | 说明 |
| ---------------- | ---------------- |
......@@ -268,14 +268,14 @@ public static void submitRoleData(final PoolRoleInfo poolRoleInfo,final PoolRole
```
#### 2.5、支付接口(必接) ####
#### 2.5、支付接口(必接)
#### 2.5.1、方法定义 ####
#### 2.5.1、方法定义
```java
public static void pay(final PoolPayInfo poolPayInfo,final PoolPayListener poolPayListener)
```
#### 2.5.2、参数说明 ####
#### 2.5.2、参数说明
| 参数 | 说明 |
| ---------------- | ---------------- |
......@@ -338,21 +338,21 @@ public static void pay(final PoolPayInfo poolPayInfo,final PoolPayListener poolP
});
```
#### 2.6、检测 SDK 是否含有用户中心接口(必接) ####
#### 2.6、检测 SDK 是否含有用户中心接口(必接)
说明:如果接口返回为 true,表示需要游戏方在合适的界面中添加一个用户中心的按钮,点击按钮时调用文档中 2.7 的用户中心接口;
如果返回 false,则不做处理
#### 2.6.1、方法定义 ####
#### 2.6.1、方法定义
```java
public static boolean hasChannelCenter()
```
#### 2.7、用户中心接口(必接) ####
#### 2.7、用户中心接口(必接)
说明:打开渠道用户中心界面
#### 2.7.1、方法定义 ####
#### 2.7.1、方法定义
```java
public static void openChannelCenter()
```
......@@ -372,11 +372,11 @@ public static void openChannelCenter()
}
```
#### 2.8、注销登录监听接口 ####
#### 2.8、注销登录监听接口
说明:可在游戏启动时设置注销监听事件,渠道注销成功后 SDK 会回调 onLogoutSuccess 方法通知游戏,游戏可在此处理切换账号逻辑
#### 2.8.1、方法定义 ####
#### 2.8.1、方法定义
```java
public static void setLogoutCallback(final PoolLogoutListener poolLogoutListener)
......@@ -401,17 +401,18 @@ public static void setLogoutCallback(final PoolLogoutListener poolLogoutListener
});
```
#### 2.9、退出游戏接口(必接) ####
#### 2.9、退出游戏接口(必接)
说明:在游戏需要退出时调用,调用此接口时需先用 PoolSdkHelper.hasExitDialog() 判断 sdk 是否有退出界
面,为 true表示有退出界面需调用 showExitDialog()显示退出界面,为 false 时表示没有退出界面,游戏需自己处
理退出逻辑且在确认 游戏退出前调用 PoolSdkHelper.exitGame 通知 SDK 游戏要退出 (具体可参照 Demo 示例)
#### 2.9.1、方法定义 ####
#### 2.9.1、方法定义
```java
public static void showExitDialog(final PoolExitDialogListener exitDialogListener)
```
#### 2.9.2、参数说明 ####
#### 2.9.2、参数说明
| 参数 | 说明 |
| ------------------ | ------------------------------ |
......@@ -565,11 +566,11 @@ public static void showExitDialog(final PoolExitDialogListener exitDialogListene
说明:该接口在游戏需要注销账号时调用,注销结果通知到PoolLogoutListener回调中,调用之前先判断是否包含此接口(hasLogout())
#### 2.15.1、方法定义 ####
#### 2.15.1、方法定义
```java
public static void logout(final Activity paramActivity) ;
```
#### 2.15.2、参数说明 ####
#### 2.15.2、参数说明
| 参数 | 说明 |
| ------------- | ---- |
......@@ -588,12 +589,13 @@ public static void logout(final Activity paramActivity) ;
说明:该接口在游戏切换账号时调用,切换成功回通知到登录监听回调中,调用前请判断是否含有此接口(hasSwitchAccount())
#### 2.16.1、方法定义 ####
#### 2.16.1、方法定义
```java
public static void switchAccount(final Activity paramActivity);
```
#### 2.16.2、参数说明 ####
#### 2.16.2、参数说明
| 参数 | 说明 |
| ------------- | ---- |
| paramActivity | 上下文 |
......