PaginatedCleanBloc<T, E> class abstract

A Bloc which handles paginated data.

Inheritance
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 and state 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 while events are still being processed, the Bloc will finish processing the pending events.
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<T, E>> handler, {EventTransformer<E>? transformer}) → void
Register event handler for an event of type E. There should only ever be one event handler per event type E.
inherited
onChange(Change<PaginatedCleanState<T, E>> 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
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<T, E>> transition) → void
Called whenever a transition occurs with the given transition. A transition occurs when a new event is added and a new state is emitted 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