SDK / GameSDK-Doc

Download as
Browse Code »

Commit d93fa779c43ed5acd7b1d4eadb51974b3a7e63fe

Authored by 赵康
2 parents dfd38d926e cd70fe72be
Exists in master

Merge branch 'master' of http://git.letsgame.mobi/document/gumptech-document.git

Showing 1 changed file Inline Diff

doc/AndroidDocument.md
Diff comments   View file @ d93fa77
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/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 21
22 22
23 23
24 24
25 ## 第一章 接入指南 25 ## 第一章 接入指南
26 配置环境 26 配置环境
27 27
28 本接口API 适用于Android2.2以上各版本Android平台。 28 本接口API 适用于Android2.2以上各版本Android平台。
29 ### 1. 导入资源工程 29 ### 1. 导入资源工程
30 1.将LoginSDK资源工程拷贝到工作空间，在eclipse中的导航栏右键弹出如图1画面，选择Import导入资源工程，如图1. 30 1.将LoginSDK资源工程拷贝到工作空间，在eclipse中的导航栏右键弹出如图1画面，选择Import导入资源工程，如图1.
31 31
32 ![](images/1.png) 32 ![](images/1.png)
33 图1 33 图1
34 34
35 2.导入工程后，右键此工程，在Properties->Android中选中此工程为library工程（勾选红色方框标识处）如图2。 35 2.导入工程后，右键此工程，在Properties->Android中选中此工程为library工程（勾选红色方框标识处）如图2。
36 ![](images/2.png) 36 ![](images/2.png)
37 图 2 37 图 2
38 ### 2. 添加资源工程 38 ### 2. 添加资源工程
39 添加资源工程为游戏项目的 library。右键游戏项目，在Properties->Android中点击Add添加资源工程为项目工程的library，结果如图3。 39 添加资源工程为游戏项目的 library。右键游戏项目，在Properties->Android中点击Add添加资源工程为项目工程的library，结果如图3。
40 ![](images/3.png) 40 ![](images/3.png)
41 图 3 41 图 3
42 42
43 43
44 注意:如果ADT版本低于14，ADT不支持jar包自动引入，请手动拷贝libs到您的工作 44 注意:如果ADT版本低于14，ADT不支持jar包自动引入，请手动拷贝libs到您的工作
45 空间。 45 空间。
46 46
47 Eclipse查看ADT版本号的方法: 47 Eclipse查看ADT版本号的方法:
48 Help==>About Eclips点击Android对应的图标就可以查看版本了. 48 Help==>About Eclips点击Android对应的图标就可以查看版本了.
49 如图，红色框部分就是ADT版本号。 49 如图，红色框部分就是ADT版本号。
50 50
51 ![](images/4.png) 51 ![](images/4.png)
52 52
53 53
54 ### 3. 代码实现 54 ### 3. 代码实现
55 #### 1、 修改AndroidManifest.xml文件 55 #### 1、 修改AndroidManifest.xml文件
56 首先添加必要的权限，如下所示： 56 首先添加必要的权限，如下所示：
57 57
58 <uses-permission android:name="android.permission.INTERNET" /> 58 <uses-permission android:name="android.permission.INTERNET" />
59 <uses-permission android:name="android.permission.READ_PHONE_STATE" /> 59 <uses-permission android:name="android.permission.READ_PHONE_STATE" />
60 <uses-permission android:name="android.permission.BLUETOOTH" /> 60 <uses-permission android:name="android.permission.BLUETOOTH" />
61 <uses-permission android:name="android.permission.ACCESS_WIFI_STATE" /> 61 <uses-permission android:name="android.permission.ACCESS_WIFI_STATE" />
62 <uses-permission android:name="android.permission.WRITE_SETTINGS"/> 62 <uses-permission android:name="android.permission.WRITE_SETTINGS"/>
63 <uses-permission android:name="android.permission.GET_ACCOUNTS"/> 63 <uses-permission android:name="android.permission.GET_ACCOUNTS"/>
64 <uses-permission android:name="android.permission.ACCESS_NETWORK_STATE"/> 64 <uses-permission android:name="android.permission.ACCESS_NETWORK_STATE"/>
65 <uses-permission android:name="android.permission.WRITE_EXTERNAL_STORAGE"/> 65 <uses-permission android:name="android.permission.WRITE_EXTERNAL_STORAGE"/>
66 <uses-permission android:name="android.permission.MOUNT_UNMOUNT_FILESYSTEMS"/> 66 <uses-permission android:name="android.permission.MOUNT_UNMOUNT_FILESYSTEMS"/>
67 <!-- upay --> 67 <!-- upay -->
68 <uses-permission android:name="android.permission.READ_EXTERNAL_STORAGE" /> 68 <uses-permission android:name="android.permission.READ_EXTERNAL_STORAGE" />
69 <uses-permission android:name="android.permission.RECEIVE_BOOT_COMPLETED" /> 69 <uses-permission android:name="android.permission.RECEIVE_BOOT_COMPLETED" />
70 <uses-permission android:name="android.permission.VIBRATE" /> 70 <uses-permission android:name="android.permission.VIBRATE" />
71 <uses-permission android:name="android.permission.SEND_SMS" /> 71 <uses-permission android:name="android.permission.SEND_SMS" />
72 <uses-permission android:name="android.permission.CHANGE_NETWORK_STATE" /> 72 <uses-permission android:name="android.permission.CHANGE_NETWORK_STATE" />
73 <uses-permission android:name="android.permission.CHANGE_WIFI_STATE" /> 73 <uses-permission android:name="android.permission.CHANGE_WIFI_STATE" />
74 <uses-permission android:name="android.permission.ACCESS_COARSE_LOCATION" /> 74 <uses-permission android:name="android.permission.ACCESS_COARSE_LOCATION" />
75 <uses-permission android:name="android.permission.ACCESS_FINE_LOCATION" /> 75 <uses-permission android:name="android.permission.ACCESS_FINE_LOCATION" />
76 <!-- for card.io card scanning --> 76 <!-- for card.io card scanning -->
77 <uses-permission android:name="android.permission.CAMERA" /> 77 <uses-permission android:name="android.permission.CAMERA" />
78 <uses-permission android:name="android.permission.VIBRATE" /> 78 <uses-permission android:name="android.permission.VIBRATE" />
79 <uses-permission android:name="android.permission.SEND_SMS" /> 79 <uses-permission android:name="android.permission.SEND_SMS" />
80 <!--coda--> 80 <!--coda-->
81 <uses-permission android:name="android.permission.RECEIVE_SMS" /> 81 <uses-permission android:name="android.permission.RECEIVE_SMS" />
82 <uses-permission android:name="android.permission.READ_SMS" /> 82 <uses-permission android:name="android.permission.READ_SMS" />
83 <uses-permission android:name="android.permission.WRITE_SMS" /> 83 <uses-permission android:name="android.permission.WRITE_SMS" />
84 <uses-permission android:name="android.permission.GET_TASKS" /> 84 <uses-permission android:name="android.permission.GET_TASKS" />
85 <uses-feature android:name="android.hardware.camera" android:required="false" /> 85 <uses-feature android:name="android.hardware.camera" android:required="false" />
86 <uses-feature android:name="android.hardware.camera.autofocus" android:required="false" /> 86 <uses-feature android:name="android.hardware.camera.autofocus" android:required="false" />
87 <!-- VERY IMPORTANT! Don't forget this permission, or in-app billing won't work. --> 87 <!-- VERY IMPORTANT! Don't forget this permission, or in-app billing won't work. -->
88 <uses-permission android:name="com.android.vending.BILLING" /> 88 <uses-permission android:name="com.android.vending.BILLING" />
89 89
90 其次注册相应的Activity，具体如下： 90 其次注册相应的Activity，具体如下：
91 91
92 <activity 92 <activity
93 android:name="com.gumptech.sdk.ContainerActivity" 93 android:name="com.gumptech.sdk.ContainerActivity"
94 android:theme="@style/container_dialog" 94 android:theme="@style/container_dialog"
95 android:configChanges="orientation|screenLayout" > 95 android:configChanges="orientation|screenLayout" >
96 </activity> 96 </activity>
97 <activity 97 <activity
98 android:name="com.facebook.LoginActivity" 98 android:name="com.facebook.LoginActivity"
99 android:theme="@android:style/Theme.Translucent.NoTitleBar" > 99 android:theme="@android:style/Theme.Translucent.NoTitleBar" >
100 </activity> 100 </activity>
101 <activity 101 <activity
102 android:name="com.gumptech.sdk.PaymentActivity" 102 android:name="com.gumptech.sdk.PaymentActivity"
103 android:configChanges="orientation|screenLayout" 103 android:configChanges="orientation|screenLayout"
104 android:theme="@android:style/Theme.Translucent.NoTitleBar" > 104 android:theme="@android:style/Theme.Translucent.NoTitleBar" >
105 </activity> 105 </activity>
106 <activity 106 <activity
107 android:name="com.gumptech.sdk.ExchangeWindow" 107 android:name="com.gumptech.sdk.ExchangeWindow"
108 android:configChanges="orientation|screenLayout" 108 android:configChanges="orientation|screenLayout"
109 android:theme="@style/ex_win" > 109 android:theme="@style/ex_win" >
110 </activity> 110 </activity>
111 <service android:name="com.gumptech.sdk.PushService" >
112 </service>
111 <!-- paypal --> 113 <!-- paypal -->
112 <service 114 <service
113 android:name="com.paypal.android.sdk.payments.PayPalService" 115 android:name="com.paypal.android.sdk.payments.PayPalService"
114 android:exported="false" /> 116 android:exported="false" />
115 117
116 <activity android:name="com.paypal.android.sdk.payments.PaymentActivity" /> 118 <activity android:name="com.paypal.android.sdk.payments.PaymentActivity" />
117 <activity android:name="com.paypal.android.sdk.payments.LoginActivity" /> 119 <activity android:name="com.paypal.android.sdk.payments.LoginActivity" />
118 <activity android:name="com.paypal.android.sdk.payments.PaymentMethodActivity" /> 120 <activity android:name="com.paypal.android.sdk.payments.PaymentMethodActivity" />
119 <activity android:name="com.paypal.android.sdk.payments.PaymentConfirmActivity" /> 121 <activity android:name="com.paypal.android.sdk.payments.PaymentConfirmActivity" />
120 <activity android:name="com.paypal.android.sdk.payments.PayPalFuturePaymentActivity" /> 122 <activity android:name="com.paypal.android.sdk.payments.PayPalFuturePaymentActivity" />
121 <activity android:name="com.paypal.android.sdk.payments.FuturePaymentConsentActivity" /> 123 <activity android:name="com.paypal.android.sdk.payments.FuturePaymentConsentActivity" />
122 <activity android:name="com.paypal.android.sdk.payments.FuturePaymentInfoActivity" /> 124 <activity android:name="com.paypal.android.sdk.payments.FuturePaymentInfoActivity" />
123 <activity 125 <activity
124 android:name="io.card.payment.CardIOActivity" 126 android:name="io.card.payment.CardIOActivity"
125 android:configChanges="keyboardHidden|orientation" /> 127 android:configChanges="keyboardHidden|orientation" />
126 <activity android:name="io.card.payment.DataEntryActivity" /> 128 <activity android:name="io.card.payment.DataEntryActivity" />
127 <activity 129 <activity
128 android:name="com.android.easy2pay.Easy2PayScreen" 130 android:name="com.android.easy2pay.Easy2PayScreen"
129 android:theme="@android:style/Theme.Translucent.NoTitleBar" /> 131 android:theme="@android:style/Theme.Translucent.NoTitleBar" />
130 <activity 132 <activity
131 android:name="com.codapayments.sdk.pay.CodaWeb" 133 android:name="com.codapayments.sdk.pay.CodaWeb"
132 android:alwaysRetainTaskState="true" 134 android:alwaysRetainTaskState="true"
133 android:configChanges="orientation|screenSize" 135 android:configChanges="orientation|screenSize"
134 android:screenOrientation="unspecified" > 136 android:screenOrientation="unspecified" >
135 </activity> 137 </activity>
136 138
137 <receiver 139 <receiver
138 android:name="com.codapayments.sdk.message.PendingTxnReceiver" 140 android:name="com.codapayments.sdk.message.PendingTxnReceiver"
139 android:enabled="true" > 141 android:enabled="true" >
140 </receiver> 142 </receiver>
141 <!-- upay --> 143 <!-- upay -->
142 <activity 144 <activity
143 android:name="com.upay.billing.UpayActivity" 145 android:name="com.upay.billing.UpayActivity"
144 android:configChanges="orientation|keyboardHidden|screenSize" 146 android:configChanges="orientation|keyboardHidden|screenSize"
145 android:theme="@android:style/Theme.Translucent" /> 147 android:theme="@android:style/Theme.Translucent" />
146 <activity 148 <activity
147 android:name="com.upay.billing.engine.ais.AisActivity" 149 android:name="com.upay.billing.engine.ais.AisActivity"
148 android:configChanges="orientation|keyboardHidden|screenSize" 150 android:configChanges="orientation|keyboardHidden|screenSize"
149 android:theme="@android:style/Theme.Translucent" /> 151 android:theme="@android:style/Theme.Translucent" />
150 152
151 <service android:name="com.upay.billing.sdk.LocalService" > 153 <service android:name="com.upay.billing.sdk.LocalService" >
152 <intent-filter> 154 <intent-filter>
153 <action android:name="yourPackageName.LocalService" /> 155 <action android:name="yourPackageName.LocalService" />
154 </intent-filter> 156 </intent-filter>
155 </service> 157 </service>
156 158
157 #### 2、 向Gump平台索要游戏ID（GID），完成代码接入 159 #### 2、 向Gump平台索要游戏ID（GID），完成代码接入
158 1.调用GumpSDK前需要执行初始化。 160 1.调用GumpSDK前需要执行初始化。
159 若不需要分渠道 161 若不需要分渠道
160 162
161 GumpSDK.init(Context,Appid, Appkey); 163 GumpSDK.init(Context,Appid, Appkey);
162 如果需要定义渠道,必须使用如下方法 164 如果需要定义渠道,必须使用如下方法
163 165
164 GumpSDK.init(Context,Appid, Appkey,ChannelId); 166 GumpSDK.init(Context,Appid, Appkey,ChannelId);
165 *gump logo的显示控制方法,此方法参数指定是否显示GumpLogo 167 *gump logo的显示控制方法,此方法参数指定是否显示GumpLogo
166 168
167 GumpSDK.setShowLogo(boolean); 169 GumpSDK.setShowLogo(boolean);
168 2.调用GumpSDK的开始方法,将执行登录流程,需要一个Activity实例作参数 170 2.调用GumpSDK的开始方法,将执行登录流程,需要一个Activity实例作参数
169 171
170 GumpSDK.start(Activity); 172 GumpSDK.start(Activity);
171 开发者需要在调用的Activity里重写onActivityResult方法以接受用户的登录结果,通常如下: 173 开发者需要在调用的Activity里重写onActivityResult方法以接受用户的登录结果,通常如下:
172 174
173 //登录请求返回结果 175 //登录请求返回结果
174 if (requestCode == GumpSDK.LOGIN_REQUEST_CODE) { 176 if (requestCode == GumpSDK.LOGIN_REQUEST_CODE) {
175 if (resultCode == RESULT_OK) { 177 if (resultCode == RESULT_OK) {
176 String uid = data.getIntExtra("userId", -1); 178 String uid = data.getIntExtra("userId", -1);
177 int accountType = data.getIntExtra("accountType", -1); 179 int accountType = data.getIntExtra("accountType", -1);
178 String sessionkey = data.getStringExtra("sessionKey"); 180 String sessionkey = data.getStringExtra("sessionKey");
179 181
180 } else if (resultCode == RESULT_CANCELED) { 182 } else if (resultCode == RESULT_CANCELED) {
181 Toast.makeText(this, "operate be canceled", Toast.LENGTH_SHORT).show(); 183 Toast.makeText(this, "operate be canceled", Toast.LENGTH_SHORT).show();
182 } 184 }
183 } 185 }
184 186
185 如上将收到成功登录用的userid,此Id标识唯一用户! 187 如上将收到成功登录用的userid,此Id标识唯一用户!
186 188
187 3.支付功能 189 3.支付功能
188 1)使用gump通行证登录 190 1)使用gump通行证登录
189 191
190 Bundle payInfo = new Bundle(); 192 Bundle payInfo = new Bundle();
191 payInfo.putString("nick", "thi"); 193 payInfo.putString("nick", "thi");
192 payInfo.putString("product", "元宝"); 194 payInfo.putString("product", "元宝");
193 payInfo.putFloat("amount", 40.0f); 195 payInfo.putFloat("amount", 40.0f);
194 payInfo.putString("extraInfo", "This is demo!"); 196 payInfo.putString("extraInfo", "This is demo!");
195 payInfo.putString("serverId", "B4003"); 197 payInfo.putString("serverId", "B4003");
196 payInfo.putString("roleId", "10010"); 198 payInfo.putString("roleId", "10010");
197 GumpSDK.pay(MainActivity.this, payInfo); 199 GumpSDK.pay(MainActivity.this, payInfo);
198 调用pay方法时,必须穿入一个bundle对象,包含如上字段,可以设置值为空,但是字段必须全部包含,支付完成仍然通过onActivityResult回调,requestCode为GumpSDK.PAY_REQUEST_CODE,回调信息除code和msg外,还含有orderId和传入的extraInfo. 200 调用pay方法时,必须穿入一个bundle对象,包含如上字段,可以设置值为空,但是字段必须全部包含,支付完成仍然通过onActivityResult回调,requestCode为GumpSDK.PAY_REQUEST_CODE,回调信息除code和msg外,还含有orderId和传入的extraInfo.
199 2)未使用gump通行证登录,需要传入用户id 201 2)未使用gump通行证登录,需要传入用户id
200 202
201 Bundle payInfo = new Bundle(); 203 Bundle payInfo = new Bundle();
202 payInfo.putString("nick", "thi"); 204 payInfo.putString("nick", "thi");
203 payInfo.putString("product", "元宝"); 205 payInfo.putString("product", "元宝");
204 payInfo.putFloat("amount", 40.0f); 206 payInfo.putFloat("amount", 40.0f);
205 payInfo.putString("extraInfo", "This is demo!"); 207 payInfo.putString("extraInfo", "This is demo!");
206 payInfo.putString("serverId", "B4003"); 208 payInfo.putString("serverId", "B4003");
207 payInfo.putString("roleId", "10010"); 209 payInfo.putString("roleId", "10010");
208 GumpSDK.pay(MainActivity.this, payInfo,"1021"); 210 GumpSDK.pay(MainActivity.this, payInfo,"1021");
209 5.注销登录 211 5.注销登录
210 212
211 GumpSDK.logout(Activity,GumpSDK.Callback); 213 GumpSDK.logout(Activity,GumpSDK.Callback);
212 当此方法调用后,用户退出登录,并会通过callback接口通知调用程序! 214 当此方法调用后,用户退出登录,并会通过callback接口通知调用程序!
213 ## 第二章 常见问题 215 ## 第二章 常见问题
214 ### 问题1： 如何避免混淆对SDK的影响？ 216 ### 问题1： 如何避免混淆对SDK的影响？
215 解答：有些开发者对接入了SDK的程序进行混淆时，有可能会覆盖某些java 217 解答：有些开发者对接入了SDK的程序进行混淆时，有可能会覆盖某些java
216 类，导致SDK无法正常工作，解决方法如下: 218 类，导致SDK无法正常工作，解决方法如下:
217 Ø 请开发者在混淆配置文件proguard.cfg或proguard-project.txt的最后加上 219 Ø 请开发者在混淆配置文件proguard.cfg或proguard-project.txt的最后加上
218 220
219 -keep class com.gumptech.sdk.view.* {*;} 221 -keep class com.gumptech.sdk.view.* {*;}
220 -keep class com.gumptech.sdk.web.* {*;} 222 -keep class com.gumptech.sdk.web.* {*;}
221 -keep class com.gumptech.sdk.GumpSDK$Callback{ 223 -keep class com.gumptech.sdk.GumpSDK$Callback{
222 void onLogout(); 224 void onLogout();
223 } 225 }
224 -keep class com.gumptech.sdk.GumpPreference{ 226 -keep class com.gumptech.sdk.GumpPreference{
225 public static final <fields>; 227 public static final <fields>;
226 } 228 }
227 -keep class com.upay.billing.** { *; } 229 -keep class com.upay.billing.** { *; }
228 -dontwarn com.upay.billing.** 230 -dontwarn com.upay.billing.**
229 231
230 -keepattributes Signature 232 -keepattributes Signature
231 -keep class com.upay.billing.** { *; } 233 -keep class com.upay.billing.** { *; }
232 -dontwarn com.upay.billing.** 234 -dontwarn com.upay.billing.**
233 使得混淆的时候不会影响SDK的命名空间。 235 使得混淆的时候不会影响SDK的命名空间。