Docs Home

/ /

io.realm.mongodb.auth

Docs Home

/ /

API Reference

io.realm.mongodb.auth

io.realm.mongodb.auth

Class EmailPasswordAuth

Atlas Device SDKs are deprecated. Refer to the deprecation page for details.

io.realm.mongodb.auth

java.lang.Object

io.realm.mongodb.auth.EmailPasswordAuth

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

Method Summary

Modifier and Type	Method and Description
protected abstract void	call ( int functionType, OsJavaNetworkTransport.NetworkTransportJNIResultCallback callback, java.lang.String[] args )
public void	callResetPasswordFunction ( String email, String newPassword, java.lang.Object[] args ) Call the reset password function configured to the Credentials.Provider.EMAIL_PASSWORD provider.
public RealmAsyncTask	callResetPasswordFunctionAsync ( String email, String newPassword, java.lang.Object[] args, io.realm.mongodb.App.Callback<java.lang.Void> callback ) Call the reset password function configured to the Credentials.Provider.EMAIL_PASSWORD provider.
public void	confirmUser ( String token, String tokenId ) Confirms a user with the given token and token id.
public RealmAsyncTask	confirmUserAsync ( String token, String tokenId, io.realm.mongodb.App.Callback<java.lang.Void> callback ) Confirms a user with the given token and token id.
public void	registerUser ( String email, String password ) Registers a new user with the given email and password.
public RealmAsyncTask	registerUserAsync ( String email, String password, io.realm.mongodb.App.Callback<java.lang.Void> callback ) Registers a new user with the given email and password.
public void	resendConfirmationEmail ( String email ) Resend the confirmation for a user to the given email.
public RealmAsyncTask	resendConfirmationEmailAsync ( String email, io.realm.mongodb.App.Callback<java.lang.Void> callback ) Resend the confirmation for a user to the given email.
public void	resetPassword ( String token, String tokenId, String newPassword ) Resets the password of a user with the given token, token id, and new password.
public RealmAsyncTask	resetPasswordAsync ( String token, String tokenId, String newPassword, io.realm.mongodb.App.Callback<java.lang.Void> callback ) Resets the newPassword of a user with the given token, token id, and new password.
public void	retryCustomConfirmation ( String email ) Retries the custom confirmation on a user for a given email.
public RealmAsyncTask	retryCustomConfirmationAsync ( String email, io.realm.mongodb.App.Callback<java.lang.Void> callback ) Retries the custom confirmation on a user for a given email.
public void	sendResetPasswordEmail ( String email ) Sends a user a password reset email for the given email.
public RealmAsyncTask	sendResetPasswordEmailAsync ( String email, io.realm.mongodb.App.Callback<java.lang.Void> callback ) Sends a user a password reset email for the given email.

Inherited Methods

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

Method Detail

call

protected abstract void call ( int functionType, OsJavaNetworkTransport.NetworkTransportJNIResultCallback callback, java.lang.String[] args )

callResetPasswordFunction

public void callResetPasswordFunction (

String  email,
String  newPassword,
java.lang.Object[]  args

)

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

AppException - if the server failed to confirm the user.

callResetPasswordFunctionAsync

public RealmAsyncTask callResetPasswordFunctionAsync (

String  email,
String  newPassword,
java.lang.Object[]  args,
io.realm.mongodb.App.Callback<java.lang.Void>  callback

)

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

IllegalStateException - if called from a non-looper thread.

confirmUser

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 AppException - if the server failed to confirm the user.

confirmUserAsync

public RealmAsyncTask confirmUserAsync ( String token, String tokenId, io.realm.mongodb.App.Callback<java.lang.Void> callback )
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 IllegalStateException - if called from a non-looper thread.

registerUser

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 AppException - if the server failed to register the user.

registerUserAsync

public RealmAsyncTask registerUserAsync (

String  email,
String  password,
io.realm.mongodb.App.Callback<java.lang.Void>  callback

)

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

IllegalStateException - if called from a non-looper thread.
AppException - if the server failed to register the user.

resendConfirmationEmail

public void resendConfirmationEmail ( String email )
Resend the confirmation for a user to the given email. Parameters `email` - the email of the user. Throws AppException - if the server failed to confirm the user.

resendConfirmationEmailAsync

public RealmAsyncTask resendConfirmationEmailAsync ( String email, io.realm.mongodb.App.Callback<java.lang.Void> callback )
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 IllegalStateException - if called from a non-looper thread.

resetPassword

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 AppException - if the server failed to confirm the user.

resetPasswordAsync

public RealmAsyncTask resetPasswordAsync (

String  token,
String  tokenId,
String  newPassword,
io.realm.mongodb.App.Callback<java.lang.Void>  callback

)

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

IllegalStateException - if called from a non-looper thread.

retryCustomConfirmation

public void retryCustomConfirmation ( String email )
Retries the custom confirmation on a user for a given email. Parameters `email` - the email of the user. Throws AppException - if the server failed to confirm the user.

retryCustomConfirmationAsync

public RealmAsyncTask retryCustomConfirmationAsync ( String email, io.realm.mongodb.App.Callback<java.lang.Void> callback )
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 IllegalStateException - if called from a non-looper thread.

sendResetPasswordEmail

public void sendResetPasswordEmail ( String email )
Sends a user a password reset email for the given email. Parameters `email` - the email of the user. Throws AppException - if the server failed to confirm the user.

sendResetPasswordEmailAsync

public RealmAsyncTask sendResetPasswordEmailAsync ( String email, io.realm.mongodb.App.Callback<java.lang.Void> callback )
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 AppException - if the server failed to confirm the user.

Back

ApiKeyAuth

GoogleAuthType