AuthEmail class abstract
The default implementation for the email account endpoint methods.
All public methods in here can be safely exposed to end-user clients.
Uses serverpod_auth_session for session management and
serverpod_auth_profile for user profiles.
Constructors
Properties
- hashCode → int
-
The hash code for this object.
no setterinherited
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
Methods
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
toString(
) → String -
A string representation of this object.
inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited
Static Properties
- admin → AuthEmailAdmin
-
Collection of admin-related functions.
final
Static Methods
-
finishPasswordReset(
Session session, {required UuidValue passwordResetRequestId, required String verificationCode, required String newPassword, Transaction? transaction}) → Future< AuthSuccess> - Completes a password reset request by setting a new password.
-
finishRegistration(
Session session, {required UuidValue accountRequestId, required String verificationCode, Transaction? transaction}) → Future< AuthSuccess> - Completes a new account registration, creating a new auth user with a profile and attaching the given email account to it.
-
login(
Session session, {required String email, required String password, Transaction? transaction}) → Future< AuthSuccess> - Logs in the user and returns a new session.
-
startPasswordReset(
Session session, {required String email, Transaction? transaction}) → Future< void> -
Requests a password reset for
email. -
startRegistration(
Session session, {required String email, required String password, Transaction? transaction}) → Future< void> - Starts the registration for a new user account with an email-based login associated to it.