为用户SDK的Demo添加注释

王琳
1 parent 3b055249
Showing 7 changed files with 78 additions and 29 deletions
app/src/main/AndroidManifest.xml
app/src/main/java/com/cnlive/libs/BaseActivity.java
app/src/main/java/com/cnlive/libs/UserActivity.java → app/src/main/java/com/cnlive/libs/LoginActivity.java
app/src/main/java/com/cnlive/libs/OtherActivity.java
app/src/main/java/com/cnlive/libs/QuickLoginActivity.java
app/src/main/java/com/cnlive/libs/RegisterActivity.java
app/src/main/res/layout/activity_user.xml
@@ -24,7 +24,7 @@
         android:label="@string/app_name"
         android:supportsRtl="true"
         android:theme="@style/AppTheme">
-        <activity android:name=".UserActivity">
+        <activity android:name=".LoginActivity">
             <intent-filter>
                 <action android:name="android.intent.action.MAIN" />
@@ -16,14 +16,18 @@ public class BaseActivity extends AppCompatActivity {
     public CNLiveUser cnLiveUser;
     public CNUserCallBack cnUserCallBack = new CNUserUtilCallback();
+    
+    //通过cnUserBuilder设置请求接口是需要传入的参数,也可以获得请求接口成功后获得的数据
     public CNUserBuilder.Builder cnUserBuilder = new CNUserBuilder.Builder();
     @Override
     protected void onCreate(Bundle savedInstanceState) {
         super.onCreate(savedInstanceState);
+        //初始化用户SDK
         cnLiveUser = new CNLiveUser(cnUserCallBack);
     }
+    //通过CNUserUtilCallback处理SDK状态,通过what和extra可以获取错误码和错误信息
     private class CNUserUtilCallback implements CNUserCallBack {
         @Override
@@ -9,7 +9,10 @@ import android.widget.TextView;
 import com.cnlive.libs.user.model.CNUserBuilder;
-public class UserActivity extends BaseActivity implements View.OnClickListener {
+/**
+ * 用户登录
+ */
+public class LoginActivity extends BaseActivity implements View.OnClickListener {
     private EditText userName, userPassword;
     private Button login;
     private TextView register, quickLogin, other, thirdParytLogin;
@@ -58,31 +61,37 @@ public class UserActivity extends BaseActivity implements View.OnClickListener {
                 startActivity(intent);
                 break;
             case R.id.login:
+                //用户名&密码登录
                 cnLiveUser.initUser(setCNUserData());
                 cnLiveUser.login();
                 break;
             case R.id.third_party_login:
+                //第三方登陆
                 cnLiveUser.initUser(thirdPartyLoginData());
                 cnLiveUser.thirdPartyLogin();
                 break;
         }
     }
+    //下面注释掉的参数为非必传参数
+
     protected CNUserBuilder.Builder setCNUserData() {
-        cnUserBuilder.setUuid("uuid");
-        cnUserBuilder.setUserName(String.valueOf(userName.getText()));
-        cnUserBuilder.setPwd(String.valueOf(userPassword.getText()));
+        cnUserBuilder.setUuid("uuid");//设备ID
+        cnUserBuilder.setUserName(String.valueOf(userName.getText()));//用户名
+        cnUserBuilder.setPwd(String.valueOf(userPassword.getText()));//密码
+//        cnUserBuilder.setFrmId("frmId");//渠道ID
         return cnUserBuilder;
     }
     private CNUserBuilder.Builder thirdPartyLoginData() {
-        cnUserBuilder.setThirdPartyPlat(1);// 1:sina weibo 2:qq weibo 3:weixin 4:renren
-        cnUserBuilder.setThirdPartyId("id");
-        cnUserBuilder.setNickName("nickname");
-        cnUserBuilder.setGender("n");
-        cnUserBuilder.setLocation("location");
-        cnUserBuilder.setFaceUrl("faceUrl");
-        cnUserBuilder.setUuid("uuid");
+        cnUserBuilder.setThirdPartyPlat(1);// 第三方平台编号 [platform ： 1:sina weibo 2:qq weibo 3:weixin 4:renren
+        cnUserBuilder.setThirdPartyId("id");//第三方用户ID
+        cnUserBuilder.setNickName("nickname");//用户昵称?重复
+        cnUserBuilder.setUuid("uuid");//设备ID
+//        cnUserBuilder.setGender("n");//性别，m：男、f：女、n：未知
+//        cnUserBuilder.setLocation("location");//用户所在地 非必传
+//        cnUserBuilder.setFaceUrl("faceUrl");//头像
+//        cnUserBuilder.setFrmId("frmId");//渠道ID
         return cnUserBuilder;
     }
 }
@@ -12,7 +12,9 @@ import java.io.File;
 public class OtherActivity extends BaseActivity implements View.OnClickListener {
+    //demo中上传的头像文件
     File file = new File("/sdcard/1.jpg");
+
     private EditText feedbackMsg;
     private Button feedback, uploadFace;
     private TextView modifyMobile, updateUserExtInfo, queryUserInfo, modifyUserInfo, modifyPwdWithMobile;
@@ -25,59 +27,74 @@ public class OtherActivity extends BaseActivity implements View.OnClickListener 
         initView();
     }
-
+    //初始化视图
     public void initView() {
+        //用户反馈
         feedbackMsg = (EditText) findViewById(R.id.feedback_textView);
         feedback = (Button) findViewById(R.id.feedback);
         feedback.setOnClickListener(this);
+        //上传头像
         uploadFace = (Button) findViewById(R.id.uploadface);
         uploadFace.setOnClickListener(this);
+        //更新手机号码
         modifyMobile = (TextView) findViewById(R.id.modify_mobile);
         modifyMobile.setOnClickListener(this);
+        //更新用户附加信息
         updateUserExtInfo = (TextView) findViewById(R.id.update_user_ext_info);
         updateUserExtInfo.setOnClickListener(this);
+        //查询用户信息
         queryUserInfo = (TextView) findViewById(R.id.query_user_info);
         queryUserInfo.setOnClickListener(this);
+        //更新用户单项信息
         modifyUserInfo = (TextView) findViewById(R.id.modify_user_info);
         modifyUserInfo.setOnClickListener(this);
+        //通过手机号码更改密码
         modifyPwdWithMobile = (TextView) findViewById(R.id.modify_pwd_through_mobile);
         modifyPwdWithMobile.setOnClickListener(this);
     }
     @Override
     public void onClick(View view) {
+        //cnLiveUser.initUser(**); 本方法是用来设置请求接口是要传入的参数
         switch (view.getId()) {
             case R.id.uploadface:
+                //上传头像
                 cnLiveUser.initUser(uploadFaceData());
                 cnLiveUser.uploadFace(file);
                 break;
             case R.id.feedback:
+                //用户反馈
                 cnLiveUser.initUser(setCNUserData());
                 cnLiveUser.feedback();
                 break;
             case R.id.modify_mobile:
+                //更新手机号
                 cnLiveUser.initUser(modifyMobile());
                 cnLiveUser.updateMobile();
                 break;
             case R.id.update_user_ext_info:
+                //更新用户附加信息
                 cnLiveUser.initUser(updateUserExtInfo());
                 cnLiveUser.updateUserExtInfo();
                 break;
             case R.id.query_user_info:
+                //查询用户信息
                 cnLiveUser.initUser(queryUserInfo());
                 cnLiveUser.queryUserInfo();
                 break;
             case R.id.modify_user_info:
+                //更新用户单项信息
                 cnLiveUser.initUser(modifyUserInfo());
                 cnLiveUser.modifyUserInfo();
                 break;
             case R.id.modify_pwd_through_mobile:
+                //通过手机号码修改密码
                 cnLiveUser.initUser(modifyPwdWithMobile());
                 cnLiveUser.modifyPwdWithMob();
                 break;
@@ -91,36 +108,36 @@ public class OtherActivity extends BaseActivity implements View.OnClickListener 
     }
     protected CNUserBuilder.Builder uploadFaceData() {
-        cnUserBuilder.setSecret("33eb04e9ca7001e878eb8a57e2a1068d7b48c2909fc341");
+        cnUserBuilder.setSecret("33eb04e9ca7001e878eb8a57e2a1068d7b48c2909fc341");//app_secret
         return cnUserBuilder;
     }
     private CNUserBuilder.Builder modifyMobile() {
-        cnUserBuilder.setMobile("18844444444");
-        cnUserBuilder.setVerificationCode("123456");
+        cnUserBuilder.setMobile("18844444444");//手机号
+        cnUserBuilder.setVerificationCode("123456");//手机验证码
         return cnUserBuilder;
     }
     private CNUserBuilder.Builder updateUserExtInfo() {
-        cnUserBuilder.setExtInfo("sdjfoisdf");
+        cnUserBuilder.setExtInfo("sdjfoisdf");//扩展信息（格式自己组织）
         return cnUserBuilder;
     }
     private CNUserBuilder.Builder queryUserInfo() {
-        cnUserBuilder.setSrcUid("1342671");
+        cnUserBuilder.setSrcUid("1342671");//被查询用户ID
         return cnUserBuilder;
     }
     private CNUserBuilder.Builder modifyUserInfo() {
-        cnUserBuilder.setType("nickName");
+        cnUserBuilder.setType("nickName");//nickName-昵称，gender-性别，email-邮箱, location-联系方式
         cnUserBuilder.setValue("woa");
         return cnUserBuilder;
     }
     private CNUserBuilder.Builder modifyPwdWithMobile() {
-        cnUserBuilder.setMobile("13811112222");
-        cnUserBuilder.setVerificationCode("123456");
-        cnUserBuilder.setNewPwd("123456");
+        cnUserBuilder.setMobile("13811112222");//手机号
+        cnUserBuilder.setVerificationCode("123456");//验证码
+        cnUserBuilder.setNewPwd("123456");//新密码
         return cnUserBuilder;
     }
 }
@@ -8,6 +8,9 @@ import android.widget.EditText;
 import com.cnlive.libs.user.model.CNUserBuilder;
 import com.cnlive.libs.user.model.UserState;
+/**
+ * 用户快捷登录(手机验证码登录)
+ */
 public class QuickLoginActivity extends BaseActivity implements View.OnClickListener {
     private EditText mobile, code;
@@ -35,7 +38,15 @@ public class QuickLoginActivity extends BaseActivity implements View.OnClickList
     public void onClick(View view) {
         switch (view.getId()) {
             case R.id.getNumber:
+                //快捷登录前发送手机验证码
                 cnLiveUser.initUser(setVerificationCode());
+
+                /**
+                 * 发送手机验证码需要传入一个type值用来区分发送的验证码是用来做什么的
+                 * QUICK_LOGIN--->快捷登陆前发送手机验证码
+                 * REGISTER_OR_MODIFY_MOBILE---> 注册或修改手机号前发手机验证码
+                 * RETRIEVE_OR_MODIFY_PASSWORD---> 找回或修改密码前发手机验证码
+                 */
                 cnLiveUser.sendMessage(UserState.QUICK_LOGIN);
                 break;
             case R.id.quick_login:
@@ -45,9 +56,10 @@ public class QuickLoginActivity extends BaseActivity implements View.OnClickList
         }
     }
+    //下面注释掉的参数为非必传参数
+
     private CNUserBuilder.Builder setVerificationCode() {
         cnUserBuilder.setMobile(mobile.getText().toString());
-        cnUserBuilder.setClientPlat("a");
         return cnUserBuilder;
     }
@@ -55,8 +67,7 @@ public class QuickLoginActivity extends BaseActivity implements View.OnClickList
         cnUserBuilder.setUserName(String.valueOf(mobile.getText()));
         cnUserBuilder.setVerificationCode(String.valueOf(code.getText()));
         cnUserBuilder.setUuid("uuid");
-        cnUserBuilder.setFrmId("frmId");
-        cnUserBuilder.setClientPlat("a");
+//        cnUserBuilder.setFrmId("frmId");
         return cnUserBuilder;
     }
 }
@@ -8,6 +8,9 @@ import android.widget.EditText;
 import com.cnlive.libs.user.model.CNUserBuilder;
 import com.cnlive.libs.user.model.UserState;
+/**
+ * 用户注册
+ */
 public class RegisterActivity extends BaseActivity implements View.OnClickListener {
     private EditText userName, userPassword, number;
@@ -40,22 +43,27 @@ public class RegisterActivity extends BaseActivity implements View.OnClickListen
                 cnLiveUser.register();
                 break;
             case R.id.getNumber:
+                //使用手机号注册前发送手机验证码
                 cnLiveUser.initUser(setInvitationCode());
                 cnLiveUser.sendMessage(UserState.REGISTER_OR_MODIFY_MOBILE);
                 break;
         }
     }
+    //下面注释掉的参数为非必传参数
+
     private CNUserBuilder.Builder setInvitationCode() {
         cnUserBuilder.setMobile(userName.getText().toString());
         return cnUserBuilder;
     }
     protected CNUserBuilder.Builder setCNUserData() {
-        cnUserBuilder.setUserName(userName.getText().toString());
-        cnUserBuilder.setPwd(userPassword.getText().toString());
-        cnUserBuilder.setVerificationCode(number.getText().toString());
+        cnUserBuilder.setUserName(userName.getText().toString());//邮箱或手机
+        cnUserBuilder.setPwd(userPassword.getText().toString());//密码
         cnUserBuilder.setUuid("uuid");
+        cnUserBuilder.setVerificationCode(number.getText().toString());//手机验证码（手机号注册时必填）
+//        cnUserBuilder.setInvitationCode("invitationCode");//邀请码
+//        cnUserBuilder.setFrmId("frmId");//渠道ID
         return cnUserBuilder;
     }
 }
@@ -7,7 +7,7 @@
     android:paddingLeft="@dimen/activity_horizontal_margin"
     android:paddingRight="@dimen/activity_horizontal_margin"
     android:paddingTop="@dimen/activity_vertical_margin"
-    tools:context="UserActivity">
+    tools:context=".LoginActivity">
     <TextView
         android:id="@+id/login_layout"