AppwriteRemoteConfig<T extends HasUpdatedAt, Id> class

Configuration for AppwriteRemoteStore

Note: This scaffold does not depend on the appwrite SDK to keep the core package lightweight. You can pass any client via client and implement the integration inside the TODOs later. All field/collection names are placeholders and should be replaced with your schema.

Constructors

AppwriteRemoteConfig.new({required Databases databases, Functions? functions, required String databaseId, required String collectionId, required String idField, required String updatedAtField, required String? deletedAtField, required String scopeNameField, required String scopeKeysField, required Id idOf(T), required String idToString(Id), required Id idFromString(String), required Map<String, dynamic> toJson(T), required T fromJson(Map<String, dynamic>), String? serverTimeFunctionId, SyncScope? defaultScope, bool injectScopeOnWrite = false, Map<String, dynamic> scopeFieldsBuilder(SyncScope scope)?, void onParsePageStats({required int skipped, required int total})?, Future<List<Map<String, dynamic>>> searchRunner(List<String> queries)?})
const

Properties

collectionId → String
final
databaseId → String
final
databases → Databases
final
defaultScope → SyncScope?
final
deletedAtField → String?
final
fromJson → T Function(Map<String, dynamic>)
final
functions → Functions?
final
hashCode → int
The hash code for this object.
no setterinherited
idField → String
final
idFromString → Id Function(String)
final
idOf → Id Function(T)
final
idToString → String Function(Id)
final
injectScopeOnWrite → bool
final
onParsePageStats → void Function({required int skipped, required int total})?
final
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
scopeFieldsBuilder → Map<String, dynamic> Function(SyncScope scope)?
final
scopeKeysField → String
final
scopeNameField → String
final
searchRunner → Future<List<Map<String, dynamic>>> Function(List<String> queries)?
Optional runner to execute remoteSearch without network. If provided, remoteSearch will call this with the built queries and expect a list of raw row maps in return. Intended for unit tests.
final
serverTimeFunctionId → String?
final
toJson → Map<String, dynamic> Function(T)
final
updatedAtField → String
final

Methods

noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
toString() → String
A string representation of this object.
inherited

Operators

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