ditto / live.ditto / DittoPendingIDSpecificOperation / observe

observe

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

Enables you to listen for changes that occur in relation to a document. The eventHandler closure will be called when local or remote changes are made to the document referenced by the findByID call that precedes the call to observe. 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.

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 ID in the collection that observe was called on.

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

fun observe(callback: DittoSingleDocumentLiveQueryCallback): DittoLiveQuery

Enables you to listen for changes that occur in relation to a document. The callback parameter will be called when local or remote changes are made to the document referenced by the findByID call that precedes the call to observe. 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.

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 ID in the collection that observe was called on.

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