BasePagingBloc<Q, D> class abstract

Base handle paging events

Inheritance

Constructors

BasePagingBloc()

Properties

comparable CompareFunction<D>?
Override this getter when we want to sort out result.
no setter
hashCode int
The hash code for this object.
no setterinherited
isClosed bool
Whether the bloc is closed.
no setterinherited
needLog bool
Whether need to log bloc transition or not
no setterinherited
pagingQueryNeedCheckConnection bool
Override this getter when we want to check internet connection before querying.
no setter
pagingTransformer EventTransformer<BasePagingEvent<Q>>
no setter
runtimeType Type
A representation of the runtime type of the object.
no setterinherited
state BaseState
The current state.
no setterinherited
stream Stream<BaseState>
The current stream of states.
no setterinherited
useIsolateForSorting bool
Override this getter when we want to sort on main isolate. For example, in case we find it hard to initialize DB instances in a worker isolate.
no setter

Methods

add(BaseEvent 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
cancelableFuture(Future inner, {String? tag, bool needCheckConnection = true, bool needHandleError = true}) Future?
Wrap cancelable async process with connection status - needCheckConnection and error process if need - needHandleError.
inherited
cancelRunningTask() Future<void>
Cancel all running task in the background.
inherited
checkConnection() Future<void>
Using whenever a event which fetch data from remote is added to bloc
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
convertedException(Exception exception) KntException
inherited
convertedIssue(DioError error) KntIssue
inherited
emit(BaseState 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
find(bool filter(D)) → D?
handleBaseErrorEvent(BaseErrorEvent event, Emitter<BaseState> emit) Future<void>
Throws error state.
override
handleBaseLoadingEvent(BaseLoadingEvent event, Emitter<BaseState> emit) Future<void>
Change to loading state.
inherited
handleCancelRunningTaskEvent(CancelRunningTaskEvent event, Emitter<BaseState> emit) Future<void>
Cancels running tasks.
inherited
handleError(Exception exception, {String? tag}) → void
Handle exception which is thrown from mapping event-state process.
inherited
handlePagingEvent(BasePagingEvent<Q> event, Emitter<BaseState> emit) Future<void>
handleResetBlocEvent(ResetBlocEvent event, Emitter<BaseState> emit) Future<void>
Needs to reset data bloc, includes cancelling all running async tasks.
inherited
indexOf(D data) int
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
on<E extends Event>(EventHandler<E, BaseState> 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<BaseState> 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(BaseEvent 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<BaseEvent, BaseState> 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
pagingInProgress(BaseRequestPaging<Q> pagingQuery) Future<BaseResponsePaging<D>>
Handle query process
pagingStateInstance(List<D> dataList, int offset, {String? tag}) BasePagingResultState<D>
Create instance of paging result
reset() → void
Reset data.
override
toString() String
A string representation of this object.
inherited
watch<E extends BaseEvent>(EventHandler<E, BaseState> handler, {EventTransformer<E>? transformer}) → void
A wrapper of on function to ease the handling error flow.
inherited

Operators

operator ==(Object other) bool
The equality operator.
inherited