Voile.Schema.Accounts.User (Voile v0.1.26)

Copy Markdown View Source

Summary

Functions

Confirms the account by setting confirmed_at.

A user changeset for changing the email.

A user changeset for onboarding that requires essential profile fields.

A user changeset for changing the password.

A user changeset for registration.

A user changeset for suspension operations.

Verifies the password.

Validates the current password otherwise adds an error to the changeset.

Functions

changeset(user, attrs, opts \\ [])

confirm_changeset(user)

Confirms the account by setting confirmed_at.

email_changeset(user, attrs, opts \\ [])

A user changeset for changing the email.

It requires the email to change otherwise an error is added.

login_changeset(user, attrs)

onboarding_changeset(user, attrs)

A user changeset for onboarding that requires essential profile fields.

password_changeset(user, attrs, opts \\ [])

A user changeset for changing the password.

Options

  • :hash_password - Hashes the password so it can be stored securely in the database and ensures the password field is cleared to prevent leaks in the logs. If password hashing is not needed and clearing the password field is not desired (like when using this changeset for validations on a LiveView form), this option can be set to false. Defaults to true.

registration_changeset(user, attrs, opts \\ [])

A user changeset for registration.

It is important to validate the length of both email and password. Otherwise databases may truncate the email without warnings, which could lead to unpredictable or insecure behaviour. Long passwords may also be very expensive to hash for certain algorithms.

Options

  • :hash_password - Hashes the password so it can be stored securely in the database and ensures the password field is cleared to prevent leaks in the logs. If password hashing is not needed and clearing the password field is not desired (like when using this changeset for validations on a LiveView form), this option can be set to false. Defaults to true.

  • :validate_email - Validates the uniqueness of the email, in case you don't want to validate the uniqueness of the email (like when using this changeset for validations on a LiveView form before submitting the form), this option can be set to false. Defaults to true.

suspension_changeset(user, attrs)

A user changeset for suspension operations.

This changeset only handles suspension-related fields and does not validate password or other user fields.

update_profile_changeset(user, attrs, opts \\ [])

update_user_profile_changeset(user, attrs, opts \\ [])

valid_password?(arg1, password)

Verifies the password.

If there is no user or the user doesn't have a password, we call Pbkdf2.no_user_verify/0 to avoid timing attacks.

validate_current_password(changeset, password)

Validates the current password otherwise adds an error to the changeset.