SDK / GameSDK-Doc

Download as
Browse Code »

Commit e96fdff45d10a09bf53a5c85c6b26c45adac40fb

Authored by 赵康
1 parent f21f12eea8
Exists in master

增加系统权限

Showing 1 changed file with 2 additions and 0 deletions Inline Diff

1 # Gump Android SDK使用文档 1 # Gump Android SDK使用文档
2 2
3 3
4 接入手册 4 接入手册
5 V 1.5 5 V 1.5
6 2014年07月23日 6 2014年07月23日
7 7
8 快速入口: 8 快速入口:
9 [支付部分服务端回调文档](http://git.letsgame.mobi/document/gumptech-document/blob/master/ServerDocument.md) 9 [支付部分服务端回调文档](http://git.letsgame.mobi/document/gumptech-document/blob/master/ServerDocument.md)
10 10
11 ## 目录 11 ## 目录
12 12
13 * [第一章 接入指南](http://git.letsgame.mobi/document/gumptech-document/blob/master/AndroidDocument.md#) 13 * [第一章 接入指南](http://git.letsgame.mobi/document/gumptech-document/blob/master/AndroidDocument.md#)
14 - [1. 导入资源工程](http://git.letsgame.mobi/document/gumptech-document/blob/master/AndroidDocument.md#1) 14 - [1. 导入资源工程](http://git.letsgame.mobi/document/gumptech-document/blob/master/AndroidDocument.md#1)
15 - [2. 添加资源工程](http://git.letsgame.mobi/document/gumptech-document/blob/master/AndroidDocument.md#2) 15 - [2. 添加资源工程](http://git.letsgame.mobi/document/gumptech-document/blob/master/AndroidDocument.md#2)
16 - [3. 代码实现](http://git.letsgame.mobi/document/gumptech-document/blob/master/AndroidDocument.md#3) 16 - [3. 代码实现](http://git.letsgame.mobi/document/gumptech-document/blob/master/AndroidDocument.md#3)
17 > [1.修改AndroidManifest.xml文件](http://git.letsgame.mobi/document/gumptech-document/blob/master/AndroidDocument.md#1-androidmanifest-xml) 17 > [1.修改AndroidManifest.xml文件](http://git.letsgame.mobi/document/gumptech-document/blob/master/AndroidDocument.md#1-androidmanifest-xml)
18 > [2.向Gump平台索要游戏ID（GID），完成代码接入](http://git.letsgame.mobi/document/gumptech-document/blob/master/AndroidDocument.md#2-gump-id-gid) 18 > [2.向Gump平台索要游戏ID（GID），完成代码接入](http://git.letsgame.mobi/document/gumptech-document/blob/master/AndroidDocument.md#2-gump-id-gid)
19 * [第二章 常见问题](http://git.letsgame.mobi/document/gumptech-document/blob/master/AndroidDocument.md#) 19 * [第二章 常见问题](http://git.letsgame.mobi/document/gumptech-document/blob/master/AndroidDocument.md#)
20 - [问题1： 如何避免混淆对SDK的影响？](http://git.letsgame.mobi/document/gumptech-document/blob/master/AndroidDocument.md#1-sdk) 20 - [问题1： 如何避免混淆对SDK的影响？](http://git.letsgame.mobi/document/gumptech-document/blob/master/AndroidDocument.md#1-sdk)
21 21
22 22
23 23
24 24
25 ## 第一章 接入指南 25 ## 第一章 接入指南
26 配置环境 26 配置环境
27 27
28 本接口API 适用于Android2.2以上各版本Android平台。 28 本接口API 适用于Android2.2以上各版本Android平台。
29 ### 1. 导入资源工程 29 ### 1. 导入资源工程
30 1.将LoginSDK资源工程拷贝到工作空间，在eclipse中的导航栏右键弹出如图1画面，选择Import导入资源工程，如图1. 30 1.将LoginSDK资源工程拷贝到工作空间，在eclipse中的导航栏右键弹出如图1画面，选择Import导入资源工程，如图1.
31 31
32 ![](images/1.png) 32 ![](images/1.png)
33 图1 33 图1
34 34
35 2.导入工程后，右键此工程，在Properties->Android中选中此工程为library工程（勾选红色方框标识处）如图2。 35 2.导入工程后，右键此工程，在Properties->Android中选中此工程为library工程（勾选红色方框标识处）如图2。
36 ![](images/2.png) 36 ![](images/2.png)
37 图 2 37 图 2
38 ### 2. 添加资源工程 38 ### 2. 添加资源工程
39 添加资源工程为游戏项目的 library。右键游戏项目，在Properties->Android中点击Add添加资源工程为项目工程的library，结果如图3。 39 添加资源工程为游戏项目的 library。右键游戏项目，在Properties->Android中点击Add添加资源工程为项目工程的library，结果如图3。
40 ![](images/3.png) 40 ![](images/3.png)
41 图 3 41 图 3
42 42
43 43
44 注意:如果ADT版本低于14，ADT不支持jar包自动引入，请手动拷贝libs到您的工作 44 注意:如果ADT版本低于14，ADT不支持jar包自动引入，请手动拷贝libs到您的工作
45 空间。 45 空间。
46 46
47 Eclipse查看ADT版本号的方法: 47 Eclipse查看ADT版本号的方法:
48 Help==>About Eclips点击Android对应的图标就可以查看版本了. 48 Help==>About Eclips点击Android对应的图标就可以查看版本了.
49 如图，红色框部分就是ADT版本号。 49 如图，红色框部分就是ADT版本号。
50 50
51 ![](images/4.png) 51 ![](images/4.png)
52 52
53 53
54 ### 3. 代码实现 54 ### 3. 代码实现
55 #### 1、 修改AndroidManifest.xml文件 55 #### 1、 修改AndroidManifest.xml文件
56 首先添加必要的权限，如下所示： 56 首先添加必要的权限，如下所示：
57 57
58 <uses-permission android:name="android.permission.INTERNET" /> 58 <uses-permission android:name="android.permission.INTERNET" />
59 <uses-permission android:name="android.permission.READ_PHONE_STATE" /> 59 <uses-permission android:name="android.permission.READ_PHONE_STATE" />
60 <uses-permission android:name="android.permission.BLUETOOTH" /> 60 <uses-permission android:name="android.permission.BLUETOOTH" />
61 <uses-permission android:name="android.permission.ACCESS_WIFI_STATE" /> 61 <uses-permission android:name="android.permission.ACCESS_WIFI_STATE" />
62 <uses-permission android:name="android.permission.WRITE_SETTINGS"/> 62 <uses-permission android:name="android.permission.WRITE_SETTINGS"/>
63 <uses-permission android:name="android.permission.GET_ACCOUNTS"/> 63 <uses-permission android:name="android.permission.GET_ACCOUNTS"/>
64 <uses-permission android:name="android.permission.ACCESS_NETWORK_STATE"/> 64 <uses-permission android:name="android.permission.ACCESS_NETWORK_STATE"/>
65 <uses-permission android:name="android.permission.WRITE_EXTERNAL_STORAGE"/>
66 <uses-permission android:name="android.permission.MOUNT_UNMOUNT_FILESYSTEMS"/>
65 <!-- for card.io card scanning --> 67 <!-- for card.io card scanning -->
66 <uses-permission android:name="android.permission.CAMERA" /> 68 <uses-permission android:name="android.permission.CAMERA" />
67 <uses-permission android:name="android.permission.VIBRATE" /> 69 <uses-permission android:name="android.permission.VIBRATE" />
68 <uses-feature android:name="android.hardware.camera" android:required="false" /> 70 <uses-feature android:name="android.hardware.camera" android:required="false" />
69 <uses-feature android:name="android.hardware.camera.autofocus" android:required="false" /> 71 <uses-feature android:name="android.hardware.camera.autofocus" android:required="false" />
70 <!-- VERY IMPORTANT! Don't forget this permission, or in-app billing won't work. --> 72 <!-- VERY IMPORTANT! Don't forget this permission, or in-app billing won't work. -->
71 <uses-permission android:name="com.android.vending.BILLING" /> 73 <uses-permission android:name="com.android.vending.BILLING" />
72 74
73 其次注册相应的Activity，具体如下： 75 其次注册相应的Activity，具体如下：
74 76
75 <activity 77 <activity
76 android:name="com.gumptech.sdk.ContainerActivity" 78 android:name="com.gumptech.sdk.ContainerActivity"
77 android:theme="@style/container_dialog" 79 android:theme="@style/container_dialog"
78 android:configChanges="orientation|screenLayout" > 80 android:configChanges="orientation|screenLayout" >
79 </activity> 81 </activity>
80 <activity 82 <activity
81 android:name="com.facebook.LoginActivity" 83 android:name="com.facebook.LoginActivity"
82 android:theme="@android:style/Theme.Translucent.NoTitleBar" > 84 android:theme="@android:style/Theme.Translucent.NoTitleBar" >
83 </activity> 85 </activity>
84 <activity 86 <activity
85 android:name="com.gumptech.sdk.PaymentActivity" 87 android:name="com.gumptech.sdk.PaymentActivity"
86 android:configChanges="orientation|screenLayout" 88 android:configChanges="orientation|screenLayout"
87 android:theme="@android:style/Theme.Translucent.NoTitleBar" > 89 android:theme="@android:style/Theme.Translucent.NoTitleBar" >
88 </activity> 90 </activity>
89 <!-- paypal --> 91 <!-- paypal -->
90 <service 92 <service
91 android:name="com.paypal.android.sdk.payments.PayPalService" 93 android:name="com.paypal.android.sdk.payments.PayPalService"
92 android:exported="false" /> 94 android:exported="false" />
93 95
94 <activity android:name="com.paypal.android.sdk.payments.PaymentActivity" /> 96 <activity android:name="com.paypal.android.sdk.payments.PaymentActivity" />
95 <activity android:name="com.paypal.android.sdk.payments.LoginActivity" /> 97 <activity android:name="com.paypal.android.sdk.payments.LoginActivity" />
96 <activity android:name="com.paypal.android.sdk.payments.PaymentMethodActivity" /> 98 <activity android:name="com.paypal.android.sdk.payments.PaymentMethodActivity" />
97 <activity android:name="com.paypal.android.sdk.payments.PaymentConfirmActivity" /> 99 <activity android:name="com.paypal.android.sdk.payments.PaymentConfirmActivity" />
98 <activity android:name="com.paypal.android.sdk.payments.PayPalFuturePaymentActivity" /> 100 <activity android:name="com.paypal.android.sdk.payments.PayPalFuturePaymentActivity" />
99 <activity android:name="com.paypal.android.sdk.payments.FuturePaymentConsentActivity" /> 101 <activity android:name="com.paypal.android.sdk.payments.FuturePaymentConsentActivity" />
100 <activity android:name="com.paypal.android.sdk.payments.FuturePaymentInfoActivity" /> 102 <activity android:name="com.paypal.android.sdk.payments.FuturePaymentInfoActivity" />
101 <activity 103 <activity
102 android:name="io.card.payment.CardIOActivity" 104 android:name="io.card.payment.CardIOActivity"
103 android:configChanges="keyboardHidden|orientation" /> 105 android:configChanges="keyboardHidden|orientation" />
104 <activity android:name="io.card.payment.DataEntryActivity" /> 106 <activity android:name="io.card.payment.DataEntryActivity" />
105 107
106 #### 2、 向Gump平台索要游戏ID（GID），完成代码接入 108 #### 2、 向Gump平台索要游戏ID（GID），完成代码接入
107 1.调用GumpSDK前需要执行初始化。 109 1.调用GumpSDK前需要执行初始化。
108 若不需要分渠道 110 若不需要分渠道
109 111
110 GumpSDK.init(Appid, Appkey,FacebookId); 112 GumpSDK.init(Appid, Appkey,FacebookId);
111 如果需要定义渠道,必须使用如下方法 113 如果需要定义渠道,必须使用如下方法
112 114
113 GumpSDK.init(Appid, Appkey,FacebookId,ChannelId); 115 GumpSDK.init(Appid, Appkey,FacebookId,ChannelId);
114 2.调用GumpSDK的开始方法,将执行登录流程,需要一个Activity实例作参数 116 2.调用GumpSDK的开始方法,将执行登录流程,需要一个Activity实例作参数
115 117
116 GumpSDK.start(Activity); 118 GumpSDK.start(Activity);
117 开发者需要在调用的Activity里重写onActivityResult方法以接受用户的登录结果,通常如下: 119 开发者需要在调用的Activity里重写onActivityResult方法以接受用户的登录结果,通常如下:
118 120
119 //登录请求返回结果 121 //登录请求返回结果
120 if (requestCode == GumpSDK.LOGIN_REQUEST_CODE) { 122 if (requestCode == GumpSDK.LOGIN_REQUEST_CODE) {
121 if (resultCode == RESULT_OK) { 123 if (resultCode == RESULT_OK) {
122 int uid = data.getIntExtra("userId", -1); 124 int uid = data.getIntExtra("userId", -1);
123 int accountType = data.getIntExtra("accountType", -1); 125 int accountType = data.getIntExtra("accountType", -1);
124 String sessionkey = data.getStringExtra("sessionKey"); 126 String sessionkey = data.getStringExtra("sessionKey");
125 127
126 } else if (resultCode == RESULT_CANCELED) { 128 } else if (resultCode == RESULT_CANCELED) {
127 Toast.makeText(this, "operate be canceled", Toast.LENGTH_SHORT).show(); 129 Toast.makeText(this, "operate be canceled", Toast.LENGTH_SHORT).show();
128 } 130 }
129 } 131 }
130 132
131 如上将收到成功登录用的userid,此Id标识唯一用户! 133 如上将收到成功登录用的userid,此Id标识唯一用户!
132 3.用户绑定邮箱,并填写密码 134 3.用户绑定邮箱,并填写密码
133 135
134 GumpSDK.boundMail(MainActivity.this); 136 GumpSDK.boundMail(MainActivity.this);
135 开发者需要在调用的Activity里重写onActivityResult方法以接受用户的绑定结果,通常如下: 137 开发者需要在调用的Activity里重写onActivityResult方法以接受用户的绑定结果,通常如下:
136 138
137 //绑定邮箱请求返回结果 139 //绑定邮箱请求返回结果
138 if (requestCode == GumpSDK.BOUND_REQUEST_CODE) { 140 if (requestCode == GumpSDK.BOUND_REQUEST_CODE) {
139 if (resultCode == RESULT_OK) { 141 if (resultCode == RESULT_OK) {
140 int uid = data.getIntExtra("userId", -1); 142 int uid = data.getIntExtra("userId", -1);
141 int accountType = data.getIntExtra("accountType", -1); 143 int accountType = data.getIntExtra("accountType", -1);
142 String sessionkey = data.getStringExtra("sessionKey"); 144 String sessionkey = data.getStringExtra("sessionKey");
143 } else if (resultCode == RESULT_CANCELED) { 145 } else if (resultCode == RESULT_CANCELED) {
144 Toast.makeText(this, "operate be canceled", Toast.LENGTH_SHORT).show(); 146 Toast.makeText(this, "operate be canceled", Toast.LENGTH_SHORT).show();
145 } 147 }
146 } 148 }
147 4.支付功能 149 4.支付功能
148 150
149 Bundle payInfo = new Bundle(); 151 Bundle payInfo = new Bundle();
150 payInfo.putString("nick", "thi"); 152 payInfo.putString("nick", "thi");
151 payInfo.putString("product", "元宝"); 153 payInfo.putString("product", "元宝");
152 payInfo.putFloat("amount", 40.0f); 154 payInfo.putFloat("amount", 40.0f);
153 payInfo.putString("extraInfo", "This is demo!"); 155 payInfo.putString("extraInfo", "This is demo!");
154 GumpSDK.pay(MainActivity.this, payInfo); 156 GumpSDK.pay(MainActivity.this, payInfo);
155 调用pay方法时,必须穿入一个bundle对象,包含如上字段,可以设置值为空,但是字段必须全部包含,支付完成仍然通过onActivityResult回调,requestCode为GumpSDK.PAY_REQUEST_CODE,回调信息除code和msg外,还含有orderId和传入的extraInfo. 157 调用pay方法时,必须穿入一个bundle对象,包含如上字段,可以设置值为空,但是字段必须全部包含,支付完成仍然通过onActivityResult回调,requestCode为GumpSDK.PAY_REQUEST_CODE,回调信息除code和msg外,还含有orderId和传入的extraInfo.
156 5.注销登录 158 5.注销登录
157 159
158 GumpSDK.logout(Activity,GumpSDK.Callback); 160 GumpSDK.logout(Activity,GumpSDK.Callback);
159 当此方法调用后,用户退出登录,并会通过callback接口通知调用程序! 161 当此方法调用后,用户退出登录,并会通过callback接口通知调用程序!
160 ## 第二章 常见问题 162 ## 第二章 常见问题
161 ### 问题1： 如何避免混淆对SDK的影响？ 163 ### 问题1： 如何避免混淆对SDK的影响？
162 解答：有些开发者对接入了SDK的程序进行混淆时，有可能会覆盖某些java 164 解答：有些开发者对接入了SDK的程序进行混淆时，有可能会覆盖某些java
163 类，导致SDK无法正常工作，解决方法如下: 165 类，导致SDK无法正常工作，解决方法如下:
164 Ø 请开发者在混淆配置文件proguard.cfg或proguard-project.txt的最后加上 166 Ø 请开发者在混淆配置文件proguard.cfg或proguard-project.txt的最后加上
165 167
166 -keep class com.gumptech.sdk.GumpSDK{ 168 -keep class com.gumptech.sdk.GumpSDK{
167 public static final <fields>; 169 public static final <fields>;
168 public static void init(java.lang.String,java.lang.String); 170 public static void init(java.lang.String,java.lang.String);
169 public static void init(java.lang.String,java.lang.String,java.lang.String,java.lang.String); 171 public static void init(java.lang.String,java.lang.String,java.lang.String,java.lang.String);
170 public static void start(android.app.Activity); 172 public static void start(android.app.Activity);
171 public static void logout(android.app.Activity); 173 public static void logout(android.app.Activity);
172 public static void boundMail(android.app.Activity); 174 public static void boundMail(android.app.Activity);
173 } 175 }
174 -keep class com.gumptech.sdk.view.* {*;} 176 -keep class com.gumptech.sdk.view.* {*;}
175 -keep class com.gumptech.sdk.GumpSDK$Callback{ 177 -keep class com.gumptech.sdk.GumpSDK$Callback{
176 void onLogout(); 178 void onLogout();
177 } 179 }
178 -keep class com.gumptech.sdk.GumpPreference{ 180 -keep class com.gumptech.sdk.GumpPreference{
179 public static final <fields>; 181 public static final <fields>;
180 } 182 }
181 -keep class com.facebook.** { *; } 183 -keep class com.facebook.** { *; }
182 184
183 -keepattributes Signature 185 -keepattributes Signature
184 使得混淆的时候不会影响SDK的命名空间。 186 使得混淆的时候不会影响SDK的命名空间。