ditto/live.ditto/DittoPendingIdSpecificOperation

DittoPendingIdSpecificOperation

These objects are returned when using findById functionality on DittoCollections. You can either call exec on the object to get an immediate return value, or you can establish either a live query or a subscription, which both work over time. A live query, established by calling observeLocal, will notify you every time there's an update to the document with the identifier you provided in the preceding findById call. A subscription, established by calling subscribe, will act as a signal to other peers that you would like to receive updates from them about the document with the identifier you provided in the preceding findById call. Update and remove functionality is also exposed through this object.

Properties

collectionName

val collectionName: String

the name of the collection that the operation will be performed on.

docId

val docId: DittoDocumentId

the document identifier that the operation will be performed on.

Functions

evict

fun evict(): Boolean

Evict the document with the matching identifier.

exec

fun exec(): DittoDocument?

Execute the find operation to return the document with the matching identifier.

observeLocal

fun observeLocal(eventHandler: (DittoDocument?, DittoSingleDocumentLiveQueryEvent) -> Unit): DittoLiveQuery

fun observeLocal(callback: DittoSingleDocumentLiveQueryCallback): DittoLiveQuery

Enables you to listen for changes that occur in relation to a document. This won't subscribe to receive changes made remotely by others and so it will only fire updates when a local change is made. If you want to receive remotely performed updates as well then also call subscribe separately after another findById call that references the same document identifier. The returned DittoLiveQuery object must be kept in scope for as long as you want the provided eventHandler to be called when an update occurs.

observeLocalWithNextSignal

fun observeLocalWithNextSignal(eventHandler: (DittoDocument?, DittoSingleDocumentLiveQueryEvent, DittoSignalNext) -> Unit): DittoLiveQuery

fun observeLocalWithNextSignal(callback: DittoSingleDocumentLiveQueryWithNextSignalCallback): DittoLiveQuery

Enables you to listen for changes that occur in relation to a document, and to signal when you are ready for the live query to deliver the next event. This won't subscribe to receive changes made remotely by others and so it will only fire updates when a local change is made. If you want to receive remotely performed updates as well then call subscribe separately after another findById call that references the same document identifier. The returned DittoLiveQuery object must be kept in scope for as long as you want the provided eventHandler to be called when an update occurs.

remove

fun remove(): Boolean

Remove the document with the matching identifier.

fun subscribe(): DittoSubscription

Enables you to subscribe to changes that occur in relation to a document. Having a subscription acts as a signal to other peers that you are interested in receiving updates when local or remote changes are made to the relevant document. The returned DittoSubscription object must be kept in scope for as long as you want to keep receiving updates.

update

fun update(closure: (DittoMutableDocument?) -> Unit): List<DittoUpdateResult>

fun update(updater: DittoSingleMutableDocumentUpdater): List<DittoUpdateResult>

Update the document with the matching identifier.