Sync class final

An object that provides sync-related functionality of Ditto.

An instance of Sync can be obtained from Ditto.sync:

final ditto = await Ditto.open(/* ... */);
final sync = ditto.sync;

This class is not user-constructible.

Annotations
  • @external

Properties

hashCode int
The hash code for this object.
no setterinherited
runtimeType Type
A representation of the runtime type of the object.
no setterinherited
subscriptions Set<SyncSubscription>
All currently active sync subscriptions.
no setter

Methods

noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
registerSubscription(String query, {Map<String, dynamic> arguments = const {}}) SyncSubscription
Installs and returns a sync subscription for a query, configuring Ditto to receive updates from other peers for documents matching that query. The passed in query must be a SELECT query, otherwise an error is thrown.
toString() String
A string representation of this object.
inherited

Operators

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