DataStorePluginInterface class abstract

Inheritance

Constructors

DataStorePluginInterface({required ModelProviderInterface? modelProvider, dynamic errorHandler(AmplifyException)?, DataStoreConflictHandler? conflictHandler, List<DataStoreSyncExpression>? syncExpressions, int? syncInterval, int? syncMaxRecords, int? syncPageSize, AuthModeStrategy authModeStrategy = AuthModeStrategy.defaultStrategy})
Constructs an AmplifyPlatform.
DataStorePluginInterface.emptyConstructor()
Internal use constructor

Properties

authModeStrategy → AuthModeStrategy
The strategy for authorizing an API call.
final
category → Category
The category implemented by this plugin.
no setteroverride
conflictHandler ↔ DataStoreConflictHandler?
getter/setter pair
errorHandler ↔ (dynamic Function(AmplifyException)?)
getter/setter pair
hashCode → int
The hash code for this object.
no setterinherited
modelProvider ↔ ModelProviderInterface?
modelProvider
getter/setter pair
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
streamController → StreamController<HubEvent>
no setter
syncExpressions ↔ List<DataStoreSyncExpression>?
list of sync expressions to filter datastore sync against
getter/setter pair
syncInterval ↔ int?
Datastore sync interval (in seconds)
getter/setter pair
syncMaxRecords ↔ int?
Datastore max number of records to sync
getter/setter pair
syncPageSize ↔ int?
Datastore page size to sync
getter/setter pair

Methods

addPlugin() → Future<void>
Called when the plugin is added to the category.
inherited
cast<P extends AmplifyPluginInterface>() → P
Casts a plugin to a category-specific implementation.
inherited
clear() → Future<void>
configure({AmplifyConfig? config}) → Future<void>
Configures the plugin using the registered config.
inherited
configureDataStore({required ModelProviderInterface modelProvider, dynamic errorHandler(AmplifyException)?, DataStoreConflictHandler? conflictHandler, int? syncInterval, int? syncMaxRecords, int? syncPageSize, AuthModeStrategy authModeStrategy = AuthModeStrategy.defaultStrategy}) → Future<void>
Configure AmplifyDataStore plugin with mandatory modelProvider and optional DataStore configuration properties including
delete<T extends Model>(T model, {QueryPredicate<Model>? where}) → Future<void>
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
observe<T extends Model>(ModelType<T> modelType, {QueryPredicate<Model>? where}) → Stream<SubscriptionEvent<T>>
observeQuery<T extends Model>(ModelType<T> modelType, {QueryPredicate<Model>? where, List<QuerySortBy>? sortBy, ObserveQueryThrottleOptions throttleOptions = const ObserveQueryThrottleOptions.defaults()}) → Stream<QuerySnapshot<T>>
query<T extends Model>(ModelType<T> modelType, {QueryPredicate<Model>? where, QueryPagination? pagination, List<QuerySortBy>? sortBy}) → Future<List<T>>
reset() → Future<void>
Resets the plugin by removing all traces of it from the device.
inherited
save<T extends Model>(T model, {QueryPredicate<Model>? where}) → Future<void>
start() → Future<void>
stop() → Future<void>
toString() → String
A string representation of this object.
inherited

Operators

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