AuthCategory class

Interface for Auth category. This expose all the APIs that are supported by this category's plugins. This class will accept plugins to be registered and configured and then subsequent API calls will be forwarded to those plugins.

Inheritance

Constructors

AuthCategory()

Properties

category → Category
no setteroverride
defaultPlugin → AuthPluginInterface
no setterinherited
hashCode → int
The hash code for this object.
no setterinherited
plugins → List<AuthPluginInterface>
finalinherited
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
streamController → StreamController
no setter

Methods

addPlugin(AuthPluginInterface plugin) → Future<void>
Adds a plugin to the category.
inherited
confirmResetPassword({required String username, required String newPassword, required String confirmationCode, ConfirmResetPasswordOptions? options}) → Future<UpdatePasswordResult>
Completes the password reset process given a username, new password, and confirmation code.
confirmSignIn({required String confirmationValue, ConfirmSignInOptions? options}) → Future<SignInResult>
confirmSignUp({required String username, required String confirmationCode, ConfirmSignUpOptions? options}) → Future<SignUpResult>
confirmUserAttribute({required UserAttributeKey userAttributeKey, required String confirmationCode}) → Future<ConfirmUserAttributeResult>
Confirms a user attribute update and returns a ConfirmUserAttributeResult
deleteUser() → Future<void>
Deletes the authenticated AuthUser.
fetchAuthSession({AuthSessionOptions? options}) → Future<AuthSession>
fetchDevices() → Future<List<AuthDevice>>
Retrieves all tracked devices for the current user.
fetchUserAttributes({FetchUserAttributesOptions? options}) → Future<List<AuthUserAttribute>>
forgetDevice([AuthDevice? device]) → Future<void>
Forgets device, or the current device, if no parameters are given.
getCurrentUser() → Future<AuthUser>
getPlugin<T extends P>() → T
inherited
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
rememberDevice() → Future<void>
Remembers the current device.
resendSignUpCode({required String username, ResendSignUpCodeOptions? options}) → Future<ResendSignUpCodeResult>
Resends the code that is used to confirm the user's account after sign up
resendUserAttributeConfirmationCode({required UserAttributeKey userAttributeKey, ResendUserAttributeConfirmationCodeOptions? options}) → Future<ResendUserAttributeConfirmationCodeResult>
Resends a confirmation code for the given attribute and returns a ResendUserAttributeConfirmationCodeResult
resetPassword({required String username, ResetPasswordOptions? options}) → Future<ResetPasswordResult>
Initiates a password reset for the user with the given username.
signIn({required String username, String? password, SignInOptions? options}) → Future<SignInResult>
signInWithWebUI({AuthProvider? provider, SignInWithWebUIOptions? options}) → Future<SignInResult>
signOut({SignOutOptions? options}) → Future<SignOutResult>
Signs the user out of the current device
signUp({required String username, required String password, SignUpOptions? options}) → Future<SignUpResult>
toString() → String
A string representation of this object.
inherited
updatePassword({required String oldPassword, required String newPassword, UpdatePasswordOptions? options}) → Future<UpdatePasswordResult>
Updates the password of the current user.
updateUserAttribute({required UserAttributeKey userAttributeKey, required String value, UpdateUserAttributeOptions? options}) → Future<UpdateUserAttributeResult>
Updates a single user attribute and returns a UpdateUserAttributeResult
updateUserAttributes({required List<AuthUserAttribute> attributes, UpdateUserAttributesOptions? options}) → Future<Map<UserAttributeKey, UpdateUserAttributeResult>>
Updates multiple user attributes and returns a map of UpdateUserAttributeResult

Operators

operator ==(Object other) → bool
The equality operator.
inherited