AndroidDocument.md 9.63 KB
edit raw blame history


Gump Android SDK使用文档
接入手册

V 3.3.4

2016年01月22日    

快速入口:

支付部分服务端回调文档                                      
目录

第一章  接入指南


1. 导入资源工程

2. 添加资源工程

3. 代码实现

> 1.修改AndroidManifest.xml文件

> 2.向Gump平台索要游戏ID（AppID），完成代码接入

第二章 常见问题


问题1： 如何避免混淆对SDK的影响?

问题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相关的配置


        图1

2.导入工程后，右键此工程，在Properties->Android中选中此工程为library工程（勾选红色方框标识处）如图2。


            图 2        
2. 添加资源工程
添加资源工程为游戏项目的 library。右键游戏项目，在Properties->Android中点击Add添加资源工程为项目工程的library，结果如图3。 


    图 3

注意:如果ADT版本低于14，ADT不支持jar包自动引入，请手动拷贝libs到您的工作
空间。 

Eclipse查看ADT版本号的方法: 
Help==>About Eclips点击Android对应的图标就可以查看版本了. 
如图，红色框部分就是ADT版本号。 

       
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:theme="@android:style/Theme.Translucent.NoTitleBar" >
</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），完成代码接入
正式开始接入逻辑代码前,先介绍下一些附加配置,以方便代码接入  

*横竖屏控制,默认为横屏,参数为false即为竖屏   


    GumpSDK.setScreenLandscape(true);   

  
*debug模式设置


    GumpSDK.setDebugState(true);  

  
*设置是否启用Facebook登录和VK登录


    GumpSDK.setFBEnable(true);
GumpSDK.setVKEnable(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时为成功,其他为失败

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外所有参数为必传参数


    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,PurchaseCallback);

  
调用pay方法时,必须穿入一个bundle对象,包含如上字段,除nick外所有字段必须全部包含

    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,userId,PurchaseCallback);

  
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.* {*;}

  
使得混淆的时候不会影响SDK的命名空间。