SDK / GameSDK-Doc

Download as
Browse Code »

Commit 99a0c407786dc9a3c8220e6f37436165d2a04956

Authored by 赵康
1 parent f53f15711d
Exists in master

v3.3.11 

修改文档说明

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

doc/AndroidDocument.md
Diff comments   View file @ 99a0c40
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:launchMode="singleTask" 86 android:launchMode="singleTask"
87 android:theme="@android:style/Theme.Translucent.NoTitleBar" > 87 android:theme="@android:style/Theme.Translucent.NoTitleBar" >
88 <intent-filter> 88 <intent-filter>
89 <category android:name="android.intent.category.DEFAULT" /> 89 <category android:name="android.intent.category.DEFAULT" />
90 90
91 <action android:name="android.intent.action.VIEW" /> 91 <action android:name="android.intent.action.VIEW" />
92 92
93 <category android:name="android.intent.category.BROWSABLE" /> 93 <category android:name="android.intent.category.BROWSABLE" />
94 94
95 <data 95 <data
96 android:host="com.gump.sdk" 96 android:host="com.gump.sdk"
97 android:scheme="gump+游戏的appId" /> 97 android:scheme="gump+游戏的appId" />
98 </intent-filter> 98 </intent-filter>
99 </activity> 99 </activity>
100 <activity 100 <activity
101 android:name="com.gumptech.sdk.ExchangeWindow" 101 android:name="com.gumptech.sdk.ExchangeWindow"
102 android:configChanges="orientation|screenSize|keyboardHidden|keyboard|screenLayout" 102 android:configChanges="orientation|screenSize|keyboardHidden|keyboard|screenLayout"
103 android:theme="@style/Theme.WinForExchange" > 103 android:theme="@style/Theme.WinForExchange" >
104 </activity> 104 </activity>
105 105
106 <service android:name="com.gumptech.sdk.PushService" > 106 <service android:name="com.gumptech.sdk.PushService" >
107 </service> 107 </service>
108 <!-- facebook --> 108 <!-- facebook -->
109 <activity 109 <activity
110 android:name="com.facebook.FacebookActivity" 110 android:name="com.facebook.FacebookActivity"
111 android:configChanges="keyboard|keyboardHidden|screenLayout|screenSize|orientation" 111 android:configChanges="keyboard|keyboardHidden|screenLayout|screenSize|orientation"
112 android:label="@string/app_name" 112 android:label="@string/app_name"
113 android:theme="@android:style/Theme.Translucent.NoTitleBar" /> 113 android:theme="@android:style/Theme.Translucent.NoTitleBar" />
114 <!-- vk登录使用，若不接入vk，不需配置 --> 114 <!-- vk登录使用，若不接入vk，不需配置 -->
115 <activity android:name="com.vk.sdk.VKOpenAuthActivity" /> 115 <activity android:name="com.vk.sdk.VKOpenAuthActivity" />
116 <activity 116 <activity
117 android:name="com.vk.sdk.VKServiceActivity" 117 android:name="com.vk.sdk.VKServiceActivity"
118 android:label="ServiceActivity" 118 android:label="ServiceActivity"
119 android:theme="@style/VK.Transparent" /> 119 android:theme="@style/VK.Transparent" />
120 120
121 121
122 #### 2、 向Gump平台索要游戏ID（AppID），完成代码接入 122 #### 2、 向Gump平台索要游戏ID（AppID），完成代码接入
123 正式开始接入逻辑代码前,先介绍下一些附加配置,以方便代码接入 123 正式开始接入逻辑代码前,先介绍下一些附加配置,以方便代码接入
124 124
125 *Gump Logo隐藏 125 *Gump Logo隐藏
126 126
127 GumpSDK.setLogoShow(false); 127 GumpSDK.setLogoShow(false);
128 128
129 *横竖屏控制,默认为横屏,参数为false即为竖屏 129 *横竖屏控制,默认为横屏,参数为false即为竖屏
130 130
131 GumpSDK.setScreenLandscape(true); 131 GumpSDK.setScreenLandscape(true);
132 *debug模式设置 132 *debug模式设置
133 133
134 GumpSDK.setDebugState(true); 134 GumpSDK.setDebugState(true);
135 135
136 *设置是否启用Facebook登录和VK登录 136 *设置是否启用Facebook登录和VK登录
137 137
138 GumpSDK.setFBEnable(true); 138 GumpSDK.setFBEnable(true);
139 GumpSDK.setVKEnable(true); 139 GumpSDK.setVKEnable(true);
140 *若要强制使用web方式登录facebook
141
142 GumpSDK.forceFBWithWeb();
140 1.调用GumpSDK前需要执行初始化。 143 1.调用GumpSDK前需要执行初始化。
141 144
142 若不需要分渠道 145 若不需要分渠道
143 146
144 GumpSDK.init(Context,Appid, Appkey,InitializeCallback); 147 GumpSDK.init(Context,Appid, Appkey,InitializeCallback);
145 如果需要定义渠道,必须使用如下方法 148 如果需要定义渠道,必须使用如下方法
146 149
147 GumpSDK.init(Context,Appid, Appkey,ChannelId,InitializeCallback); 150 GumpSDK.init(Context,Appid, Appkey,ChannelId,InitializeCallback);
148 151
149 InitializeCallback为初始化回调接口,此接口只有一个回调方法initComplete(int result) result标识是否初始化成功,当result等于GumpSDK.CODE.OK时为成功,其他为失败 152 InitializeCallback为初始化回调接口,此接口只有一个回调方法initComplete(int result) result标识是否初始化成功,当result等于GumpSDK.CODE.OK时为成功,其他为失败
150 153
151 2.调用GumpSDK的开始方法,将执行登录流程,需要一个Activity实例作参数 154 2.调用GumpSDK的开始方法,将执行登录流程,需要一个Activity实例作参数
152 155
153 GumpSDK.start(Activity); 156 GumpSDK.start(Activity);
154 在此之前,开发者需要注册用户状态监听以接受用户的登录/登出通知,通常如下: 157 在此之前,开发者需要注册用户状态监听以接受用户的登录/登出通知,通常如下:
155 158
156 GumpSDK.setUserStateListener(new LoginStateListener() { 159 GumpSDK.setUserStateListener(new LoginStateListener() {
157 @Override 160 @Override
158 public void onLoginSuccess(GumpUser gumpUser) { 161 public void onLoginSuccess(GumpUser gumpUser) {
159 //登录成功,用户信息包含在GumpUser对象里 162 //登录成功,用户信息包含在GumpUser对象里
160 } 163 }
161 164
162 @Override 165 @Override
163 public void onLoginFailed(int code, String msg) { 166 public void onLoginFailed(int code, String msg) {
164 //登录出错,根据错误码和信息判断错误类型 167 //登录出错,根据错误码和信息判断错误类型
165 Toast.makeText(MainActivity.this, "Login failed:code="+code+",message="+msg, Toast.LENGTH_SHORT).show(); 168 Toast.makeText(MainActivity.this, "Login failed:code="+code+",message="+msg, Toast.LENGTH_SHORT).show();
166 } 169 }
167 170
168 @Override 171 @Override
169 public void onLoginCanceled() { 172 public void onLoginCanceled() {
170 //用户取消登录 173 //用户取消登录
171 Toast.makeText(MainActivity.this, "operate be canceled", Toast.LENGTH_SHORT).show(); 174 Toast.makeText(MainActivity.this, "operate be canceled", Toast.LENGTH_SHORT).show();
172 } 175 }
173 176
174 @Override 177 @Override
175 public void onLogout() { 178 public void onLogout() {
176 //用户登出 179 //用户登出
177 180
178 } 181 }
179 }); 182 });
180 183
181 如上成功登录后收到的GumpUser对象包含以下信息 184 如上成功登录后收到的GumpUser对象包含以下信息
182 185
183 gumpUser.getUid();//获取用户的userid,此Id标识唯一用户! 186 gumpUser.getUid();//获取用户的userid,此Id标识唯一用户!
184 gumpUser.getAccountType();//用户类型,此类型数据可从GumpPreference常量获取 187 gumpUser.getAccountType();//用户类型,此类型数据可从GumpPreference常量获取
185 gumpUser.getSessionKey();//登录的sesionKey 188 gumpUser.getSessionKey();//登录的sesionKey
186 189
187 190
188 3.支付功能 191 3.支付功能
189 1)使用gump通行证登录,其中除nick和roleId外所有参数为必传参数 192 1)使用gump通行证登录,其中除nick和roleId外所有参数为必传参数
190 193
191 Bundle payInfo = new Bundle(); 194 Bundle payInfo = new Bundle();
192 payInfo.putString("nick", "thi"); 195 payInfo.putString("nick", "thi");
193 payInfo.putString("product", "元宝"); 196 payInfo.putString("product", "元宝");
194 payInfo.putFloat("amount", 40.0f); 197 payInfo.putFloat("amount", 40.0f);
195 payInfo.putString("extraInfo", "This is demo!"); 198 payInfo.putString("extraInfo", "This is demo!");
196 payInfo.putString("serverId", "B4003"); 199 payInfo.putString("serverId", "B4003");
197 payInfo.putString("roleId", "10010"); 200 payInfo.putString("roleId", "10010");
198 payInfo.putString("sessionKey","sessionkey"); 201 payInfo.putString("sessionKey","sessionkey");
199 GumpSDK.pay(MainActivity.this, payInfo,PurchaseCallback); 202 GumpSDK.pay(MainActivity.this, payInfo,PurchaseCallback);
200 调用pay方法时,必须穿入一个bundle对象,包含如上字段,除nick和roleId外所有字段必须全部包含,其中sessionKey为登录时返回的sessionKey 203 调用pay方法时,必须穿入一个bundle对象,包含如上字段,除nick和roleId外所有字段必须全部包含,其中sessionKey为登录时返回的sessionKey
201 2)未使用gump通行证登录,需要传入用户id，同时sessionKey不再需要 204 2)未使用gump通行证登录,需要传入用户id，同时sessionKey不再需要
202 205
203 Bundle payInfo = new Bundle(); 206 Bundle payInfo = new Bundle();
204 payInfo.putString("nick", "thi"); 207 payInfo.putString("nick", "thi");
205 payInfo.putString("product", "元宝"); 208 payInfo.putString("product", "元宝");
206 payInfo.putFloat("amount", 40.0f); 209 payInfo.putFloat("amount", 40.0f);
207 payInfo.putString("extraInfo", "This is demo!"); 210 payInfo.putString("extraInfo", "This is demo!");
208 payInfo.putString("serverId", "B4003"); 211 payInfo.putString("serverId", "B4003");
209 payInfo.putString("roleId", "10010"); 212 payInfo.putString("roleId", "10010");
210 GumpSDK.pay(MainActivity.this, payInfo,userId,PurchaseCallback); 213 GumpSDK.pay(MainActivity.this, payInfo,userId,PurchaseCallback);
211 214
212 PurchaseCallback为支付状态回调接口,此接口含有3个方法 215 PurchaseCallback为支付状态回调接口,此接口含有3个方法
213 216
214 @Override 217 @Override
215 public void onPurchaseCompleted(PurchaseResult result) { 218 public void onPurchaseCompleted(PurchaseResult result) {
216 Log.i(TAG,"purchase completed"); 219 Log.i(TAG,"purchase completed");
217 } 220 }
218 221
219 @Override 222 @Override
220 public void onPurchaseError(int code, String msg) { 223 public void onPurchaseError(int code, String msg) {
221 Log.i(TAG,"purchase error"); 224 Log.i(TAG,"purchase error");
222 } 225 }
223 226
224 @Override 227 @Override
225 public void onPurchaseCanceled() { 228 public void onPurchaseCanceled() {
226 Log.i(TAG,"purchase canceled"); 229 Log.i(TAG,"purchase canceled");
227 } 230 }
228 231
229 5.注销登录 232 5.注销登录
230 233
231 GumpSDK.logout(Activity); 234 GumpSDK.logout(Activity);
232 当此方法调用后,用户退出登录,并会通过LoginStateListener接口通知调用程序! 235 当此方法调用后,用户退出登录,并会通过LoginStateListener接口通知调用程序!
233 ## 第二章 常见问题 236 ## 第二章 常见问题
234 ### 问题1： 如何避免混淆对SDK的影响？ 237 ### 问题1： 如何避免混淆对SDK的影响？
235 解答：有些开发者对接入了SDK的程序进行混淆时，有可能会覆盖某些java 238 解答：有些开发者对接入了SDK的程序进行混淆时，有可能会覆盖某些java
236 类，导致SDK无法正常工作，解决方法如下: 239 类，导致SDK无法正常工作，解决方法如下:
237 Ø 请开发者在混淆配置文件proguard.cfg或proguard-project.txt的最后加上 240 Ø 请开发者在混淆配置文件proguard.cfg或proguard-project.txt的最后加上
238 241
239 -keepattributes *Annotation*,InnerClasses,SourceFile,LineNumberTable 242 -keepattributes *Annotation*,InnerClasses,SourceFile,LineNumberTable
240 -keep public class * extends android.app.Service 243 -keep public class * extends android.app.Service
241 -keep public class com.google.vending.licensing.ILicensingService 244 -keep public class com.google.vending.licensing.ILicensingService
242 -keep public class com.android.vending.licensing.ILicensingService 245 -keep public class com.android.vending.licensing.ILicensingService
243 -keep class com.gumptech.sdk.view.* {*;} 246 -keep class com.gumptech.sdk.view.* {*;}
244 -keep class com.gumptech.sdk.web.* {*;} 247 -keep class com.gumptech.sdk.web.* {*;}
245 -keep class com.gumptech.sdk.bridge.impl.*{*;} 248 -keep class com.gumptech.sdk.bridge.impl.*{*;}
246 249
247 250
248 使得混淆的时候不会影响SDK的命名空间。 251 使得混淆的时候不会影响SDK的命名空间。