HydratedRequestCubit<T> class
Properties
-
fromMap
→ (T Function(dynamic json)?)
-
A function that converts the given
json map to
T type model
finalinherited
-
hashCode
→ int
-
The hash code for this object.
no setterinherited
-
httpClient
→ Client
-
for testing
finalinherited
-
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
-
state
→ RequestState<T>
-
The current state.
no setterinherited
-
storageToken
→ String
-
storageToken is used as registration token for hydrated storage.
no setterinherited
-
stream
→ Stream<RequestState<T>>
-
The current state stream.
no setterinherited
-
toMap
→ Map<String, dynamic> Function(T model)
-
A function that converts the given
T type model
json map
final
Methods
-
addError(Object error, [StackTrace? stackTrace])
→ void
-
Reports an
error which triggers onError with an optional StackTrace.
inherited
-
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.
override
-
emit(RequestState<T> state)
→ void
-
Updates the
state to the provided state.
emit does nothing if the instance has been closed or if the
state being emitted is equal to the current state.
inherited
-
emptyCubit()
→ void
-
Empties out the bloc and emits the empty state
inherited
-
fromJson(Map<String, dynamic> json)
→ RequestState<T>
-
Responsible for converting the
Map<String, dynamic> representation
of the bloc state into a concrete instance of the bloc state.
-
getRequest({required String handle, String? baseUrl, T fromMap(dynamic json)?, Duration? timeOut, bool? enableLogs})
→ Future<void>
-
Used to initiate a
GET request
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
-
listen(void onData(RequestState<T>)?, {Function? onError, void onDone()?, bool? cancelOnError})
→ StreamSubscription<RequestState<T>>
-
Adds a subscription to the
Stream<State>.
Returns a StreamSubscription which handles events from
the Stream<State> using the provided onData, onError and onDone
handlers.
inherited
-
localRequest(String json, {bool? enableLogs = false})
→ Future<void>
-
Used to convert a locally provided
json String to object T
inherited
-
noSuchMethod(Invocation invocation)
→ dynamic
-
Invoked when a nonexistent method or property is accessed.
inherited
-
onChange(Change<RequestState<T>> 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
-
postRequest({required String handle, String? baseUrl, dynamic body, T fromMap(dynamic json)?, Duration? timeOut, bool? enableLogs})
→ Future<void>
-
Used to initiate a
POST request
inherited
-
request(Future<T> requestFunction)
→ void
-
A general function to control bloc with any given
requestFuntion that returns a future of type T
inherited
-
toJson(RequestState<T> state)
→ Map<String, dynamic>
-
Responsible for converting a concrete instance of the bloc state
into the the
Map<String, dynamic> representation.
-
toModel(T fromMap(dynamic json)?, Map<String, dynamic>? json)
→ T?
-
This function converts th given
json to model T using the
funtion fromMap and returns the model
inherited
-
toString()
→ String
-
A string representation of this object.
inherited
-
updateModel(T model)
→ void
-
Emits the success state with the given model
inherited
