PaginatedCleanBloc<T, E> class
abstract
A Bloc which handles paginated data.
- Inheritance
-
- Object
- BlocBase<
PaginatedCleanState< T, E> > - Bloc<
PaginatedCleanEvent, PaginatedCleanState< T, E> > - PaginatedCleanBloc
- Mixed in types
Constructors
- PaginatedCleanBloc()
- A Bloc which handles paginated data.
Properties
- currentPage → int
-
no setterinherited
-
errorHandler
→ PaginatedCleanErrorHandler<
T, E> -
error handler for custom logic
no setter
-
future
→ Future<
void> -
Get the future
no setterinherited
- hashCode → int
-
The hash code for this object.
no setterinherited
- hasNextPage → bool
-
Returns true if the current page is less than the last page and the length of the list is less than the total number of items
no setterinherited
- initialPage → PageParams
-
initial page params
no setter
- isClosed → bool
-
Whether the bloc is closed.
no setterinherited
- lastPage → int
-
no setterinherited
- nextParams → PageParams
-
returns the next page params
no setterinherited
- perPage → int
-
no setterinherited
-
remoteCall
→ PaginatedEitherResponse<
E, T> Function(PageParams params) -
Remote call
no setter
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
-
state
→ PaginatedCleanState<
T, E> -
The current state.
no setterinherited
-
stream
→ Stream<
PaginatedCleanState< T, E> > -
The current stream of states.
no setterinherited
-
successHandler
→ PaginatedCleanSuccessHandler<
T, E> -
success handler for custom logic
no setter
- total → int
-
no setterinherited
Methods
-
add(
PaginatedCleanEvent event) → void -
Notifies the Bloc of a new
event
which triggers all corresponding EventHandler 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 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 -
complete(
) → void -
Complete the completer
inherited
-
emit(
PaginatedCleanState< T, E> 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
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
on<
E extends Event> (EventHandler< E, PaginatedCleanState< handler, {EventTransformer<T, E> >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< PaginatedCleanState< change) → voidT, E> > -
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(
PaginatedCleanEvent event) → void -
Called whenever an
event
is added to the Bloc. A great spot to add logging/analytics at the individual Bloc level.inherited -
onTransition(
Transition< PaginatedCleanEvent, PaginatedCleanState< transition) → voidT, E> > -
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 -
resetPagination(
) → void -
reset the pagination
inherited
-
toString(
) → String -
A string representation of this object.
inherited
-
updatePagination(
PaginatedResponse response) → void -
update the pagination
inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited