PaginatedCleanCubit<T, E> class
abstract
A Cubit which handles paginated data.
- Inheritance
-
- Object
- BlocBase<
PaginatedCleanState< T, E> > - Cubit<
PaginatedCleanState< T, E> > - PaginatedCleanCubit
- Mixed in types
Constructors
- PaginatedCleanCubit()
- A Cubit 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
-
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
-
complete(
) → void -
Complete the completer
inherited
-
emit(
PaginatedCleanState< T, E> state) → void -
Updates the
state
to the providedstate
. emit does nothing if thestate
being emitted is equal to the currentstate
.inherited -
fetchMore(
) → void - Fetch the next page of data
-
init(
{bool showLoading = true}) → void - Handle a remote call and emit the appropriate state
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
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 -
refresh(
) → Future< void> - refresh the data
-
resetPagination(
) → void -
reset the pagination
inherited
-
safeEmit(
PaginatedCleanState< T, E> state) → void -
This is to prevent emitting a state after the cubit has been closed
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