InjectedAuthImp<T, P> class
Injected state that is responsible for authenticating and authorization of a user.
- Inheritance
-
- Object
- ReactiveModel<
T> - ReactiveModelImp<
T> - InjectedImp<
T> - InjectedImpRedoPersistState<
T> - InjectedAuthImp
- Mixed-in types
-
- InjectedAuth<
T, P>
- InjectedAuth<
- Available extensions
Constructors
-
InjectedAuthImp({required IAuth<
T, P> repoCreator(), T? unsignedUser, required P param()?, required void onSigned(T s)?, required void onUnsigned()?, required Duration autoSignOut(T auth)?, required FutureOr<Stream< onAuthStream(IAuth<T> >T, P> repo)?, required StateInterceptor<T> ? stateInterceptor, required SideEffects<T> ? sideEffects, required PersistState<T> persist()?, required String? debugPrintWhenNotifiedPreMessage, required Object? toDebugString(T?)?}) - Injected state that is responsible for authenticating and authorization of a user.
Properties
-
auth
→ _AuthService<
T, P> -
Object that encapsulates the signIn, signUp, signOut methods
no setterinherited
- autoDisposeWhenNotUsed → bool
-
finalinherited
- autoSignOut → Duration Function(T auth)?
-
Auto signOut
final
-
cachedCreatorMocks
↔ List<
dynamic Function()?> -
getter/setter pairinherited
- canRedoState → bool
-
Whether the state can be redone.
no setterinherited
- canUndoState → bool
-
Whether the state can be done
no setterinherited
- completer ↔ Completer?
-
getter/setter pairinherited
- connectionState → ConnectionState
-
no setterinherited
- creator → Object? Function()
-
finalinherited
- creatorUpdatable ↔ Object? Function()
-
getter/setter pairinherited
- customStatus ↔ Object?
-
Custom status of the state. Set manually to mark the state with a particular
tag to be used in your logic.
getter/setter pairinherited
- debugPrintWhenNotifiedPreMessageGlobal → String?
-
finalinherited
-
dependsOn
→ DependsOn<
T> ? -
finalinherited
- error → dynamic
-
The error
no setterinherited
- hasData → bool
-
The state is mutated successfully.
no setterinherited
- hasError → bool
-
The stats has error
no setterinherited
- hashCode → int
-
The hash code for this object.
no setterinherited
- hasObservers → bool
-
Whether the state has listeners or not
no setterinherited
-
inheritedInjects
→ Set<
InjectedImp< T> > -
finalinherited
-
initialSnapState
→ SnapState<
T> -
no setterinherited
- initialState ↔ T?
-
getter/setter pairinherited
- isDone → bool
-
The state is mutated using a stream and the stream is done.
no setterinherited
- isIdle → bool
-
The state is initialized and never mutated.
no setterinherited
- isInitialized ↔ bool
-
getter/setter pairinherited
- isSigned → bool
-
Whether the a user is signed or not
no setteroverride
- isStateInitialized → bool
-
no setterinherited
- isWaiting → bool
-
The state is waiting for and asynchronous task to end.
no setterinherited
- isWaitingToInitialize ↔ bool
-
getter/setter pairinherited
- mockableCreator → Object? Function()
-
no setteroverride
- observerLength → int
-
no setterinherited
-
oldSnapState
→ SnapState<
T> ? -
no setterinherited
-
onAuthStream
→ FutureOr<
Stream< Function(IAuth<T> >T, P> repo)? -
final
-
onAuthStreamSubscription
↔ StreamSubscription<
T> ? -
getter/setter pair
- onSigned → void Function(T s)?
-
Callback for side effect on user signed
final
- onUnsigned → void Function()?
-
Callback for side effect on user unsigned
final
- param → P Function()?
-
Params of the repository
final
- removeFromReactiveModel ↔ VoidCallback?
-
getter/setter pairinherited
-
repoCreator
→ IAuth<
T, P> Function() -
Repository creator
final
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
- shouldRecreateTheValue ↔ T?
-
getter/setter pairinherited
-
sideEffects
→ SideEffects<
T> ? -
Side effects
final
-
sideEffectsGlobal
→ SideEffects<
T> ? -
finalinherited
-
snapState
→ SnapState<
T> -
A snap representation of the state
no setterinherited
-
snapValue
↔ SnapState<
T> -
getter/setter pairinherited
- state ↔ T
-
The current state
getter/setter pairinherited
-
stateAsync
↔ Future<
T> -
The current Async state
getter/setter pairinherited
-
stateInterceptorGlobal
→ StateInterceptor<
T> ? -
finalinherited
- subscription ↔ StreamSubscription?
-
It is not null if the state is waiting for a Future or is subscribed to a
Stream
getter/setter pairinherited
- toDebugString → Object? Function(T?)?
-
finalinherited
-
undoRedoPersistState
↔ UndoRedoPersistState<
T> ? -
getter/setter pairinherited
- unsignedUser → T?
-
final
- watch → Object? Function(T? s)?
-
finalinherited
Methods
-
addCleaner(
VoidCallback listener) → VoidCallback -
Add a callback to be executed when the state is disposed of.
inherited
-
addObserver(
{required ObserveReactiveModel listener, bool shouldAutoClean = false, bool isSideEffects = true}) → VoidCallback -
Add observer to this state.
inherited
-
call(
BuildContext context, {bool defaultToGlobal = false}) → Injected< T> -
Obtain the Injected model from the nearest InheritedWidget inserted using inherited.
inherited
-
cleanState(
) → void -
Clean the state
inherited
-
clearUndoStack(
) → void -
Clear undoStack;
inherited
-
deletePersistState(
) → void -
Delete the state form the persistence store
inherited
-
dispose(
) → void -
Dispose the state
override
-
disposeIfNotUsed(
) → void -
Dispose the state if it has no listener
inherited
-
getRepoAs<
R extends IAuth< (T, P> >) → R -
Get the auth repository of type R
inherited
-
inherited(
{required Widget builder(BuildContext), Key? key, required FutureOr< T> stateOverride()?, bool? connectWithGlobal, SideEffects<T> ? sideEffects, String? debugPrintWhenNotifiedPreMessage, Object? toDebugString(T?)?}) → Widget -
Provide the injected model using an InheritedWidget that wraps its state.
inherited
-
initialize(
) → void -
inherited
-
initializeState(
) → FutureOr< T?> -
Initialize the state
inherited
-
injectAuthMock(
IAuth< T, P> fakeRepository()?) → void -
Inject a fake implementation of this injected model.
inherited
-
injectFutureMock(
Future< T> fakeCreator()) → void -
Inject a fake future implementation of this injected model.
inherited
-
injectMock(
T fakeCreator()) → void -
Inject a fake implementation of this injected model.
inherited
-
injectStreamMock(
Stream< T> fakeCreator()) → void -
Inject a fake stream implementation of this injected model.
inherited
-
interceptState(
SnapState< T> snap, StateInterceptor<T> ? stateInterceptor) → SnapState<T> ? -
inherited
-
middleSetCreator(
StateStatus status, Object? result) → void -
inherited
-
middleSetState(
StateStatus status, Object? result, {SideEffects< T> ? sideEffects, StateInterceptor<T> ? stateInterceptor, bool shouldOverrideDefaultSideEffects(SnapState<T> )?}) → dynamic -
inherited
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
notify(
{SnapState< T> ? nextSnap, SideEffects<T> ? sideEffects, bool shouldOverrideDefaultSideEffects(SnapState<T> )?, StateInterceptor<T> ? stateInterceptor}) → bool -
Notify observers
inherited
-
of(
BuildContext context, {bool defaultToGlobal = false}) → T -
Obtain the state from the nearest InheritedWidget inserted using inherited.
inherited
-
onAll<
R> ({R onIdle()?, required R onWaiting()?, required R onError(dynamic error, VoidCallback refreshError)?, required R onData(T data)}) → R -
Listen to the injected Model and rebuild when it emits a notification.
inherited
-
onOrElse<
R> ({R onIdle()?, R onWaiting()?, R onError(dynamic error, VoidCallback refreshError)?, R onData(T data)?, required R orElse(T data)}) → R -
Listen to the injected Model and rebuild when it emits a notification.
inherited
-
onStateInitialized(
) → void -
inherited
-
persistState(
) → void -
Persist the state
inherited
-
rebuildState(
) → void -
inherited
-
redoState(
) → void -
Redo to the next valid state (isWaiting and hasError are ignored)
inherited
-
refresh(
{String? infoMessage}) → Future< T?> -
Refresh the Injected state. Refreshing the state means reinitialize
it and reinvoke its creation function and notify its listeners.
inherited
-
reInherited(
{Key? key, required BuildContext context, required Widget builder(BuildContext context)}) → Widget -
Provide the Injected model to another widget tree branch.
inherited
-
resetDefaultState(
[VoidCallback? fn]) → void -
override
-
setState(
Object? mutator(T s), {SideEffects< T> ? sideEffects, StateInterceptor<T> ? stateInterceptor, bool shouldOverrideDefaultSideEffects(SnapState<T> snap)?, int debounceDelay = 0, int throttleDelay = 0}) → Future<T?> -
Mutate the state of the model and notify observers.
inherited
-
setStateNullable(
Object? mutator(T? s), {required void middleSetState(StateStatus, dynamic result), required StackTrace? stackTrace}) → FutureOr< T?> -
inherited
-
setToHasData(
dynamic data, {SideEffects< T> ? sideEffects, bool shouldOverrideDefaultSideEffects(SnapState<T> )?, StateInterceptor<T> ? stateInterceptor}) → void -
Set the state to the data status
inherited
-
setToHasError(
dynamic error, {StackTrace? stackTrace, VoidCallback? refresher, SideEffects< T> ? sideEffects, bool shouldOverrideDefaultSideEffects(SnapState<T> )?, StateInterceptor<T> ? stateInterceptor}) → void -
Set the state to the error status
inherited
-
setToIsIdle(
[Object? data]) → void -
Set the state to the idle status
inherited
-
setToIsWaiting(
{SideEffects< T> ? sideEffects, bool shouldOverrideDefaultSideEffects(SnapState<T> )?, StateInterceptor<T> ? stateInterceptor}) → void -
Set the state to the waiting status
inherited
-
toString(
) → String -
A string representation of this object.
inherited
-
undoState(
) → void -
Undo to the last valid state (isWaiting and hasError are ignored)
inherited
-
whenConnectionState<
R> ({R onIdle()?, required R onWaiting()?, required R onError(dynamic error)?, required R onData(T data)}) → R -
inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited