DittoPendingIDSpecificOperation

class 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 observe, will notify you every time there's an update to the document with the ID 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 ID you provided in the preceding findByID call. Calling observe will generate both a subscription and a live query at the same time. If you'd like to only observe local changes then you can call observeLocal. Update and remove functionality is also exposed through this object.

Functions

evict

fun evict(): Boolean

Evict the document with the matching ID.

exec

fun exec(): DittoDocument?

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

observe

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

Enables you to listen for changes that occur in relation to a document.

fun observe(callback: DittoSingleDocumentLiveQueryCallback): DittoLiveQuery

Enables you to listen for changes that occur in relation to a document.

observeLocal

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

Enables you to listen for changes that occur in relation to a document.

fun observeLocal(callback: DittoSingleDocumentLiveQueryCallback): DittoLiveQuery

Enables you to listen for changes that occur in relation to a document.

observeLocalWithNextSignal

fun observeLocalWithNextSignal(eventHandler: (DittoDocument?, DittoSingleDocumentLiveQueryEvent, DittoSignalNext) -> Unit): 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.

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.

observeWithNextSignal

fun observeWithNextSignal(eventHandler: (DittoDocument?, DittoSingleDocumentLiveQueryEvent, DittoSignalNext) -> Unit): 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.

fun observeWithNextSignal(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.

remove

fun remove(): Boolean

Remove the document with the matching ID.

fun subscribe(): DittoSubscription

Enables you to subscribe to changes that occur in relation to a document.

update

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

Update the document with the matching ID.

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

Update the document with the matching ID.

Properties

collectionName

val collectionName: String

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

docID

val docID: DittoDocumentID

the ID of the document that the operation will be performed on.