AuthCubit class

Inheritance

Properties

authApi ↔ AuthApi?
getter/setter pair
hashCode → int
The hash code for this object.
no setterinherited
id → String
id is used to uniquely identify multiple instances of the same HydratedBloc type. In most cases it is not necessary; however, if you wish to intentionally have multiple instances of the same HydratedBloc, then you must override id and return a unique identifier for each HydratedBloc 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
socialLogins ↔ List<SocialLogin>
getter/setter pairinherited
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 of storagePrefix and id.
no setterinherited
stream → Stream<AuthState>
The current stream of states.
no setterinherited

Methods

addError(Object error, [StackTrace? stackTrace]) → void
Reports an error which triggers onError with an optional StackTrace.
inherited
changePassword({required String id, required ChangePasswordRequest changePasswordRequest}) → Future<void>
override
clear() → Future<void>
clear is used to wipe or invalidate the cache of a HydratedBloc. Calling clear 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 provided state. emit does nothing if the state being emitted is equal to the current state.
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.
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
Login user with magic link. magiclink should not be empty It supports only email at the moment.
override
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
override
logout() → Future<void>
Logout user, also removes token from storage and logs out user from social logins
override
logoutFromSocialProvider(SocialLoginType type) → Future<void>
override
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.
override
onChange(Change<AuthState> change) → void
Called whenever a change occurs with the given change. A change occurs when a new state is emitted. onChange is called before the state of the cubit is updated. onChange is a great spot to add logging/analytics for a specific cubit.
inherited
onError(Object error, StackTrace stackTrace) → void
Called whenever an error occurs and notifies BlocObserver.onError.
inherited
registerOrInviteUser({required UserIdentityRequest userIdentityRequest}) → Future<UserIdentity?>
Register or invite user to the system
override
requestOTP({required OTPObtainRequest otpObtainRequest}) → Future<void>
Request OTP for verification.
override
requestTokenFromSocialProvider<R>(SocialLoginType type) → Future<R?>
Authenticate and request token for user from the Social Auth Provider eg, facebook, google etc.
override
toJson(AuthState state) → Map<String, dynamic>?
Responsible for converting a concrete instance of the bloc state into the the Map<String, dynamic> representation.
toString() → String
A string representation of this object.
inherited

Operators

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

Static Properties

instance → AuthCubit
no setter