couchbase-lite-ee/kotbase/Collection/addDocumentChangeListener

addDocumentChangeListener

expect fun addDocumentChangeListener(id: String, listener: DocumentChangeListener): ListenerToken(source)

Add a change listener to listen to change events occurring to a document of the given document id. To remove the listener, call remove() function on the returned listener token.

Parameters

id

document ID

listener

The listener to post changes.

See also

expect fun addDocumentChangeListener(id: String, context: CoroutineContext, listener: DocumentChangeSuspendListener): ListenerToken(source)

Add a change listener to listen to change events occurring to a document of the given document id.

The CoroutineContext will be used to launch coroutines the listener will be called on. Coroutines will be launched in a CoroutineScope that is canceled when the listener is removed.

Return

An opaque listener token object for removing the listener.

Parameters

id

document ID

context

coroutine context in which the listener will run

listener

The listener to post changes.

See also

expect fun addDocumentChangeListener(id: String, scope: CoroutineScope, listener: DocumentChangeSuspendListener)(source)

Add a change listener to listen to change events occurring to a document of the given document id.

The CoroutineScope will be used to launch coroutines the listener will be called on. The listener is removed when the scope is canceled.

Parameters

id

document ID

scope

coroutine scope in which the listener will run

listener

callback

actual fun addDocumentChangeListener(id: String, listener: DocumentChangeListener): ListenerToken(source)
actual fun addDocumentChangeListener(id: String, context: CoroutineContext, listener: DocumentChangeSuspendListener): ListenerToken(source)
actual fun addDocumentChangeListener(id: String, scope: CoroutineScope, listener: DocumentChangeSuspendListener)(source)
actual fun addDocumentChangeListener(id: String, listener: DocumentChangeListener): ListenerToken(source)
actual fun addDocumentChangeListener(id: String, context: CoroutineContext, listener: DocumentChangeSuspendListener): ListenerToken(source)
actual fun addDocumentChangeListener(id: String, scope: CoroutineScope, listener: DocumentChangeSuspendListener)(source)