FetchAndRefreshCubit<TState extends FetchAndRefreshState<TIdType, TType>, TIdType, TType> class

Cubit used to fetch and/or refresh data

Mixed-in types
Implementers

Constructors

FetchAndRefreshCubit({TState? initialState, Future<TType?> fetchObject({required TIdType idToGet})?})

Properties

fetchObject → Function?
final
hashCode → int
The hash code for this object.
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 → TState
The current state.
no setterinherited
stream → Stream<TState>
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
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
createFetchedErrorState(TIdType id) → FetchAndRefreshFetchingErrorState<TIdType, TType>
createFetchedSuccessState(TIdType id, TType objectToSet) → FetchAndRefreshFetchingSuccessState<TIdType, TType>
createFetchingState(TIdType id) → FetchAndRefreshFetchingState<TIdType, TType>
createInitialState() → FetchAndRefreshInitialState<TIdType, TType>
createRefreshedErrorState(TIdType id, TType objectToSet) → FetchAndRefreshRefreshingErrorState<TIdType, TType>
createRefreshedSuccessState(TIdType id, TType objectToSet) → FetchAndRefreshRefreshingSuccessState<TIdType, TType>
createRefreshingState(TIdType id, TType objectToSet) → FetchAndRefreshRefreshingState<TIdType, TType>
directSet(TIdType id, TType objectToSet) → dynamic
Used to directly pass an instance of the object
emit(TState state) → void
Updates the state to the provided state. emit does nothing if the state being emitted is equal to the current state.
inherited
fetch({required TIdType idToFetch}) → Future<void>
Do the fetching
getObject({required TIdType idToGet}) → Future<TType?>
Must return a object of TType to show success, null if error
isRefreshSuccessful() → Future<bool>
Check if a refresh was successful Especially useful with smart-refresher, remove a lot of boiler-plate code
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
onChange(Change<TState> 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
refresh() → Future<void>
Do the refreshing
reset() → dynamic
Should reset the cubit to initialState
toString() → String
A string representation of this object.
inherited

Operators

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