PersistedInputCubit class
Controller to save data from persisted input
Constructors
- PersistedInputCubit({required String id})
- Default controller for persisted cubit
Properties
- 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 sameHydratedBloc
, then you must override id and return a unique identifier for eachHydratedBloc
instance in order to keep the caches independent of each other.final - isClosed → bool
-
Whether the bloc is closed.
no setterinherited
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
- state → PersistedInputData
-
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<
PersistedInputData> -
The current stream of states.
no setterinherited
- valuesExist → bool
-
Checks if values exist
no setter
Methods
-
addError(
Object error, [StackTrace? stackTrace]) → void -
Reports an
error
which triggers onError with an optional StackTrace.inherited -
addValue(
String value) → void - Adds new input value to the list
-
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
-
deleteValue(
String value) → void - Deletes value from the list
-
emit(
PersistedInputData 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) → PersistedInputData? -
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 -
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
onChange(
Change< PersistedInputData> 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 -
setFavoriteValue(
String value) → void - Sets favorite value
-
toJson(
PersistedInputData 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