OfflineFirstRepository<RepositoryModel extends OfflineFirstModel> class abstract

A ModelRepository that interacts with a SqliteProvider first before using a Provider from a remote source.

The OfflineFirstRepository should be extended by an implementation in the end class. The implementation can then be accessed via singleton or InheritedWidget. For example:

class MyRepository extends OfflineFirstRepository {
  const MyRepository._(
    RestProvider _restProvider,
    SqliteProvider _sqliteProvider,
  ) : super(
        remoteProvider: _restProvider,
        sqliteProvider: _sqliteProvider,
      );
  factory MyRepository() => _singleton!;

  /// The singleton could be configured on the first call of `MyRepository()` or it can
  /// be set by calling `configure` during app initialization.
  static void configure({
    required RestProvider restProvider,
    required SqliteProvider sqliteProvider,
  }) {
    _singleton = MyRepository._(
      restProvider,
      sqliteProvider,
    );
  }
}

Constructors

OfflineFirstRepository({required Provider<Model> remoteProvider, required SqliteProvider sqliteProvider, bool? autoHydrate, MemoryCacheProvider? memoryCacheProvider, required Set<Migration> migrations, String? loggerName})

Properties

autoHydrate → bool
Refetch results in the background from remote source when any request is made. Defaults to false.
final
hashCode → int
The hash code for this object.
no setterinherited
logger → Logger
User for low-level debugging. The logger name can be defined in the default constructor; it defaults to OfflineFirstRepository.
final
memoryCacheProvider → MemoryCacheProvider
The first data source to speed up otherwise taxing queries. Only caches specified models.
final
migrationManager → MigrationManager
final
remoteProvider → Provider<Model>
The data source that data is pushed to and from.
final
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
sqliteProvider → SqliteProvider
The local data source utilized before every operation.
final
subscriptions → Map<Type, Map<Query?, StreamController<List<RepositoryModel>>>>
final

Methods

applyPolicyToQuery(Query? query, {OfflineFirstDeletePolicy? delete, OfflineFirstGetPolicy? get, OfflineFirstUpsertPolicy? upsert}) → Query?
As some remote provider's may utilize an OfflineFirstPolicy from the request, this composes the policy to the query (such as in the providerArgs).
delete<TModel extends RepositoryModel>(TModel instance, {OfflineFirstDeletePolicy policy = OfflineFirstDeletePolicy.optimisticLocal, Query? query}) → Future<bool>
Remove a model from SQLite and the remoteProvider
exists<TModel extends RepositoryModel>({Query? query}) → Future<bool>
Check if a TModel is accessible locally. First checks if there's a matching query in memoryCacheProvider and then check sqliteProvider. Does not query remoteProvider.
get<TModel extends RepositoryModel>({OfflineFirstGetPolicy policy = OfflineFirstGetPolicy.awaitRemoteWhenNoneExist, Query? query, bool seedOnly = false}) → Future<List<TModel>>
Load association from SQLite first; if the TModel hasn't been loaded previously, fetch it from remoteProvider and hydrate SQLite. For available query providerArgs see remoteProvider#get SqliteProvider.get.
getAssociation<TModel extends RepositoryModel>(Query query) → Future<List<TModel>?>
Used exclusively by the OfflineFirstAdapter. If there are no results, returns null.
getBatched<TModel extends RepositoryModel>({int batchSize = 50, OfflineFirstGetPolicy policy = OfflineFirstGetPolicy.awaitRemoteWhenNoneExist, Query? query, bool seedOnly = false}) → Future<List<TModel>>
Get all results in series of batchSizes (defaults to 50). Useful for large queries or remote results.
hydrate<TModel extends RepositoryModel>({bool deserializeSqlite = true, Query? query}) → Future<List<TModel>>
Fetch and store results from remoteProvider into SQLite and the memory cache.
initialize() → Future<void>
Prepare the environment for future repository functions. It is recommended to call this method within a StatefulWidget's initState to ensure it is only invoked once. It is not automatically invoked.
migrate() → Future<void>
Update SQLite structure with only new migrations.
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
notifySubscriptionsWithLocalData<TModel extends RepositoryModel>({bool notifyWhenEmpty = true}) → Future<void>
Iterate through subscriptions after an upsert and notify any subscribe listeners.
reset() → Future<void>
Destroys all local records - specifically, memoryCache and sqliteProvider's data sources.
storeRemoteResults<TModel extends RepositoryModel>(List<TModel> models, {bool shouldNotify = true}) → Future<List<TModel>>
Save response results to SQLite.
subscribe<TModel extends RepositoryModel>({OfflineFirstGetPolicy policy = OfflineFirstGetPolicy.localOnly, Query? query}) → Stream<List<TModel>>
Listen for streaming changes when the sqliteProvider is upserted. This method utilizes remoteProvider's get.
toString() → String
A string representation of this object.
inherited
upsert<TModel extends RepositoryModel>(TModel instance, {Query? query, OfflineFirstUpsertPolicy policy = OfflineFirstUpsertPolicy.optimisticLocal}) → Future<TModel>
Send a model to remoteProvider and hydrate.

Operators

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