observeLocal

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

Return

a DittoLiveQuery object that must be kept in scope for as long as you want to keep receiving updates.

Parameters

eventHandler

a closure that will be called every time there is a transaction committed to the store that involves a modification to the document with the relevant identifier in the collection that observeLocal was called on.


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.

Return

a DittoLiveQuery object that must be kept in scope for as long as you want to keep receiving updates.

Parameters

callback

an object that implements the DittoSingleDocumentLiveQueryCallback interface, whose update function will be called every time there is a transaction committed to the store that involves a modification to the document with the relevant identifier in the collection that observeLocal was called on.