com.nifcloud.mbaas.core

Class NCMBUser

java.lang.Object

com.nifcloud.mbaas.core.NCMBBase

com.nifcloud.mbaas.core.NCMBObject

com.nifcloud.mbaas.core.NCMBUser

public class NCMBUser
extends NCMBObject

NCMBUser is used to sign up and login/logout the user

Field Summary

Fields inherited from class com.nifcloud.mbaas.core.NCMBBase

mClassName, mFields, mIgnoreKeys, mUpdateKeys

Constructor Summary

Constructors

Constructor and Description
NCMBUser() Constructor

Method Summary

Modifier and Type	Method and Description
void	deleteObject() delete current NCMBObject from data store
void	deleteObjectInBackground(DoneCallback callback) delete current NCMBObject from data store asynchronously
void	fetch() fetch current NCMBObject data from data store
void	fetchInBackground(FetchCallback callback) fetch current NCMBObject data from data store asynchronously
org.json.JSONObject	getAuthData() Get authData
org.json.JSONObject	getAuthData(java.lang.String provider) Get Specified Authentication Data
static NCMBUser	getCurrentUser() Get current user object
java.lang.String	getMailAddress() Get mail address
static NCMBQuery<NCMBUser>	getQuery() Create query for file class
static java.lang.String	getSessionToken() Get sessionToken
java.lang.String	getUserName() Get user name
boolean	isAuthenticated() Decision whether logged in
boolean	isLinkedWith(java.lang.String provider) Check for specified provider's authentication data is linked
java.lang.Boolean	isMailAddressConfirmed() Get mail address confirmed flag
void	linkInBackgroundWith(java.lang.Object params, DoneCallback callback) link specified authentication data asynchronously for current user
void	linkWith(java.lang.Object params) link specified authentication data for current user
static NCMBUser	login(java.lang.String userName, java.lang.String password) login with username and password
static void	loginInBackground(java.lang.String userName, java.lang.String password, LoginCallback callback) Login with username and password in background
static void	loginInBackgroundWith(java.lang.Object authData, LoginCallback callback) login asynchronously with parameter that can be obtained after the OAuth authentication
static NCMBUser	loginWith(java.lang.Object authData) login with parameter that can be obtained after the OAuth authentication
static NCMBUser	loginWithAnonymous() Login with anonymous
static void	loginWithAnonymousInBackground(LoginCallback callback) Login with anonymous in background
static NCMBUser	loginWithMailAddress(java.lang.String mailAddress, java.lang.String password) Login with mailAddress and password
static void	loginWithMailAddressInBackground(java.lang.String mailAddress, java.lang.String password, LoginCallback callback) Login with mailAddress and password in background
static void	logout() logout from NIFCLOUD mobile backend
static void	logoutInBackground(DoneCallback callback) logout from NIFCLOUD mobile backend
static void	requestAuthenticationMail(java.lang.String mailAddress) Mail request of user authentication
static void	requestAuthenticationMailInBackground(java.lang.String mailAddress, DoneCallback callback) Mail request of user authentication in background
static void	requestPasswordReset(java.lang.String mailAddress) Request Email for the password reset
static void	requestPasswordResetInBackground(java.lang.String mailAddress, DoneCallback callback) Request Email for the password reset in background thread
void	save() save current NCMBObject to data store
void	saveInBackground(DoneCallback callback) save current NCMBObject to data store asynchronously
void	setMailAddress(java.lang.String mailAddress) Set mail address
void	setPassword(java.lang.String password) set password
void	setUserName(java.lang.String userName) set user name
void	signUp() sign up to NIFCLOUD mobile backend
void	signUpInBackground(DoneCallback callback) sign up to NIFCLOUD mobile backend
void	unlink(java.lang.String provider)
void	unlinkInBackground(java.lang.String provider, DoneCallback callback)

Methods inherited from class com.nifcloud.mbaas.core.NCMBObject

addToList, addUniqueToList, fetchInBackground, increment, removeFromList

Methods inherited from class com.nifcloud.mbaas.core.NCMBBase

allKeys, containsKey, createUpdateJsonData, getAcl, getBoolean, getClassName, getCreateDate, getDate, getDouble, getGeolocation, getIncludeObject, getInt, getJSONArray, getJSONObject, getList, getLong, getMap, getObjectId, getString, getUpdateDate, put, put, put, put, put, put, put, put, put, put, put, put, put, remove, setAcl, setAclFromInternal, setCreateDate, setObjectId, setUpdateDate

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

NCMBUser

public NCMBUser()

Constructor

Method Detail

getQuery

public static NCMBQuery<NCMBUser> getQuery()

Create query for file class

Returns:

NCMBQuery for file class

getUserName

public java.lang.String getUserName()

Get user name

Returns:

String user name

setUserName

public void setUserName(java.lang.String userName)

set user name

Parameters:

userName - user name string

setPassword

public void setPassword(java.lang.String password)

set password

Parameters:

password - password string

isMailAddressConfirmed

public java.lang.Boolean isMailAddressConfirmed()

Get mail address confirmed flag

Returns:

Boolean mail address is confirmed or not

getMailAddress

public java.lang.String getMailAddress()

Get mail address

Returns:

String mail address

setMailAddress

public void setMailAddress(java.lang.String mailAddress)

Set mail address

Parameters:

mailAddress - String mail address

isAuthenticated

public boolean isAuthenticated()

Decision whether logged in

Returns:

Return true if logged in

isLinkedWith

public boolean isLinkedWith(java.lang.String provider)

Check for specified provider's authentication data is linked

Parameters:

provider - facebook or twitter or google or anonymous

Returns:

Return true if authentication data is linked

getAuthData

public org.json.JSONObject getAuthData()

Get authData

Returns:

JSONObject or null

getAuthData

public org.json.JSONObject getAuthData(java.lang.String provider)

Get Specified Authentication Data

Parameters:

provider - String "facebook" or "twitter" or "google" or "anonymous"

Returns:

Specified Authentication Data or null

signUp

public void signUp()
            throws NCMBException

sign up to NIFCLOUD mobile backend

Throws:

NCMBException - exception from NIFCLOUD mobile backend

signUpInBackground

public void signUpInBackground(DoneCallback callback)

sign up to NIFCLOUD mobile backend

Parameters:

callback - callback for after sign up

requestAuthenticationMail

public static void requestAuthenticationMail(java.lang.String mailAddress)
                                      throws NCMBException

Mail request of user authentication

Parameters:

mailAddress - e-mail address for user authentication

Throws:

NCMBException - exception from NIFCLOUD mobile backend

requestAuthenticationMailInBackground

public static void requestAuthenticationMailInBackground(java.lang.String mailAddress,
                                                         DoneCallback callback)

Mail request of user authentication in background

Parameters:

mailAddress - e-mail address for user authentication

callback - Callback is executed after mail signUp request

requestPasswordReset

public static void requestPasswordReset(java.lang.String mailAddress)
                                 throws NCMBException

Request Email for the password reset

Parameters:

mailAddress - mail address

Throws:

NCMBException - exception from NIFCLOUD mobile backend

requestPasswordResetInBackground

public static void requestPasswordResetInBackground(java.lang.String mailAddress,
                                                    DoneCallback callback)

Request Email for the password reset in background thread

Parameters:

mailAddress - mail address

callback - callback when process finished

loginWithMailAddress

public static NCMBUser loginWithMailAddress(java.lang.String mailAddress,
                                            java.lang.String password)
                                     throws NCMBException

Login with mailAddress and password

Parameters:

mailAddress - mailAddress

password - password

Returns:

NCMBUser object that logged-in

Throws:

NCMBException - exception from NIFCLOUD mobile backend

loginWithMailAddressInBackground

public static void loginWithMailAddressInBackground(java.lang.String mailAddress,
                                                    java.lang.String password,
                                                    LoginCallback callback)

Login with mailAddress and password in background

Parameters:

mailAddress - mailAddress

password - password

callback - Callback is executed after login

loginWithAnonymous

public static NCMBUser loginWithAnonymous()
                                   throws NCMBException

Login with anonymous

Returns:

anonymous user authenticated

Throws:

NCMBException - exception from NIFCLOUD mobile backend

loginWithAnonymousInBackground

public static void loginWithAnonymousInBackground(LoginCallback callback)

Login with anonymous in background

Parameters:

callback - Callback is executed after login

login

public static NCMBUser login(java.lang.String userName,
                             java.lang.String password)
                      throws NCMBException

login with username and password

Parameters:

userName - user name

password - password

Returns:

NCMBUser object that logged-in

Throws:

NCMBException - exception from NIFCLOUD mobile backend

loginInBackground

public static void loginInBackground(java.lang.String userName,
                                     java.lang.String password,
                                     LoginCallback callback)
                              throws NCMBException

Login with username and password in background

Parameters:

userName - user name

password - password

callback - callback when finished

Throws:

NCMBException - exception from NIFCLOUD mobile backend

logout

public static void logout()
                   throws NCMBException

logout from NIFCLOUD mobile backend

Throws:

NCMBException - exception from NIFCLOUD mobile backend

logoutInBackground

public static void logoutInBackground(DoneCallback callback)

logout from NIFCLOUD mobile backend

Parameters:

callback - Callback is executed after logout

loginWith

public static NCMBUser loginWith(java.lang.Object authData)
                          throws NCMBException

login with parameter that can be obtained after the OAuth authentication

Parameters:

authData - NCMBFacebookParameters or NCMBTwitterParameters or NCMBGoogleParameters

Returns:

Authenticated user

Throws:

NCMBException - exception from NIFCLOUD mobile backend

loginInBackgroundWith

public static void loginInBackgroundWith(java.lang.Object authData,
                                         LoginCallback callback)

login asynchronously with parameter that can be obtained after the OAuth authentication

Parameters:

authData - NCMBFacebookParameters or NCMBTwitterParameters or NCMBGoogleParameters

callback - if login is succeeded, callback include authenticated user.

linkWith

public void linkWith(java.lang.Object params)
              throws NCMBException

link specified authentication data for current user

Parameters:

params - NCMBFacebookParameters or NCMBTwitterParameters or NCMBGoogleParameters

Throws:

NCMBException - exception from NIFCLOUD mobile backend

linkInBackgroundWith

public void linkInBackgroundWith(java.lang.Object params,
                                 DoneCallback callback)

link specified authentication data asynchronously for current user

Parameters:

params - NCMBFacebookParameters or NCMBTwitterParameters or NCMBGoogleParameters

callback - Callback is executed after link or throw Exception

unlink

public void unlink(java.lang.String provider)
            throws NCMBException

Throws:

NCMBException

unlinkInBackground

public void unlinkInBackground(java.lang.String provider,
                               DoneCallback callback)

save

public void save()
          throws NCMBException

Description copied from class: NCMBObject

save current NCMBObject to data store

Overrides:

save in class NCMBObject

Throws:

NCMBException - exception from NIFCLOUD mobile backend

saveInBackground

public void saveInBackground(DoneCallback callback)

Description copied from class: NCMBObject

save current NCMBObject to data store asynchronously

Overrides:

saveInBackground in class NCMBObject

Parameters:

callback - callback after object save

fetch

public void fetch()
           throws NCMBException

Description copied from class: NCMBObject

fetch current NCMBObject data from data store

Overrides:

fetch in class NCMBObject

Throws:

NCMBException - exception from NIFCLOUD mobile backend

fetchInBackground

public void fetchInBackground(FetchCallback callback)

Description copied from class: NCMBObject

fetch current NCMBObject data from data store asynchronously

Overrides:

fetchInBackground in class NCMBObject

Parameters:

callback - callback after fetch data

deleteObject

public void deleteObject()
                  throws NCMBException

Description copied from class: NCMBObject

delete current NCMBObject from data store

Overrides:

deleteObject in class NCMBObject

Throws:

NCMBException - exception from NIFCLOUD mobile backend

deleteObjectInBackground

public void deleteObjectInBackground(DoneCallback callback)

Description copied from class: NCMBObject

delete current NCMBObject from data store asynchronously

Overrides:

deleteObjectInBackground in class NCMBObject

Parameters:

callback - callback after delete object

getCurrentUser

public static NCMBUser getCurrentUser()

Get current user object

Returns:

user

getSessionToken

public static java.lang.String getSessionToken()

Get sessionToken

Returns:

sessionToken