ditto-kotlin/com.ditto.kotlin/DittoSyncSubscription

DittoSyncSubscription

class DittoSyncSubscription : DittoResource

A sync subscription configures Ditto to receive updates from remote peers about documents matching the subscription's query.

Create a sync subscription by calling DittoSync.registerSubscription. The subscription will remain active until either explicitly canceled via close or the owning Ditto instance goes out of scope.

Properties

isClosed

val isClosed: Boolean

Convenience property, returns true if the sync subscription has been canceled, otherwise returns false. Also, a sync subscription is considered canceled if the owning Ditto instance goes out of scope.

queryArguments

val queryArguments: DittoCborSerializable.Dictionary?

The query arguments of the sync subscription (as passed while registering it).

queryString

val queryString: String

Documents matching this query will be included in the subscription.

Functions

open override fun close()