com.nifcloud.mbaas.core

Class NCMBUserService

java.lang.Object

com.nifcloud.mbaas.core.NCMBService

com.nifcloud.mbaas.core.NCMBUserService

public class NCMBUserService
extends NCMBService

Service for user api

Nested Class Summary

Nested classes/interfaces inherited from class com.nifcloud.mbaas.core.NCMBService

NCMBService.RequestParams

Field Summary

Fields

Modifier and Type	Field and Description
static int	HTTP_STATUS_AUTHORIZED Status code of authorize success
static int	HTTP_STATUS_REGISTERED Status code of register success
static int	HTTP_STATUS_REQUEST_ACCEPTED Status code of invite api accespted
static java.lang.String	SERVICE_PATH service path for API category

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

mContext, mServicePath

Method Summary

Modifier and Type	Method and Description
void	deleteUser(java.lang.String userId) Delete user by given id
protected void	deleteUserCheckResponse(NCMBResponse response) Check responkse to delete user
void	deleteUserInBackground(java.lang.String userId, ExecuteServiceCallback callback) Delete user by given id in background
protected NCMBService.RequestParams	deleteUserParams(java.lang.String userId) Setup params to delete user
NCMBUser	fetchUser(java.lang.String userId) Get user entity from given id
void	fetchUserInBackground(java.lang.String userId, FetchCallback callback) Get user entity from given id in background
protected org.json.JSONObject	fillParameters(java.lang.String[] keys, org.json.JSONObject src) Create JSONObject and copy values with given keys
protected void	getUserCheckResponse(NCMBResponse response) Check response to get user entity
protected NCMBService.RequestParams	getUserParams(java.lang.String userId) Setup params to get user entity
void	inviteByMail(java.lang.String mailAddress) Invite new user by Email ( /requestMailAddressUserEntry API )
protected void	inviteByMailCheckResponse(NCMBResponse response) Check response to invite new user by Email
void	inviteByMailInBackground(java.lang.String mailAddress, DoneCallback callback) Invite new user by Email in background
protected NCMBService.RequestParams	inviteByMailParams(java.lang.String mailAddress) Setup params to invite new user by Email
NCMBUser	loginByMail(java.lang.String mailAddress, java.lang.String password) login by mail address
protected void	loginByMailCheckResponse(NCMBResponse response) Check response to login by mail address
void	loginByMailInBackground(java.lang.String mailAddress, java.lang.String password, LoginCallback callback) Login by mail address in background
protected NCMBService.RequestParams	loginByMailParams(java.lang.String mailAddress, java.lang.String password) Setup params to login by mail address
NCMBUser	loginByName(java.lang.String userName, java.lang.String password) Login by user name
protected void	loginByNameCheckResponse(NCMBResponse response) Check response to login by user name
void	loginByNameInBackground(java.lang.String userName, java.lang.String password, LoginCallback callback) Login by user name in background
protected NCMBService.RequestParams	loginByNameParams(java.lang.String userName, java.lang.String password) Setup params to login by user name
void	logout() Logout from session
protected void	logoutCheckResponse(NCMBResponse response) Check response to logout
void	logoutInBackground(DoneCallback callback) Logout from session in background
protected NCMBService.RequestParams	logoutParams() Setup parameters to logout
protected NCMBUser	postLoginProcess(NCMBResponse response) process after login
NCMBUser	registerByName(java.lang.String userName, java.lang.String password) Register new user by name
NCMBUser	registerByName(java.lang.String userName, java.lang.String password, org.json.JSONObject otherFields) Register new user by name
void	registerByNameInBackground(java.lang.String userName, java.lang.String password, org.json.JSONObject otherFields, LoginCallback callback) Register new user by name in background
void	registerByNameInBackground(java.lang.String userName, java.lang.String password, LoginCallback callback) Register new user by name in background
NCMBUser	registerByOauth(org.json.JSONObject oauthOptions) Register new user by OAuth services
void	registerByOauthInBackground(org.json.JSONObject oauthOptions, LoginCallback callback) Register new user by OAuth services in background
protected org.json.JSONObject	registerByOauthSetup(org.json.JSONObject oauthOptions) Setup OAuth parameters to register new user with OAuth
protected NCMBUser	registerUser(org.json.JSONObject params, boolean oauth) Internal method to register user
protected void	registerUserCheckResponse(NCMBResponse response, boolean oauth) Check response to register new user
protected void	registerUserInBackground(org.json.JSONObject params, boolean oauth, LoginCallback callback) Internal method to register user in background
protected NCMBService.RequestParams	registerUserParams(org.json.JSONObject params) Setup params to register new user
void	requestPasswordReset(java.lang.String mailAddress) Send Email for the password reset in background thread
void	requestPasswordResetInBackground(java.lang.String mailAddress, DoneCallback callback) Send Email for the password reset in background thread
protected NCMBService.RequestParams	requestPasswordResetParams(java.lang.String mailAddress)
void	saveByName(java.lang.String userName, java.lang.String password) Save new user by name
void	saveByName(java.lang.String userName, java.lang.String password, org.json.JSONObject otherFields) Save new user by name
protected void	saveByNameInBackground(java.lang.String userName, java.lang.String password, DoneCallback callback) Internal Save new user by name in background
protected void	saveByNameInBackground(java.lang.String userName, java.lang.String password, org.json.JSONObject otherFields, DoneCallback callback) Internal Save new user by name in background
protected void	saveUser(org.json.JSONObject params, boolean oauth) Internal method to save user
protected void	saveUserInBackground(org.json.JSONObject params, DoneCallback callback) Internal method to save user in background
java.util.ArrayList<NCMBUser>	searchUser(org.json.JSONObject conditions) Search users
protected void	searchUserCheckResponse(NCMBResponse response) Check response to search users
void	searchUserInBackground(org.json.JSONObject conditions, SearchUserCallback callback) Search users in background
protected NCMBService.RequestParams	searchUserParams(org.json.JSONObject conditions) Setup parameters to search users
protected java.util.ArrayList<NCMBUser>	searchUserPostProcess(org.json.JSONObject data) Post process to search users
org.json.JSONObject	updateUser(java.lang.String userId, org.json.JSONObject params) Update user information
protected void	updateUserCheckResponse(NCMBResponse response) Check response to update user information
void	updateUserInBackground(java.lang.String userId, org.json.JSONObject params, ExecuteServiceCallback callback) Update user information in background
protected NCMBService.RequestParams	updateUserParams(java.lang.String userId, org.json.JSONObject params) Set up to update user information

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

sendRequest, sendRequest, sendRequest, sendRequest, sendRequestAsync, sendRequestAsync, sendRequestFile, sendRequestFileAsync

Methods inherited from class java.lang.Object

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

Field Detail

SERVICE_PATH

public static final java.lang.String SERVICE_PATH

service path for API category

See Also:

Constant Field Values

HTTP_STATUS_REGISTERED

public static final int HTTP_STATUS_REGISTERED

Status code of register success

See Also:

Constant Field Values

HTTP_STATUS_AUTHORIZED

public static final int HTTP_STATUS_AUTHORIZED

Status code of authorize success

See Also:

Constant Field Values

HTTP_STATUS_REQUEST_ACCEPTED

public static final int HTTP_STATUS_REQUEST_ACCEPTED

Status code of invite api accespted

See Also:

Constant Field Values

Method Detail

registerByName

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

Register new user by name

Parameters:

userName - user name

password - password

Returns:

new NCMBUser object that registered

Throws:

NCMBException - exception from NIFCLOUD mobile backend

registerByName

public NCMBUser registerByName(java.lang.String userName,
                               java.lang.String password,
                               org.json.JSONObject otherFields)
                        throws NCMBException

Register new user by name

Parameters:

userName - user name

password - password

otherFields - other fields

Returns:

new NCMBUser object that registered

Throws:

NCMBException - exception from NIFCLOUD mobile backend

saveByName

public void saveByName(java.lang.String userName,
                       java.lang.String password)
                throws NCMBException

Save new user by name

Parameters:

userName - user name

password - password

Throws:

NCMBException - exception from NIFCLOUD mobile backend

saveByName

public void saveByName(java.lang.String userName,
                       java.lang.String password,
                       org.json.JSONObject otherFields)
                throws NCMBException

Save new user by name

Parameters:

userName - user name

password - password

otherFields - other fields

Throws:

NCMBException - exception from NIFCLOUD mobile backend

registerByNameInBackground

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

Register new user by name in background

Parameters:

userName - user name

password - password

callback - callback when process finished

Throws:

NCMBException - exception from NIFCLOUD mobile backend

registerByNameInBackground

public void registerByNameInBackground(java.lang.String userName,
                                       java.lang.String password,
                                       org.json.JSONObject otherFields,
                                       LoginCallback callback)
                                throws NCMBException

Register new user by name in background

Parameters:

userName - user name

password - password

otherFields - other fields

callback - callback when process finished

Throws:

NCMBException - exception from NIFCLOUD mobile backend

saveByNameInBackground

protected void saveByNameInBackground(java.lang.String userName,
                                      java.lang.String password,
                                      DoneCallback callback)
                               throws NCMBException

Internal Save new user by name in background

Parameters:

userName - user name

password - password

callback - callback when process finished

Throws:

NCMBException - exception from NIFCLOUD mobile backend

saveByNameInBackground

protected void saveByNameInBackground(java.lang.String userName,
                                      java.lang.String password,
                                      org.json.JSONObject otherFields,
                                      DoneCallback callback)
                               throws NCMBException

Internal Save new user by name in background

Parameters:

userName - userName

password - password

otherFields - other fields

callback - callback when process finished

Throws:

NCMBException - exception from NIFCLOUD mobile backend

registerByOauthSetup

protected org.json.JSONObject registerByOauthSetup(org.json.JSONObject oauthOptions)
                                            throws NCMBException

Setup OAuth parameters to register new user with OAuth

Parameters:

oauthOptions - OAuth options

Returns:

"authData" params in JSONObject

Throws:

NCMBException - exception from NIFCLOUD mobile backend

registerByOauth

public NCMBUser registerByOauth(org.json.JSONObject oauthOptions)
                         throws NCMBException

Register new user by OAuth services

Parameters:

oauthOptions - OAuth options

Returns:

new NCMBUser object that registered

Throws:

NCMBException - exception from NIFCLOUD mobile backend

registerByOauthInBackground

public void registerByOauthInBackground(org.json.JSONObject oauthOptions,
                                        LoginCallback callback)
                                 throws NCMBException

Register new user by OAuth services in background

Parameters:

oauthOptions - OAuth options

callback - callback when process finished

Throws:

NCMBException - exception from NIFCLOUD mobile backend

fillParameters

protected org.json.JSONObject fillParameters(java.lang.String[] keys,
                                             org.json.JSONObject src)
                                      throws NCMBException

Create JSONObject and copy values with given keys

Parameters:

keys - String[] keys to copy

src - JSONObject source of copy

Returns:

JSONObject

Throws:

NCMBException - exception from NIFCLOUD mobile backend

inviteByMailParams

protected NCMBService.RequestParams inviteByMailParams(java.lang.String mailAddress)
                                                throws NCMBException

Setup params to invite new user by Email

Parameters:

mailAddress - mail address

Returns:

parameters in object

Throws:

NCMBException - exception from NIFCLOUD mobile backend

inviteByMailCheckResponse

protected void inviteByMailCheckResponse(NCMBResponse response)
                                  throws NCMBException

Check response to invite new user by Email

Parameters:

response - response of invitation mail

Throws:

NCMBException - exception from NIFCLOUD mobile backend

inviteByMail

public void inviteByMail(java.lang.String mailAddress)
                  throws NCMBException

Invite new user by Email ( /requestMailAddressUserEntry API )

Parameters:

mailAddress - mail address

Throws:

NCMBException - exception from NIFCLOUD mobile backend

inviteByMailInBackground

public void inviteByMailInBackground(java.lang.String mailAddress,
                                     DoneCallback callback)
                              throws NCMBException

Invite new user by Email in background

Parameters:

mailAddress - mail address

callback - callback when process finished

Throws:

NCMBException - exception from NIFCLOUD mobile backend

requestPasswordResetParams

protected NCMBService.RequestParams requestPasswordResetParams(java.lang.String mailAddress)
                                                        throws java.lang.Exception

Throws:

java.lang.Exception

requestPasswordReset

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

Send Email for the password reset in background thread

Parameters:

mailAddress - mail address

Throws:

NCMBException - exception from NIFCLOUD mobile backend

requestPasswordResetInBackground

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

Send Email for the password reset in background thread

Parameters:

mailAddress - mail address

callback - callback when process finished

Throws:

NCMBException - exception from NIFCLOUD mobile backend

registerUserParams

protected NCMBService.RequestParams registerUserParams(org.json.JSONObject params)
                                                throws NCMBException

Setup params to register new user

Parameters:

params - user parameters

Returns:

parameters in object

Throws:

NCMBException - exception from NIFCLOUD mobile backend

registerUserCheckResponse

protected void registerUserCheckResponse(NCMBResponse response,
                                         boolean oauth)
                                  throws NCMBException

Check response to register new user

Parameters:

response - response of the registration

oauth - use oauth or not

Throws:

NCMBException - exception from NIFCLOUD mobile backend

registerUser

protected NCMBUser registerUser(org.json.JSONObject params,
                                boolean oauth)
                         throws NCMBException

Internal method to register user

Parameters:

params - parameters

oauth - use oauth or not

Returns:

new NCMBUser object that logged-in

Throws:

NCMBException - exception from NIFCLOUD mobile backend

saveUser

protected void saveUser(org.json.JSONObject params,
                        boolean oauth)
                 throws NCMBException

Internal method to save user

Parameters:

params - parameters

oauth - use oauth or not

Throws:

NCMBException

registerUserInBackground

protected void registerUserInBackground(org.json.JSONObject params,
                                        boolean oauth,
                                        LoginCallback callback)
                                 throws NCMBException

Internal method to register user in background

Parameters:

params - parameters

oauth - use oauth or not

callback - callback when process finished

Throws:

NCMBException - exception from NIFCLOUD mobile backend

saveUserInBackground

protected void saveUserInBackground(org.json.JSONObject params,
                                    DoneCallback callback)
                             throws NCMBException

Internal method to save user in background

Parameters:

params - parameters

callback - callback when process finished

Throws:

NCMBException - exception from NIFCLOUD mobile backend

getUserParams

protected NCMBService.RequestParams getUserParams(java.lang.String userId)
                                           throws NCMBException

Setup params to get user entity

Parameters:

userId - user id

Returns:

parameters for NCMBRequest

Throws:

NCMBException - exception from NIFCLOUD mobile backend

getUserCheckResponse

protected void getUserCheckResponse(NCMBResponse response)
                             throws NCMBException

Check response to get user entity

Parameters:

response - response to get user entity

Throws:

NCMBException - exception from NIFCLOUD mobile backend

fetchUser

public NCMBUser fetchUser(java.lang.String userId)
                   throws NCMBException

Get user entity from given id

Parameters:

userId - user id

Returns:

NCMBUser instance

Throws:

NCMBException - exception from NIFCLOUD mobile backend

fetchUserInBackground

public void fetchUserInBackground(java.lang.String userId,
                                  FetchCallback callback)
                           throws NCMBException

Get user entity from given id in background

Parameters:

userId - user id

callback - callback when process finished

Throws:

NCMBException - exception from NIFCLOUD mobile backend

updateUserParams

protected NCMBService.RequestParams updateUserParams(java.lang.String userId,
                                                     org.json.JSONObject params)

Set up to update user information

Parameters:

userId - user id

params - update values

Returns:

parameters for NCMBRequest

updateUserCheckResponse

protected void updateUserCheckResponse(NCMBResponse response)
                                throws NCMBException

Check response to update user information

Parameters:

response - response to update user information

Throws:

NCMBException - exception from NIFCLOUD mobile backend

updateUser

public org.json.JSONObject updateUser(java.lang.String userId,
                                      org.json.JSONObject params)
                               throws NCMBException

Update user information

Parameters:

userId - user id

params - update values

Returns:

result of update user

Throws:

NCMBException - exception from NIFCLOUD mobile backend

updateUserInBackground

public void updateUserInBackground(java.lang.String userId,
                                   org.json.JSONObject params,
                                   ExecuteServiceCallback callback)
                            throws NCMBException

Update user information in background

Parameters:

userId - user id

params - update values

callback - callback when process finished

Throws:

NCMBException - exception from NIFCLOUD mobile backend

loginByNameParams

protected NCMBService.RequestParams loginByNameParams(java.lang.String userName,
                                                      java.lang.String password)
                                               throws NCMBException

Setup params to login by user name

Parameters:

userName - user name

password - password

Returns:

parameters in object

Throws:

NCMBException - exception from NIFCLOUD mobile backend

loginByNameCheckResponse

protected void loginByNameCheckResponse(NCMBResponse response)
                                 throws NCMBException

Check response to login by user name

Parameters:

response - response to login by user name

Throws:

NCMBException - exception from NIFCLOUD mobile backend

loginByName

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

Login by user name

Parameters:

userName - user name

password - password

Returns:

new NCMBUser object that logged-in

Throws:

NCMBException - exception from NIFCLOUD mobile backend

loginByNameInBackground

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

Login by user name in background

Parameters:

userName - user name

password - password

callback - callback when process finished

Throws:

NCMBException - exception from NIFCLOUD mobile backend

loginByMailParams

protected NCMBService.RequestParams loginByMailParams(java.lang.String mailAddress,
                                                      java.lang.String password)
                                               throws NCMBException

Setup params to login by mail address

Parameters:

mailAddress - mail address

password - password

Returns:

parameters in object

Throws:

NCMBException - exception from NIFCLOUD mobile backend

loginByMailCheckResponse

protected void loginByMailCheckResponse(NCMBResponse response)
                                 throws NCMBException

Check response to login by mail address

Parameters:

response - exception from NIFCLOUD mobile backend

Throws:

NCMBException - exception from NIFCLOUD mobile backend

loginByMail

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

login by mail address

Parameters:

mailAddress - mail address

password - password

Returns:

new NCMBUser object that loggged-in

Throws:

NCMBException - exception from NIFCLOUD mobile backend

loginByMailInBackground

public void loginByMailInBackground(java.lang.String mailAddress,
                                    java.lang.String password,
                                    LoginCallback callback)
                             throws NCMBException

Login by mail address in background

Parameters:

mailAddress - mail address

password - password

callback - callback when process finished

Throws:

NCMBException - exception from NIFCLOUD mobile backend

postLoginProcess

protected NCMBUser postLoginProcess(NCMBResponse response)
                             throws NCMBException

process after login

Parameters:

response - response object

Returns:

new NCMBUser object

Throws:

NCMBException - exception from NIFCLOUD mobile backend

deleteUserParams

protected NCMBService.RequestParams deleteUserParams(java.lang.String userId)

Setup params to delete user

Parameters:

userId - user id

Returns:

parameters in object

deleteUserCheckResponse

protected void deleteUserCheckResponse(NCMBResponse response)
                                throws NCMBException

Check responkse to delete user

Parameters:

response - responkse to delete user

Throws:

NCMBException - exception from NIFCLOUD mobile backend

deleteUser

public void deleteUser(java.lang.String userId)
                throws NCMBException

Delete user by given id

Parameters:

userId - user id

Throws:

NCMBException - exception from NIFCLOUD mobile backend

deleteUserInBackground

public void deleteUserInBackground(java.lang.String userId,
                                   ExecuteServiceCallback callback)
                            throws NCMBException

Delete user by given id in background

Parameters:

userId - user id

callback - Callback is executed after delete user

Throws:

NCMBException - exception from NIFCLOUD mobile backend

logoutParams

protected NCMBService.RequestParams logoutParams()

Setup parameters to logout

Returns:

request params in object

logoutCheckResponse

protected void logoutCheckResponse(NCMBResponse response)
                            throws NCMBException

Check response to logout

Parameters:

response - response to logout

Throws:

NCMBException - exception from NIFCLOUD mobile backend

logout

public void logout()
            throws NCMBException

Logout from session

Throws:

NCMBException - exception from NIFCLOUD mobile backend

logoutInBackground

public void logoutInBackground(DoneCallback callback)
                        throws NCMBException

Logout from session in background

Parameters:

callback - callback when logout completed

Throws:

NCMBException - exception from NIFCLOUD mobile backend

searchUserParams

protected NCMBService.RequestParams searchUserParams(org.json.JSONObject conditions)

Setup parameters to search users

Parameters:

conditions - search conditions

Returns:

request params in object

searchUserCheckResponse

protected void searchUserCheckResponse(NCMBResponse response)
                                throws NCMBException

Check response to search users

Parameters:

response - response to search users

Throws:

NCMBException - exception from NIFCLOUD mobile backend

searchUserPostProcess

protected java.util.ArrayList<NCMBUser> searchUserPostProcess(org.json.JSONObject data)
                                                       throws NCMBException

Post process to search users

Parameters:

data - response body in JSONObject

Returns:

found users in ArrayList

Throws:

NCMBException - exception from NIFCLOUD mobile backend

searchUser

public java.util.ArrayList<NCMBUser> searchUser(org.json.JSONObject conditions)
                                         throws NCMBException

Search users

Parameters:

conditions - search conditions, if no condition set to null

Returns:

result of search user

Throws:

NCMBException - exception from NIFCLOUD mobile backend

searchUserInBackground

public void searchUserInBackground(org.json.JSONObject conditions,
                                   SearchUserCallback callback)

Search users in background

Parameters:

conditions - search conditions, if no condition set to null

callback - callback when process finished