RequestCubit<T > class
Constructors
RequestCubit ({T fromMap (dynamic json )?, Client? httpClient })
Properties
fromMap
→ (T Function(dynamic json ) ?)
A function that converts the given json
map to
T
type model
final
hashCode
→ int
The hash code for this object.
no setter inherited
httpClient
→ Client
for testing
final
isClosed
→ bool
Whether the bloc is closed.
no setter inherited
runtimeType
→ Type
A representation of the runtime type of the object.
no setter inherited
state
→ RequestState <T >
The current state .
no setter inherited
stream
→ Stream <RequestState <T > >
The current state stream.
no setter inherited
Methods
addError (Object error , [StackTrace ? stackTrace ])
→ void
Reports an error
which triggers onError with an optional StackTrace .
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.
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
getRequest ({required String handle , String ? baseUrl , T fromMap (dynamic json )?, Duration ? timeOut , bool ? enableLogs })
→ Future <void >
Used to initiate a GET
request
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
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
request (Future <T > requestFunction )
→ void
A general function to control bloc with any given
requestFuntion
that returns a future of type T
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
toString ()
→ String
A string representation of this object.
inherited
updateModel (T model )
→ void
Emits the success state with the given model
bloc_rest_api 1.0.0-nullsafety.0