Class DittoSync

java.lang.Object

com.ditto.java.DittoSync

public final class DittoSync
extends Object

Provides access to sync-related functionality of Ditto.

Method Summary

Modifier and Type	Method	Description
@NonNull Set<? extends DittoSyncSubscription>	getSubscriptions()	Returns all currently active sync subscriptions.
@NonNull DittoSyncSubscription	registerSubscription(@NonNull String query)	Installs and returns a sync subscription for a query, configuring Ditto to receive updates from other peers for documents matching that query.
@NonNull DittoSyncSubscription	registerSubscription(@NonNull String query, @Nullable DittoCborSerializable.Dictionary arguments)	Installs and returns a sync subscription for a query, configuring Ditto to receive updates from other peers for documents matching that query.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Details

getSubscriptions

public @NonNull Set<? extends DittoSyncSubscription> getSubscriptions()

Returns all currently active sync subscriptions.

Returns:

a Set of active DittoSyncSubscription instances.

registerSubscription

public @NonNull DittoSyncSubscription registerSubscription(@NonNull String query)
                                                    throws DittoException

Installs and returns a sync subscription for a query, configuring Ditto to receive updates from other peers for documents matching that query. The given query must be a SELECT query, otherwise a DittoException.StoreException with store error reason DittoException.StoreExceptionReason.QueryNotSupported is thrown.

Parameters:

query - a string containing a valid query expressed in DQL.

Returns:

an active DittoSyncSubscription for the given query that can be used to close the subscription. Otherwise, the subscription will remain active until the owning Ditto instance goes out of scope.

Throws:

DittoException - if there is a problem creating or registering the subscription.

See Also:

• registerSubscription(String, DittoCborSerializable.Dictionary)

registerSubscription

public @NonNull DittoSyncSubscription registerSubscription(@NonNull String query,
 @Nullable DittoCborSerializable.Dictionary arguments)
                                                    throws DittoException

Installs and returns a sync subscription for a query, configuring Ditto to receive updates from other peers for documents matching that query. The given query must be a SELECT query, otherwise a DittoException.StoreException with store error reason DittoException.StoreExceptionReason.QueryNotSupported is thrown.

Parameters:

query - a string containing a valid query expressed in DQL.

arguments - an optional dictionary of values keyed by the placeholder name without the leading :. Example: ["mileage": 123].

Returns:

an active DittoSyncSubscription for the given query that can be used to close the subscription. Otherwise, the subscription will remain active until the owning Ditto instance goes out of scope.

Throws:

DittoException - if there is a problem creating or registering the subscription.

See Also:

• registerSubscription(String)