SDK / GameSDK4-android

Download as
Browse Code »

Commit 441ba61c57d03ef60ed3b90f887bdfb516e60a12

Authored by 赵康
1 parent 43932caac2
Exists in master

update format

Showing 1 changed file with 16 additions and 19 deletions Inline Diff

1 # Gump SDK 4 for Android接入文档 1 # Gump SDK 4 for Android接入文档
2 2
3 V4.3.1 3 V4.3.1
4 2018年1月16日 4 2018年1月16日
5 5
6 ## 版本概述 6 ## 版本概述
7 7
8 此版本为使用AndroidStudio开发的版本,一改eclipse的工程依赖方式,使用aar的方式提供sdk接入包,除功能外,相对上一版本没有继承关系,请按此文档描述接入. 8 此版本为使用AndroidStudio开发的版本,一改eclipse的工程依赖方式,使用aar的方式提供sdk接入包,除功能外,相对上一版本没有继承关系,请按此文档描述接入.
9 9
10 此SDK适用android2.3以上系统. 10 此SDK适用android2.3以上系统.
11 11
12 ## 第一章 接入指南 12 ## 第一章 接入指南
13 ### 1.依赖导入 13 ### 1.依赖导入
14 将aar添加到libs目录下,然后配置gradle 14 将aar添加到libs目录下,然后配置gradle
15 以下为必须项 15 以下为必须项
16 16
17 repositories{ 17 repositories{
18 flatDir{ 18 flatDir{
19 dirs 'libs' 19 dirs 'libs'
20 } 20 }
21 } 21 }
22 dependencies { 22 dependencies {
23 compile(name:'GameSDK-releaseXXX',ext:'aar') 23 compile(name:'GameSDK-releaseXXX',ext:'aar')
24 } 24 }
25 25
26 26
27 可选接入vk登录时,需要导入vkLibrary工程,并配置模块依赖,如下 27 可选接入vk登录时,需要导入vkLibrary工程,并配置模块依赖,如下
28 28
29 compile project(':vksdk_library') 29 compile project(':vksdk_library')
30 30
31 ### 2.修改AndroidManifest.xml文件 31 ### 2.修改AndroidManifest.xml文件
32 首先添加必要的权限，如下所示： 32 首先添加必要的权限，如下所示：
33 33
34 <uses-permission android:name="android.permission.INTERNET" /> 34 <uses-permission android:name="android.permission.INTERNET" />
35 <uses-permission android:name="android.permission.READ_PHONE_STATE" /> 35 <uses-permission android:name="android.permission.READ_PHONE_STATE" />
36 <uses-permission android:name="android.permission.BLUETOOTH" /> 36 <uses-permission android:name="android.permission.BLUETOOTH" />
37 <uses-permission android:name="android.permission.ACCESS_WIFI_STATE" /> 37 <uses-permission android:name="android.permission.ACCESS_WIFI_STATE" />
38 <uses-permission android:name="android.permission.WRITE_SETTINGS"/> 38 <uses-permission android:name="android.permission.WRITE_SETTINGS"/>
39 <uses-permission android:name="android.permission.GET_ACCOUNTS"/> 39 <uses-permission android:name="android.permission.GET_ACCOUNTS"/>
40 <uses-permission android:name="android.permission.ACCESS_NETWORK_STATE"/> 40 <uses-permission android:name="android.permission.ACCESS_NETWORK_STATE"/>
41 <uses-permission android:name="android.permission.WRITE_EXTERNAL_STORAGE"/> 41 <uses-permission android:name="android.permission.WRITE_EXTERNAL_STORAGE"/>
42 <uses-permission android:name="android.permission.MOUNT_UNMOUNT_FILESYSTEMS"/> 42 <uses-permission android:name="android.permission.MOUNT_UNMOUNT_FILESYSTEMS"/>
43 <uses-permission android:name="android.permission.SEND_SMS"/> 43 <uses-permission android:name="android.permission.SEND_SMS"/>
44 <!-- VERY IMPORTANT! Don't forget this permission, or in-app billing won't work. --> 44 <!-- VERY IMPORTANT! Don't forget this permission, or in-app billing won't work. -->
45 <uses-permission android:name="com.android.vending.BILLING" /> 45 <uses-permission android:name="com.android.vending.BILLING" />
46 46
47 其次注册相应的Activity，具体如下： 47 其次注册相应的Activity，具体如下：
48 48
49 <activity 49 <activity
50 android:name="com.gumptech.sdk.ContainerActivity" 50 android:name="com.gumptech.sdk.ContainerActivity"
51 android:configChanges="orientation|screenSize|keyboardHidden|keyboard|screenLayout" 51 android:configChanges="orientation|screenSize|keyboardHidden|keyboard|screenLayout"
52 android:windowSoftInputMode="stateAlwaysHidden|adjustPan" 52 android:windowSoftInputMode="stateAlwaysHidden|adjustPan"
53 android:launchMode="singleTask" 53 android:launchMode="singleTask"
54 android:theme="@style/Theme.TransparentWin" > 54 android:theme="@style/Theme.TransparentWin" >
55 </activity> 55 </activity>
56 <activity 56 <activity
57 android:name="com.gumptech.sdk.PaymentActivity" 57 android:name="com.gumptech.sdk.PaymentActivity"
58 android:configChanges="orientation|screenSize|keyboardHidden|keyboard|screenLayout" 58 android:configChanges="orientation|screenSize|keyboardHidden|keyboard|screenLayout"
59 android:launchMode="singleTask" 59 android:launchMode="singleTask"
60 android:theme="@android:style/Theme.Translucent.NoTitleBar" > 60 android:theme="@android:style/Theme.Translucent.NoTitleBar" >
61 <intent-filter> 61 <intent-filter>
62 <category android:name="android.intent.category.DEFAULT" /> 62 <category android:name="android.intent.category.DEFAULT" />
63 <action android:name="android.intent.action.VIEW" /> 63 <action android:name="android.intent.action.VIEW" />
64 <category android:name="android.intent.category.BROWSABLE" /> 64 <category android:name="android.intent.category.BROWSABLE" />
65 <data 65 <data
66 android:host="com.gump.sdk" 66 android:host="com.gump.sdk"
67 android:scheme="gump+游戏的appId" /> 67 android:scheme="gump+游戏的appId" />
68 </intent-filter> 68 </intent-filter>
69 </activity> 69 </activity>
70 <activity 70 <activity
71 android:name="com.gumptech.sdk.ExchangeWindow" 71 android:name="com.gumptech.sdk.ExchangeWindow"
72 android:configChanges="orientation|screenSize|keyboardHidden|keyboard|screenLayout" 72 android:configChanges="orientation|screenSize|keyboardHidden|keyboard|screenLayout"
73 android:theme="@style/Theme.WinForExchange" > 73 android:theme="@style/Theme.WinForExchange" >
74 </activity> 74 </activity>
75 75
76 <service android:name="com.gumptech.sdk.PushService" /> 76 <service android:name="com.gumptech.sdk.PushService" />
77 77
78 <!-- vk登录使用，若不接入vk，不需配置 --> 78 <!-- vk登录使用，若不接入vk，不需配置 -->
79 <activity android:name="com.vk.sdk.VKOpenAuthActivity" /> 79 <activity android:name="com.vk.sdk.VKOpenAuthActivity" />
80 <activity 80 <activity
81 android:name="com.vk.sdk.VKServiceActivity" 81 android:name="com.vk.sdk.VKServiceActivity"
82 android:label="ServiceActivity" 82 android:label="ServiceActivity"
83 android:theme="@style/VK.Transparent" /> 83 android:theme="@style/VK.Transparent" />
84 84
85 ### 3.向Gump平台索要游戏ID（AppID），完成代码接入 85 ### 3.向Gump平台索要游戏ID（AppID），完成代码接入
86 正式开始接入逻辑代码前,先介绍下一些附加设置,以方便代码接入 86 正式开始接入逻辑代码前,先介绍下一些附加设置,以方便代码接入
87 87
88 *是否打印debug日志 88 *是否打印debug日志
89 89
90 GumpSDK.getSettings().enableDebugLogging(true); 90 GumpSDK.getSettings().enableDebugLogging(true);
91 91
92 *横竖屏控制,默认为横屏,参数为false即为竖屏 92 *横竖屏控制,默认为横屏,参数为false即为竖屏
93 93
94 GumpSDK.getSettings().setScreenLandscape(true); 94 GumpSDK.getSettings().setScreenLandscape(true);
95 95
96 *设置需要启用的第三方登录，参数可选类型见第二章：<a href="#third_palt">第三方登录平台</a> 字段说明 96 *设置需要启用的第三方登录，参数可选类型见第二章：[第三方登录平台](http://repository.gumptech.com:81/document/gamesdk4-android/master/IntegrationGuide.md#1-third_plat) 字段说明
97 97
98 GumpSDK.getSettings().requestThirdSupport(SDKSettings.THIRD_SUPPORT_*)； 98 GumpSDK.getSettings().requestThirdSupport(SDKSettings.THIRD_SUPPORT_*)；
99 99
100 *若要使用V4版支付请设置 100 *若要使用V4版支付请设置
101 101
102 GumpSDK.getSettings().setPaymentVersion(PaymentVersion.V4); 102 GumpSDK.getSettings().setPaymentVersion(PaymentVersion.V4);
103 103
104 #### 1.调用GumpSDK前需要执行初始化。 104 #### 1.调用GumpSDK前需要执行初始化。
105 105
106 若不需要分渠道 106 若不需要分渠道
107 107
108 GumpSDK.init(Context,Appid, Appkey,InitializeCallback); 108 GumpSDK.init(Context,Appid, Appkey,InitializeCallback);
109 如果需要定义渠道,必须使用如下方法 109 如果需要定义渠道,必须使用如下方法
110 110
111 GumpSDK.init(Context,Appid, Appkey,ChannelId,InitializeCallback); 111 GumpSDK.init(Context,Appid, Appkey,ChannelId,InitializeCallback);
112 112
113 InitializeCallback为初始化回调接口,此接口只有一个回调方法initComplete(int result) result标识是否初始化成功,当result等于GumpSDK.CODE.OK时为成功,其他为失败 113 InitializeCallback为初始化回调接口,此接口只有一个回调方法initComplete(int result) result标识是否初始化成功,当result等于GumpSDK.CODE.OK时为成功,其他为失败
114 114
115 #### 2.调用GumpSDK的开始方法,将执行登录流程,需要一个Activity实例作参数 115 #### 2.调用GumpSDK的开始方法,将执行登录流程,需要一个Activity实例作参数
116 116
117 GumpSDK.start(Activity); 117 GumpSDK.start(Activity);
118 在此之前,开发者需要注册用户状态监听以接受用户的登录/登出通知,通常如下: 118 在此之前,开发者需要注册用户状态监听以接受用户的登录/登出通知,通常如下:
119 119
120 GumpSDK.setUserStateListener(new LoginStateListener() { 120 GumpSDK.setUserStateListener(new LoginStateListener() {
121 @Override 121 @Override
122 public void onLoginSuccess(GumpUser gumpUser) { 122 public void onLoginSuccess(GumpUser gumpUser) {
123 //登录成功,用户信息包含在GumpUser对象里 123 //登录成功,用户信息包含在GumpUser对象里
124 } 124 }
125 125
126 @Override 126 @Override
127 public void onLoginFailed(int code, String msg) { 127 public void onLoginFailed(int code, String msg) {
128 //登录出错,根据错误码和信息判断错误类型 128 //登录出错,根据错误码和信息判断错误类型
129 Toast.makeText(MainActivity.this, "Login failed:code="+code+",message="+msg, Toast.LENGTH_SHORT).show(); 129 Toast.makeText(MainActivity.this, "Login failed:code="+code+",message="+msg, Toast.LENGTH_SHORT).show();
130 } 130 }
131 131
132 @Override 132 @Override
133 public void onLoginCanceled() { 133 public void onLoginCanceled() {
134 //用户取消登录 134 //用户取消登录
135 Toast.makeText(MainActivity.this, "operate be canceled", Toast.LENGTH_SHORT).show(); 135 Toast.makeText(MainActivity.this, "operate be canceled", Toast.LENGTH_SHORT).show();
136 } 136 }
137 137
138 @Override 138 @Override
139 public void onLogout() { 139 public void onLogout() {
140 //用户登出 140 //用户登出
141 141
142 } 142 }
143 }); 143 });
144 144
145 如上成功登录后收到的GumpUser对象包含以下信息 145 如上成功登录后收到的GumpUser对象包含以下信息
146 146
147 gumpUser.getUid();//获取用户的userid,此Id标识唯一用户! 147 gumpUser.getUid();//获取用户的userid,此Id标识唯一用户!
148 gumpUser.getAccountType();//用户类型,此类型数据可从GumpPreference常量获取 148 gumpUser.getAccountType();//用户类型,此类型数据可从GumpPreference常量获取
149 gumpUser.getSessionKey();//登录的sesionKey 149 gumpUser.getSessionKey();//登录的sesionKey
150 150
151 151
152 #### 3.支付功能 152 #### 3.支付功能
153 1)使用gump通行证登录,其中除nick外所有参数为必传参数 153 1)使用gump通行证登录,其中除nick外所有参数为必传参数
154 154
155 Bundle payInfo = new Bundle(); 155 Bundle payInfo = new Bundle();
156 payInfo.putString("nick", "thi"); 156 payInfo.putString("nick", "thi");
157 payInfo.putString("product", "元宝"); 157 payInfo.putString("product", "元宝");
158 payInfo.putFloat("amount", 40.0f); 158 payInfo.putFloat("amount", 40.0f);
159 payInfo.putString("extraInfo", "This is demo!"); 159 payInfo.putString("extraInfo", "This is demo!");
160 payInfo.putString("serverId", "B4003"); 160 payInfo.putString("serverId", "B4003");
161 payInfo.putString("roleId", "10010"); 161 payInfo.putString("roleId", "10010");
162 payInfo.putString("sessionKey","sessionkey"); 162 payInfo.putString("sessionKey","sessionkey");
163 GumpSDK.pay(MainActivity.this, payInfo,PurchaseCallback); 163 GumpSDK.pay(MainActivity.this, payInfo,PurchaseCallback);
164 调用pay方法时,必须穿入一个bundle对象,包含如上字段,除nick外所有字段必须全部包含,其中sessionKey为登录时返回的sessionKey 164 调用pay方法时,必须穿入一个bundle对象,包含如上字段,除nick外所有字段必须全部包含,其中sessionKey为登录时返回的sessionKey
165 165
166 166
167 2)IAP支付 167 2)IAP支付
168 168
169 Bundle payInfo = new Bundle(); 169 Bundle payInfo = new Bundle();
170 payInfo.putString("product", "gp_skuId"); 170 payInfo.putString("product", "gp_skuId");
171 payInfo.putFloat("amount", 0.1f); 171 payInfo.putFloat("amount", 0.1f);
172 payInfo.putString("extraInfo", "This is demo!"); 172 payInfo.putString("extraInfo", "This is demo!");
173 payInfo.putString("serverId", "100"); 173 payInfo.putString("serverId", "100");
174 payInfo.putString("roleId","100123"); 174 payInfo.putString("roleId","100123");
175 GumpSDK.iap(MainActivity.this, payInfo, PurchaseCallback); 175 GumpSDK.iap(MainActivity.this, payInfo, PurchaseCallback);
176 176
177 3)PurchaseCallback为支付状态回调接口,此接口含有3个方法 177 3)PurchaseCallback为支付状态回调接口,此接口含有3个方法
178 178
179 @Override 179 @Override
180 public void onPurchaseCompleted(PurchaseResult result) { 180 public void onPurchaseCompleted(PurchaseResult result) {
181 Log.i(TAG,"purchase completed"); 181 Log.i(TAG,"purchase completed");
182 } 182 }
183 183
184 @Override 184 @Override
185 public void onPurchaseError(int code, String msg) { 185 public void onPurchaseError(int code, String msg) {
186 Log.i(TAG,"purchase error"); 186 Log.i(TAG,"purchase error");
187 } 187 }
188 188
189 @Override 189 @Override
190 public void onPurchaseCanceled() { 190 public void onPurchaseCanceled() {
191 Log.i(TAG,"purchase canceled"); 191 Log.i(TAG,"purchase canceled");
192 } 192 }
193 193
194 #### 4.注销登录 194 #### 4.注销登录
195 195
196 GumpSDK.logout(Activity); 196 GumpSDK.logout(Activity);
197 当此方法调用后,用户退出登录,并会通过LoginStateListener接口通知调用程序!为了便于用户切换登录账户,请在游戏内提供用户注销的触发按钮 197 当此方法调用后,用户退出登录,并会通过LoginStateListener接口通知调用程序!为了便于用户切换登录账户,请在游戏内提供用户注销的触发按钮
198 #### 5.运营开关接口，若需要接入，会有我方运营人员提出需求，否则不需要接入（若对此接口不知所云，即可认为不需要接入，请自行忽略） 198 #### 5.运营开关接口，若需要接入，会有我方运营人员提出需求，否则不需要接入（若对此接口不知所云，即可认为不需要接入，请自行忽略）
199 199
200 GumpSDK.checkRisk(this, new ResultCallback() { 200 GumpSDK.checkRisk(this, new ResultCallback() {
201 @Override 201 @Override
202 public void onResult(boolean result) { 202 public void onResult(boolean result) {
203 Log.i(TAG,result?"There is some risks":"Nothing is risk"); 203 Log.i(TAG,result?"There is some risks":"Nothing is risk");
204 } 204 }
205 }); 205 });
206 206
207 ## 第二章 常量字段与代码 207 ## 第二章 常量字段与代码
208 <a name="third_plat"> 1.第三方登录平台</a> 208 ### 1.第三方登录平台(third_plat)
209 209 | 常量字段 | 说明 |
210 | 常量字段 | 说明 | 210 |--------------------------------|--------------|
211 | -------- | -------- | 211 |SDKSettings.THIRD_SUPPORT_FB |Facebook登录 |
212 |SDKSettings.THIRD_SUPPORT_FB|Facebook登录| 212 |SDKSettings.THIRD_SUPPORT_GOOGLE|Google登录 |
213 |SDKSettings.THIRD_SUPPORT_GOOGLE|Google登录| 213 |SDKSettings.THIRD_SUPPORT_LINE |Line登录 |
214 |SDKSettings.THIRD_SUPPORT_LINE|Line登录| 214 |SDKSettings.THIRD_SUPPORT_VK |VK登录 |
215 |SDKSettings.THIRD_SUPPORT_VK|VK登录|
216
217 ### 2.登录账户类型 215 ### 2.登录账户类型
218 216 | 常量字段 | 说明 |
219 | 常量字段 | 说明 | 217 |-------------------------------------|-------------|
220 | -------- | -------- | 218 |GumpPreference.ACCOUNT_TYPE_FB |Facebook用户 |
221 |GumpPreference.ACCOUNT_TYPE_FB|Facebook用户| 219 |GumpPreference.ACCOUNT_TYPE_REG |Gump注册用户 |
222 |GumpPreference.ACCOUNT_TYPE_REG|Gump注册用户| 220 |GumpPreference.ACCOUNT_TYPE_QUICK_REG|快速注册用户 |
223 |GumpPreference.ACCOUNT_TYPE_QUICK_REG|快速注册用户| 221 |GumpPreference.ACCOUNT_TYPE_GOOGLE |Google用户 |
224 |GumpPreference.ACCOUNT_TYPE_GOOGLE|Google用户| 222 |GumpPreference.ACCOUNT_TYPE_LINE |Line用户 |
225 |GumpPreference.ACCOUNT_TYPE_LINE|Line用户| 223 |GumpPreference.ACCOUNT_TYPE_VK |VK用户 |
226 |GumpPreference.ACCOUNT_TYPE_VK|VK用户|
227 224
228 ## 第三章 常见问题 225 ## 第三章 常见问题
229 ### 问题1： 如何避免混淆对SDK的影响？ 226 ### 问题1： 如何避免混淆对SDK的影响？
230 解答：有些开发者对接入了SDK的程序进行混淆时，有可能会覆盖某些java 227 解答：有些开发者对接入了SDK的程序进行混淆时，有可能会覆盖某些java
231 类，导致SDK无法正常工作，解决方法如下: 228 类，导致SDK无法正常工作，解决方法如下:
232 Ø 请开发者在混淆配置文件proguard.cfg或proguard-project.txt的最后加上 229 Ø 请开发者在混淆配置文件proguard.cfg或proguard-project.txt的最后加上
233 230
234 -keepattributes *Annotation*,InnerClasses,SourceFile,LineNumberTable 231 -keepattributes *Annotation*,InnerClasses,SourceFile,LineNumberTable
235 -keep public class * extends android.app.Service 232 -keep public class * extends android.app.Service
236 -keep public class com.google.vending.licensing.ILicensingService 233 -keep public class com.google.vending.licensing.ILicensingService
237 -keep public class com.android.vending.licensing.ILicensingService 234 -keep public class com.android.vending.licensing.ILicensingService
238 -keep class com.gumptech.sdk.view.* {*;} 235 -keep class com.gumptech.sdk.view.* {*;}
239 -keep class com.gumptech.sdk.web.* {*;} 236 -keep class com.gumptech.sdk.web.* {*;}
240 -keep class com.gumptech.sdk.bridge.impl.*{*;} 237 -keep class com.gumptech.sdk.bridge.impl.*{*;}
241 238
242 239
243 使得混淆的时候不会影响SDK的命名空间。 240 使得混淆的时候不会影响SDK的命名空间。