AuthWorkflowController class Null safety
Authentication workflow controller
- Inheritance
- Object
- GetLifeCycle
- DisposableInterface
- GetxController
- WorkflowController<
AuthStatus> - AuthWorkflowController
Constructors
- AuthWorkflowController()
- auth workflow controller
Properties
- container → WorkflowContainer
-
Container to store data to be transferred between listener plugins
final, inherited
- emitMinorEvents → bool
-
Should minor events be emitted
final, inherited
-
events
→ Rx<
PluginEvent< AuthStatus> > -
Events occurring within the workflow
final, inherited
- hashCode → int
-
The hash code for this object. [...]
read-only, inherited
- hasListeners → bool
-
read-only, inherited
- initialized → bool
-
Checks whether the controller has already been initialized.
read-only, inherited
- isClosed → bool
-
Checks whether the controller has already been closed.
read-only, inherited
-
lastEvent
→ PluginEvent<
AuthStatus> -
The last event that occurred in this workflow
read-only, inherited
- listeners → int
-
read-only, inherited
-
minorEvents
→ Rx<
MinorPluginEvent< AuthStatus> > -
Minor events occurring within the workflow
final, inherited
-
onDelete
→ InternalFinalCallback<
void> -
Internal callback that starts the cycle of this controller.
final, inherited
-
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.
final, inherited
-
registry
→ Map<
AuthStatus, List< WorkflowListenerPlugin< >AuthStatus, WorkflowController< >AuthStatus> > -
Registry mapping state to the plugins to be executed for that state
final, inherited
- runtimeType → Type
-
A representation of the runtime type of the object.
read-only, inherited
- state → AuthStatus
-
The current state of this workflow
read-only, inherited
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
-
changeState(
AuthStatus state, {Json? params, Object? data, bool resetData = false}) → Future< void> -
Change the current
state
[...]inherited -
dispose(
) → void -
@mustCallSuper, inherited
-
disposeId(
Object id) → void -
To dispose an
id
from future updates(), this ids are registered byGetBuilder()
or similar, so is a way to unlink the state change with the Widget from the Controller.inherited -
executeListeners(
PluginEvent< AuthStatus> event) → Future -
Executes listeners in registry for the specified event
inherited
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a non-existent method or property is accessed. [...]
inherited
-
notifyChildrens(
) → void -
@protected, inherited
-
onceState(
AuthStatus state, dynamic callback(PluginEvent< AuthStatus> )) → dynamic -
Executes the
callback
oncestate
is emittedinherited -
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.
inherited
-
onInit(
) → void -
Start listening to state changes
inherited
-
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
-
refresh(
) → void -
@protected, inherited
-
refreshGroup(
Object id) → void -
@protected, inherited
-
registerListenerPlugin(
WorkflowListenerPlugin< AuthStatus, WorkflowController< plugin) → dynamicAuthStatus> > -
Registers a listener plugin
inherited
-
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
-
setAuthState(
bool authenticated, [String? tokenType]) → void - Set the authentication state
-
toString(
) → String -
A string representation of this object. [...]
inherited
-
update(
[List< Object> ? ids, bool condition = true]) → void -
Rebuilds
GetBuilder
each time you callupdate()
; Can take a List ofids
, that will only update the matchingGetBuilder( id: )
,ids
can be reused amongGetBuilders
like group tags. The update will only notify the Widgets, ifcondition
is true.inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator. [...]
inherited
Static Properties
- instance → AuthWorkflowController
-
Current inserted instance
read-only