Blame view

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