SDK / GameSDK4-android

Download as
Browse Code »

Commit d6b9069eaacd91a4f48e3b2cf6c3fc04a352cce9

Authored by 赵康
1 parent c825479866
Exists in master

update to 4.1.0:FB webLogin is the way be reserved

Showing 3 changed files with 6 additions and 16 deletions Inline Diff

GameSDK-release4.0.1.aar
View file @ d6b9069
No preview for this file type
GameSDK-release4.1.0.aar
Diff comments   View file @ d6b9069
No preview for this file type
1 # Gump SDK 4 for Android接入文档 1 # Gump SDK 4 for Android接入文档
2 2
3 V4.0.0 3 V4.1.0
4 2016年09月23日 4 2016年11月09日
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-release',ext:'aar') 23 compile(name:'GameSDK-releaseXXX',ext:'aar')
24 } 24 }
25 25
26 可选接入facebook登录并使用sdk方式时,需要增加依赖(web方式登录请忽略)
27
28 compile 'com.facebook.android:facebook-android-sdk:4.4.0'
29 26
30 可选接入vk登录时,需要导入vkLibrary工程,并配置模块依赖,如下 27 可选接入vk登录时,需要导入vkLibrary工程,并配置模块依赖,如下
31 28
32 compile project(':vksdk_library') 29 compile project(':vksdk_library')
33 30
34 ### 2.修改AndroidManifest.xml文件 31 ### 2.修改AndroidManifest.xml文件
35 首先添加必要的权限，如下所示： 32 首先添加必要的权限，如下所示：
36 33
37 <uses-permission android:name="android.permission.INTERNET" /> 34 <uses-permission android:name="android.permission.INTERNET" />
38 <uses-permission android:name="android.permission.READ_PHONE_STATE" /> 35 <uses-permission android:name="android.permission.READ_PHONE_STATE" />
39 <uses-permission android:name="android.permission.BLUETOOTH" /> 36 <uses-permission android:name="android.permission.BLUETOOTH" />
40 <uses-permission android:name="android.permission.ACCESS_WIFI_STATE" /> 37 <uses-permission android:name="android.permission.ACCESS_WIFI_STATE" />
41 <uses-permission android:name="android.permission.WRITE_SETTINGS"/> 38 <uses-permission android:name="android.permission.WRITE_SETTINGS"/>
42 <uses-permission android:name="android.permission.GET_ACCOUNTS"/> 39 <uses-permission android:name="android.permission.GET_ACCOUNTS"/>
43 <uses-permission android:name="android.permission.ACCESS_NETWORK_STATE"/> 40 <uses-permission android:name="android.permission.ACCESS_NETWORK_STATE"/>
44 <uses-permission android:name="android.permission.WRITE_EXTERNAL_STORAGE"/> 41 <uses-permission android:name="android.permission.WRITE_EXTERNAL_STORAGE"/>
45 <uses-permission android:name="android.permission.MOUNT_UNMOUNT_FILESYSTEMS"/> 42 <uses-permission android:name="android.permission.MOUNT_UNMOUNT_FILESYSTEMS"/>
46 <uses-permission android:name="android.permission.SEND_SMS"/> 43 <uses-permission android:name="android.permission.SEND_SMS"/>
47 <!-- 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. -->
48 <uses-permission android:name="com.android.vending.BILLING" /> 45 <uses-permission android:name="com.android.vending.BILLING" />
49 46
50 其次注册相应的Activity，具体如下： 47 其次注册相应的Activity，具体如下：
51 48
52 <activity 49 <activity
53 android:name="com.gumptech.sdk.ContainerActivity" 50 android:name="com.gumptech.sdk.ContainerActivity"
54 android:configChanges="orientation|screenSize|keyboardHidden|keyboard|screenLayout" 51 android:configChanges="orientation|screenSize|keyboardHidden|keyboard|screenLayout"
55 android:windowSoftInputMode="stateAlwaysHidden|adjustPan" 52 android:windowSoftInputMode="stateAlwaysHidden|adjustPan"
56 android:launchMode="singleTask" 53 android:launchMode="singleTask"
57 android:theme="@style/Theme.TransparentWin" > 54 android:theme="@style/Theme.TransparentWin" >
58 </activity> 55 </activity>
59 <activity 56 <activity
60 android:name="com.gumptech.sdk.PaymentActivity" 57 android:name="com.gumptech.sdk.PaymentActivity"
61 android:configChanges="orientation|screenSize|keyboardHidden|keyboard|screenLayout" 58 android:configChanges="orientation|screenSize|keyboardHidden|keyboard|screenLayout"
62 android:launchMode="singleTask" 59 android:launchMode="singleTask"
63 android:theme="@android:style/Theme.Translucent.NoTitleBar" > 60 android:theme="@android:style/Theme.Translucent.NoTitleBar" >
64 <intent-filter> 61 <intent-filter>
65 <category android:name="android.intent.category.DEFAULT" /> 62 <category android:name="android.intent.category.DEFAULT" />
66 <action android:name="android.intent.action.VIEW" /> 63 <action android:name="android.intent.action.VIEW" />
67 <category android:name="android.intent.category.BROWSABLE" /> 64 <category android:name="android.intent.category.BROWSABLE" />
68 <data 65 <data
69 android:host="com.gump.sdk" 66 android:host="com.gump.sdk"
70 android:scheme="gump+游戏的appId" /> 67 android:scheme="gump+游戏的appId" />
71 </intent-filter> 68 </intent-filter>
72 </activity> 69 </activity>
73 <activity 70 <activity
74 android:name="com.gumptech.sdk.ExchangeWindow" 71 android:name="com.gumptech.sdk.ExchangeWindow"
75 android:configChanges="orientation|screenSize|keyboardHidden|keyboard|screenLayout" 72 android:configChanges="orientation|screenSize|keyboardHidden|keyboard|screenLayout"
76 android:theme="@style/Theme.WinForExchange" > 73 android:theme="@style/Theme.WinForExchange" >
77 </activity> 74 </activity>
78 75
79 <service android:name="com.gumptech.sdk.PushService" /> 76 <service android:name="com.gumptech.sdk.PushService" />
80 <!-- facebook --> 77
81 <activity 78 <!-- vk登录使用，若不接入vk，不需配置 -->
82 android:name="com.facebook.FacebookActivity"
83 android:configChanges="keyboard|keyboardHidden|screenLayout|screenSize|orientation"
84 android:label="@string/app_name"
85 android:theme="@android:style/Theme.Translucent.NoTitleBar" />
86 <!-- vk登录使用，若不接入vk，不需配置 -->
87 <activity android:name="com.vk.sdk.VKOpenAuthActivity" /> 79 <activity android:name="com.vk.sdk.VKOpenAuthActivity" />
88 <activity 80 <activity
89 android:name="com.vk.sdk.VKServiceActivity" 81 android:name="com.vk.sdk.VKServiceActivity"
90 android:label="ServiceActivity" 82 android:label="ServiceActivity"
91 android:theme="@style/VK.Transparent" /> 83 android:theme="@style/VK.Transparent" />
92 84
93 ### 3.向Gump平台索要游戏ID（AppID），完成代码接入 85 ### 3.向Gump平台索要游戏ID（AppID），完成代码接入
94 正式开始接入逻辑代码前,先介绍下一些附加设置,以方便代码接入 86 正式开始接入逻辑代码前,先介绍下一些附加设置,以方便代码接入
95 87
96 *是否打印debug日志 88 *是否打印debug日志
97 89
98 GumpSDK.getSettings().enableDebugLogging(true); 90 GumpSDK.getSettings().enableDebugLogging(true);
99 91
100 *Gump Logo隐藏 92 *Gump Logo隐藏
101 93
102 GumpSDK.getSettings().setLogoShow(false); 94 GumpSDK.getSettings().setLogoShow(false);
103 95
104 *横竖屏控制,默认为横屏,参数为false即为竖屏 96 *横竖屏控制,默认为横屏,参数为false即为竖屏
105 97
106 GumpSDK.getSettings().setScreenLandscape(true); 98 GumpSDK.getSettings().setScreenLandscape(true);
107 99
108 *设置是否启用Facebook登录和VK登录 100 *设置是否启用Facebook登录和VK登录
109 101
110 GumpSDK.getSettings().setFBEnable(true); 102 GumpSDK.getSettings().setFBEnable(true);
111 GumpSDK.getSettings().setVKEnable(true); 103 GumpSDK.getSettings().setVKEnable(true);
112 *若要强制使用web方式登录facebook
113 104
114 GumpSDK.getSettings().forceFBWithWeb();
115 #### 1.调用GumpSDK前需要执行初始化。 105 #### 1.调用GumpSDK前需要执行初始化。
116 106
117 若不需要分渠道 107 若不需要分渠道
118 108
119 GumpSDK.init(Context,Appid, Appkey,InitializeCallback); 109 GumpSDK.init(Context,Appid, Appkey,InitializeCallback);
120 如果需要定义渠道,必须使用如下方法 110 如果需要定义渠道,必须使用如下方法
121 111
122 GumpSDK.init(Context,Appid, Appkey,ChannelId,InitializeCallback); 112 GumpSDK.init(Context,Appid, Appkey,ChannelId,InitializeCallback);
123 113
124 InitializeCallback为初始化回调接口,此接口只有一个回调方法initComplete(int result) result标识是否初始化成功,当result等于GumpSDK.CODE.OK时为成功,其他为失败 114 InitializeCallback为初始化回调接口,此接口只有一个回调方法initComplete(int result) result标识是否初始化成功,当result等于GumpSDK.CODE.OK时为成功,其他为失败
125 115
126 #### 2.调用GumpSDK的开始方法,将执行登录流程,需要一个Activity实例作参数 116 #### 2.调用GumpSDK的开始方法,将执行登录流程,需要一个Activity实例作参数
127 117
128 GumpSDK.start(Activity); 118 GumpSDK.start(Activity);
129 在此之前,开发者需要注册用户状态监听以接受用户的登录/登出通知,通常如下: 119 在此之前,开发者需要注册用户状态监听以接受用户的登录/登出通知,通常如下:
130 120
131 GumpSDK.setUserStateListener(new LoginStateListener() { 121 GumpSDK.setUserStateListener(new LoginStateListener() {
132 @Override 122 @Override
133 public void onLoginSuccess(GumpUser gumpUser) { 123 public void onLoginSuccess(GumpUser gumpUser) {
134 //登录成功,用户信息包含在GumpUser对象里 124 //登录成功,用户信息包含在GumpUser对象里
135 } 125 }
136 126
137 @Override 127 @Override
138 public void onLoginFailed(int code, String msg) { 128 public void onLoginFailed(int code, String msg) {
139 //登录出错,根据错误码和信息判断错误类型 129 //登录出错,根据错误码和信息判断错误类型
140 Toast.makeText(MainActivity.this, "Login failed:code="+code+",message="+msg, Toast.LENGTH_SHORT).show(); 130 Toast.makeText(MainActivity.this, "Login failed:code="+code+",message="+msg, Toast.LENGTH_SHORT).show();
141 } 131 }
142 132
143 @Override 133 @Override
144 public void onLoginCanceled() { 134 public void onLoginCanceled() {
145 //用户取消登录 135 //用户取消登录
146 Toast.makeText(MainActivity.this, "operate be canceled", Toast.LENGTH_SHORT).show(); 136 Toast.makeText(MainActivity.this, "operate be canceled", Toast.LENGTH_SHORT).show();
147 } 137 }
148 138
149 @Override 139 @Override
150 public void onLogout() { 140 public void onLogout() {
151 //用户登出 141 //用户登出
152 142
153 } 143 }
154 }); 144 });
155 145
156 如上成功登录后收到的GumpUser对象包含以下信息 146 如上成功登录后收到的GumpUser对象包含以下信息
157 147
158 gumpUser.getUid();//获取用户的userid,此Id标识唯一用户! 148 gumpUser.getUid();//获取用户的userid,此Id标识唯一用户!
159 gumpUser.getAccountType();//用户类型,此类型数据可从GumpPreference常量获取 149 gumpUser.getAccountType();//用户类型,此类型数据可从GumpPreference常量获取
160 gumpUser.getSessionKey();//登录的sesionKey 150 gumpUser.getSessionKey();//登录的sesionKey
161 151
162 152
163 #### 3.支付功能 153 #### 3.支付功能
164 1)使用gump通行证登录,其中除nick和roleId外所有参数为必传参数 154 1)使用gump通行证登录,其中除nick和roleId外所有参数为必传参数
165 155
166 Bundle payInfo = new Bundle(); 156 Bundle payInfo = new Bundle();
167 payInfo.putString("nick", "thi"); 157 payInfo.putString("nick", "thi");
168 payInfo.putString("product", "元宝"); 158 payInfo.putString("product", "元宝");
169 payInfo.putFloat("amount", 40.0f); 159 payInfo.putFloat("amount", 40.0f);
170 payInfo.putString("extraInfo", "This is demo!"); 160 payInfo.putString("extraInfo", "This is demo!");
171 payInfo.putString("serverId", "B4003"); 161 payInfo.putString("serverId", "B4003");
172 payInfo.putString("roleId", "10010"); 162 payInfo.putString("roleId", "10010");
173 payInfo.putString("sessionKey","sessionkey"); 163 payInfo.putString("sessionKey","sessionkey");
174 GumpSDK.pay(MainActivity.this, payInfo,PurchaseCallback); 164 GumpSDK.pay(MainActivity.this, payInfo,PurchaseCallback);
175 调用pay方法时,必须穿入一个bundle对象,包含如上字段,除nick和roleId外所有字段必须全部包含,其中sessionKey为登录时返回的sessionKey 165 调用pay方法时,必须穿入一个bundle对象,包含如上字段,除nick和roleId外所有字段必须全部包含,其中sessionKey为登录时返回的sessionKey
176 166
177 167
178 2)PurchaseCallback为支付状态回调接口,此接口含有3个方法 168 2)PurchaseCallback为支付状态回调接口,此接口含有3个方法
179 169
180 @Override 170 @Override
181 public void onPurchaseCompleted(PurchaseResult result) { 171 public void onPurchaseCompleted(PurchaseResult result) {
182 Log.i(TAG,"purchase completed"); 172 Log.i(TAG,"purchase completed");
183 } 173 }
184 174
185 @Override 175 @Override
186 public void onPurchaseError(int code, String msg) { 176 public void onPurchaseError(int code, String msg) {
187 Log.i(TAG,"purchase error"); 177 Log.i(TAG,"purchase error");
188 } 178 }
189 179
190 @Override 180 @Override
191 public void onPurchaseCanceled() { 181 public void onPurchaseCanceled() {
192 Log.i(TAG,"purchase canceled"); 182 Log.i(TAG,"purchase canceled");
193 } 183 }
194 184
195 #### 4.注销登录 185 #### 4.注销登录
196 186
197 GumpSDK.logout(Activity); 187 GumpSDK.logout(Activity);
198 当此方法调用后,用户退出登录,并会通过LoginStateListener接口通知调用程序! 188 当此方法调用后,用户退出登录,并会通过LoginStateListener接口通知调用程序!为了便于用户切换登录账户,请在游戏内提供用户注销的触发按钮
199 ## 第二章 常见问题 189 ## 第二章 常见问题
200 ### 问题1： 如何避免混淆对SDK的影响？ 190 ### 问题1： 如何避免混淆对SDK的影响？
201 解答：有些开发者对接入了SDK的程序进行混淆时，有可能会覆盖某些java 191 解答：有些开发者对接入了SDK的程序进行混淆时，有可能会覆盖某些java
202 类，导致SDK无法正常工作，解决方法如下: 192 类，导致SDK无法正常工作，解决方法如下:
203 Ø 请开发者在混淆配置文件proguard.cfg或proguard-project.txt的最后加上 193 Ø 请开发者在混淆配置文件proguard.cfg或proguard-project.txt的最后加上
204 194
205 -keepattributes *Annotation*,InnerClasses,SourceFile,LineNumberTable 195 -keepattributes *Annotation*,InnerClasses,SourceFile,LineNumberTable
206 -keep public class * extends android.app.Service 196 -keep public class * extends android.app.Service
207 -keep public class com.google.vending.licensing.ILicensingService 197 -keep public class com.google.vending.licensing.ILicensingService
208 -keep public class com.android.vending.licensing.ILicensingService 198 -keep public class com.android.vending.licensing.ILicensingService
209 -keep class com.gumptech.sdk.view.* {*;} 199 -keep class com.gumptech.sdk.view.* {*;}
210 -keep class com.gumptech.sdk.web.* {*;} 200 -keep class com.gumptech.sdk.web.* {*;}
211 -keep class com.gumptech.sdk.bridge.impl.*{*;} 201 -keep class com.gumptech.sdk.bridge.impl.*{*;}
212 202
213 203
214 使得混淆的时候不会影响SDK的命名空间。 204 使得混淆的时候不会影响SDK的命名空间。