ditto/live.ditto/DittoSyncSubscription

DittoSyncSubscription

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

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

Since

4.5.0

Types

Companion

object Companion

Properties

isClosed

var isClosed: Boolean

true when if the DittoSyncSubscription has been closed (i.e. removed from its store. Also, a sync subscription is considered closed if the owning Ditto instance goes out of scope.

queryArguments

@JvmField

val queryArguments: Map<String, Any?>? = null

Arguments for the queryString.

queryString

@JvmField

val queryString: String

Documents matching this query will be included in the subscription.

Functions

open override fun close()

Closes the sync subscription so that new changes matching the query are no longer received from other peers. No-op if it's already closed via a previous call or the owning Ditto instance has gone out of scope.