CNLive Android Team / CNUserDemo · Commits

Commit 609fcb38ffc80aad54be703f114ff1acebbaff6b

Authored by 王琳
1 parent 7f4f05e6

添加readme

Inline Side-by-side
Showing 1 changed file with 166 additions and 0 deletions
README.md 0 → 100644
  View file @609fcb3
  1 +用户Android SDK 说明文档
  2 +用户Android SDK是在Android 平台上使用的软件开发工具包(SDK),通过本SDK可实现：登录、快捷登录、第三方登陆、注册、查询用户信息、更新用户附加信息、更新手机号、通过手机号修改密码、上传头像、修改用户单项信息、用户反馈和发送手机验证码的功能。
  3 +
  4 +引入资源包：
  5 +{project}/libs/libcnliveutil.jar
  6 +{project}/libs/libcnliveuser.jar
  7 +系统权限
  8 +<uses-permission android:name="android.permission.SEND_SMS" />
  9 +<uses-permission android:name="android.permission.RECEIVE_SMS" />
  10 +<uses-permission android:name="android.permission.READ_SMS" />
  11 +<uses-permission android:name="android.permission.INTERNET" />
  12 +<uses-permission 
  13 + android:name="android.permission.WRITE_EXTERNAL_STORAGE" />
  14 +<uses-permission 
  15 + android:name="android.permission.READ_EXTERNAL_STORAGE" />
  16 +使用方法（详见Demo）：
  17 +初始化用户SDK
  18 +@Override
  19 +protected void onCreate(Bundle savedInstanceState) {
  20 +    super.onCreate(savedInstanceState);
  21 +    //初始化用户SDK
  22 +    cnLiveUser = new CNLiveUser(cnUserCallBack, cnUserBuilder);
  23 +}
  24 +
  25 +
  26 +
  27 +
  28 +
  29 +
  30 +
  31 +
  32 +处理SDK状态
  33 +private class CNUserUtilCallback implements CNUserCallBack {
  34 +        @Override
  35 +        public void onUserState(String what, String extra) {
  36 +            switch (what){
  37 +                case UserState.ERROR_INIT_NETWORK:
  38 +                    //网络连接失败
  39 +                    break;
  40 +                case UserState.ERROR_INIT_OTHER:
  41 +                    //内部错误
  42 +                    break;
  43 +            }
  44 +            Log.e("DemoView","errorCode="+what+"errorMessage="+extra);
  45 +        }
  46 +}
  47 +
  48 +以用户登录为例介绍SDK的使用方法，其他与其类似
  49 +public class LoginActivity extends BaseActivity 
  50 + implements View.OnClickListener {
  51 +    private EditText userName, userPassword;
  52 +    private Button login;
  53 +    private TextView register, quickLogin, other, thirdParytLogin;
  54 + 
  55 +    @Override
  56 +    protected void onCreate(Bundle savedInstanceState) {
  57 +        super.onCreate(savedInstanceState);
  58 +        setContentView(R.layout.activity_user);
  59 +        initView();
  60 +    }
  61 + 
  62 +    public void initView() {
  63 +        //...
  64 +    }
  65 + 
  66 +    
  67 +
  68 +
  69 +
  70 +
  71 +
  72 +
  73 +
  74 +
  75 +
  76 +@Override
  77 +    public void onClick(View view) {
  78 +        Intent intent;
  79 +        switch (view.getId()) {
  80 +            case R.id.quick_login_textView:
  81 +                intent = new Intent(this, QuickLoginActivity.class);
  82 +                startActivity(intent);
  83 +                break;
  84 +            case R.id.register_textView:
  85 +                intent = new Intent(this, RegisterActivity.class);
  86 +                startActivity(intent);
  87 +                break;
  88 +            case R.id.other_textView:
  89 +                intent = new Intent(this, OtherActivity.class);
  90 +                startActivity(intent);
  91 +                break;
  92 +            case R.id.login:
  93 +                //用户名&密码登录
  94 +                cnUserBuilder.setUserName(
  95 + String.valueOf(userName.getText()));//用户名
  96 +                cnUserBuilder.setPwd(
  97 + String.valueOf(userPassword.getText()));//密码
  98 +//                cnUserBuilder.setFrmId("frmId");//渠道ID
  99 +                cnLiveUser.login();
  100 +                break;
  101 +            case R.id.third_party_login:
  102 +                //第三方登陆
  103 + // 第三方平台编号
  104 +  [platform ： 1:sina weibo 2:qq weibo 3:weixin 4:renren
  105 +                cnUserBuilder.setThirdPartyPlat(1);
  106 +                cnUserBuilder.setThirdPartyId("id");//第三方用户ID
  107 +                cnUserBuilder.setNickName("nickname");//用户昵称?重复
  108 + //性别，m：男、f：女、n：未知
  109 +//                cnUserBuilder.setGender("n");
  110 + //用户所在地 非必传
  111 +                 cnUserBuilder.setLocation("location");
  112 +//                cnUserBuilder.setFaceUrl("faceUrl");//头像
  113 +//                cnUserBuilder.setFrmId("frmId");//渠道ID
  114 +                cnLiveUser.thirdPartyLogin();
  115 +                break;
  116 +        }
  117 +    }
  118 +}
  119 +SDK开放的方法：
  120 +来设置请求接口是要传入的参数
  121 +cnLiveUser.initUser(**);
  122 +
  123 +上传头像
  124 +cnLiveUser.uploadFace(file);
  125 +
  126 +用户反馈
  127 +cnLiveUser.feedback();
  128 +
  129 +更新手机号
  130 +cnLiveUser.updateMobile();
  131 +
  132 +更新用户附加信息
  133 +cnLiveUser.updateUserExtInfo();
  134 +
  135 +查询用户信息
  136 +cnLiveUser.queryUserInfo();
  137 +
  138 +更新用户单项信息
  139 +cnLiveUser.modifyUserInfo();
  140 +
  141 +通过手机号修改密码
  142 +cnLiveUser.modifyPwdWithMob();
  143 +
  144 +登录
  145 +cnLiveUser.login();
  146 +
  147 +第三方登录
  148 +cnLiveUser.thirdPartyLogin();
  149 +
  150 +快捷登录
  151 +cnLiveUser.quickLogin();
  152 +
  153 +发送验证码
  154 +* 发送手机验证码需要传入一个type值用来区分发送的验证码是用来做什么的
  155 +* QUICK_LOGIN--->快捷登陆前发送手机验证码
  156 +* REGISTER_OR_MODIFY_MOBILE---> 注册或修改手机号前发手机验证码
  157 +* RETRIEVE_OR_MODIFY_PASSWORD---> 找回或修改密码前发手机验证码
  158 +cnLiveUser.sendMessage(UserState.QUICK_LOGIN);
  159 +
  160 +注册
  161 +cnLiveUser.register()
  162 +
  163 +错误类型定义：
  164 +变量名 数值 含义
  165 +ERROR_INIT_NETWORK -1000 网络连接失败
  166 +ERROR_INIT_OTHER -1001 内部错误
... ...