帮助文档

快发助手Object-C接入文档

1.介绍

快发助手SDK针对繁琐的越狱CP SDK接入过程，通过整合三方渠道，提供统一的功能函数入口，并提供多渠道一键打包方式，达到了高度简化接入流程、缩短项目周期、更加专注游戏本身的目的。

2.接入前准备

2.1 官网下载资源包，详细阅读快发助手参考文档。解压后文件目录如下：

ios-1.jpg

2.2 联系运营或者官网注册获取GameKey等信息，供后面游戏接入使用。

2.3 收集CP参数配置信息（参数配置：参见3.8）。

2.4 接入环境（推荐xcode6.0++）。

3.接入流程

3.1 将之前准备阶段下载的资源包解压，将目录下的lib文件夹下面的所有文件拖放项目目录中，并且勾选Copy items if needed选项。效果参见下图：

ios-2.jpg

3.2 设置属性：targets ->Build phases ->Link Binary With Libraries & targets ->build phases ->Embed Frameworks；效果如下：

ios-3.jpg

3.3 设置属性：targets ->Build Settings ->Linking ->Runpath Search Paths属性，添加依赖项：@executable_path/；targets ->Build Settings ->Linking ->Mach-O Type属性，添加依赖项Executable；效果图如下：

ios-4.jpg

3.4 设置属性：targets ->Build Settings ->Code Signing Resource Rules Path属性，添加依赖项：$(SDKROOT)/ResourceRules.plist；效果图如下：

ios-5.jpg

3.5 设置屏幕支持方向

3.6 设置属性：targets –>Info ->URL Types，添加2个URL Schemes，Identifier分别为MyGameSchemes和alipay。推荐URL Schemes值为Identifier + your bundleID的方式，效果图如下：

ios-6.jpg

3.7 设置游戏Icon Image和LaunchImage（请注意iOS图标尺寸标准，快发助手打包过程只添加角标，不对尺寸做出更改）。

3.8 根据准备阶段收集的KEY，填写Configure.xml配置文件，如下： 

<?xml version="1.0" encoding="UTF-8"?>
<!-- 平台初始化配置文件-->
<confingure>
    
    <!-- 整合平台key -->
    <PTGameKey>0e0e978cb50c65f5e725ce0f5b5095f5</PTGameKey>
    <!-- 整合平台渠道号 -->
    <PTGameChannel></PTGameChannel>
    
    <!-- 渠道名称 -->
    <CPName>dl</CPName>
    <!-- 渠道版本号 -->
    <CPVersion>1.0.0</CPVersion>
    <!-- 渠道分配appid -->
    <CPAppID>195</CPAppID>
    <!-- 渠道分配appKey -->
    <CPAppKey>j5VEvxhc</CPAppKey>
    <!-- 渠道 Gamekey -->
    <CPGameKey></CPGameKey>
    <!-- 渠道 GameChannel -->
    <CPGameChannel></CPGameChannel>
    <!-- 给平台预留的私有key 比如:cukey -->
    <CPPrivateKey></CPPrivateKey>
    <!-- 是否开启自动登录 1:开启 2:关闭 -->
    <CPAutoLogin>1</CPAutoLogin>
    <!-- 是否强制更新 1:开启 2:关闭 -->
    <CPForceUpdate>1</CPForceUpdate>
    <!-- 是否强制登录 1:开启 2:关闭 -->
    <CPForceLogin>1</CPForceLogin>
    
    <!-- 是否调试模式 1:调试模式(debug)  0:发布模式(release)  -->
    <DEV_ISDebugModel>1</DEV_ISDebugModel>
    <!-- 是否显示浮动框或者操作条 1:显示   0:不显示 -->
    <DEV_ShowFloatWindowOrBar>1</DEV_ShowFloatWindowOrBar>
    <!-- 悬浮框停靠的位置 1:上左 2:上中 3:上右 4:中左  5:中右 6.底左 7:底中 8:底右 -->
    <DEV_FloatWindowOrBarScreenPlace>6</DEV_FloatWindowOrBarScreenPlace>
    <!-- 支持屏幕方向 1:竖屏正向 2:竖屏倒立 3:横屏左方向 4:横屏右方向 
        5:横屏双方向（不支持则3）6:横屏双方向（不支持则4） 7:所有方向（不支持则6）-->
    <DEV_SupportScreenOrientation>3</DEV_SupportScreenOrientation>
    
    <!-- 设置充值页面初始化金额 -->
    <PAY_DefaultPayAmount>10</PAY_DefaultPayAmount>
    <!-- 商户私有信息 -->
    <PAY_ShopingPrivateInfo>商户私有信息</PAY_ShopingPrivateInfo>
    <!-- 支付回调地址 -->
    <PAY_PayNotifyUrl>www.baidu.com</PAY_PayNotifyUrl>
    <!-- 商户ID -->
    <PAY_MerchantId>101</PAY_MerchantId>
    <!-- app 之间通信  支付宝 -->
    <PAY_AlipayScheme>alipay-com.gameworks.GameKitDemo</PAY_AlipayScheme>
    <!-- 应用Scheme -->
    <PAY_AppScheme>com.gameworks.GameKitDemo</PAY_AppScheme>

</confingure>

4.SDK接口说明

4.1 Configure.xml配置文件说明

参数 定义说明 取值说明
PTGameKey 整合平台key 快发助手提供
PTGameChannel 整合平台渠道号 快发助手提供
CPName 渠道名称 CP提供
CPVersion 渠道版本号 CP提供
CPAppID 渠道分配appid CP提供
CPAppKey 渠道分配appKey CP提供
CPGameKey 渠道的GameKey CP提供
CPGameChannel 渠道的GameChannel CP提供
CPPrivateKey 给平台预留的私有key CP提供
CPAutoLogin 是否开启自动登录 游戏方设定
1：自动登录 0：不自动登录
CPForceUpdate 是否强制更新 游戏方设定
1：开启 0：关闭
CPForceLogin 是否强制登录 游戏方设定
1：开启 0：关闭
DEV_ISDebugModel 是否为调试模式 游戏方设定
1：开启 0：关闭
DEV_ShowFloatWindowOrBar 是否显示悬浮框或者操作条 游戏方设定
1：显示 0：不显示
DEV_FloatWindowOrBarScreenPlace 悬浮框停靠位置 游戏方设定，必填
1.上左 2.上中 3.上右 4.中左 5.中右 6.底左 7.底中
8.底右
DEV_SupportScreenOrientation 屏幕方向 游戏方设定
1.竖屏正向 2.竖屏倒立
3.横屏左方向 4.横屏右方向
5.横屏双方向（不支持则3）
6.横屏双方向（不支持则4）
7.所有方向（不支持则6）
PAY_DefaultPayAmount 设置充值页面初始化金额 游戏方设定
PAY_ShopingPrivateInfo 商户私有信息 游戏方设定
PAY_PayNotifyUrl 支付回调地址 游戏方设定
PAY_AlipayScheme app之间通信 支付宝 游戏方设定，同URL Types的alipayScheme一致
PAY_MerchantId 商户ID 游戏方设定
PAY_AppScheme 应用Scheme 游戏方设定，同URL Types的MyGameSheme一致

4.2 函数接入流程

ios-7.jpg

4.3 CP功能点检测调用说明（可不接入）

函数定义 注释说明
-(BOOL)hasProvide_nomal_login_service; 检测渠道是否提供 用户名登录 服务
-(BOOL)hasProvide_guest_login_service; 检测渠道是否提供 快速登录 服务
-(BOOL)hasProvide_gusetTonomal_service; 检测渠道是否提供 快速登录用户转为注册用户 服务
-(BOOL)hasProvide_isLogined_service; 检测渠道是否提供 检查是否登录 服务
-(BOOL)hasProvide_getloginedUser_service; 检测渠道是否提供 获取登录用户信息 服务
-(BOOL)hasProvide_loginout_service; 检测渠道是否提供 注销登录 服务
-(BOOL)hasProvide_usercenter_service; 检测渠道是否提供 进入用户中心 服务
-(BOOL)hasProvide_changeuser_service; 检测渠道是否提供 切换用户 服务
-(BOOL)hasProvide_openurl_service; 检测渠道是否提供 openUrl 服务
-(BOOL)hasProvide_checkupdate_service; 检测渠道是否提供 检查更新 服务
-(BOOL)hasProvide_pay_service; 检测渠道是否提供 支付充值 服务
-(BOOL)hasProvide_checkorder_service; 检测渠道是否提供 订单查询 服务
-(BOOL)hasProvide_showFloatWindowOrBar_service; 检测渠道是否提供 显示/隐藏浮动窗口或者操作栏 服务
-(BOOL)hasProvide_statistics_UserLogin_service; 检查渠道是否提供 统计用户登录 服务
-(BOOL)hasProvide_statistics_Pay_service; 检查渠道是否提供 统计支付 服务
-(BOOL)hasProvide_statistics_CreateRole_service; 检查渠道是否提供 统计玩家创建角色 服务
-(BOOL)hasProvide_statistics_UserUpGrade_service; 检查渠道是否提供 统计玩家升级 服务
-(BOOL)hasProvide_statistics_BtnClickEvent_service; 检查渠道是否提供 统计按钮点击 服务
-(BOOL)hasProvide_response_continueEvent_service; 检查渠道是否提供 响应游戏继续 事件处理服务
-(BOOL)hasProvide_response_suspendEvent_service; 检查渠道是否提供 响应游戏暂停 事件处理服务
-(BOOL)hasProvide_response_stopEvent_service; 检查渠道是否提供 响应游戏停止 事件处理服务

4.4 SDK 回调函数接入API

函数定义 注释说明
-(void)gameKitInitCompletedISSucceedStatus:(BOOL) isSucceed error:(GWError *)error; 平台初始化回调函数
-(void)rigisterCompletedWithResponseData:(GWUserInfo *)obj; 注册成功回调函数
-(void)loginCompletedWithLoginStatus:(LoginStatus)loginStatus responseObj:(GWUserIn
fo *)obj error:(GWError *)error; 		登录回调接口
-(void)payCompletedWithPayStatus:(PayStatus)payStatus responseObj:(GWPayBackInfo *
)obj error:(GWError *)error; 		支付回调接口
-(void)LoginOutCompletedISSucceedStatus:(BOOL) isSucceed error:(GWError *)error; 登录注销完成回调
-(void)checkOrderCompletedWithData:(GWCheckOrderInfo *)obj error:(GWError *)error; 订单查询
-(void)checkUpdateCompletedWithData:(GWUpdateInfo *)obj error:(GWError *)error; 检查更新获取回调数据

4.5 功能函数API调用说明

函数定义 注释说明
+(GameKitSDK *)defaultSdk; 获取单例对象
-(void)initWithObserver:(id) observer params:(GameKitInitParam *)params; 注册统一回调函数&&初始化参数
-(void)nomalLogin; 登录
-(void)guestLogin; 游客登录（快速登录）
-(void)guestRegist; 游客转为注册账号
-(bool)isLogined; 是否登录
-(void)loginOut; 注销登录
-(void)userCenter; 用户中心
-(void)swapAccount; 切换用户
-(GWUserInfo *)loginUserInfo; 获取登录用户信息
-(void)pay:(GWPayOrder *)order; 提交订单
-(void)checkOrder:(NSString *)orderId; 查询订单（非必须接入）
-(void)showFloatWindowOrBar:(BOOL) isShow; 是否显示浮动窗口或者操作栏
-(void)checkUpdate; 检查更新
-(void)statisticsUserLogin:(NSDictionary *)info; 用户登录统计（非必须接入）
-(void)statisticsPay:(NSDictionary *)order; 支付统计（非必须接入）
-(void)statisticsUserUpGrade:(NSDictionary *)info; 玩家升级统计（非必须接入）
-(void)statisticsCreateRole:(NSDictionary *)info; 玩家创建角色统计（非必须接入）
-(void)statisticsBtnClickEvent:(NSDictionary *)info; 按钮点击统计（非必须接入）
-(void)gameContinueEvent; 继续游戏（非必须接入）
-(void)gameSuspendEvent; 暂停游戏（非必须接入）
-(void)gameStopEvent; 停止游戏
-(void)application:(UIApplication *)application openURL:(NSURL *)url sourceAp
plication:(NSString *)sourceApplication annotation:(id)annotation; 		open url 跳转

5.常见接入错误处理

参见：demo

6.技术支持

点击访问：快发助手开发者社区
QQ：940111913
Email：support@haojieru.com

为了尽快响应您的反馈，请提供您的gamekey及log中的详细出错日志，您所提供的内容越详细越有助于我们帮您解决问题。