SDK / GameSDK-Doc

Download as
Browse Code »

Commit db0758e41765433fb48cace3d04096612e5a5558

Authored by 赵康
1 parent 68b98edcd8
Exists in master

修改progurad配置

Showing 1 changed file with 1 additions and 0 deletions Inline Diff

doc/AndroidDocument.md
Diff comments   View file @ db0758e
1 # Gump Android SDK使用文档 1 # Gump Android SDK使用文档
2 2
3 3
4 接入手册 4 接入手册
5 V 3.3.5 5 V 3.3.5
6 2016年03月04日 6 2016年03月04日
7 7
8 快速入口: 8 快速入口:
9 [支付部分服务端回调文档](http://git.letsgame.mobi/document/gumptech-document/blob/master/doc/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（AppID），完成代码接入](http://git.letsgame.mobi/document/gumptech-document/blob/master/AndroidDocument.md#2-gump-id-gid) 18 > [2.向Gump平台索要游戏ID（AppID），完成代码接入](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.将GameSDK资源工程拷贝到工作空间，在eclipse中的导航栏右键弹出如图1画面，选择Import导入资源工程，如图1. 31 1.将GameSDK资源工程拷贝到工作空间，在eclipse中的导航栏右键弹出如图1画面，选择Import导入资源工程，如图1.
32 注意:本sdk需要使用Facebook sdk for android 4.4.1实现fb登录,请自行导入Facebook SDK 32 注意:本sdk需要使用Facebook sdk for android 4.4.1实现fb登录,请自行导入Facebook SDK
33 注意:本sdk需要使用VK sdk for android 1.5.4实现vk登录,请自行导入此sdk；若不接入vk登录，可以不导入此sdk并忽略vk相关的配置 33 注意:本sdk需要使用VK sdk for android 1.5.4实现vk登录,请自行导入此sdk；若不接入vk登录，可以不导入此sdk并忽略vk相关的配置
34 34
35 ![](images/1.png) 35 ![](images/1.png)
36 图1 36 图1
37 37
38 2.导入工程后，右键此工程，在Properties->Android中选中此工程为library工程（勾选红色方框标识处）如图2。 38 2.导入工程后，右键此工程，在Properties->Android中选中此工程为library工程（勾选红色方框标识处）如图2。
39 ![](images/2.png) 39 ![](images/2.png)
40 图 2 40 图 2
41 ### 2. 添加资源工程 41 ### 2. 添加资源工程
42 添加资源工程为游戏项目的 library。右键游戏项目，在Properties->Android中点击Add添加资源工程为项目工程的library，结果如图3。 42 添加资源工程为游戏项目的 library。右键游戏项目，在Properties->Android中点击Add添加资源工程为项目工程的library，结果如图3。
43 ![](images/3.png) 43 ![](images/3.png)
44 图 3 44 图 3
45 45
46 46
47 注意:如果ADT版本低于14，ADT不支持jar包自动引入，请手动拷贝libs到您的工作 47 注意:如果ADT版本低于14，ADT不支持jar包自动引入，请手动拷贝libs到您的工作
48 空间。 48 空间。
49 49
50 Eclipse查看ADT版本号的方法: 50 Eclipse查看ADT版本号的方法:
51 Help==>About Eclips点击Android对应的图标就可以查看版本了. 51 Help==>About Eclips点击Android对应的图标就可以查看版本了.
52 如图，红色框部分就是ADT版本号。 52 如图，红色框部分就是ADT版本号。
53 53
54 ![](images/4.png) 54 ![](images/4.png)
55 55
56 56
57 ### 3. 代码实现 57 ### 3. 代码实现
58 #### 1、 修改AndroidManifest.xml文件 58 #### 1、 修改AndroidManifest.xml文件
59 首先添加必要的权限，如下所示： 59 首先添加必要的权限，如下所示：
60 60
61 <uses-permission android:name="android.permission.INTERNET" /> 61 <uses-permission android:name="android.permission.INTERNET" />
62 <uses-permission android:name="android.permission.READ_PHONE_STATE" /> 62 <uses-permission android:name="android.permission.READ_PHONE_STATE" />
63 <uses-permission android:name="android.permission.BLUETOOTH" /> 63 <uses-permission android:name="android.permission.BLUETOOTH" />
64 <uses-permission android:name="android.permission.ACCESS_WIFI_STATE" /> 64 <uses-permission android:name="android.permission.ACCESS_WIFI_STATE" />
65 <uses-permission android:name="android.permission.WRITE_SETTINGS"/> 65 <uses-permission android:name="android.permission.WRITE_SETTINGS"/>
66 <uses-permission android:name="android.permission.GET_ACCOUNTS"/> 66 <uses-permission android:name="android.permission.GET_ACCOUNTS"/>
67 <uses-permission android:name="android.permission.ACCESS_NETWORK_STATE"/> 67 <uses-permission android:name="android.permission.ACCESS_NETWORK_STATE"/>
68 <uses-permission android:name="android.permission.WRITE_EXTERNAL_STORAGE"/> 68 <uses-permission android:name="android.permission.WRITE_EXTERNAL_STORAGE"/>
69 <uses-permission android:name="android.permission.MOUNT_UNMOUNT_FILESYSTEMS"/> 69 <uses-permission android:name="android.permission.MOUNT_UNMOUNT_FILESYSTEMS"/>
70 <uses-permission android:name="android.permission.SEND_SMS"/> 70 <uses-permission android:name="android.permission.SEND_SMS"/>
71 71
72 <!-- VERY IMPORTANT! Don't forget this permission, or in-app billing won't work. --> 72 <!-- VERY IMPORTANT! Don't forget this permission, or in-app billing won't work. -->
73 <uses-permission android:name="com.android.vending.BILLING" /> 73 <uses-permission android:name="com.android.vending.BILLING" />
74 74
75 其次注册相应的Activity，具体如下： 75 其次注册相应的Activity，具体如下：
76 76
77 <activity 77 <activity
78 android:name="com.gumptech.sdk.ContainerActivity" 78 android:name="com.gumptech.sdk.ContainerActivity"
79 android:configChanges="orientation|screenSize|keyboardHidden|keyboard|screenLayout" 79 android:configChanges="orientation|screenSize|keyboardHidden|keyboard|screenLayout"
80 android:windowSoftInputMode="stateAlwaysHidden|adjustPan" 80 android:windowSoftInputMode="stateAlwaysHidden|adjustPan"
81 android:theme="@style/Theme.TransparentWin" > 81 android:theme="@style/Theme.TransparentWin" >
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|screenSize|keyboardHidden|keyboard|screenLayout" 85 android:configChanges="orientation|screenSize|keyboardHidden|keyboard|screenLayout"
86 android:theme="@android:style/Theme.Translucent.NoTitleBar" > 86 android:theme="@android:style/Theme.Translucent.NoTitleBar" >
87 <intent-filter> 87 <intent-filter>
88 <category android:name="android.intent.category.DEFAULT" /> 88 <category android:name="android.intent.category.DEFAULT" />
89 89
90 <action android:name="android.intent.action.VIEW" /> 90 <action android:name="android.intent.action.VIEW" />
91 91
92 <category android:name="android.intent.category.BROWSABLE" /> 92 <category android:name="android.intent.category.BROWSABLE" />
93 93
94 <data 94 <data
95 android:host="com.gump.sdk" 95 android:host="com.gump.sdk"
96 android:scheme="gump+游戏的appId" /> 96 android:scheme="gump+游戏的appId" />
97 </intent-filter> 97 </intent-filter>
98 </activity> 98 </activity>
99 <activity 99 <activity
100 android:name="com.gumptech.sdk.ExchangeWindow" 100 android:name="com.gumptech.sdk.ExchangeWindow"
101 android:configChanges="orientation|screenSize|keyboardHidden|keyboard|screenLayout" 101 android:configChanges="orientation|screenSize|keyboardHidden|keyboard|screenLayout"
102 android:theme="@style/Theme.WinForExchange" > 102 android:theme="@style/Theme.WinForExchange" >
103 </activity> 103 </activity>
104 104
105 <service android:name="com.gumptech.sdk.PushService" > 105 <service android:name="com.gumptech.sdk.PushService" >
106 </service> 106 </service>
107 <!-- facebook --> 107 <!-- facebook -->
108 <activity 108 <activity
109 android:name="com.facebook.FacebookActivity" 109 android:name="com.facebook.FacebookActivity"
110 android:configChanges="keyboard|keyboardHidden|screenLayout|screenSize|orientation" 110 android:configChanges="keyboard|keyboardHidden|screenLayout|screenSize|orientation"
111 android:label="@string/app_name" 111 android:label="@string/app_name"
112 android:theme="@android:style/Theme.Translucent.NoTitleBar" /> 112 android:theme="@android:style/Theme.Translucent.NoTitleBar" />
113 <!-- vk登录使用，若不接入vk，不需配置 --> 113 <!-- vk登录使用，若不接入vk，不需配置 -->
114 <activity android:name="com.vk.sdk.VKOpenAuthActivity" /> 114 <activity android:name="com.vk.sdk.VKOpenAuthActivity" />
115 <activity 115 <activity
116 android:name="com.vk.sdk.VKServiceActivity" 116 android:name="com.vk.sdk.VKServiceActivity"
117 android:label="ServiceActivity" 117 android:label="ServiceActivity"
118 android:theme="@style/VK.Transparent" /> 118 android:theme="@style/VK.Transparent" />
119 119
120 120
121 #### 2、 向Gump平台索要游戏ID（AppID），完成代码接入 121 #### 2、 向Gump平台索要游戏ID（AppID），完成代码接入
122 正式开始接入逻辑代码前,先介绍下一些附加配置,以方便代码接入 122 正式开始接入逻辑代码前,先介绍下一些附加配置,以方便代码接入
123 123
124 *Gump Logo隐藏 124 *Gump Logo隐藏
125 125
126 GumpSDK.setLogoShow(false); 126 GumpSDK.setLogoShow(false);
127 127
128 *横竖屏控制,默认为横屏,参数为false即为竖屏 128 *横竖屏控制,默认为横屏,参数为false即为竖屏
129 129
130 GumpSDK.setScreenLandscape(true); 130 GumpSDK.setScreenLandscape(true);
131 *debug模式设置 131 *debug模式设置
132 132
133 GumpSDK.setDebugState(true); 133 GumpSDK.setDebugState(true);
134 134
135 *设置是否启用Facebook登录和VK登录 135 *设置是否启用Facebook登录和VK登录
136 136
137 GumpSDK.setFBEnable(true); 137 GumpSDK.setFBEnable(true);
138 GumpSDK.setVKEnable(true); 138 GumpSDK.setVKEnable(true);
139 1.调用GumpSDK前需要执行初始化。 139 1.调用GumpSDK前需要执行初始化。
140 140
141 若不需要分渠道 141 若不需要分渠道
142 142
143 GumpSDK.init(Context,Appid, Appkey,InitializeCallback); 143 GumpSDK.init(Context,Appid, Appkey,InitializeCallback);
144 如果需要定义渠道,必须使用如下方法 144 如果需要定义渠道,必须使用如下方法
145 145
146 GumpSDK.init(Context,Appid, Appkey,ChannelId,InitializeCallback); 146 GumpSDK.init(Context,Appid, Appkey,ChannelId,InitializeCallback);
147 147
148 InitializeCallback为初始化回调接口,此接口只有一个回调方法initComplete(int result) result标识是否初始化成功,当result等于GumpSDK.CODE.OK时为成功,其他为失败 148 InitializeCallback为初始化回调接口,此接口只有一个回调方法initComplete(int result) result标识是否初始化成功,当result等于GumpSDK.CODE.OK时为成功,其他为失败
149 149
150 2.调用GumpSDK的开始方法,将执行登录流程,需要一个Activity实例作参数 150 2.调用GumpSDK的开始方法,将执行登录流程,需要一个Activity实例作参数
151 151
152 GumpSDK.start(Activity); 152 GumpSDK.start(Activity);
153 在此之前,开发者需要注册用户状态监听以接受用户的登录/登出通知,通常如下: 153 在此之前,开发者需要注册用户状态监听以接受用户的登录/登出通知,通常如下:
154 154
155 GumpSDK.setUserStateListener(new LoginStateListener() { 155 GumpSDK.setUserStateListener(new LoginStateListener() {
156 @Override 156 @Override
157 public void onLoginSuccess(GumpUser gumpUser) { 157 public void onLoginSuccess(GumpUser gumpUser) {
158 //登录成功,用户信息包含在GumpUser对象里 158 //登录成功,用户信息包含在GumpUser对象里
159 } 159 }
160 160
161 @Override 161 @Override
162 public void onLoginFailed(int code, String msg) { 162 public void onLoginFailed(int code, String msg) {
163 //登录出错,根据错误码和信息判断错误类型 163 //登录出错,根据错误码和信息判断错误类型
164 Toast.makeText(MainActivity.this, "Login failed:code="+code+",message="+msg, Toast.LENGTH_SHORT).show(); 164 Toast.makeText(MainActivity.this, "Login failed:code="+code+",message="+msg, Toast.LENGTH_SHORT).show();
165 } 165 }
166 166
167 @Override 167 @Override
168 public void onLoginCanceled() { 168 public void onLoginCanceled() {
169 //用户取消登录 169 //用户取消登录
170 Toast.makeText(MainActivity.this, "operate be canceled", Toast.LENGTH_SHORT).show(); 170 Toast.makeText(MainActivity.this, "operate be canceled", Toast.LENGTH_SHORT).show();
171 } 171 }
172 172
173 @Override 173 @Override
174 public void onLogout() { 174 public void onLogout() {
175 //用户登出 175 //用户登出
176 176
177 } 177 }
178 }); 178 });
179 179
180 如上成功登录后收到的GumpUser对象包含以下信息 180 如上成功登录后收到的GumpUser对象包含以下信息
181 181
182 gumpUser.getUid();//获取用户的userid,此Id标识唯一用户! 182 gumpUser.getUid();//获取用户的userid,此Id标识唯一用户!
183 gumpUser.getAccountType();//用户类型,此类型数据可从GumpPreference常量获取 183 gumpUser.getAccountType();//用户类型,此类型数据可从GumpPreference常量获取
184 gumpUser.getSessionKey();//登录的sesionKey 184 gumpUser.getSessionKey();//登录的sesionKey
185 185
186 186
187 3.支付功能 187 3.支付功能
188 1)使用gump通行证登录,其中除nick和roleId外所有参数为必传参数 188 1)使用gump通行证登录,其中除nick和roleId外所有参数为必传参数
189 189
190 Bundle payInfo = new Bundle(); 190 Bundle payInfo = new Bundle();
191 payInfo.putString("nick", "thi"); 191 payInfo.putString("nick", "thi");
192 payInfo.putString("product", "元宝"); 192 payInfo.putString("product", "元宝");
193 payInfo.putFloat("amount", 40.0f); 193 payInfo.putFloat("amount", 40.0f);
194 payInfo.putString("extraInfo", "This is demo!"); 194 payInfo.putString("extraInfo", "This is demo!");
195 payInfo.putString("serverId", "B4003"); 195 payInfo.putString("serverId", "B4003");
196 payInfo.putString("roleId", "10010"); 196 payInfo.putString("roleId", "10010");
197 payInfo.putString("sessionKey","sessionkey"); 197 payInfo.putString("sessionKey","sessionkey");
198 GumpSDK.pay(MainActivity.this, payInfo,PurchaseCallback); 198 GumpSDK.pay(MainActivity.this, payInfo,PurchaseCallback);
199 调用pay方法时,必须穿入一个bundle对象,包含如上字段,除nick和roleId外所有字段必须全部包含,其中sessionKey为登录时返回的sessionKey 199 调用pay方法时,必须穿入一个bundle对象,包含如上字段,除nick和roleId外所有字段必须全部包含,其中sessionKey为登录时返回的sessionKey
200 2)未使用gump通行证登录,需要传入用户id，同时sessionKey不再需要 200 2)未使用gump通行证登录,需要传入用户id，同时sessionKey不再需要
201 201
202 Bundle payInfo = new Bundle(); 202 Bundle payInfo = new Bundle();
203 payInfo.putString("nick", "thi"); 203 payInfo.putString("nick", "thi");
204 payInfo.putString("product", "元宝"); 204 payInfo.putString("product", "元宝");
205 payInfo.putFloat("amount", 40.0f); 205 payInfo.putFloat("amount", 40.0f);
206 payInfo.putString("extraInfo", "This is demo!"); 206 payInfo.putString("extraInfo", "This is demo!");
207 payInfo.putString("serverId", "B4003"); 207 payInfo.putString("serverId", "B4003");
208 payInfo.putString("roleId", "10010"); 208 payInfo.putString("roleId", "10010");
209 GumpSDK.pay(MainActivity.this, payInfo,userId,PurchaseCallback); 209 GumpSDK.pay(MainActivity.this, payInfo,userId,PurchaseCallback);
210 210
211 PurchaseCallback为支付状态回调接口,此接口含有3个方法 211 PurchaseCallback为支付状态回调接口,此接口含有3个方法
212 212
213 @Override 213 @Override
214 public void onPurchaseCompleted(PurchaseResult result) { 214 public void onPurchaseCompleted(PurchaseResult result) {
215 Log.i(TAG,"purchase completed"); 215 Log.i(TAG,"purchase completed");
216 } 216 }
217 217
218 @Override 218 @Override
219 public void onPurchaseError(int code, String msg) { 219 public void onPurchaseError(int code, String msg) {
220 Log.i(TAG,"purchase error"); 220 Log.i(TAG,"purchase error");
221 } 221 }
222 222
223 @Override 223 @Override
224 public void onPurchaseCanceled() { 224 public void onPurchaseCanceled() {
225 Log.i(TAG,"purchase canceled"); 225 Log.i(TAG,"purchase canceled");
226 } 226 }
227 227
228 5.注销登录 228 5.注销登录
229 229
230 GumpSDK.logout(Activity); 230 GumpSDK.logout(Activity);
231 当此方法调用后,用户退出登录,并会通过LoginStateListener接口通知调用程序! 231 当此方法调用后,用户退出登录,并会通过LoginStateListener接口通知调用程序!
232 ## 第二章 常见问题 232 ## 第二章 常见问题
233 ### 问题1： 如何避免混淆对SDK的影响？ 233 ### 问题1： 如何避免混淆对SDK的影响？
234 解答：有些开发者对接入了SDK的程序进行混淆时，有可能会覆盖某些java 234 解答：有些开发者对接入了SDK的程序进行混淆时，有可能会覆盖某些java
235 类，导致SDK无法正常工作，解决方法如下: 235 类，导致SDK无法正常工作，解决方法如下:
236 Ø 请开发者在混淆配置文件proguard.cfg或proguard-project.txt的最后加上 236 Ø 请开发者在混淆配置文件proguard.cfg或proguard-project.txt的最后加上
237 237
238 -keepattributes *Annotation*,InnerClasses,SourceFile,LineNumberTable 238 -keepattributes *Annotation*,InnerClasses,SourceFile,LineNumberTable
239 -keep public class * extends android.app.Service 239 -keep public class * extends android.app.Service
240 -keep public class com.google.vending.licensing.ILicensingService 240 -keep public class com.google.vending.licensing.ILicensingService
241 -keep public class com.android.vending.licensing.ILicensingService 241 -keep public class com.android.vending.licensing.ILicensingService
242 -keep class com.gumptech.sdk.view.* {*;} 242 -keep class com.gumptech.sdk.view.* {*;}
243 -keep class com.gumptech.sdk.web.* {*;} 243 -keep class com.gumptech.sdk.web.* {*;}
244 -keep class com.gumptech.sdk.bridge.impl.*{*;}
244 245
245 246
246 使得混淆的时候不会影响SDK的命名空间。 247 使得混淆的时候不会影响SDK的命名空间。