Blame view

doc/AndroidDocument.md 11.3 KB
b58707f79   赵康   init
1
  # Gump Android SDK使用文档
5817fcc88   赵康   增加链接
2
  接入手册        
418a1e0cf   赵康   修改版本号
3
  V 2.3.1       
34a1e9f2d   赵康   修改日期
4
  2015年01月08日    
5817fcc88   赵康   增加链接
5
6
7
          
  快速入口:       
  [支付部分服务端回调文档](http://git.letsgame.mobi/document/gumptech-document/blob/master/ServerDocument.md)										
b58707f79   赵康   init
8
9
  
  ## 目录
2172eb633   赵康   修正链接地址
10
11
12
13
14
15
16
  * [第一章  接入指南](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(GID),完成代码接入](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#)     
4360990e7   赵康   更新常见问题
17
   - [问题1: 如何避免混淆对SDK的影响?](http://git.letsgame.mobi/document/gumptech-document/blob/master/AndroidDocument.md#1-sdk)       
08e1204e6   赵康   修改目录地址
18
   - [问题2:后台已经配置ok的情况下,支付列表仍然为空或登录总是出错?](http://git.letsgame.mobi/document/gumptech-document/blob/master/doc/AndroidDocument.md#2-ok)
b58707f79   赵康   init
19
20
21
22
23
24
25
26
  
  
  
  
  ## 第一章  接入指南
  配置环境
  
  本接口API	适用于Android2.2以上各版本Android平台。     
04a9e9502   赵康   完成格式编辑
27
  ### 1. 导入资源工程     
b58707f79   赵康   init
28
  1.将LoginSDK资源工程拷贝到工作空间,在eclipse中的导航栏右键弹出如图1画面,选择Import导入资源工程,如图1.
04a9e9502   赵康   完成格式编辑
29
30
  ![](images/1.png)       
          图1
b58707f79   赵康   init
31
32
  
  2.导入工程后,右键此工程,在Properties->Android中选中此工程为library工程(勾选红色方框标识处)如图2。
04a9e9502   赵康   完成格式编辑
33
34
35
  ![](images/2.png)         
  			图 2        
  ### 2. 添加资源工程
b58707f79   赵康   init
36
  添加资源工程为游戏项目的 library。右键游戏项目,在Properties->Android中点击Add添加资源工程为项目工程的library,结果如图3。 
04a9e9502   赵康   完成格式编辑
37
  ![](images/3.png)       
b58707f79   赵康   init
38
  	图 3
04a9e9502   赵康   完成格式编辑
39

b58707f79   赵康   init
40
41
42
43
44
45
  注意:如果ADT版本低于14,ADT不支持jar包自动引入,请手动拷贝libs到您的工作
  空间。 
  
  Eclipse查看ADT版本号的方法: 
  Help==>About Eclips点击Android对应的图标就可以查看版本了. 
  如图,红色框部分就是ADT版本号。 
04a9e9502   赵康   完成格式编辑
46
  ![](images/4.png)       
b58707f79   赵康   init
47

04a9e9502   赵康   完成格式编辑
48
49
  ### 3. 代码实现
  #### 1、	修改AndroidManifest.xml文件
b58707f79   赵康   init
50
  	首先添加必要的权限,如下所示:
04a9e9502   赵康   完成格式编辑
51
52
  	
      <uses-permission android:name="android.permission.INTERNET" />
b58707f79   赵康   init
53
54
      <uses-permission android:name="android.permission.READ_PHONE_STATE" />
      <uses-permission android:name="android.permission.BLUETOOTH" />
04a9e9502   赵康   完成格式编辑
55
56
57
58
      <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"/>
e96fdff45   赵康   增加系统权限
59
60
      <uses-permission android:name="android.permission.WRITE_EXTERNAL_STORAGE"/>
      <uses-permission android:name="android.permission.MOUNT_UNMOUNT_FILESYSTEMS"/>
532dc35e5   赵康   add upay
61
62
63
64
65
66
67
68
69
      <!-- upay -->
      <uses-permission android:name="android.permission.READ_EXTERNAL_STORAGE" />
      <uses-permission android:name="android.permission.RECEIVE_BOOT_COMPLETED" />
      <uses-permission android:name="android.permission.VIBRATE" />
      <uses-permission android:name="android.permission.SEND_SMS" />
      <uses-permission android:name="android.permission.CHANGE_NETWORK_STATE" />
      <uses-permission android:name="android.permission.CHANGE_WIFI_STATE" />
      <uses-permission android:name="android.permission.ACCESS_COARSE_LOCATION" />
      <uses-permission android:name="android.permission.ACCESS_FINE_LOCATION" />
04a9e9502   赵康   完成格式编辑
70
      <!-- for card.io card scanning -->
b58707f79   赵康   init
71
72
      <uses-permission android:name="android.permission.CAMERA" />
      <uses-permission android:name="android.permission.VIBRATE" />
9248ce1ac   赵康   增加coda支付权限和activity
73
74
75
76
77
78
      <uses-permission android:name="android.permission.SEND_SMS" />
      <!--coda-->
      <uses-permission android:name="android.permission.RECEIVE_SMS" />
      <uses-permission android:name="android.permission.READ_SMS" />
      <uses-permission android:name="android.permission.WRITE_SMS" />
      <uses-permission android:name="android.permission.GET_TASKS" />
b58707f79   赵康   init
79
80
81
82
      <uses-feature android:name="android.hardware.camera" android:required="false" />
      <uses-feature android:name="android.hardware.camera.autofocus" android:required="false" />
      <!-- VERY IMPORTANT! Don't forget this permission, or in-app billing won't work. -->
      <uses-permission android:name="com.android.vending.BILLING" />
04a9e9502   赵康   完成格式编辑
83
      
b58707f79   赵康   init
84
  其次注册相应的Activity,具体如下:
04a9e9502   赵康   完成格式编辑
85
86
87
88
89
90
91
92
93
94
  
      <activity
          android:name="com.gumptech.sdk.ContainerActivity"
          android:theme="@style/container_dialog"
          android:configChanges="orientation|screenLayout" >
      </activity>
      <activity
          android:name="com.facebook.LoginActivity"
          android:theme="@android:style/Theme.Translucent.NoTitleBar" >
      </activity>
b58707f79   赵康   init
95
  	<activity
04a9e9502   赵康   完成格式编辑
96
97
98
99
          android:name="com.gumptech.sdk.PaymentActivity"
          android:configChanges="orientation|screenLayout"
          android:theme="@android:style/Theme.Translucent.NoTitleBar" >
      </activity>
91314fccb   赵康   增加activity配置
100
101
102
103
104
      <activity
              android:name="com.gumptech.sdk.ExchangeWindow"
              android:configChanges="orientation|screenLayout"
              android:theme="@style/ex_win" >
      </activity>
cd70fe72b   赵康   add push service
105
106
      <service android:name="com.gumptech.sdk.PushService" >
      </service>
04a9e9502   赵康   完成格式编辑
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
      <!-- paypal -->
      <service
          android:name="com.paypal.android.sdk.payments.PayPalService"
          android:exported="false" />
  
      <activity android:name="com.paypal.android.sdk.payments.PaymentActivity" />
      <activity android:name="com.paypal.android.sdk.payments.LoginActivity" />
      <activity android:name="com.paypal.android.sdk.payments.PaymentMethodActivity" />
      <activity android:name="com.paypal.android.sdk.payments.PaymentConfirmActivity" />
      <activity android:name="com.paypal.android.sdk.payments.PayPalFuturePaymentActivity" />
      <activity android:name="com.paypal.android.sdk.payments.FuturePaymentConsentActivity" />
      <activity android:name="com.paypal.android.sdk.payments.FuturePaymentInfoActivity" />
      <activity
          android:name="io.card.payment.CardIOActivity"
          android:configChanges="keyboardHidden|orientation" />
      <activity android:name="io.card.payment.DataEntryActivity" />
9248ce1ac   赵康   增加coda支付权限和activity
123
124
125
126
127
128
129
130
131
132
133
134
135
136
      <activity
          android:name="com.android.easy2pay.Easy2PayScreen"
          android:theme="@android:style/Theme.Translucent.NoTitleBar" />
      <activity
          android:name="com.codapayments.sdk.pay.CodaWeb"
          android:alwaysRetainTaskState="true"
          android:configChanges="orientation|screenSize"
          android:screenOrientation="unspecified" >
      </activity>
  
      <receiver
          android:name="com.codapayments.sdk.message.PendingTxnReceiver"
          android:enabled="true" >
      </receiver>
532dc35e5   赵康   add upay
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
      <!-- upay -->
      <activity
          android:name="com.upay.billing.UpayActivity"
          android:configChanges="orientation|keyboardHidden|screenSize"
          android:theme="@android:style/Theme.Translucent" />
      <activity
          android:name="com.upay.billing.engine.ais.AisActivity"
          android:configChanges="orientation|keyboardHidden|screenSize"
          android:theme="@android:style/Theme.Translucent" />
  
      <service android:name="com.upay.billing.sdk.LocalService" >
         <intent-filter>
             <action android:name="yourPackageName.LocalService" />
         </intent-filter>
      </service>
04a9e9502   赵康   完成格式编辑
152
153
154
155
      
  #### 2、	向Gump平台索要游戏ID(GID),完成代码接入
  1.调用GumpSDK前需要执行初始化。        
  若不需要分渠道      
7eb9062fd   赵康   修改初始化方法
156
      GumpSDK.init(Context,Appid, Appkey);   
04a9e9502   赵康   完成格式编辑
157
  如果需要定义渠道,必须使用如下方法       
7eb9062fd   赵康   修改初始化方法
158
      GumpSDK.init(Context,Appid, Appkey,ChannelId);      
fa787d2d0   赵康   增加控制logo显示方法
159
160
161
  *gump logo的显示控制方法,此方法参数指定是否显示GumpLogo
      
      GumpSDK.setShowLogo(boolean);  
04a9e9502   赵康   完成格式编辑
162
163
164
165
166
167
168
169
  2.调用GumpSDK的开始方法,将执行登录流程,需要一个Activity实例作参数       
  
      GumpSDK.start(Activity);  
  开发者需要在调用的Activity里重写onActivityResult方法以接受用户的登录结果,通常如下:    
  
  	//登录请求返回结果      
  	if (requestCode == GumpSDK.LOGIN_REQUEST_CODE) {
  		if (resultCode == RESULT_OK) {
5be652e26   赵康   修改文档至v2.3.1
170
  			String uid = data.getIntExtra("userId", -1);
04a9e9502   赵康   完成格式编辑
171
172
  			int accountType = data.getIntExtra("accountType", -1);
  			String sessionkey = data.getStringExtra("sessionKey");
b58707f79   赵康   init
173
  				
04a9e9502   赵康   完成格式编辑
174
175
  		} else if (resultCode == RESULT_CANCELED) {
  			Toast.makeText(this, "operate be canceled", Toast.LENGTH_SHORT).show();
b58707f79   赵康   init
176
  		}
04a9e9502   赵康   完成格式编辑
177
178
179
  	}
  	
  如上将收到成功登录用的userid,此Id标识唯一用户!      
b58707f79   赵康   init
180

a5e38235c   maduo   页面支付
181
  3.支付功能(已过期,请优先考虑手机页面支付,参考地址:[GumpTech页面支付](http://git.letsgame.mobi/document/gumptech-document/blob/master/doc/webpay.md)			)      
bfd80f63f   赵康   add pay method fo...
182
  	1)使用gump通行证登录
99febc3b9   赵康   修改格式
183

04a9e9502   赵康   完成格式编辑
184
185
186
187
188
  	Bundle payInfo = new Bundle();
  	payInfo.putString("nick", "thi");
  	payInfo.putString("product", "元宝");
  	payInfo.putFloat("amount", 40.0f);
  	payInfo.putString("extraInfo", "This is demo!");
abafb4224   赵康   修改初始化方法
189
190
  	payInfo.putString("serverId", "B4003");
  	payInfo.putString("roleId", "10010");
04a9e9502   赵康   完成格式编辑
191
  	GumpSDK.pay(MainActivity.this, payInfo);
bfd80f63f   赵康   add pay method fo...
192
193
194
195
196
197
198
199
200
201
202
  调用pay方法时,必须穿入一个bundle对象,包含如上字段,可以设置值为空,但是字段必须全部包含,支付完成仍然通过onActivityResult回调,requestCode为GumpSDK.PAY_REQUEST_CODE,回调信息除code和msg外,还含有orderId和传入的extraInfo.  
  	2)未使用gump通行证登录,需要传入用户id
  
  	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");
  	GumpSDK.pay(MainActivity.this, payInfo,"1021");
04a9e9502   赵康   完成格式编辑
203
204
205
206
207
  5.注销登录      
  
  	GumpSDK.logout(Activity,GumpSDK.Callback);
  当此方法调用后,用户退出登录,并会通过callback接口通知调用程序!
  ## 第二章 常见问题      
5817fcc88   赵康   增加链接
208
  ### 问题1: 如何避免混淆对SDK的影响?       
04a9e9502   赵康   完成格式编辑
209
210
211
  解答:有些开发者对接入了SDK的程序进行混淆时,有可能会覆盖某些java
  类,导致SDK无法正常工作,解决方法如下:      
  Ø  请开发者在混淆配置文件proguard.cfg或proguard-project.txt的最后加上       
04a9e9502   赵康   完成格式编辑
212
      -keep class com.gumptech.sdk.view.* {*;}
100dc95c2   赵康   修改混淆配置
213
      -keep class com.gumptech.sdk.web.* {*;}
04a9e9502   赵康   完成格式编辑
214
215
216
217
218
219
      -keep class com.gumptech.sdk.GumpSDK$Callback{
      	void onLogout();
      }
      -keep class  com.gumptech.sdk.GumpPreference{
      public static final <fields>;
      }
100dc95c2   赵康   修改混淆配置
220
221
      -keep class com.upay.billing.** { *; }
      -dontwarn com.upay.billing.**
04a9e9502   赵康   完成格式编辑
222
223
      
      -keepattributes Signature
532dc35e5   赵康   add upay
224
225
      -keep class com.upay.billing.** { *; }
      -dontwarn com.upay.billing.**
4360990e7   赵康   更新常见问题
226
227
228
229
  使得混淆的时候不会影响SDK的命名空间。   
  ### 问题2:后台已经配置ok的情况下,支付列表仍然为空或登录总是出错?   
  解答:sdk在debug模式下使用的默认服务器地址是开发环境地址,此地址区别于正式环境地址,为开发调试用;若进行线上调试或正式环境测试,需要使用release模式来进行!       
  一般在IDE中直接run应用到设备上使用的是debug证书安装,此时即处于debug模式;若要使用正式环境,应该使用正式证书签名打包后进行安装!