ListBloc<T> class
A basic list BLoC with no filtering or pagination. Thus it should be used with a reasonable small amount of data.
Designed to collaborate with ViewStateBuilder for displaying data.
Call loadItems to perform initial data fetch. Call refreshItems to perform a refresh.
T
- type of list items.
- Inheritance
-
- Object
- FilterListBloc<
T, void> - ListBloc
Constructors
-
ListBloc(ListRepository<
T> repository)
Properties
- filter → void
-
no setterinherited
- 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
→ ViewState<
List< T> > -
The current state.
no setterinherited
-
stream
→ Stream<
ViewState< List< >T> > -
The current stream of states.
no setterinherited
Methods
-
add(
ListEvent< void> event) → void -
Notifies the
Bloc
of a newevent
which triggers all correspondingEventHandler
instances.inherited -
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 aBloc
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, theBloc
will finish processing the pendingevents
.inherited -
emit(
ViewState< List< state) → voidT> > -
emit is only for internal use and should never be called directly
outside of tests. The
Emitter
instance provided to eachEventHandler
should be used instead.inherited -
loadItems(
{void filter}) → void -
Loads items using the given
filter
.inherited -
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
on<
E extends Event> (EventHandler< E, ViewState< handler, {EventTransformer<List< >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< ViewState< change) → voidList< >T> > -
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 -
onEvent(
ListEvent< void> event) → void -
Called whenever an
event
is added to theBloc
. A great spot to add logging/analytics at the individualBloc
level.inherited -
onTransition(
Transition< ListEvent< transition) → voidvoid> , ViewState<List< >T> > -
Called whenever a
transition
occurs with the giventransition
. Atransition
occurs when a newevent
is added and a new state isemitted
from a correspondingEventHandler
.inherited -
refreshItems(
{void filter}) → void -
Refreshes items using the given
filter
.inherited -
toString(
) → String -
A string representation of this object.
inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited