add 创角接口说明

chufan
Commit d1fd055f2c8dacf72beade6db69a37f37ca3800d d1fd055f 1 parent 148f7d4d
Showing 1 changed file with 63 additions and 63 deletions
publicAndroidSDK/doc/公共SDK客户端接入文档.md
--- a/publicAndroidSDK/doc/公共SDK客户端接入文档.md
View file @d1fd055
+++ b/publicAndroidSDK/doc/公共SDK客户端接入文档.md
View file @d1fd055
@@ -20,7 +20,7 @@
 #### 1.3、修改游戏工程的AndroidManifest.xml（可以参照复制Demo中	AndroidManifest.xml文件） ####
 - 添加声明权限：
-- 
+- 
 ```xml
         <uses-permission android:name="android.permission.INTERNET" />
         <uses-permission android:name="android.permission.WRITE_EXTERNAL_STORAGE" />
@@ -123,10 +123,10 @@
         2.2.1、方法定义
             public static void init(final Activity activity,final PoolSDKCallBackListener callBackListener) 
         2.2.2、参数说明
-参数 |说明
+| 参数               | 说明                               |
------------- 		| ------------- 
+| ---------------- | -------------------------------- |
-activity 			| Activity 对应  
+| activity         | Activity 对应                      |
-callBackListener 	| 初始化完成回调通知,需实现 poolSdkCallBack 方法        	
+| callBackListener | 初始化完成回调通知,需实现 poolSdkCallBack 方法 |
         2.2.3、代码示例:
         PoolSdkHelper.init(this, new PoolSDKCallBackListener() {
@@ -150,10 +150,10 @@ callBackListener 	| 初始化完成回调通知,需实现 poolSdkCallBack 方法
         2.3.1、方法定义
         public static void login(final String paramCustom,final 			PoolLoginListener poolLoginListener)
         2.3.2、参数说明
-参数 |说明
+| 参数                | 说明                                       |
------------- 		| ------------- 
+| ----------------- | ---------------------------------------- |
-paramCustom 		| 游戏自定义参数,可通过登录成功回调方法onLoginSuccess 中的参数PoolLoginInfo 对象的 getCustom()获取  
+| paramCustom       | 游戏自定义参数,可通过登录成功回调方法onLoginSuccess 中的参数PoolLoginInfo 对象的 getCustom()获取 |
-poolLoginListener 	| 登录结果回调通知,需实现 onLoginSuccess 方法
+| poolLoginListener | 登录结果回调通知,需实现 onLoginSuccess 方法           |
 	    2.3.3、代码示例
 			PoolSdkHelper.login("登录自定义字段", new PoolLoginListener() {
@@ -176,34 +176,34 @@ poolLoginListener 	| 登录结果回调通知,需实现 onLoginSuccess 方法
 	2.4、提交角色数据接口(必接)
 	    接口说明:游戏提交角色数据接口,该接口需要在以下 3 中情况下
-        调用:进入游戏主场景、创建角色、角色升级
+	    调用:进入游戏主场景、创建角色、角色升级(如果游戏创建角色时没有角色名，需要在用户创建角色名时调用多一次进入游戏统计，否则用户名无法正常统计，投放测试无法通过)
 	    2.4.1、方法定义
 	    public static void submitRoleData(final PoolRoleInfo poolRoleInfo,
 			final PoolRoleListener poolRoleListener)
 		2.4.2、参数说明
-参数 |说明
+| 参数               | 说明               |
------------- 		| ------------- 
+| ---------------- | ---------------- |
-poolRoleInfo 		| 角色数据实体类
+| poolRoleInfo     | 角色数据实体类          |
-poolRoleListener 	| 角色数据提交结果回调通知,需实现
+| poolRoleListener | 角色数据提交结果回调通知,需实现 |
 		PoolRoleInfo 实体类字段说明
-字段名 				|说明
+| 字段名            | 说明                                       |
------------- 		| ------------- 
+| -------------- | ---------------------------------------- |
-callType 			| 调用类型Type_EnterGame 登录游戏主 场景;Type_CreatRole 为创建角 色;Type_RoleUpgrade 为角色升级
+| callType       | 调用类型Type_EnterGame 登录游戏主 场景;Type_CreatRole 为创建角 色;Type_RoleUpgrade 为角色升级 |
-roleId			 	| 角色 Id
+| roleId         | 角色 Id                                    |
-roleName 			| 角色名称
+| roleName       | 角色名称                                     |
-roleLevel 			| 角色等级
+| roleLevel      | 角色等级                                     |
-roleSex 			| 角色性别(1 男 0 女,如果角 色不分性别请填写 0)
+| roleSex        | 角色性别(1 男 0 女,如果角 色不分性别请填写 0)             |
-serverId 			| 服务器 id
+| serverId       | 服务器 id                                   |
-serverName 			| 服务器名称
+| serverName     | 服务器名称                                    |
-custom 				| 自定义字段
+| custom         | 自定义字段                                    |
-roleCTime 			| 角色创建时间(秒)
+| roleCTime      | 角色创建时间(秒)                                |
-partyName 			| 公会名称
+| partyName      | 公会名称                                     |
-roleType 			| 角色类型
+| roleType       | 角色类型                                     |
-roleChangeTime 		| 角色等级更新时间(以秒为单位)
+| roleChangeTime | 角色等级更新时间(以秒为单位)                          |
-vipLevel 			| VIP等级
+| vipLevel       | VIP等级                                    |
-diamond 			| 余额
+| diamond        | 余额                                       |
-moneyType 			| 商品单位
+| moneyType      | 商品单位                                     |
 		2.4.3、代码示例
 		/********************************************
@@ -239,24 +239,24 @@ moneyType 			| 商品单位
 	    2.5.1、方法定义
 	        public static void pay(final PoolPayInfo poolPayInfo,final PoolPayListener poolPayListener)
 	    2.5.2、参数说明
-参数 |说明
+| 参数               | 说明               |
------------- 		| ------------- 
+| ---------------- | ---------------- |
-poolRoleInfo 		| 角色数据实体类
+| poolRoleInfo     | 角色数据实体类          |
-poolRoleListener 	| 角色数据提交结果回调通知,需实现
+| poolRoleListener | 角色数据提交结果回调通知,需实现 |
 	   支付信息实体类(PoolPayInfo)字段说明
-参数 |说明
+| 参数          | 说明                  |
------------- 		| ------------- 
+| ----------- | ------------------- |
-amount 		| 金额(单位元,必须大于 0)
+| amount      | 金额(单位元,必须大于 0)      |
-productId 	| 商品 ID(如果没有可以传空字符 串)
+| productId   | 商品 ID(如果没有可以传空字符 串) |
-productName | 商品描述
+| productName | 商品描述                |
-roleid 		| 角色 id
+| roleid      | 角色 id               |
-rolelevel 		| 角色等级
+| rolelevel   | 角色等级                |
-roleName 	| 角色名称
+| roleName    | 角色名称                |
-serverId 		| 服务器 id
+| serverId    | 服务器 id              |
-serverName 	| 服务器名称
+| serverName  | 服务器名称               |
-exchange 		| 游戏币与人民币(元)的兑换比例
+| exchange    | 游戏币与人民币(元)的兑换比例     |
-custom 	| 自定义透传参数,通过回调函数原样返回
+| custom      | 自定义透传参数,通过回调函数原样返回  |
 	   2.5.3、代码示例
 	        /********************************************
@@ -323,9 +323,9 @@ custom 	| 自定义透传参数,通过回调函数原样返回
 	2.8.1、方法定义
 	public static void setLogoutCallback(final PoolLogoutListener poolLogoutListener)
 	2.8.2、参数说明
-参数 |说明
+| 参数                 | 说明                                |
------------- 			| ------------- 
+| ------------------ | --------------------------------- |
-poolLogoutListener 		| 账户注销成功回调监听,需实现 onLogoutSuccess 方法
+| poolLogoutListener | 账户注销成功回调监听,需实现 onLogoutSuccess 方法 |
     2.8.3、代码示例
         PoolSdkHelper.setLogoutCallback(new PoolLogoutListener() {
@@ -344,9 +344,9 @@ poolLogoutListener 		| 账户注销成功回调监听,需实现 onLogoutSuccess 
     	2.9.1、方法定义
     	    public static void showExitDialog(final PoolExitDialogListener exitDialogListener)
     	2.9.2、参数说明
-  参数 |说明
+| 参数                 | 说明                             |
------------- 			| ------------- 
+| ------------------ | ------------------------------ |
-exitDialogListener 		| 退出结果回调监听,需实现 onDialogResult 方法
+| exitDialogListener | 退出结果回调监听,需实现 onDialogResult 方法 |
     	2.9.3、代码示例
@@ -469,10 +469,10 @@ exitDialogListener 		| 退出结果回调监听,需实现 onDialogResult 方法
     	2.11.1、方法定义
     		public static void expansionInterface(final String paramCustom,final PoolExpansionListener poolExpansionListener)
     	2.11.2、参数说明
- 参数 |说明
+| 参数                    | 说明                   |
------------- 			| ------------- 
+| --------------------- | -------------------- |
-paramCustom 			| 自定义参数
+| paramCustom           | 自定义参数                |
-poolExpansionListener 	| 方法回调参数,实现onSuccess方法
+| poolExpansionListener | 方法回调参数,实现onSuccess方法 |
     2.12、获取渠道包标识(可选)
         接口名称:PoolSdkHelper.getGameChannelId()
@@ -492,9 +492,9 @@ poolExpansionListener 	| 方法回调参数,实现onSuccess方法
     	2.15.1、方法定义
     	public static void logout(final Activity paramActivity) ;
     	2.15.2、参数说明
-参数 |说明
+| 参数            | 说明   |
------------- 			| ------------- 
+| ------------- | ---- |
-paramActivity 			| 上下文
+| paramActivity | 上下文  |
 		2.15.3、代码示例
 		private void logout(){
@@ -507,9 +507,9 @@ paramActivity 			| 上下文
 		2.16.1、方法定义
 		public static void switchAccount(final Activity paramActivity)；
 		2.16.2、参数说明
-参数 |说明
+| 参数            | 说明   |
------------- 			| ------------- 
+| ------------- | ---- |
-paramActivity 			| 上下文
+| paramActivity | 上下文  |
 		2.16.3、代码示例
 		/**