LoginController class

GetxController of a LoginView.

Inheritance

Constructors

LoginController.new(AuthService _authService, {LoginViewStage initial = LoginViewStage.signUp, MyUser? myUser, void onSuccess({bool? signedUp})?})

Properties

authStatus Rx<RxStatus>
Current authentication status.
no setter
codeAttempts int
Amount of emailCode unsuccessful submitting attempts.
getter/setter pair
codeTimeout RxInt
Timeout of a emailCode next submit attempt.
final
email TextFieldState
TextFieldState for an UserEmail text input.
latefinal
emailCode TextFieldState
TextFieldState for ConfirmationCode for UserEmail input.
latefinal
hashCode int
The hash code for this object.
no setterinherited
hasListeners bool
no setterinherited
identifier TextFieldState
TextFieldState for an UserNum, UserLogin or UserEmail text input.
latefinal
initialized bool
Checks whether the controller has already been initialized.
no setterinherited
isClosed bool
Checks whether the controller has already been closed.
no setterinherited
listeners int
no setterinherited
login TextFieldState
TextFieldState of a login text input.
latefinal
newPassword TextFieldState
TextFieldState of a new password text input.
latefinal
obscureCode RxBool
Indicator whether the emailCode should be obscured.
final
obscureNewPassword RxBool
Indicator whether the newPassword should be obscured.
final
obscurePassword RxBool
Indicator whether the password should be obscured.
final
obscureRepeatPassword RxBool
Indicator whether the repeatPassword should be obscured.
final
onDelete InternalFinalCallback<void>
Internal callback that starts the cycle of this controller.
finalinherited
onStart InternalFinalCallback<void>
Called at the exact moment the widget is allocated in memory. It uses an internal "callable" type, to avoid any @overrides in subclases. This method should be internal and is required to define the lifetime cycle of the subclass.
finalinherited
onSuccess → void Function({bool? signedUp})?
Callback, called when this LoginController successfully signs into an account.
final
password TextFieldState
TextFieldState of a password text input.
latefinal
recovered RxBool
Indicator whether the password has been reset.
final
recovery TextFieldState
TextFieldState of a recovery text input.
latefinal
recoveryCode TextFieldState
TextFieldState of a recovery code text input.
latefinal
repeatPassword TextFieldState
TextFieldState of a repeat password text input.
latefinal
resendEmailTimeout RxInt
Timeout of a resendEmail next invoke attempt.
final
returnTo LoginViewStage?
LoginView stage to go back to.
getter/setter pair
runtimeType Type
A representation of the runtime type of the object.
no setterinherited
scrollController ScrollController
ScrollController to pass to a Scrollbar.
final
signInAttempts int
Amount of signIn unsuccessful submitting attempts.
getter/setter pair
signInTimeout RxInt
Timeout of a signIn next invoke attempt.
final
stage Rx<LoginViewStage>
LoginViewStage currently being displayed.
final

Methods

$configureLifeCycle() → void
inherited
addListener(GetStateUpdate listener) Disposer
Register a closure to be called when the object notifies its listeners.
inherited
addListenerId(Object? key, GetStateUpdate listener) Disposer
inherited
dispose() → void
inherited
disposeId(Object id) → void
To dispose an id from future updates(), this ids are registered by GetBuilder() or similar, so is a way to unlink the state change with the Widget from the Controller.
inherited
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
notifyChildrens() → void
inherited
onClose() → void
Called before onDelete method. onClose might be used to dispose resources used by the controller. Like closing events, or streams before the controller is destroyed. Or dispose objects that can potentially create some memory leaks, like TextEditingControllers, AnimationControllers. Might be useful as well to persist some data on disk.
override
onInit() → void
Called immediately after the widget is allocated in memory. You might use this to initialize something for the controller.
override
onReady() → void
Called 1 frame after onInit(). It is the perfect place to enter navigation events, like snackbar, dialogs, or a new route, or async request.
inherited
recoverAccess() Future<void>
Initiates password recovery for the MyUser identified by the provided recovery input and stores the parsed value.
refresh() → void
inherited
refreshGroup(Object id) → void
inherited
register({UserPassword? password, UserLogin? login}) Future<void>
Creates a new one-time account right away.
removeListener(VoidCallback listener) → void
Remove a previously registered closure from the list of closures that the object notifies.
inherited
removeListenerId(Object id, VoidCallback listener) → void
inherited
resendEmail() Future<void>
Resends a ConfirmationCode to the specified email.
resetUserPassword() Future<void>
Resets password for the MyUser identified by the provided in recoverAccess identity and ConfirmationCode.
signIn() Future<void>
Signs in and redirects to the Routes.home page.
toString() String
A string representation of this object.
inherited
update([List<Object>? ids, bool condition = true]) → void
Rebuilds GetBuilder each time you call update(); Can take a List of ids, that will only update the matching GetBuilder( id: ), ids can be reused among GetBuilders like group tags. The update will only notify the Widgets, if condition is true.
inherited
validateCode() Future<void>
Validates the provided password recovery ConfirmationCode for the MyUser identified by the provided in recoverAccess identity.

Operators

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