BloweBloc<T, P> class
abstract
BloweBloc is an abstract class that extends Bloc and serves as the base for managing specific events and states in the blowe_bloc package. It provides a structure for handling data fetching, updating, resetting, and pagination.
- Inheritance
-
- Object
- BlocBase<
BloweState< T> > - Bloc<
BloweEvent, BloweState< T> > - BloweBloc
- Implementers
Constructors
- BloweBloc([T? initialData])
- Creates an instance of BloweBloc.
Properties
- 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
→ BloweState<
T> -
The current state.
no setterinherited
-
stream
→ Stream<
BloweState< T> > -
The current stream of states.
no setterinherited
Methods
-
add(
BloweEvent event) → void -
Notifies the Bloc of a new
event
which triggers all corresponding EventHandler instances.override -
addError(
Object error, [StackTrace? stackTrace]) → void -
Reports an
error
which triggers onError with an optional StackTrace.inherited -
close(
) → Future< void> -
Closes the
event
andstate
Streams
. This method should be called when a Bloc is no longer needed. Once close is called,events
that are added will not be processed. In addition, if close is called whileevents
are still being processed, the Bloc will finish processing the pendingevents
.inherited -
emit(
BloweState< T> state) → void -
emit is only for internal use and should never be called directly
outside of tests. The Emitter instance provided to each EventHandler
should be used instead.
inherited
-
fetch(
P params) → void - Emits a BloweFetch event with the provided parameters.
-
fetchMore(
P params) → void - Emits a BloweFetchMore event with the provided parameters.
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
on<
E extends Event> (EventHandler< E, BloweState< handler, {EventTransformer<T> >E> ? transformer}) → void -
Register event handler for an event of type
E
. There should only ever be one event handler per event typeE
.inherited -
onChange(
Change< BloweState< change) → voidT> > -
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 notifies BlocObserver.onError.inherited -
onEvent(
BloweEvent event) → void -
Called whenever an
event
is added to the Bloc. A great spot to add logging/analytics at the individual Bloc level.inherited -
onFetch(
BloweFetch< P> event, Emitter<BloweState< emit) → Future<T> >void> - Abstract method that must be implemented by derived classes to handle the BloweFetch event. This method is invoked when BloweFetch is called.
-
onFetchMore(
BloweFetchMore< P> event, Emitter<BloweState< emit) → Future<T> >void> - Abstract method that must be implemented by derived classes to handle the BloweFetchMore event. This method is invoked when BloweFetchMore is called.
-
onReset(
BloweReset event, Emitter< BloweState< emit) → voidT> > - Emits the BloweInitial state to reset the Bloc to its initial state. This method is invoked when BloweReset is called.
-
onTransition(
Transition< BloweEvent, BloweState< transition) → voidT> > -
Called whenever a
transition
occurs with the giventransition
. Atransition
occurs when a newevent
is added and a new state isemitted
from a corresponding EventHandler.inherited -
reset(
) → void - Emits a BloweReset event to reset the bloc's state.
-
toString(
) → String -
A string representation of this object.
inherited
-
updateData(
T data) → void - Emits a BloweUpdateData event with the new data.
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited