Commit f444066a384fae381ecf92f88f74a6ea779770d0
Exists in
master
Merge branch 'master' of http://git.letsgame.mobi/document/gumptech-document.git
Showing 4 changed files Inline Diff
doc/AndroidDocument.md
1 | # Gump Android SDK使用文档 | 1 | # Gump Android SDK使用文档 |
2 | 2 | ||
3 | 3 | ||
4 | 接入手册 | 4 | 接入手册 |
5 | V 2.3.1 | 5 | V 2.3.1 |
6 | 2015年01月08日 | 6 | 2015年01月08日 |
7 | 7 | ||
8 | 快速入口: | 8 | 快速入口: |
9 | [支付部分服务端回调文档](http://git.letsgame.mobi/document/gumptech-document/blob/master/ServerDocument.md) | 9 | [支付部分服务端回调文档](http://git.letsgame.mobi/document/gumptech-document/blob/master/doc/ServerDocument.md) |
10 | 10 | ||
11 | ## 目录 | 11 | ## 目录 |
12 | 12 | ||
13 | * [第一章 接入指南](http://git.letsgame.mobi/document/gumptech-document/blob/master/AndroidDocument.md#) | 13 | * [第一章 接入指南](http://git.letsgame.mobi/document/gumptech-document/blob/master/AndroidDocument.md#) |
14 | - [1. 导入资源工程](http://git.letsgame.mobi/document/gumptech-document/blob/master/AndroidDocument.md#1) | 14 | - [1. 导入资源工程](http://git.letsgame.mobi/document/gumptech-document/blob/master/AndroidDocument.md#1) |
15 | - [2. 添加资源工程](http://git.letsgame.mobi/document/gumptech-document/blob/master/AndroidDocument.md#2) | 15 | - [2. 添加资源工程](http://git.letsgame.mobi/document/gumptech-document/blob/master/AndroidDocument.md#2) |
16 | - [3. 代码实现](http://git.letsgame.mobi/document/gumptech-document/blob/master/AndroidDocument.md#3) | 16 | - [3. 代码实现](http://git.letsgame.mobi/document/gumptech-document/blob/master/AndroidDocument.md#3) |
17 | > [1.修改AndroidManifest.xml文件](http://git.letsgame.mobi/document/gumptech-document/blob/master/AndroidDocument.md#1-androidmanifest-xml) | 17 | > [1.修改AndroidManifest.xml文件](http://git.letsgame.mobi/document/gumptech-document/blob/master/AndroidDocument.md#1-androidmanifest-xml) |
18 | > [2.向Gump平台索要游戏ID(GID),完成代码接入](http://git.letsgame.mobi/document/gumptech-document/blob/master/AndroidDocument.md#2-gump-id-gid) | 18 | > [2.向Gump平台索要游戏ID(GID),完成代码接入](http://git.letsgame.mobi/document/gumptech-document/blob/master/AndroidDocument.md#2-gump-id-gid) |
19 | * [第二章 常见问题](http://git.letsgame.mobi/document/gumptech-document/blob/master/AndroidDocument.md#) | 19 | * [第二章 常见问题](http://git.letsgame.mobi/document/gumptech-document/blob/master/AndroidDocument.md#) |
20 | - [问题1: 如何避免混淆对SDK的影响?](http://git.letsgame.mobi/document/gumptech-document/blob/master/AndroidDocument.md#1-sdk) | 20 | - [问题1: 如何避免混淆对SDK的影响?](http://git.letsgame.mobi/document/gumptech-document/blob/master/AndroidDocument.md#1-sdk) |
21 | - [问题2:后台已经配置ok的情况下,支付列表仍然为空或登录总是出错?](http://git.letsgame.mobi/document/gumptech-document/blob/master/doc/AndroidDocument.md#2-ok) | 21 | - [问题2:后台已经配置ok的情况下,支付列表仍然为空或登录总是出错?](http://git.letsgame.mobi/document/gumptech-document/blob/master/doc/AndroidDocument.md#2-ok) |
22 | 22 | ||
23 | 23 | ||
24 | 24 | ||
25 | 25 | ||
26 | ## 第一章 接入指南 | 26 | ## 第一章 接入指南 |
27 | 配置环境 | 27 | 配置环境 |
28 | 28 | ||
29 | 本接口API 适用于Android2.2以上各版本Android平台。 | 29 | 本接口API 适用于Android2.2以上各版本Android平台。 |
30 | ### 1. 导入资源工程 | 30 | ### 1. 导入资源工程 |
31 | 1.将LoginSDK资源工程拷贝到工作空间,在eclipse中的导航栏右键弹出如图1画面,选择Import导入资源工程,如图1. | 31 | 1.将LoginSDK资源工程拷贝到工作空间,在eclipse中的导航栏右键弹出如图1画面,选择Import导入资源工程,如图1. |
32 | 32 | ||
33 |  | 33 |  |
34 | 图1 | 34 | 图1 |
35 | 35 | ||
36 | 2.导入工程后,右键此工程,在Properties->Android中选中此工程为library工程(勾选红色方框标识处)如图2。 | 36 | 2.导入工程后,右键此工程,在Properties->Android中选中此工程为library工程(勾选红色方框标识处)如图2。 |
37 |  | 37 |  |
38 | 图 2 | 38 | 图 2 |
39 | ### 2. 添加资源工程 | 39 | ### 2. 添加资源工程 |
40 | 添加资源工程为游戏项目的 library。右键游戏项目,在Properties->Android中点击Add添加资源工程为项目工程的library,结果如图3。 | 40 | 添加资源工程为游戏项目的 library。右键游戏项目,在Properties->Android中点击Add添加资源工程为项目工程的library,结果如图3。 |
41 |  | 41 |  |
42 | 图 3 | 42 | 图 3 |
43 | 43 | ||
44 | 44 | ||
45 | 注意:如果ADT版本低于14,ADT不支持jar包自动引入,请手动拷贝libs到您的工作 | 45 | 注意:如果ADT版本低于14,ADT不支持jar包自动引入,请手动拷贝libs到您的工作 |
46 | 空间。 | 46 | 空间。 |
47 | 47 | ||
48 | Eclipse查看ADT版本号的方法: | 48 | Eclipse查看ADT版本号的方法: |
49 | Help==>About Eclips点击Android对应的图标就可以查看版本了. | 49 | Help==>About Eclips点击Android对应的图标就可以查看版本了. |
50 | 如图,红色框部分就是ADT版本号。 | 50 | 如图,红色框部分就是ADT版本号。 |
51 | 51 | ||
52 |  | 52 |  |
53 | 53 | ||
54 | 54 | ||
55 | ### 3. 代码实现 | 55 | ### 3. 代码实现 |
56 | #### 1、 修改AndroidManifest.xml文件 | 56 | #### 1、 修改AndroidManifest.xml文件 |
57 | 首先添加必要的权限,如下所示: | 57 | 首先添加必要的权限,如下所示: |
58 | 58 | ||
59 | <uses-permission android:name="android.permission.INTERNET" /> | 59 | <uses-permission android:name="android.permission.INTERNET" /> |
60 | <uses-permission android:name="android.permission.READ_PHONE_STATE" /> | 60 | <uses-permission android:name="android.permission.READ_PHONE_STATE" /> |
61 | <uses-permission android:name="android.permission.BLUETOOTH" /> | 61 | <uses-permission android:name="android.permission.BLUETOOTH" /> |
62 | <uses-permission android:name="android.permission.ACCESS_WIFI_STATE" /> | 62 | <uses-permission android:name="android.permission.ACCESS_WIFI_STATE" /> |
63 | <uses-permission android:name="android.permission.WRITE_SETTINGS"/> | 63 | <uses-permission android:name="android.permission.WRITE_SETTINGS"/> |
64 | <uses-permission android:name="android.permission.GET_ACCOUNTS"/> | 64 | <uses-permission android:name="android.permission.GET_ACCOUNTS"/> |
65 | <uses-permission android:name="android.permission.ACCESS_NETWORK_STATE"/> | 65 | <uses-permission android:name="android.permission.ACCESS_NETWORK_STATE"/> |
66 | <uses-permission android:name="android.permission.WRITE_EXTERNAL_STORAGE"/> | 66 | <uses-permission android:name="android.permission.WRITE_EXTERNAL_STORAGE"/> |
67 | <uses-permission android:name="android.permission.MOUNT_UNMOUNT_FILESYSTEMS"/> | 67 | <uses-permission android:name="android.permission.MOUNT_UNMOUNT_FILESYSTEMS"/> |
68 | 68 | ||
69 | <!-- VERY IMPORTANT! Don't forget this permission, or in-app billing won't work. --> | 69 | <!-- VERY IMPORTANT! Don't forget this permission, or in-app billing won't work. --> |
70 | <uses-permission android:name="com.android.vending.BILLING" /> | 70 | <uses-permission android:name="com.android.vending.BILLING" /> |
71 | 71 | ||
72 | 其次注册相应的Activity,具体如下: | 72 | 其次注册相应的Activity,具体如下: |
73 | 73 | ||
74 | <activity | 74 | <activity |
75 | android:name="com.gumptech.sdk.ContainerActivity" | 75 | android:name="com.gumptech.sdk.ContainerActivity" |
76 | android:theme="@style/container_dialog" | 76 | android:theme="@style/container_dialog" |
77 | android:configChanges="orientation|screenLayout" > | 77 | android:configChanges="orientation|screenLayout" > |
78 | </activity> | 78 | </activity> |
79 | <activity | 79 | <activity |
80 | android:name="com.facebook.LoginActivity" | 80 | android:name="com.facebook.LoginActivity" |
81 | android:theme="@android:style/Theme.Translucent.NoTitleBar" > | 81 | android:theme="@android:style/Theme.Translucent.NoTitleBar" > |
82 | </activity> | 82 | </activity> |
83 | <activity | 83 | <activity |
84 | android:name="com.gumptech.sdk.PaymentActivity" | 84 | android:name="com.gumptech.sdk.PaymentActivity" |
85 | android:configChanges="orientation|screenLayout" | 85 | android:configChanges="orientation|screenLayout" |
86 | android:theme="@android:style/Theme.Translucent.NoTitleBar" > | 86 | android:theme="@android:style/Theme.Translucent.NoTitleBar" > |
87 | </activity> | 87 | </activity> |
88 | <activity | 88 | <activity |
89 | android:name="com.gumptech.sdk.ExchangeWindow" | 89 | android:name="com.gumptech.sdk.ExchangeWindow" |
90 | android:configChanges="orientation|screenLayout" | 90 | android:configChanges="orientation|screenLayout" |
91 | android:theme="@style/ex_win" > | 91 | android:theme="@style/ex_win" > |
92 | </activity> | 92 | </activity> |
93 | <service android:name="com.gumptech.sdk.PushService" > | 93 | <service android:name="com.gumptech.sdk.PushService" > |
94 | </service> | 94 | </service> |
95 | 95 | ||
96 | 96 | ||
97 | #### 2、 向Gump平台索要游戏ID(GID),完成代码接入 | 97 | #### 2、 向Gump平台索要游戏ID(GID),完成代码接入 |
98 | 1.调用GumpSDK前需要执行初始化。 | 98 | 1.调用GumpSDK前需要执行初始化。 |
99 | 若不需要分渠道 | 99 | 若不需要分渠道 |
100 | 100 | ||
101 | GumpSDK.init(Context,Appid, Appkey); | 101 | GumpSDK.init(Context,Appid, Appkey); |
102 | 如果需要定义渠道,必须使用如下方法 | 102 | 如果需要定义渠道,必须使用如下方法 |
103 | 103 | ||
104 | GumpSDK.init(Context,Appid, Appkey,ChannelId); | 104 | GumpSDK.init(Context,Appid, Appkey,ChannelId); |
105 | *gump logo的显示控制方法,此方法参数指定是否显示GumpLogo | 105 | *gump logo的显示控制方法,此方法参数指定是否显示GumpLogo |
106 | 106 | ||
107 | GumpSDK.setShowLogo(boolean); | 107 | GumpSDK.setShowLogo(boolean); |
108 | 2.调用GumpSDK的开始方法,将执行登录流程,需要一个Activity实例作参数 | 108 | 2.调用GumpSDK的开始方法,将执行登录流程,需要一个Activity实例作参数 |
109 | 109 | ||
110 | GumpSDK.start(Activity); | 110 | GumpSDK.start(Activity); |
111 | 开发者需要在调用的Activity里重写onActivityResult方法以接受用户的登录结果,通常如下: | 111 | 开发者需要在调用的Activity里重写onActivityResult方法以接受用户的登录结果,通常如下: |
112 | 112 | ||
113 | //登录请求返回结果 | 113 | //登录请求返回结果 |
114 | if (requestCode == GumpSDK.LOGIN_REQUEST_CODE) { | 114 | if (requestCode == GumpSDK.LOGIN_REQUEST_CODE) { |
115 | if (resultCode == RESULT_OK) { | 115 | if (resultCode == RESULT_OK) { |
116 | String uid = data.getIntExtra("userId", -1); | 116 | String uid = data.getIntExtra("userId", -1); |
117 | int accountType = data.getIntExtra("accountType", -1); | 117 | int accountType = data.getIntExtra("accountType", -1); |
118 | String sessionkey = data.getStringExtra("sessionKey"); | 118 | String sessionkey = data.getStringExtra("sessionKey"); |
119 | 119 | ||
120 | } else if (resultCode == RESULT_CANCELED) { | 120 | } else if (resultCode == RESULT_CANCELED) { |
121 | Toast.makeText(this, "operate be canceled", Toast.LENGTH_SHORT).show(); | 121 | Toast.makeText(this, "operate be canceled", Toast.LENGTH_SHORT).show(); |
122 | } | 122 | } |
123 | } | 123 | } |
124 | 124 | ||
125 | 如上将收到成功登录用的userid,此Id标识唯一用户! | 125 | 如上将收到成功登录用的userid,此Id标识唯一用户! |
126 | 126 | ||
127 | 3.支付功能(已过期,请优先考虑手机页面支付,参考地址:[GumpTech页面支付](http://git.letsgame.mobi/document/gumptech-document/blob/master/doc/webpay.md) ) | 127 | 3.支付功能(已过期,请优先考虑手机页面支付,参考地址:[GumpTech页面支付](http://git.letsgame.mobi/document/gumptech-document/blob/master/doc/webpay.md) ) |
128 | 1)使用gump通行证登录 | 128 | 1)使用gump通行证登录 |
129 | 129 | ||
130 | Bundle payInfo = new Bundle(); | 130 | Bundle payInfo = new Bundle(); |
131 | payInfo.putString("nick", "thi"); | 131 | payInfo.putString("nick", "thi"); |
132 | payInfo.putString("product", "元宝"); | 132 | payInfo.putString("product", "元宝"); |
133 | payInfo.putFloat("amount", 40.0f); | 133 | payInfo.putFloat("amount", 40.0f); |
134 | payInfo.putString("extraInfo", "This is demo!"); | 134 | payInfo.putString("extraInfo", "This is demo!"); |
135 | payInfo.putString("serverId", "B4003"); | 135 | payInfo.putString("serverId", "B4003"); |
136 | payInfo.putString("roleId", "10010"); | 136 | payInfo.putString("roleId", "10010"); |
137 | GumpSDK.pay(MainActivity.this, payInfo); | 137 | GumpSDK.pay(MainActivity.this, payInfo); |
138 | 调用pay方法时,必须穿入一个bundle对象,包含如上字段,可以设置值为空,但是字段必须全部包含,支付完成仍然通过onActivityResult回调,requestCode为GumpSDK.PAY_REQUEST_CODE,回调信息除code和msg外,还含有orderId和传入的extraInfo. | 138 | 调用pay方法时,必须穿入一个bundle对象,包含如上字段,可以设置值为空,但是字段必须全部包含,支付完成仍然通过onActivityResult回调,requestCode为GumpSDK.PAY_REQUEST_CODE,回调信息除code和msg外,还含有orderId和传入的extraInfo. |
139 | 2)未使用gump通行证登录,需要传入用户id | 139 | 2)未使用gump通行证登录,需要传入用户id |
140 | 140 | ||
141 | Bundle payInfo = new Bundle(); | 141 | Bundle payInfo = new Bundle(); |
142 | payInfo.putString("nick", "thi"); | 142 | payInfo.putString("nick", "thi"); |
143 | payInfo.putString("product", "元宝"); | 143 | payInfo.putString("product", "元宝"); |
144 | payInfo.putFloat("amount", 40.0f); | 144 | payInfo.putFloat("amount", 40.0f); |
145 | payInfo.putString("extraInfo", "This is demo!"); | 145 | payInfo.putString("extraInfo", "This is demo!"); |
146 | payInfo.putString("serverId", "B4003"); | 146 | payInfo.putString("serverId", "B4003"); |
147 | payInfo.putString("roleId", "10010"); | 147 | payInfo.putString("roleId", "10010"); |
148 | GumpSDK.pay(MainActivity.this, payInfo,"1021"); | 148 | GumpSDK.pay(MainActivity.this, payInfo,"1021"); |
149 | 5.注销登录 | 149 | 5.注销登录 |
150 | 150 | ||
151 | GumpSDK.logout(Activity,GumpSDK.Callback); | 151 | GumpSDK.logout(Activity,GumpSDK.Callback); |
152 | 当此方法调用后,用户退出登录,并会通过callback接口通知调用程序! | 152 | 当此方法调用后,用户退出登录,并会通过callback接口通知调用程序! |
153 | ## 第二章 常见问题 | 153 | ## 第二章 常见问题 |
154 | ### 问题1: 如何避免混淆对SDK的影响? | 154 | ### 问题1: 如何避免混淆对SDK的影响? |
155 | 解答:有些开发者对接入了SDK的程序进行混淆时,有可能会覆盖某些java | 155 | 解答:有些开发者对接入了SDK的程序进行混淆时,有可能会覆盖某些java |
156 | 类,导致SDK无法正常工作,解决方法如下: | 156 | 类,导致SDK无法正常工作,解决方法如下: |
157 | Ø 请开发者在混淆配置文件proguard.cfg或proguard-project.txt的最后加上 | 157 | Ø 请开发者在混淆配置文件proguard.cfg或proguard-project.txt的最后加上 |
158 | 158 | ||
159 | -keep class com.gumptech.sdk.view.* {*;} | 159 | -keep class com.gumptech.sdk.view.* {*;} |
160 | -keep class com.gumptech.sdk.web.* {*;} | 160 | -keep class com.gumptech.sdk.web.* {*;} |
161 | -keep class com.gumptech.sdk.GumpSDK$Callback{ | 161 | -keep class com.gumptech.sdk.GumpSDK$Callback{ |
162 | void onLogout(); | 162 | void onLogout(); |
163 | } | 163 | } |
164 | -keep class com.gumptech.sdk.GumpPreference{ | 164 | -keep class com.gumptech.sdk.GumpPreference{ |
165 | public static final <fields>; | 165 | public static final <fields>; |
166 | } | 166 | } |
167 | 167 | ||
168 | 使得混淆的时候不会影响SDK的命名空间。 | 168 | 使得混淆的时候不会影响SDK的命名空间。 |
169 | ### 问题2:后台已经配置ok的情况下,支付列表仍然为空或登录总是出错? | 169 | ### 问题2:后台已经配置ok的情况下,支付列表仍然为空或登录总是出错? |
170 | 解答:sdk在debug模式下使用的默认服务器地址是开发环境地址,此地址区别于正式环境地址,为开发调试用;若进行线上调试或正式环境测试,需要使用release模式来进行! | 170 | 解答:sdk在debug模式下使用的默认服务器地址是开发环境地址,此地址区别于正式环境地址,为开发调试用;若进行线上调试或正式环境测试,需要使用release模式来进行! |
171 | 一般在IDE中直接run应用到设备上使用的是debug证书安装,此时即处于debug模式;若要使用正式环境,应该使用正式证书签名打包后进行安装! | 171 | 一般在IDE中直接run应用到设备上使用的是debug证书安装,此时即处于debug模式;若要使用正式环境,应该使用正式证书签名打包后进行安装! |
doc/IOSDocument.md
1 | # Gump IOS SDK使用文档 | 1 | # Gump IOS SDK使用文档 |
2 | 2 | ||
3 | 3 | ||
4 | 接入手册 | 4 | 接入手册 |
5 | V | 5 | V |
6 | 2015年02月13日 | 6 | 2015年02月13日 |
7 | 7 | ||
8 | 8 | ||
9 | 9 | ||
10 | ## 1、添加动态库 | 10 | ## 1、添加动态库 |
11 | 在工程里添加FacebookSDK.framework、MobileCoreServices.framework、SystemConfiguration.framework、libz.dylib、CFNetwork.framework、libletsgame.a | 11 | 在工程里添加MobileCoreServices.framework、SystemConfiguration.framework、libz.dylib、CFNetwork.framework、libletsgame.a |
12 | 12 | ||
13 | 13 | ||
14 | ## 2、设置头文件搜索路径 | 14 | ## 2、设置头文件搜索路径 |
15 | 头文件只有LetsGameAPI.h和LSGAccount.h两个文件,引入头文件,并设置搜索路径。 | 15 | 头文件只有LetsGameAPI.h和LSGAccount.h两个文件,引入头文件,并设置搜索路径。 |
16 | 16 | ||
17 | 17 | ||
18 | ## 3、添加资源文件 | 18 | ## 3、添加资源文件 |
19 | 在工程里添加letsgame.bundle资源文件,里面包含图片及相关语言包 | 19 | 在工程里添加letsgame.bundle资源文件,里面包含图片及相关语言包 |
20 | 20 | ||
21 | 21 | ||
22 | ## 4、设置FacebookAppID和FacebookDisplayName | 22 | ## 4、在工程里添加SDK登录代码 |
23 | 在工程的info.plist里设置FacebookAppID和FacebookDisplayName | ||
24 | |||
25 | |||
26 | ## 5、在工程里添加SDK登录代码 | ||
27 | 23 | ||
28 | [LetsGameAPI instance].appId = @"100"; // 设置appId | 24 | [LetsGameAPI instance].appId = @"100"; // 设置appId |
29 | [LetsGameAPI instance].appKey = @"100"; // 设置appKey | 25 | [LetsGameAPI instance].appKey = @"100"; // 设置appKey |
30 | 26 | ||
31 | [[LetsGameAPI instance] showLoginView]; // 弹出登录页面 | 27 | [[LetsGameAPI instance] showLoginView]; // 弹出登录页面 |
32 | 28 | ||
33 | // 登录成功回调 | 29 | // 登录成功回调 |
34 | [LetsGameAPI instance].succBlock = ^(NSString *userId, NSString *sessionKey, LSGAccountType type) { | 30 | [LetsGameAPI instance].succBlock = ^(NSString *userId, NSString *sessionKey, LSGAccountType type) { |
35 | NSLog(@"%@", [NSString stringWithFormat:@"login succ: userId = %@, sessionKey = %@, accountType = %d", userId, sessionKey, type]); | 31 | NSLog(@"%@", [NSString stringWithFormat:@"login succ: userId = %@, sessionKey = %@, accountType = %d", userId, sessionKey, type]); |
36 | }; | 32 | }; |
37 | 33 | ||
38 | // 登录失败回调 | 34 | // 登录失败回调 |
39 | [LetsGameAPI instance].dismissBlock = ^() { | 35 | [LetsGameAPI instance].dismissBlock = ^() { |
40 | NSLog(@"dismiss without login"); | 36 | NSLog(@"dismiss without login"); |
41 | }; | 37 | }; |
42 | 38 | ||
43 | 39 | ||
44 | ## 6、在xxAppDelegate.h里添加代码 | ||
45 | |||
46 | - (BOOL)application:(UIApplication *)application openURL:(NSURL *)url sourceApplication:(NSString *)sourceApplication annotation:(id)annotation { | ||
47 | // attempt to extract a token from the url | ||
48 | return [[LetsGameAPI instance] handleOpenURL:url sourceApplication:sourceApplication]; | ||
49 | } | ||
50 | |||
51 | 这样facebook跳转到web或facebook app 后, 登录返回时,才能够把登录信息带回来 |
ios/.DS_Store
No preview for this file type
ios/ios_sdk_20150423.zip
No preview for this file type