SDK / GameSDK-Doc

Download as
Browse Code »

Commit c7b074b4505b7e75954324b5465c619325d07919

Authored by 赵康
1 parent f857501755
Exists in master

升级文档

Showing 1 changed file with 6 additions and 5 deletions Inline Diff

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