Blame view

doc/AndroidDocument.md 9.12 KB
b58707f79   赵康   init
1
  # Gump Android SDK使用文档
5817fcc88   赵康   增加链接
2
  接入手册        
dafcd90c0   赵康   修改权限设置,修改常见问题
3
4
  V 3.2.0       
  2015年07月29日    
5817fcc88   赵康   增加链接
5
6
          
  快速入口:       
41f36ed90   赵康   修改服务端回调文档地址
7
  [支付部分服务端回调文档](http://git.letsgame.mobi/document/gumptech-document/blob/master/doc/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. 导入资源工程     
4ab539d5e   赵康   增加Facebook依赖说明
28
29
  1.将GameSDK资源工程拷贝到工作空间,在eclipse中的导航栏右键弹出如图1画面,选择Import导入资源工程,如图1.  
  注意:本sdk需要使用Facebook sdk4.4.1实现fb登录,请自行导入Facebook SDK
b58707f79   赵康   init
30

04a9e9502   赵康   完成格式编辑
31
32
  ![](images/1.png)       
          图1
b58707f79   赵康   init
33
34
  
  2.导入工程后,右键此工程,在Properties->Android中选中此工程为library工程(勾选红色方框标识处)如图2。
04a9e9502   赵康   完成格式编辑
35
36
37
  ![](images/2.png)         
  			图 2        
  ### 2. 添加资源工程
b58707f79   赵康   init
38
  添加资源工程为游戏项目的 library。右键游戏项目,在Properties->Android中点击Add添加资源工程为项目工程的library,结果如图3。 
04a9e9502   赵康   完成格式编辑
39
  ![](images/3.png)       
b58707f79   赵康   init
40
  	图 3
04a9e9502   赵康   完成格式编辑
41

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

04a9e9502   赵康   完成格式编辑
50
51
  ### 3. 代码实现
  #### 1、	修改AndroidManifest.xml文件
b58707f79   赵康   init
52
  	首先添加必要的权限,如下所示:
04a9e9502   赵康   完成格式编辑
53
54
  	
      <uses-permission android:name="android.permission.INTERNET" />
b58707f79   赵康   init
55
56
      <uses-permission android:name="android.permission.READ_PHONE_STATE" />
      <uses-permission android:name="android.permission.BLUETOOTH" />
04a9e9502   赵康   完成格式编辑
57
58
59
60
      <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   赵康   增加系统权限
61
62
      <uses-permission android:name="android.permission.WRITE_EXTERNAL_STORAGE"/>
      <uses-permission android:name="android.permission.MOUNT_UNMOUNT_FILESYSTEMS"/>
dafcd90c0   赵康   修改权限设置,修改常见问题
63
      <uses-permission android:name="android.permission.SEND_SMS"/>
19a7ec3f1   赵康   sdk3.0.0更新使用web支付
64
     
b58707f79   赵康   init
65
66
      <!-- VERY IMPORTANT! Don't forget this permission, or in-app billing won't work. -->
      <uses-permission android:name="com.android.vending.BILLING" />
04a9e9502   赵康   完成格式编辑
67
      
b58707f79   赵康   init
68
  其次注册相应的Activity,具体如下:
04a9e9502   赵康   完成格式编辑
69
70
71
72
73
74
75
76
77
78
  
      <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
79
  	<activity
04a9e9502   赵康   完成格式编辑
80
81
82
83
          android:name="com.gumptech.sdk.PaymentActivity"
          android:configChanges="orientation|screenLayout"
          android:theme="@android:style/Theme.Translucent.NoTitleBar" >
      </activity>
91314fccb   赵康   增加activity配置
84
      <activity
82eb378ad   赵康   3.2.0文档更新
85
86
87
          android:name="com.gumptech.sdk.ExchangeWindow"
          android:configChanges="orientation|screenLayout"
          android:theme="@style/ex_win" >
91314fccb   赵康   增加activity配置
88
      </activity>
cd70fe72b   赵康   add push service
89
90
      <service android:name="com.gumptech.sdk.PushService" >
      </service>
82eb378ad   赵康   3.2.0文档更新
91
92
93
94
95
      <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" />
19a7ec3f1   赵康   sdk3.0.0更新使用web支付
96
      
04a9e9502   赵康   完成格式编辑
97
98
      
  #### 2、	向Gump平台索要游戏ID(GID),完成代码接入
82eb378ad   赵康   3.2.0文档更新
99
  正式开始接入逻辑代码前,先介绍下一些附加配置,以方便代码接入  
fa787d2d0   赵康   增加控制logo显示方法
100
101
102
  *gump logo的显示控制方法,此方法参数指定是否显示GumpLogo
      
      GumpSDK.setShowLogo(boolean);  
2f2769497   赵康   增加横竖屏控制
103
104
105
  *横竖屏控制,默认为横屏,参数为false即为竖屏   
      
      GumpSDK.setScreenLandscape(true);   
82eb378ad   赵康   3.2.0文档更新
106
107
108
109
110
111
112
113
114
115
116
117
118
  *debug模式设置
  
      GumpSDK.setDebugState(true);  
  1.调用GumpSDK前需要执行初始化。     
  
  若不需要分渠道      
  
      GumpSDK.init(Context,Appid, Appkey,InitializeCallback);   
  如果需要定义渠道,必须使用如下方法       
  
      GumpSDK.init(Context,Appid, Appkey,ChannelId,InitializeCallback);   
  
  InitializeCallback为初始化回调接口,此接口只有一个回调方法initComplete(int result) result标识是否初始化成功,当result等于GumpSDK.CODE.OK时为成功,其他为失败
04a9e9502   赵康   完成格式编辑
119
120
121
  2.调用GumpSDK的开始方法,将执行登录流程,需要一个Activity实例作参数       
  
      GumpSDK.start(Activity);  
82eb378ad   赵康   3.2.0文档更新
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
  在此之前,开发者需要注册用户状态监听以接受用户的登录/登出通知,通常如下:    
  
  	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() {
                  //用户登出
                  
              }
          });
04a9e9502   赵康   完成格式编辑
148
  	
82eb378ad   赵康   3.2.0文档更新
149
150
151
152
153
  如上成功登录后收到的GumpUser对象包含以下信息  
  
      gumpUser.getUid();//获取用户的userid,此Id标识唯一用户!  
      gumpUser.getAccountType();//用户类型,此类型数据可从GumpPreference常量获取  
      gumpUser.getSessionKey();//登录的sesionKey  
b58707f79   赵康   init
154

b2ce2ea85   赵康   删除页面支付内容链接
155
  3.支付功能      
e9a2f24b3   赵康   修改支付方法说明
156
  	1)使用gump通行证登录,其中除nick外所有参数为必传参数
99febc3b9   赵康   修改格式
157

04a9e9502   赵康   完成格式编辑
158
159
160
161
162
  	Bundle payInfo = new Bundle();
  	payInfo.putString("nick", "thi");
  	payInfo.putString("product", "元宝");
  	payInfo.putFloat("amount", 40.0f);
  	payInfo.putString("extraInfo", "This is demo!");
abafb4224   赵康   修改初始化方法
163
164
  	payInfo.putString("serverId", "B4003");
  	payInfo.putString("roleId", "10010");
82eb378ad   赵康   3.2.0文档更新
165
  	GumpSDK.pay(MainActivity.this, payInfo,PurchaseCallback);
e9a2f24b3   赵康   修改支付方法说明
166
167
  调用pay方法时,必须穿入一个bundle对象,包含如上字段,除nick外所有字段必须全部包含  
  	2)未使用gump通行证登录,需要传入用户id
bfd80f63f   赵康   add pay method fo...
168
169
170
171
172
173
174
175
  
  	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");
e9a2f24b3   赵康   修改支付方法说明
176
  	GumpSDK.pay(MainActivity.this, payInfo,userId,PurchaseCallback);
82eb378ad   赵康   3.2.0文档更新
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
  	
  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");
      }
      
04a9e9502   赵康   完成格式编辑
195
  5.注销登录      
82eb378ad   赵康   3.2.0文档更新
196
197
  	GumpSDK.logout(Activity);
  当此方法调用后,用户退出登录,并会通过LoginStateListener接口通知调用程序!
04a9e9502   赵康   完成格式编辑
198
  ## 第二章 常见问题      
5817fcc88   赵康   增加链接
199
  ### 问题1: 如何避免混淆对SDK的影响?       
04a9e9502   赵康   完成格式编辑
200
201
202
  解答:有些开发者对接入了SDK的程序进行混淆时,有可能会覆盖某些java
  类,导致SDK无法正常工作,解决方法如下:      
  Ø  请开发者在混淆配置文件proguard.cfg或proguard-project.txt的最后加上       
82eb378ad   赵康   3.2.0文档更新
203
      -keepattributes *Annotation*,InnerClasses,SourceFile,LineNumberTable
0a29f3843   赵康   修改混淆配置,增加保留项
204
205
206
      -keep public class * extends android.app.Service
      -keep public class com.google.vending.licensing.ILicensingService
      -keep public class com.android.vending.licensing.ILicensingService
04a9e9502   赵康   完成格式编辑
207
      -keep class com.gumptech.sdk.view.* {*;}
100dc95c2   赵康   修改混淆配置
208
      -keep class com.gumptech.sdk.web.* {*;}
82eb378ad   赵康   3.2.0文档更新
209
      
04a9e9502   赵康   完成格式编辑
210
      
4ab539d5e   赵康   增加Facebook依赖说明
211
  使得混淆的时候不会影响SDK的命名空间。