CloudSyncableMixin<T extends CloudSyncable> mixin

A mixin that provides common functionality for BLoCs that manage CloudSyncable entities.

Properties

hashCode → int

The hash code for this object.

no setter, inherited

isClosed → bool

Whether the bloc is closed.

no setter, inherited

localRepository → LocalRepository<T>

The local repository for storing and retrieving entities.

final

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

state → CloudSyncableState

The current state.

no setter, inherited

stream → Stream<CloudSyncableState>

The current stream of states.

no setter, inherited

syncService → SyncService<T>

The sync service for synchronizing entities with the remote repository.

final

Methods

add(CloudSyncableEvent 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

copyFileToLocalPath(T entity) → Future<T>

emit(CloudSyncableState 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

initCloudSyncableMixin() → void

Initializes the mixin and adds event handlers.

noSuchMethod(Invocation invocation) → dynamic

Invoked when a nonexistent method or property is accessed.

inherited

on<E extends Event>(EventHandler<E, CloudSyncableState> 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<CloudSyncableState> 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(CloudSyncableEvent 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<CloudSyncableEvent, CloudSyncableState> 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