HydratedAuthCubitBase class abstract
This is the base class for AuthCubit. It allows to create AuthCubit based on any kind of backends.
- Implementers
Constructors
- HydratedAuthCubitBase(AuthState initialState)
Properties
- hashCode → int
-
The hash code for this object.
no setterinherited
- id → String
-
id
is used to uniquely identify multiple instances of the sameHydratedBloc
type. In most cases it is not necessary; however, if you wish to intentionally have multiple instances of the sameHydratedBloc
, then you must overrideid
and return a unique identifier for eachHydratedBloc
instance in order to keep the caches independent of each other.no setterinherited - isClosed → bool
-
Whether the bloc is closed.
no setterinherited
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
-
getter/setter pair
- state → AuthState
-
The current state.
no setterinherited
- storagePrefix → String
-
Storage prefix which can be overridden to provide a custom
storage namespace.
Defaults to runtimeType but should be overridden in cases
where stored data should be resilient to obfuscation or persist
between debug/release builds.
no setterinherited
- storageToken → String
-
storageToken
is used as registration token for hydrated storage. Composed ofstoragePrefix
andid
.no setterinherited -
stream
→ Stream<
AuthState> -
The current stream of states.
no setterinherited
Methods
-
addError(
Object error, [StackTrace? stackTrace]) → void -
Reports an
error
which triggersonError
with an optional StackTrace.inherited -
changePassword(
{required String id, required ChangePasswordRequest changePasswordRequest}) → Future< void> -
clear(
) → Future< void> -
clear
is used to wipe or invalidate the cache of aHydratedBloc
. Callingclear
will delete the cached state of the bloc but will not modify the current state of the bloc.inherited -
close(
) → Future< void> -
Closes the instance.
This method should be called when the instance is no longer needed.
Once
close
is called, the instance can no longer be used.inherited -
emit(
AuthState state) → void -
Updates the
state
to the providedstate
.emit
does nothing if thestate
being emitted is equal to the currentstate
.inherited -
fromJson(
Map< String, dynamic> json) → AuthState? -
Responsible for converting the
Map<String, dynamic>
representation of the bloc state into a concrete instance of the bloc state.inherited -
hydrate(
) → void -
Populates the internal state storage with the latest state.
This should be called when using the
HydratedMixin
directly within the constructor body.inherited -
loginWithMagicLink(
{required String magiclink}) → Future< void> - Login user with magic link. magiclink should not be empty It supports only email at the moment.
-
loginWithSocialProviderToken(
{required SocialTokenObtainRequest socialTokenObtainRequest}) → Future< void> - Login user with social provider token data that was retrieved via requestTokenFromSocialProvider This will retrieve token from backend and login user
-
logout(
) → Future< void> -
logoutFromSocialProvider(
SocialLoginType type) → Future< void> -
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
obtainTokenAndLogin(
{required TokenObtainRequest tokenObtainRequest}) → Future< void> - Authenticates the user based on provided credentials (e.g., username+password or email+OTP etc) and logs them in by obtaining and processing a JWT token.
-
onChange(
Change< AuthState> change) → void -
Called whenever a
change
occurs with the givenchange
. Achange
occurs when a newstate
is emitted. onChange is called before thestate
of thecubit
is updated. onChange is a great spot to add logging/analytics for a specificcubit
.inherited -
onError(
Object error, StackTrace stackTrace) → void -
Called whenever an
error
occurs and notifiesBlocObserver.onError
.inherited -
registerOrInviteUser(
{required UserIdentityRequest userIdentityRequest}) → Future< UserIdentity?> -
requestOTP(
{required OTPObtainRequest otpObtainRequest}) → Future< void> -
requestTokenFromSocialProvider<
R> (SocialLoginType type) → Future< R?> - Authenticate and request token for user from the Social Auth Provider eg, facebook, google etc.
-
toJson(
AuthState state) → Map< String, dynamic> ? -
Responsible for converting a concrete instance of the bloc state
into the the
Map<String, dynamic>
representation.inherited -
toString(
) → String -
A string representation of this object.
inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited