API Reference

Field Detail

• Companion

  public static UserStore.Companion Companion

Constructor Detail

• UserStore

  public UserStore()

Method Detail

• loginKinveyAuthToken

  public <T extends User> void loginKinveyAuthToken(java.lang.String userId,
                                                    java.lang.String authToken,
                                                    com.kinvey.java.AbstractClient<T> client,
                                                    com.kinvey.java.core.KinveyClientCallback<T> callback)

  Deprecated. 

  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).

  Parameters:

  userId - the _id field of the user to login

  authToken - a valid Kinvey Auth token

  callback - interface KinveyUserCallback that contains a valid logged in user

• save

  public <T extends User> void save(com.kinvey.java.AbstractClient<T> client,
                                    com.kinvey.java.core.KinveyClientCallback<T> callback)

  Deprecated. 

  Asynchronous Update current user info

• signUp

  public static void signUp(java.lang.String username,
                            java.lang.String password,
                            com.kinvey.java.AbstractClient<com.kinvey.android.model.User> client,
                            com.kinvey.java.core.KinveyClientCallback<com.kinvey.android.model.User> callback)

  Asynchronous request to signUp.

  Creates an asynchronous request to create new User at the kinvey backend. If signUp was successful user will be login automatically. Uses to return a User.

  Sample Usage:

  Parameters:

  username - String the userName of Kinvey user

  password - String the password of Kinvey user.

  client - class Client an instance of the client

  callback - the callback

• signUp

  public static <T extends User> void signUp(java.lang.String username,
                                             java.lang.String password,
                                             T user,
                                             com.kinvey.java.AbstractClient<T> client,
                                             com.kinvey.java.core.KinveyClientCallback<T> callback)

• login

  public static <T extends User> void login(com.kinvey.java.AbstractClient<T> client,
                                            com.kinvey.java.core.KinveyClientCallback<T> callback)

  Asynchronous request to login the implicit user.

  Creates an asynchronous request to login at the kinvey backend. Login with the implicit user. If the implicit user does not exist, the user is created. After calling this method, the application should retrieve and store the userID using getId(). Uses to return a User.

  Sample Usage:

  Parameters:

  client - class Client an instance of the client

  callback - the callback

  Throws:

• login

  public static <T extends User> void login(java.lang.String userId,
                                            java.lang.String password,
                                            com.kinvey.java.AbstractClient<T> client,
                                            com.kinvey.java.core.KinveyClientCallback<T> callback)

  Asynchronous request to login with the existing user.

  Creates an asynchronous request to login new User at kinvey backend. Login with the with existing user. If user does not exist, returns a error response. Uses to return a User.

  Sample Usage:

  Parameters:

  userId - String the userId of Kinvey user

  password - String the password of Kinvey user.

  client - class Client an instance of the client

  callback - the callback

  Throws:

• loginFacebook

  public static <T extends User> void loginFacebook(java.lang.String accessToken,
                                                    com.kinvey.java.AbstractClient<T> client,
                                                    com.kinvey.java.core.KinveyClientCallback<T> callback)

  Deprecated. 

  Asynchronous request to login with the Facebook application.

  Creates an asynchronous request to login with the Facebook accessToken. Before this request you must authorize in Facebook application and get Facebook access token. Uses to return a User.

  Sample Usage:

  Parameters:

  accessToken - String the Facebook access token

  client - class Client an instance of the client

  callback - the callback

  Throws:

• loginGoogle

  public static <T extends User> void loginGoogle(java.lang.String accessToken,
                                                  com.kinvey.java.AbstractClient<T> client,
                                                  com.kinvey.java.core.KinveyClientCallback<T> callback)

  Deprecated. 

  Asynchronous request to login with the Google application.

  Creates an asynchronous request to login with the Google accessToken. Before this request you must authorize in Google application and get Google access token. Uses to return a User.

  Sample Usage:

  Parameters:

  accessToken - String the Facebook access token

  client - class Client an instance of the client

  callback - the callback

  Throws:

• loginTwitter

  public static <T extends User> void loginTwitter(java.lang.String accessToken,
                                                   java.lang.String accessSecret,
                                                   java.lang.String consumerKey,
                                                   java.lang.String consumerSecret,
                                                   com.kinvey.java.AbstractClient<T> client,
                                                   com.kinvey.java.core.KinveyClientCallback<T> callback)

  Deprecated. 

  Asynchronous request to login with the Twitter application.

  Creates an asynchronous request to login with the Twitter. Before this request you must authorize in Twitter application and get Twitter accessToken, accessSecret,consumerKey and consumerSecret. Uses to return a User.

  Sample Usage:

  Parameters:

  accessToken - String the Twitter access token

  accessSecret - String the Twitter accessSecret token

  consumerKey - String the Twitter consumerKey token

  consumerSecret - String the Twitter consumerSecret token

  client - class Client an instance of the client

  callback - the callback

  Throws:

• loginLinkedIn

  public static <T extends User> void loginLinkedIn(java.lang.String accessToken,
                                                    java.lang.String accessSecret,
                                                    java.lang.String consumerKey,
                                                    java.lang.String consumerSecret,
                                                    com.kinvey.java.AbstractClient<T> client,
                                                    com.kinvey.java.core.KinveyClientCallback<T> callback)

  Deprecated. 

  Asynchronous request to login with the LinkedIn application.

  Creates an asynchronous request to login with the LinkedIn. Before this request you must authorize in LinkedIn application and get LinkedIn accessToken, accessSecret,consumerKey and consumerSecret. Uses to return a User.

  Sample Usage:

  Parameters:

  accessToken - String the LinkedIn access token

  accessSecret - String the LinkedIn accessSecret token

  consumerKey - String the LinkedIn consumerKey token

  consumerSecret - String the LinkedIn consumerSecret token

  client - class Client an instance of the client

  callback - the callback

  Throws:

• loginAuthLink

  public static <T extends User> void loginAuthLink(java.lang.String accessToken,
                                                    java.lang.String refreshToken,
                                                    com.kinvey.java.AbstractClient<T> client,
                                                    com.kinvey.java.core.KinveyClientCallback<T> callback)

  Asynchronous request to login with login link.

  Creates an asynchronous request to login with login link. Uses to return a User.

  Sample Usage:

  Parameters:

  accessToken - String the access token

  refreshToken - String the refresh token

  client - class Client an instance of the client

  callback - the callback

  Throws:

• loginSalesForce

  public static <T extends User> void loginSalesForce(java.lang.String accessToken,
                                                      java.lang.String client_id,
                                                      java.lang.String refreshToken,
                                                      java.lang.String id,
                                                      com.kinvey.java.AbstractClient<T> client,
                                                      com.kinvey.java.core.KinveyClientCallback<T> callback)

  Deprecated. 

  Asynchronous request to login with the SalesForce application.

  Creates an asynchronous request to login with the SalesForce. Before this request you must authorize in LinkedIn application and get SalesForce accessToken, client_id, refreshToken and id. Uses to return a User.

  Sample Usage:

  Parameters:

  accessToken - String the SalesForce access token

  client_id - String the SalesForce client id

  refreshToken - String the SalesForce refresh token

  id - String the SalesForce id

  client - class Client an instance of the client

  callback - the callback

  Throws:

• loginMobileIdentity

  public static <T extends User> void loginMobileIdentity(java.lang.String accessToken,
                                                          com.kinvey.java.AbstractClient<T> client,
                                                          com.kinvey.java.core.KinveyClientCallback<T> callback)

  Asynchronous request to login with the MobileIdentity accessToken.

  Creates an asynchronous request to login with the MobileIdentity accessToken. Uses to return a User.

  Sample Usage:

  Parameters:

  accessToken - String the MobileIdentity access token

  client - class Client an instance of the client

  callback - the callback

  Throws:

• login

  public static <T extends User> void login(com.kinvey.java.auth.Credential credential,
                                            com.kinvey.java.AbstractClient<T> client,
                                            com.kinvey.java.core.KinveyClientCallback<T> callback)

  Asynchronous request to login with kinvey Credential object.

  Creates an asynchronous request to login with kinvey Credential object. You can get Credential object from CredentialStorage, if user was logged before. Uses to return a User.

  Sample Usage:

  Parameters:

  credential - Credential the credential of kinvey user

  client - class Client an instance of the client

  callback - the callback

  Throws:

• logout

  public static void logout(com.kinvey.java.AbstractClient<com.kinvey.java.dto.BaseUser> client,
                            com.kinvey.java.core.KinveyClientCallback<java.lang.Void> callback)

  Synchronous request to logout.

  Creates an Synchronous request to logout. Storage will be cleared in this request. To keep data in storage need to call keepOfflineStorageOnLogout() before this method. Uses to return a User.

  Sample Usage:

  Parameters:

  client - class Client an instance of the client

• destroy

  public static void destroy(boolean isHard,
                             com.kinvey.java.AbstractClient<com.kinvey.java.dto.BaseUser> client,
                             KinveyUserDeleteCallback callback)

  Asynchronous request to destroy user from kinvey backend.

  Creates an Asynchronous request to destroy user from kinvey backend. If isHard is true user will be deleted from kinvey backend. If isHard is false user will be disabled from kinvey backend, but it can be enabled again. Uses interface KinveyUserDeleteCallback to return a status of request execution.

  Sample Usage:

  Parameters:

  isHard - flag for detect hard/soft deleting user

  client - class Client an instance of the client

  callback - interface KinveyUserDeleteCallback the callback

  See Also:

  interface KinveyUserDeleteCallback

• sendEmailConfirmation

  public static void sendEmailConfirmation(com.kinvey.java.AbstractClient<?> client,
                                           KinveyUserManagementCallback callback)

  Asynchronous request to send email confirmation.

  Creates an Asynchronous request to send email confirmation. Uses interface KinveyUserManagementCallback to return a status of request execution.

  Sample Usage:

  Parameters:

  client - class Client an instance of the client

  callback - interface KinveyUserManagementCallback the callback

  See Also:

  interface KinveyUserManagementCallback

• forgotUsername

  public static void forgotUsername(com.kinvey.java.AbstractClient<?> client,
                                    java.lang.String email,
                                    KinveyUserManagementCallback callback)

  Asynchronous request to forgot username.

  Creates an Asynchronous request to forgot username. Uses interface KinveyUserManagementCallback to return a status of request execution.

  Sample Usage:

  Parameters:

  client - class Client an instance of the client

  email - String a user's email

  callback - interface KinveyUserManagementCallback the callback

  See Also:

  interface KinveyUserManagementCallback

• resetPassword

  public static void resetPassword(java.lang.String usernameOrEmail,
                                   com.kinvey.java.AbstractClient<?> client,
                                   KinveyUserManagementCallback callback)

• exists

  public static void exists(java.lang.String username,
                            com.kinvey.java.AbstractClient<?> client,
                            com.kinvey.java.core.KinveyClientCallback<java.lang.Boolean> callback)

• changePassword

  public static void changePassword(java.lang.String password,
                                    com.kinvey.java.AbstractClient<?> client,
                                    KinveyUserManagementCallback callback)

• get

  public static <T extends User> void get(java.lang.String userId,
                                          com.kinvey.java.AbstractClient<?> client,
                                          com.kinvey.java.core.KinveyClientCallback<T> callback)

• convenience

  public static <T extends User> void convenience(com.kinvey.java.AbstractClient<T> client,
                                                  com.kinvey.java.core.KinveyClientCallback<T> callback)

  Asynchronous Retrieve Metadata

  Convenience method for retrieving user metadata and updating the current user with the metadata. Used when initializing the client.

  Parameters:

  callback - KinveyUserCallback

• retrieve

  public static void retrieve(com.kinvey.java.AbstractClient<com.kinvey.android.model.User> client,
                              com.kinvey.java.core.KinveyClientCallback<com.kinvey.android.model.User> callback)

  Asynchronous Call to Retrieve (refresh) the current user

  Constructs an asynchronous request to refresh current user's data via the Kinvey back-end.

  Sample Usage:

  Parameters:

  callback - containing a refreshed User instance.

  client - class Client an instance of the client

• retrieve

  public static <T extends User> void retrieve(java.lang.String[] resolves,
                                               com.kinvey.java.AbstractClient<T> client,
                                               com.kinvey.java.core.KinveyClientCallback<T> callback)

  Asynchronous call to retrieve (refresh) the current user, and resolve KinveyReferences

  Constructs an asynchronous request to refresh current user's data via the Kinvey back-end.

  Sample Usage:

  Parameters:

  resolves - an array of json keys maintaining KinveyReferences to be resolved

  client - class Client an instance of the client

  callback - interface KinveyUserCallback containing refreshed user instance

• retrieve

  public static void retrieve(com.kinvey.java.Query query,
                              java.lang.String[] resolves,
                              com.kinvey.java.AbstractClient<com.kinvey.android.model.User> client,
                              KinveyListCallback<com.kinvey.android.model.User> callback)

  Asynchronous call to retrieve (refresh) the users by query, and resolve KinveyReferences

  Constructs an asynchronous request to retrieve User objects via a Query.

  Sample Usage:

  Parameters:

  query - Query the query to execute defining users to return

  resolves - an array of json keys maintaining KinveyReferences to be resolved

  client - class Client an instance of the client

  callback - containing an array of queried users

• retrieve

  public static void retrieve(com.kinvey.java.Query q,
                              com.kinvey.java.AbstractClient<com.kinvey.android.model.User> client,
                              KinveyListCallback<com.kinvey.android.model.User> callback)

  Asynchronous Call to Retrieve users via a Query

  Constructs an asynchronous request to retrieve User objects via a Query.

  Sample Usage:

  Parameters:

  q - Query the query to execute defining users to return

  client - class Client an instance of the client

  callback - for retrieved users

• retrieve

  public static void retrieve(com.kinvey.java.Query query,
                              java.lang.String[] resolves,
                              com.kinvey.java.AbstractClient<com.kinvey.android.model.User> client,
                              KinveyUserListCallback callback)

  Deprecated. 

  Asynchronous call to retrieve (refresh) the users by query, and resolve KinveyReferences

  Constructs an asynchronous request to retrieve User objects via a Query.

  Sample Usage:

  Parameters:

  query - Query the query to execute defining users to return

  resolves - an array of json keys maintaining KinveyReferences to be resolved

  client - class Client an instance of the client

  callback - interface KinveyUserListCallback containing an array of queried users

• loginWithAuthorizationCodeLoginPage

  public static void loginWithAuthorizationCodeLoginPage(Client<?> client,
                                                         java.lang.String redirectURI,
                                                         KinveyMICCallback<?> callback)

  Deprecated. 

  Login with the MIC service, using the oauth flow. This method provides a URL to render containing a login page.

  Parameters:

  client - Client object

  redirectURI - redirectURI

  callback - KinveyMICCallback

• loginWithAuthorizationCodeLoginPage

  public static void loginWithAuthorizationCodeLoginPage(Client<?> client,
                                                         java.lang.String clientId,
                                                         java.lang.String redirectURI,
                                                         KinveyMICCallback<?> callback)

  Deprecated. 

  Login with the MIC service, using the oauth flow. This method provides a URL to render containing a login page.

  Parameters:

  redirectURI - redirectURI

  callback - KinveyMICCallback

• loginWithMIC

  public static void loginWithMIC(Client<?> client,
                                  java.lang.String clientId,
                                  java.lang.String redirectURI,
                                  KinveyMICCallback<?> callback)

  Login with the MIC service, using the oauth flow. This method provides a URL to render containing a login page.

  Parameters:

  redirectURI - redirectURI

  callback - KinveyMICCallback

• onOAuthCallbackReceived

  public static void onOAuthCallbackReceived(android.content.Intent intent,
                                             java.lang.String clientId,
                                             com.kinvey.java.AbstractClient<com.kinvey.android.model.User> client)

  Used by the MIC login flow, this method should be called after a successful login in the onNewIntent Method of your activity. See the MIC guide for more information.

  Parameters:

  intent - The intent provided to the application from the redirect

  clientId - ClientId

  client - Client object

• loginWithAuthorizationCodeAPI

  public static void loginWithAuthorizationCodeAPI(com.kinvey.java.AbstractClient<com.kinvey.android.model.User> client,
                                                   java.lang.String username,
                                                   java.lang.String password,
                                                   java.lang.String redirectURI,
                                                   KinveyUserCallback<com.kinvey.android.model.User> callback)

  Deprecated. 

  Login with the MIC service, using the oauth flow. This method provides direct login, without rending a login page.

  Parameters:

  username - String the userName of Kinvey user

  password - String the password of Kinvey user.

  redirectURI - redirectURI

  callback - interface KinveyUserCallback

• loginWithAuthorizationCodeAPI

  public static void loginWithAuthorizationCodeAPI(com.kinvey.java.AbstractClient<com.kinvey.android.model.User> client,
                                                   java.lang.String username,
                                                   java.lang.String password,
                                                   java.lang.String clientId,
                                                   java.lang.String redirectURI,
                                                   KinveyUserCallback<com.kinvey.android.model.User> callback)

  Deprecated. 

  Login with the MIC service, using the oauth flow. This method provides direct login, without rending a login page.

  Parameters:

  username - String the userName of Kinvey user

  password - String the password of Kinvey user.

  redirectURI - redirectURI

  callback - interface KinveyUserCallback

• loginWithMIC

  public static <T extends User> void loginWithMIC(com.kinvey.java.AbstractClient<T> client,
                                                   java.lang.String username,
                                                   java.lang.String password,
                                                   java.lang.String clientId,
                                                   KinveyUserCallback<T> callback)

  Login with the MIC service, using the resource owner grant flow.

  Parameters:

  username - String the userName of Kinvey user

  password - String the password of Kinvey user.

  callback - interface KinveyUserCallback

• loginWithMIC

  public static void loginWithMIC(com.kinvey.java.AbstractClient<com.kinvey.android.model.User> client,
                                  java.lang.String username,
                                  java.lang.String password,
                                  java.lang.String clientId,
                                  java.lang.String redirectURI,
                                  KinveyUserCallback<com.kinvey.android.model.User> callback)

  Deprecated. 

  Login with the MIC service, using the oauth flow. This method provides direct login, without rending a login page.

  Parameters:

  username - String the userName of Kinvey user

  password - String the password of Kinvey user.

  redirectURI - redirectURI

  callback - interface KinveyUserCallback