cn.leancloud

类 AVUser

java.lang.Object

cn.leancloud.AVObject

cn.leancloud.AVUser

public class AVUser
extends AVObject

嵌套类概要

嵌套类

限定符和类型	类和说明
static class	AVUser.SNS_PLATFORM

字段概要

字段

限定符和类型	字段和说明
static String	ATTR_EMAIL
static String	ATTR_MOBILEPHONE
static String	ATTR_SESSION_TOKEN
static String	ATTR_USERNAME
static String	CLASS_NAME
static String	FOLLOWEE_TAG
static String	FOLLOWER_TAG

从类继承的字段 cn.leancloud.AVObject

acl, className, endpointClassName, KEY_ACL, KEY_CLASSNAME, KEY_CREATED_AT, KEY_OBJECT_ID, KEY_UPDATED_AT, logger, objectId, operations, serverData, totallyOverwrite, UUID_LEN

构造器概要

构造器

构造器和说明
AVUser() constructor

方法概要

限定符和类型	方法和说明
static void	alwaysUseSubUserClass(Class<? extends AVUser> clazz) 通过设置此方法，所有关联对象中的 AVUser 对象都会被强转成注册的 AVUser 子类对象
io.reactivex.Observable<AVUser>	associateWithAuthData(Map<String,Object> authData, String platform)
io.reactivex.Observable<AVUser>	associateWithAuthData(Map<String,Object> authData, String platform, String unionId, String unionIdPlatform, boolean asMainAccount)
static AVUser	becomeWithSessionToken(String sessionToken)
static <T extends AVUser> T	becomeWithSessionToken(String sessionToken, Class<T> clazz)
static io.reactivex.Observable<? extends AVUser>	becomeWithSessionTokenInBackground(String sessionToken)
static <T extends AVUser> io.reactivex.Observable<T>	becomeWithSessionTokenInBackground(String sessionToken, Class<T> clazz)
static <T extends AVUser> T	cast(AVUser user, Class<T> clazz) 通过这个方法可以将 AVUser 对象强转为其子类对象
static void	changeCurrentUser(AVUser newUser, boolean save)
io.reactivex.Observable<Boolean>	checkAuthenticatedInBackground() Session token operations
static AVUser	currentUser() 获取当前登录用户
static void	disableAutomaticUser()
io.reactivex.Observable<AVUser>	dissociateWithAuthData(String platform)
static void	enableAutomaticUser()
AVQuery<AVObject>	followeeQuery()
static <T extends AVObject> AVQuery<T>	followeeQuery(String userObjectId, Class<T> clazz)
AVQuery<AVObject>	followerQuery()
static <T extends AVObject> AVQuery<T>	followerQuery(String userObjectId, Class<T> clazz)
io.reactivex.Observable<com.alibaba.fastjson.JSONObject>	followInBackground(String userObjectId) follow-relative opersations
io.reactivex.Observable<com.alibaba.fastjson.JSONObject>	followInBackground(String userObjectId, Map<String,Object> attributes)
static AVUser	getCurrentUser()
static <T extends AVUser> T	getCurrentUser(Class<T> userClass)
String	getEmail() get user email.
void	getFollowersAndFolloweesInBackground(FollowersAndFolloweesCallback callback)
String	getMobilePhoneNumber() get user mobilephone.
String	getPassword() get user password.
static AVQuery<AVUser>	getQuery() Get User Query
io.reactivex.Observable<List<AVRole>>	getRolesInBackground() Get roles in background.
String	getSessionToken() get user session token.
String	getUsername() get user name.
static <T extends AVUser> AVQuery<T>	getUserQuery(Class<T> clazz) Get User Query
void	internalChangeSessionToken(String token) not use it!
boolean	isAnonymous() Whether is anonymous or not.
boolean	isAuthenticated() whether user is authenticated or not.
static boolean	isEnableAutomatic()
boolean	isMobilePhoneVerified() whether user's mobilephone is verified or not.
static io.reactivex.Observable<? extends AVUser>	logIn(String username, String password) logIn in background
static <T extends AVUser> io.reactivex.Observable<T>	logIn(String username, String password, Class<T> clazz) logIn in background
static io.reactivex.Observable<? extends AVUser>	logInAnonymously()
static io.reactivex.Observable<? extends AVUser>	loginByEmail(String email, String password) logIn with email and password
static io.reactivex.Observable<? extends AVUser>	loginByMobilePhoneNumber(String mobile, String password) logIn with mobile phone and password.
static <T extends AVUser> io.reactivex.Observable<T>	loginByMobilePhoneNumber(String mobile, String password, Class<T> clazz) logIn with mobile phone and password.
static io.reactivex.Observable<? extends AVUser>	loginBySMSCode(String mobile, String smsCode) logIn with mobile phone and sms code.
static <T extends AVUser> io.reactivex.Observable<T>	loginBySMSCode(String mobile, String smsCode, Class<T> clazz) logIn with mobile phone and sms code.
static <T extends AVUser> io.reactivex.Observable<T>	loginWithAuthData(Class<T> clazz, Map<String,Object> authData, String platform) login with auth data.
static <T extends AVUser> io.reactivex.Observable<T>	loginWithAuthData(Class<T> clazz, Map<String,Object> authData, String platform, String unionId, String unionIdPlatform, boolean asMainAccount) login with auth data.
static io.reactivex.Observable<? extends AVUser>	loginWithAuthData(Map<String,Object> authData, String platform) login with auth data.
io.reactivex.Observable<AVUser>	loginWithAuthData(Map<String,Object> authData, String platform, boolean failOnNotExist) login with auth data.
static io.reactivex.Observable<? extends AVUser>	loginWithAuthData(Map<String,Object> authData, String platform, String unionId, String unionIdPlatform, boolean asMainAccount) login with auth data.
io.reactivex.Observable<AVUser>	loginWithAuthData(Map<String,Object> authData, String platform, String unionId, String unionIdPlatform, boolean asMainAccount, boolean failOnNotExist)
static void	logOut()
protected void	onDataSynchronized()
protected void	onSaveFailure()
protected void	onSaveSuccess()
io.reactivex.Observable<Boolean>	refreshSessionTokenInBackground()
static io.reactivex.Observable<AVNull>	requestEmailVerifyInBackground(String email)
static io.reactivex.Observable<AVNull>	requestLoginSmsCodeInBackground(String phoneNumber)
static io.reactivex.Observable<AVNull>	requestLoginSmsCodeInBackground(String phoneNumber, String validateToken)
static io.reactivex.Observable<AVNull>	requestMobilePhoneVerifyInBackground(String mobilePhone)
static io.reactivex.Observable<AVNull>	requestMobilePhoneVerifyInBackground(String mobilePhone, String validateToken)
static io.reactivex.Observable<AVNull>	requestPasswordResetBySmsCodeInBackground(String phoneNumber)
static io.reactivex.Observable<AVNull>	requestPasswordResetBySmsCodeInBackground(String phoneNumber, String validateToken)
static io.reactivex.Observable<AVNull>	requestPasswordResetInBackground(String email) Password-relative operations
static io.reactivex.Observable<AVNull>	resetPasswordBySmsCodeInBackground(String smsCode, String newPassword)
void	setEmail(String email) set user email
void	setMobilePhoneNumber(String mobile) set user mobilephone.
void	setPassword(String password) set user password.
void	setUsername(String name) set user name.
void	signUp() sign up(blocking).
io.reactivex.Observable<AVUser>	signUpInBackground() sign up in background.
static AVUser	signUpOrLoginByMobilePhone(String mobilePhoneNumber, String smsCode) signUpOrLoginByMobilePhone
static <T extends AVUser> T	signUpOrLoginByMobilePhone(String mobilePhoneNumber, String smsCode, Class<T> clazz) signUpOrLoginByMobilePhone
static io.reactivex.Observable<? extends AVUser>	signUpOrLoginByMobilePhoneInBackground(String mobilePhoneNumber, String smsCode) signUpOrLoginByMobilePhoneInBackground
static <T extends AVUser> io.reactivex.Observable<T>	signUpOrLoginByMobilePhoneInBackground(String mobilePhoneNumber, String smsCode, Class<T> clazz) signUpOrLoginByMobilePhoneInBackground
io.reactivex.Observable<com.alibaba.fastjson.JSONObject>	unfollowInBackground(String userObjectId)
io.reactivex.Observable<AVNull>	updatePasswordInBackground(String oldPass, String newPass)
static io.reactivex.Observable<AVNull>	verifyMobilePhoneInBackground(String verifyCode)

从类继承的方法 cn.leancloud.AVObject

abortOperations, add, addAll, addAllUnique, addNewOperation, addUnique, bitAnd, bitOr, bitXor, cast, containsKey, createWithoutData, createWithoutData, decrement, decrement, delete, deleteAll, deleteAllInBackground, deleteEventually, deleteInBackground, equals, extractCascadingObjects, extractUnsavedFiles, fetch, fetch, fetchIfNeeded, fetchIfNeededInBackground, fetchIfNeededInBackground, fetchInBackground, fetchInBackground, generateACLFromServerData, generateChangedParam, get, getACL, getAVFile, getAVGeoPoint, getAVObject, getBoolean, getBytes, getCascadingSaveObjects, getClassName, getCreatedAt, getCreatedAtString, getDate, getDouble, getInt, getJSONArray, getJSONObject, getList, getLong, getNumber, getObjectId, getQuery, getRelation, getRequestMethod, getRequestRawEndpoint, getServerData, getString, getUnsavedFiles, getUpdatedAt, getUpdatedAtString, getUuid, has, hasCircleReference, hashCode, increment, increment, internalClassName, internalId, isDataAvailable, isFetchWhenSave, parseAVObject, put, refresh, refresh, refreshInBackground, refreshInBackground, registerSubclass, remove, removeAll, resetAll, resetByRawData, resetServerData, save, saveAll, saveAllInBackground, saveEventually, saveInBackground, saveInBackground, setACL, setClassName, setFetchWhenSave, setObjectId, toJSONObject, toJSONString, toString, validFieldName, verifyInternalId

从类继承的方法 java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

字段详细资料

ATTR_USERNAME

public static final String ATTR_USERNAME

另请参阅:

常量字段值

ATTR_EMAIL

public static final String ATTR_EMAIL

另请参阅:

常量字段值

ATTR_MOBILEPHONE

public static final String ATTR_MOBILEPHONE

另请参阅:

常量字段值

ATTR_SESSION_TOKEN

public static final String ATTR_SESSION_TOKEN

另请参阅:

常量字段值

CLASS_NAME

public static final String CLASS_NAME

另请参阅:

常量字段值

FOLLOWER_TAG

public static final String FOLLOWER_TAG

另请参阅:

常量字段值

FOLLOWEE_TAG

public static final String FOLLOWEE_TAG

另请参阅:

常量字段值

构造器详细资料

AVUser

public AVUser()

constructor

方法详细资料

currentUser

public static AVUser currentUser()

获取当前登录用户

返回:

current user.

getEmail

public String getEmail()

get user email.

返回:

user email.

setEmail

public void setEmail(String email)

set user email

参数:

email - user email.

getUsername

public String getUsername()

get user name.

返回:

user name

setUsername

public void setUsername(String name)

set user name.

参数:

name - username

getPassword

public String getPassword()

get user password.

返回:

user password.

setPassword

public void setPassword(String password)

set user password.

参数:

password - user password.

getMobilePhoneNumber

public String getMobilePhoneNumber()

get user mobilephone.

返回:

user mobilephone number.

setMobilePhoneNumber

public void setMobilePhoneNumber(String mobile)

set user mobilephone.

参数:

mobile - user mobilephone number.

isMobilePhoneVerified

public boolean isMobilePhoneVerified()

whether user's mobilephone is verified or not.

返回:

flag to indicate user's mobilephone is verified or not

getSessionToken

public String getSessionToken()

get user session token. if user not login, session token is null.

返回:

user session token, null if not login.

internalChangeSessionToken

public void internalChangeSessionToken(String token)

not use it!

参数:

token - user token.

isAuthenticated

public boolean isAuthenticated()

whether user is authenticated or not.

返回:

flag to indicate user is authenticated or not.

onSaveSuccess

protected void onSaveSuccess()

覆盖:

onSaveSuccess 在类中 AVObject

onSaveFailure

protected void onSaveFailure()

覆盖:

onSaveFailure 在类中 AVObject

onDataSynchronized

protected void onDataSynchronized()

覆盖:

onDataSynchronized 在类中 AVObject

isAnonymous

public boolean isAnonymous()

Whether is anonymous or not.

返回:

flag to indicate current user is anonymous or not.

signUp

public void signUp()

sign up(blocking).

signUpInBackground

public io.reactivex.Observable<AVUser> signUpInBackground()

sign up in background.

返回:

observable instance.

signUpOrLoginByMobilePhone

public static AVUser signUpOrLoginByMobilePhone(String mobilePhoneNumber,
                                                String smsCode)

signUpOrLoginByMobilePhone

参数:

mobilePhoneNumber - mobile phone

smsCode - sms code

返回:

user instance.

signUpOrLoginByMobilePhone

public static <T extends AVUser> T signUpOrLoginByMobilePhone(String mobilePhoneNumber,
                                                              String smsCode,
                                                              Class<T> clazz)

signUpOrLoginByMobilePhone

类型参数:

T - template type.

参数:

mobilePhoneNumber - mobile phone number

smsCode - sms code

clazz - class name

返回:

user instance.

signUpOrLoginByMobilePhoneInBackground

public static io.reactivex.Observable<? extends AVUser> signUpOrLoginByMobilePhoneInBackground(String mobilePhoneNumber,
                                                                                               String smsCode)

signUpOrLoginByMobilePhoneInBackground

参数:

mobilePhoneNumber - mobile phone number.

smsCode - sms code

返回:

observable instance.

signUpOrLoginByMobilePhoneInBackground

public static <T extends AVUser> io.reactivex.Observable<T> signUpOrLoginByMobilePhoneInBackground(String mobilePhoneNumber,
                                                                                                   String smsCode,
                                                                                                   Class<T> clazz)

signUpOrLoginByMobilePhoneInBackground

类型参数:

T - template type.

参数:

mobilePhoneNumber - mobile phone number

smsCode - sms code

clazz - class name

返回:

observable instance.

logIn

public static io.reactivex.Observable<? extends AVUser> logIn(String username,
                                                              String password)

logIn in background

参数:

username - username

password - user password

返回:

observable instance.

logInAnonymously

public static io.reactivex.Observable<? extends AVUser> logInAnonymously()

logIn

public static <T extends AVUser> io.reactivex.Observable<T> logIn(String username,
                                                                  String password,
                                                                  Class<T> clazz)

logIn in background

类型参数:

T - template type.

参数:

username - username

password - user password

clazz - user class name

返回:

observable instance.

loginByMobilePhoneNumber

public static io.reactivex.Observable<? extends AVUser> loginByMobilePhoneNumber(String mobile,
                                                                                 String password)

logIn with mobile phone and password.

参数:

mobile - mobile phone

password - password

返回:

observable instance.

loginByEmail

public static io.reactivex.Observable<? extends AVUser> loginByEmail(String email,
                                                                     String password)

logIn with email and password

参数:

email - email.

password - password.

返回:

observable instance.

loginByMobilePhoneNumber

public static <T extends AVUser> io.reactivex.Observable<T> loginByMobilePhoneNumber(String mobile,
                                                                                     String password,
                                                                                     Class<T> clazz)

logIn with mobile phone and password.

类型参数:

T - template type.

参数:

mobile - mobile phone.

password - user password.

clazz - user class.

返回:

observable instance.

loginBySMSCode

public static io.reactivex.Observable<? extends AVUser> loginBySMSCode(String mobile,
                                                                       String smsCode)

logIn with mobile phone and sms code.

参数:

mobile - mobile phone.

smsCode - sms code.

返回:

observable instance.

loginBySMSCode

public static <T extends AVUser> io.reactivex.Observable<T> loginBySMSCode(String mobile,
                                                                           String smsCode,
                                                                           Class<T> clazz)

logIn with mobile phone and sms code.

类型参数:

T - template type.

参数:

mobile - mobile phone.

smsCode - sms code.

clazz - user class.

返回:

observable instance.

loginWithAuthData

public static io.reactivex.Observable<? extends AVUser> loginWithAuthData(Map<String,Object> authData,
                                                                          String platform)

login with auth data.

参数:

authData - auth data.

platform - platform string.

返回:

observable instance.

loginWithAuthData

public static io.reactivex.Observable<? extends AVUser> loginWithAuthData(Map<String,Object> authData,
                                                                          String platform,
                                                                          String unionId,
                                                                          String unionIdPlatform,
                                                                          boolean asMainAccount)

login with auth data.

参数:

authData - auth data.

platform - platform string.

unionId - unionid.

unionIdPlatform - unionid platform string.

asMainAccount - flag to treat as main account.

返回:

observable instance.

loginWithAuthData

public static <T extends AVUser> io.reactivex.Observable<T> loginWithAuthData(Class<T> clazz,
                                                                              Map<String,Object> authData,
                                                                              String platform)

login with auth data.

类型参数:

T - template type.

参数:

authData - auth data.

platform - platform string.

clazz - user class name.

返回:

observable instance.

loginWithAuthData

public static <T extends AVUser> io.reactivex.Observable<T> loginWithAuthData(Class<T> clazz,
                                                                              Map<String,Object> authData,
                                                                              String platform,
                                                                              String unionId,
                                                                              String unionIdPlatform,
                                                                              boolean asMainAccount)

login with auth data.

类型参数:

T - template type.

参数:

authData - auth data.

platform - platform string.

unionId - unionid.

unionIdPlatform - unionid platform string.

asMainAccount - flag to treat as main account.

clazz - user class name.

返回:

observable instance.

loginWithAuthData

public io.reactivex.Observable<AVUser> loginWithAuthData(Map<String,Object> authData,
                                                         String platform,
                                                         boolean failOnNotExist)

login with auth data.

参数:

authData - auth data.

platform - platform string.

failOnNotExist - flag to indicate to exit if failed or not.

返回:

observable instance.

loginWithAuthData

public io.reactivex.Observable<AVUser> loginWithAuthData(Map<String,Object> authData,
                                                         String platform,
                                                         String unionId,
                                                         String unionIdPlatform,
                                                         boolean asMainAccount,
                                                         boolean failOnNotExist)

associateWithAuthData

public io.reactivex.Observable<AVUser> associateWithAuthData(Map<String,Object> authData,
                                                             String platform)

associateWithAuthData

public io.reactivex.Observable<AVUser> associateWithAuthData(Map<String,Object> authData,
                                                             String platform,
                                                             String unionId,
                                                             String unionIdPlatform,
                                                             boolean asMainAccount)

dissociateWithAuthData

public io.reactivex.Observable<AVUser> dissociateWithAuthData(String platform)

checkAuthenticatedInBackground

public io.reactivex.Observable<Boolean> checkAuthenticatedInBackground()

Session token operations

返回:

observable instance.

refreshSessionTokenInBackground

public io.reactivex.Observable<Boolean> refreshSessionTokenInBackground()

becomeWithSessionToken

public static AVUser becomeWithSessionToken(String sessionToken)

becomeWithSessionTokenInBackground

public static io.reactivex.Observable<? extends AVUser> becomeWithSessionTokenInBackground(String sessionToken)

becomeWithSessionToken

public static <T extends AVUser> T becomeWithSessionToken(String sessionToken,
                                                          Class<T> clazz)

becomeWithSessionTokenInBackground

public static <T extends AVUser> io.reactivex.Observable<T> becomeWithSessionTokenInBackground(String sessionToken,
                                                                                               Class<T> clazz)

logOut

public static void logOut()

getUserQuery

public static <T extends AVUser> AVQuery<T> getUserQuery(Class<T> clazz)

Get User Query

类型参数:

T - template type.

参数:

clazz - class name.

返回:

query instance.

getQuery

public static AVQuery<AVUser> getQuery()

Get User Query

返回:

query instance.

getRolesInBackground

public io.reactivex.Observable<List<AVRole>> getRolesInBackground()

Get roles in background.

返回:

observable instance.

enableAutomaticUser

public static void enableAutomaticUser()

isEnableAutomatic

public static boolean isEnableAutomatic()

disableAutomaticUser

public static void disableAutomaticUser()

changeCurrentUser

public static void changeCurrentUser(AVUser newUser,
                                     boolean save)

getCurrentUser

public static AVUser getCurrentUser()

getCurrentUser

public static <T extends AVUser> T getCurrentUser(Class<T> userClass)

requestPasswordResetInBackground

public static io.reactivex.Observable<AVNull> requestPasswordResetInBackground(String email)

Password-relative operations

参数:

email - user email.

返回:

observable instance.

requestPasswordResetBySmsCodeInBackground

public static io.reactivex.Observable<AVNull> requestPasswordResetBySmsCodeInBackground(String phoneNumber)

requestPasswordResetBySmsCodeInBackground

public static io.reactivex.Observable<AVNull> requestPasswordResetBySmsCodeInBackground(String phoneNumber,
                                                                                        String validateToken)

resetPasswordBySmsCodeInBackground

public static io.reactivex.Observable<AVNull> resetPasswordBySmsCodeInBackground(String smsCode,
                                                                                 String newPassword)

updatePasswordInBackground

public io.reactivex.Observable<AVNull> updatePasswordInBackground(String oldPass,
                                                                  String newPass)

requestEmailVerifyInBackground

public static io.reactivex.Observable<AVNull> requestEmailVerifyInBackground(String email)

requestMobilePhoneVerifyInBackground

public static io.reactivex.Observable<AVNull> requestMobilePhoneVerifyInBackground(String mobilePhone)

requestMobilePhoneVerifyInBackground

public static io.reactivex.Observable<AVNull> requestMobilePhoneVerifyInBackground(String mobilePhone,
                                                                                   String validateToken)

requestLoginSmsCodeInBackground

public static io.reactivex.Observable<AVNull> requestLoginSmsCodeInBackground(String phoneNumber)

requestLoginSmsCodeInBackground

public static io.reactivex.Observable<AVNull> requestLoginSmsCodeInBackground(String phoneNumber,
                                                                              String validateToken)

verifyMobilePhoneInBackground

public static io.reactivex.Observable<AVNull> verifyMobilePhoneInBackground(String verifyCode)

followInBackground

public io.reactivex.Observable<com.alibaba.fastjson.JSONObject> followInBackground(String userObjectId)

follow-relative opersations

参数:

userObjectId - user objectId.

返回:

observable instance.

followInBackground

public io.reactivex.Observable<com.alibaba.fastjson.JSONObject> followInBackground(String userObjectId,
                                                                                   Map<String,Object> attributes)

unfollowInBackground

public io.reactivex.Observable<com.alibaba.fastjson.JSONObject> unfollowInBackground(String userObjectId)

followerQuery

public AVQuery<AVObject> followerQuery()

followeeQuery

public AVQuery<AVObject> followeeQuery()

followerQuery

public static <T extends AVObject> AVQuery<T> followerQuery(String userObjectId,
                                                            Class<T> clazz)

followeeQuery

public static <T extends AVObject> AVQuery<T> followeeQuery(String userObjectId,
                                                            Class<T> clazz)

getFollowersAndFolloweesInBackground

public void getFollowersAndFolloweesInBackground(FollowersAndFolloweesCallback callback)

alwaysUseSubUserClass

public static void alwaysUseSubUserClass(Class<? extends AVUser> clazz)

通过设置此方法，所有关联对象中的 AVUser 对象都会被强转成注册的 AVUser 子类对象

参数:

clazz - class name

cast

public static <T extends AVUser> T cast(AVUser user,
                                        Class<T> clazz)

通过这个方法可以将 AVUser 对象强转为其子类对象

类型参数:

T - template type.

参数:

user - user object.

clazz - user class name.

返回:

user subclass instance.