PaginationServiceBloc<PaginationServiceRequestedEvent extends PaginationServiceRequested, ResponseData, PageType> class abstract

Base class for pagination service implement with bloc architecture.

Each PaginationServiceBloc should create a unique event class extending PaginationServiceRequested

Each PaginationServiceBloc should only return a single base type as response type.

Inheritance
  • Object
  • ServiceBloc<PaginationServiceRequestedEvent, ResponseData>
  • PaginationServiceBloc

Constructors

PaginationServiceBloc({required Pagination<PageType, ResponseData> pagination, required PaginationResponseData<ResponseData> paginationResponseData, EventTransformer<PaginationServiceRequestedEvent>? eventTransformer})
Constructor for creating PaginationServiceBloc.

Properties

data → ResponseData?
Quick shortcut for getting response data if state is ServiceLoadSuccess. Otherwise, return null.
no setterinherited
hasData → bool
Quick shortcut for checking
no setterinherited
hashCode → int
The hash code for this object.
no setterinherited
isClosed → bool
Whether the bloc is closed.
no setterinherited
isFirstLoaded → bool
Getter for is first loaded boolean flag
no setter
pagination → Pagination<PageType, ResponseData>
Getter for pagination.
no setter
paginationResponseData → PaginationResponseData<ResponseData>
Getter for pagination response data.
no setter
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
state → ServiceState
The current state.
no setterinherited
stream → Stream<ServiceState>
The current stream of states.
no setterinherited

Methods

add(PaginationServiceRequestedEvent event) → void
Overrode add function from Bloc to prevent
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
emit(ServiceState 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, ServiceState> 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<ServiceState> 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
onDone(PaginationServiceRequestedEvent event, [Object? error, StackTrace? stackTrace]) → void
Called whenever an event handler for a specific Bloc has completed. This may include an error and stackTrace if an uncaught exception occurred within the event handler.
inherited
onError(Object error, StackTrace stackTrace) → void
Called whenever an error occurs and notifies BlocObserver.onError.
inherited
onEvent(PaginationServiceRequestedEvent event) → void
Called whenever an event is added to the Bloc. A great spot to add logging/analytics at the individual Bloc level.
inherited
onPaginationRequest(PaginationServiceRequestedEvent event, PageType page) → FutureOr<ResponseData>
Function for implementation of handling event process. All request must be call or complete within this function.
onPostRequest(PaginationServiceRequestedEvent event, Emitter<ServiceState> emit) → FutureOr<void>
Function for handling custom action after event getting processed.
inherited
onPreRequest(PaginationServiceRequestedEvent event, Emitter<ServiceState> emit) → FutureOr<void>
Function for handling reset data or page increment before request.
override
onReloadReset() → FutureOr<void>
Function for implementation of resetting bloc fields when event is PaginationReloadServiceRequested
onRequest(PaginationServiceRequestedEvent event, Emitter<ServiceState> emit) → FutureOr<void>
Function for handling pagination request.
override
onServiceRequested(PaginationServiceRequestedEvent event, Emitter<ServiceState> emit) → FutureOr<void>
Function for handling ServiceEvent when use add event to ServiceBloc.
inherited
onTransition(Transition<PaginationServiceRequestedEvent, ServiceState> 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
toString() → String
A string representation of this object.
inherited

Operators

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