Docs Menu
Docs Home
/ /
Atlas Device SDKs
/ / /

Class EmailPasswordAuth

On this page

  • io.realm.mongodb.auth
  • Method Summary
  • Inherited Methods
  • Method Detail
  • call
  • callResetPasswordFunction
  • callResetPasswordFunctionAsync
  • confirmUser
  • confirmUserAsync
  • registerUser
  • registerUserAsync
  • resendConfirmationEmail
  • resendConfirmationEmailAsync
  • resetPassword
  • resetPasswordAsync
  • retryCustomConfirmation
  • retryCustomConfirmationAsync
  • sendResetPasswordEmail
  • sendResetPasswordEmailAsync
io.realm.mongodb.auth.EmailPasswordAuth

Class encapsulating functionality provided when User 's are logged in through the Credentials.Provider.EMAIL_PASSWORD provider.

Modifier and Type
Method and Description
protected abstract void
int functionType,
OsJavaNetworkTransport.NetworkTransportJNIResultCallback callback,
)
public void

Call the reset password function configured to the Credentials.Provider.EMAIL_PASSWORD provider.

Call the reset password function configured to the Credentials.Provider.EMAIL_PASSWORD provider.

public void
String token,
String tokenId
)

Confirms a user with the given token and token id.

Confirms a user with the given token and token id.

public void
String email,
String password
)

Registers a new user with the given email and password.

Registers a new user with the given email and password.

public void

Resend the confirmation for a user to the given email.

Resend the confirmation for a user to the given email.

public void
String token,
String tokenId,
String newPassword
)

Resets the password of a user with the given token, token id, and new password.

Resets the newPassword of a user with the given token, token id, and new password.

public void

Retries the custom confirmation on a user for a given email.

Retries the custom confirmation on a user for a given email.

public void

Sends a user a password reset email for the given email.

Sends a user a password reset email for the given email.

  • Methods inherited from class java.lang.Object : getClass , hashCode , equals , clone , toString , notify , notifyAll , wait , wait , wait , finalize

protected abstract void call (
int functionType,
OsJavaNetworkTransport.NetworkTransportJNIResultCallback callback,
)
String email,
String newPassword,
)

Call the reset password function configured to the Credentials.Provider.EMAIL_PASSWORD provider.

Parameters

  • email - the email of the user.

  • newPassword - the new password of the user.

  • args - any additional arguments provided to the reset function. All arguments must be able to be converted to JSON compatible values using toString() .

Throws

Call the reset password function configured to the Credentials.Provider.EMAIL_PASSWORD provider.

Parameters

  • email - the email of the user.

  • newPassword - the new password of the user.

  • args - any additional arguments provided to the reset function. All arguments must be able to be converted to JSON compatible values using toString() .

  • callback - callback when the reset has completed or failed. The callback will always happen on the same thread as this this method is called on.

Throws

public void confirmUser (
String token,
String tokenId
)

Confirms a user with the given token and token id.

Parameters

  • token - the confirmation token.

  • tokenId - the id of the confirmation token.

Throws

Confirms a user with the given token and token id.

Parameters

  • token - the confirmation token.

  • tokenId - the id of the confirmation token.

  • callback - callback when confirmation has completed or failed. The callback will always happen on the same thread as this method is called on.

Throws

public void registerUser (
String email,
String password
)

Registers a new user with the given email and password.

Parameters

  • email - the email to register with. This will be the username used during log in.

  • password - the password to associate with the email. The password must be between 6 and 128 characters long.

Throws

Registers a new user with the given email and password.

Parameters

  • email - the email to register with. This will be the username used during log in.

  • password - the password to associated with the email. The password must be between 6 and 128 characters long.

  • callback - callback when registration has completed or failed. The callback will always happen on the same thread as this method is called on.

Throws

String email
)

Resend the confirmation for a user to the given email.

Parameters

  • email - the email of the user.

Throws

Resend the confirmation for a user to the given email.

Parameters

  • email - the email of the user.

  • callback - callback when resending the email has completed or failed. The callback will always happen on the same thread as this method is called on.

Throws

public void resetPassword (
String token,
String tokenId,
String newPassword
)

Resets the password of a user with the given token, token id, and new password.

Parameters

  • token - the reset password token.

  • tokenId - the id of the reset password token.

  • newPassword - the new password for the user identified by the token . The password must be between 6 and 128 characters long.

Throws

Resets the newPassword of a user with the given token, token id, and new password.

Parameters

  • token - the reset password token.

  • tokenId - the id of the reset password token.

  • newPassword - the new password for the user identified by the token . The password must be between 6 and 128 characters long.

  • callback - callback when the reset has completed or failed. The callback will always happen on the same thread as this this method is called on.

Throws

String email
)

Retries the custom confirmation on a user for a given email.

Parameters

  • email - the email of the user.

Throws

Retries the custom confirmation on a user for a given email.

Parameters

  • email - the email of the user.

  • callback - callback when retrying the custom confirmation has completed or failed. The callback will always happen on the same thread as this method is called on.

Throws

String email
)

Sends a user a password reset email for the given email.

Parameters

  • email - the email of the user.

Throws

Sends a user a password reset email for the given email.

Parameters

  • email - the email of the user.

  • callback - callback when sending the email has completed or failed. The callback will always happen on the same thread as this method is called on.

Throws

← ApiKeyAuth