Realm.Auth.EmailPasswordAuth

Class for managing email/password for users

callResetPasswordFunction(email, password, args)Promose<void>

Resets the password of an email identity using the password reset function set up in the application.

Parameters:
  • email
    • Type: string
    • The email address of the user.

  • password
    • Type: string
    • The desired new password.

  • args repeatable
    • Type: [BSON, ...]
    • Arguments passed onto the function.

Returns: Promose<void>
confirmUser(token, id)Promise<void>

Confirms an email identity with the email/password provider.

Parameters:
  • token
    • Type: string
    • The confirmation token that was emailed to the user.

  • id
    • Type: string
    • The confirmation token id that was emailed to the user.

Returns: Promise<void>
registerUser(email, password)Promise<void>

Registers a new email identity with the email/password provider, and sends a confirmation email to the provided address.

Parameters:
  • email
    • Type: string
    • The email address of the user to register.

  • password
    • Type: string
    • The password that the user created for the new username/password identity.

Returns: Promise<void>
resendConfirmationEmail(email)Promise<void>

Re-sends a confirmation email to a user that has registered but not yet confirmed their email address.

Parameters:
  • email
    • Type: string
    • The email address of the user to re-send a confirmation for.

Returns: Promise<void>
resetPassword(password, token, id)Promise<void>

Resets the password of an email identity using the password reset token emailed to a user.

Parameters:
  • password
    • Type: string
    • The desired new password.

  • token
    • Type: string
    • The password reset token that was emailed to the user.

  • id
    • Type: string
    • The password reset token id that was emailed to the user.

Returns: Promise<void>
sendResetPasswordEmail(email)Promise<void>

Sends an email to the user for resetting the password.

Parameters:
  • email
    • Type: string
    • The email address of the user to re-send a confirmation for.

Returns: Promise<void>