java.lang.Object | ||||
↳ | java.util.AbstractMap<K, V> | |||
↳ | com.google.api.client.util.GenericData | |||
↳ | com.google.api.client.json.GenericJson | |||
↳ | com.kinvey.java.User<T extends com.kinvey.java.User> |
This class is not thread-safe.
Nested Classes | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
class | User.Delete | Delete Request Class, extends AbstractKinveyJsonClientRequest |
|||||||||
class | User.EmailVerification | EmailVerification Request Class, extends AbstractKinveyJsonClientRequest |
|||||||||
class | User.GetMICAccessToken | ||||||||||
class | User.GetMICTempURL | ||||||||||
class | User.LockDownUser | ||||||||||
class | User.LoginRequest | Login Request Class. | |||||||||
class | User.LoginToTempURL | ||||||||||
class | User.LogoutRequest | Logout Request Class. | |||||||||
class | User.ResetPassword | ResetPassword Request Class, extends AbstractKinveyJsonClientRequest |
|||||||||
class | User.Retrieve | Retrieve Request Class, extends AbstractKinveyJsonClientRequest |
|||||||||
class | User.RetrieveUsers | Retrieve Request Class, extends AbstractKinveyJsonClientRequest |
|||||||||
class | User.Update | Update Request Class, extends AbstractKinveyJsonClientRequest |
Constants | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
String | USER_COLLECTION_NAME |
Fields | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
public String | MICHostName | The hostname to use for MIC authentication |
Public Constructors | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
User(AbstractClient client, Class<T> userClass, KinveyAuthRequest.Builder builder)
Constructor to access Kinvey's UserGroup management.
| |||||||||||
User() |
Public Methods | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
LoginToTempURL | MICLoginToTempURL(String username, String password, String tempURL) | ||||||||||
void | clearCustomRequestProperties() | ||||||||||
LoginRequest |
createBlocking(String userid, String password)
Creates an explicit Kinvey User.
| ||||||||||
Delete |
deleteBlocking(boolean hardDelete)
Delete's the given user from the server.
| ||||||||||
String |
getAuthToken()
Get the Authtoken associated with this User for making requests with Kinvey
| ||||||||||
String | getId() | ||||||||||
GetMICTempURL | getMICTempURL() | ||||||||||
GetMICAccessToken | getMICToken(String code) | ||||||||||
String |
getUsername()
Get the username of this User
| ||||||||||
boolean |
isUserLoggedIn()
Method to determine if the current user instnace represents a logged-in user
| ||||||||||
Set<String> |
keySet()
Enforce the Generic Json typing to be
| ||||||||||
LockDownUser |
lockDownUserBlocking(String userid, boolean setLockdownStateTo)
modify the locked down state of the provided user id.
| ||||||||||
LoginRequest |
login(Credential credential)
Log in with existing credential
| ||||||||||
LoginRequest | loginAuthLinkBlocking(String accessToken, String refreshToken) | ||||||||||
LoginRequest |
loginBlocking()
Login with the implicit user.
| ||||||||||
LoginRequest |
loginBlocking(String username, String password)
Login with Kinvey user and password.
| ||||||||||
LoginRequest |
loginFacebookBlocking(String accessToken)
Login to Kinvey services using Facebook access token obtained through OAuth2.
| ||||||||||
LoginRequest |
loginGoogleBlocking(String accessToken)
Login to Kinvey services using Google access token obtained through OAuth2.
| ||||||||||
LoginRequest |
loginKinveyAuthTokenBlocking(String userId, String authToken)
Login to Kinvey services using a Kinvey user's _id and their valid Kinvey Auth Token.
| ||||||||||
LoginRequest |
loginLinkedInBlocking(String accessToken, String accessSecret, String consumerKey, String consumerSecret)
Login to Kinvey services using LinkedIn-generated access token, access secret, consumer key, and consumer secret
obtained through OAuth1a.
| ||||||||||
LoginRequest |
loginMobileIdentityBlocking(String authToken)
Login to Kinvey Services using Mobile Identity Connect@return
| ||||||||||
LoginRequest |
loginSalesForceBlocking(String accessToken, String Clientid, String refreshToken, String id)
Login to Kinvey services using SalesForce access token obtained through OAuth2.
| ||||||||||
LoginRequest |
loginTwitterBlocking(String accessToken, String accessSecret, String consumerKey, String consumerSecret)
Login to Kinvey services using Twitter-generated access token, access secret, consumer key, and consumer secret
obtained through OAuth1a.
| ||||||||||
LogoutRequest |
logout()
Logs the user out of the current app
| ||||||||||
ResetPassword |
resetPasswordBlocking(String username)
Initiates a password reset request for a provided username
| ||||||||||
Retrieve |
retrieveBlocking()
Retrieves current user's metadata.
| ||||||||||
RetrieveUsers |
retrieveBlocking(Query query)
Retrieves an array of User[] based on a Query.
| ||||||||||
Retrieve |
retrieveBlocking(String[] resolves)
Retrieve current user's metadata with support for resolving KinveyReferences
| ||||||||||
RetrieveUsers |
retrieveBlocking(Query query, String[] resolves)
Retrieves an array of User[] based on a Query with support for resolving KinveyReferences
| ||||||||||
User |
retrieveMetadataBlocking()
Convenience Method to retrieve Metadata.
| ||||||||||
EmailVerification |
sendEmailVerificationBlocking()
Initiates an EmailVerification request for the current user
| ||||||||||
void | setAuthToken(String authToken) | ||||||||||
void | setClientAppVersion(String appVersion) | ||||||||||
void | setClientAppVersion(int major, int minor, int revision) | ||||||||||
void | setCustomRequestProperties(GenericJson customheaders) | ||||||||||
void | setCustomRequestProperty(String key, Object value) | ||||||||||
void |
setId(String id)
Set the unique id of this User
| ||||||||||
void |
setMICHostName(String newHostName)
Change the hostname used by MIC for authentication.
| ||||||||||
void |
setUsername(String username)
Set the username of this user
| ||||||||||
Update |
updateBlocking(User user)
Updates a provided user's profile
| ||||||||||
Update |
updateBlocking()
Updates the current user's profile
| ||||||||||
GetMICAccessToken | useRefreshToken(String refreshToken) |
[Expand]
Inherited Methods | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
![]() | |||||||||||
![]() | |||||||||||
![]() | |||||||||||
![]() | |||||||||||
![]() |
The hostname to use for MIC authentication
Constructor to access Kinvey's UserGroup management.
client | - an instance of Kinvey AbstractClient, configured for the application |
---|
IOException |
---|
Creates an explicit Kinvey User.
userid | userID of Kinvey user |
---|---|
password | password of Kinvey user |
IOException |
---|
Delete's the given user from the server.
hardDelete | if true, physically deletes the user. If false, marks user as inactive. |
---|
IOException |
---|
Get the Authtoken associated with this User for making requests with Kinvey
Get the username of this User
Method to determine if the current user instnace represents a logged-in user
Enforce the Generic Json typing to be
modify the locked down state of the provided user id.
This operation must be performed with the master secret Locking down a user will prevent them from logging in and remove all locally stored content on their deviceuserid | the id to lockdown |
---|---|
setLockdownStateTo | true to lockdown, false to remove lockdown state |
IOException |
---|
Log in with existing credential
IOException |
---|
IOException |
---|
Login with the implicit user. If implicit user does not exist, the user is created. After calling this method, the application should retrieve and store the userID using getId()
IOException |
---|
Login with Kinvey user and password. If user does not exist, returns a error response.
username | userID of Kinvey User |
---|---|
password | password of Kinvey user |
IOException |
---|
Login to Kinvey services using Facebook access token obtained through OAuth2. If the user does not exist in the Kinvey service, the user will be created.
accessToken | Facebook-generated access token. |
---|
IOException |
---|
Login to Kinvey services using Google access token obtained through OAuth2. If the user does not exist in the Kinvey service, the user will be created.
accessToken | Google-generated access token |
---|
IOException |
---|
Login to Kinvey services using a Kinvey user's _id and their valid Kinvey Auth Token. This method is provided to allow for cross-platform login, by reusing a session provided with another client library (or the REST api).
userId | the _id field of the user to login |
---|---|
authToken | a valid Kinvey Auth token |
IOException |
---|
Login to Kinvey services using LinkedIn-generated access token, access secret, consumer key, and consumer secret obtained through OAuth1a. If the user does not exist in the Kinvey service, the user will be created.
accessToken | Linked In generated access token |
---|---|
accessSecret | Linked In generated access secret |
consumerKey | Linked In generated consumer key |
consumerSecret | Linked In generated consumer secret |
IOException |
---|
Login to Kinvey Services using Mobile Identity Connect@return
IOException |
---|
Login to Kinvey services using SalesForce access token obtained through OAuth2. If the user does not exist in the Kinvey service, the user will be created.
accessToken | SalesForce-generated access token |
---|
IOException |
---|
Login to Kinvey services using Twitter-generated access token, access secret, consumer key, and consumer secret obtained through OAuth1a. If the user does not exist in the Kinvey service, the user will be created.
accessToken | Twitter-generated access token |
---|---|
accessSecret | Twitter-generated access secret |
consumerKey | Twitter-generated consumer key |
consumerSecret | Twitter-generated consumer secret |
IOException |
---|
Logs the user out of the current app
IOException |
---|
Initiates a password reset request for a provided username
username | the username to request a password reset for |
---|
IOException |
---|
Retrieves current user's metadata.
IOException |
---|
Retrieves an array of User[] based on a Query.
IOException |
---|
Retrieve current user's metadata with support for resolving KinveyReferences
resolves | - List of KinveyReference fields to resolve |
---|
IOException |
---|
Retrieves an array of User[] based on a Query with support for resolving KinveyReferences
query | the query to execute |
---|---|
resolves | - List of KinveyReference fields to resolve |
IOException |
---|
Convenience Method to retrieve Metadata.
IOException |
---|
Initiates an EmailVerification request for the current user
IOException |
---|
Set the unique id of this User
id | a unique user id |
---|
Change the hostname used by MIC for authentication.
Set the username of this user
username | the new username to set |
---|
Updates a provided user's profile
user | the user to update |
---|
IOException |
---|
Updates the current user's profile
IOException |
---|