couchbase-lite-ee/kotbase/Database/addDocumentChangeListener

addDocumentChangeListener

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

Deprecated

Use defaultCollection.addDocumentChangeListener()

Replace with

defaultCollection.addDocumentChangeListener(id, listener)
Content copied to clipboard

Adds a change listener for the changes that occur to the specified document, in the default collection.

The changes will be delivered on the main thread for platforms that support it: Android, iOS, and macOS. Callbacks are on an arbitrary thread for the JVM, Linux, and Windows platform.

Return

An opaque listener token object for removing the listener.

Parameters

id

document ID

listener

The listener to post changes.

See also

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

Deprecated

Use defaultCollection.addDocumentChangeListener()

Replace with

defaultCollection.addDocumentChangeListener(id, context, listener)
Content copied to clipboard

Adds a change listener for the changes that occur to the specified document, in the default collection, with a CoroutineContext that 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)

Deprecated

Use defaultCollection.addDocumentChangeListener()

Replace with

defaultCollection.addDocumentChangeListener(id, scope, listener)
Content copied to clipboard

Adds a change listener for the changes that occur to the specified document, in the default collection, with a CoroutineScope that 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)

Deprecated

Use defaultCollection.addDocumentChangeListener()

Replace with

defaultCollection.addDocumentChangeListener(id, listener)
Content copied to clipboard
actual fun addDocumentChangeListener(id: String, context: CoroutineContext, listener: DocumentChangeSuspendListener): ListenerToken(source)

Deprecated

Use defaultCollection.addDocumentChangeListener()

Replace with

defaultCollection.addDocumentChangeListener(id, context, listener)
Content copied to clipboard
actual fun addDocumentChangeListener(id: String, scope: CoroutineScope, listener: DocumentChangeSuspendListener)(source)

Deprecated

Use defaultCollection.addDocumentChangeListener()

Replace with

defaultCollection.addDocumentChangeListener(id, scope, listener)
Content copied to clipboard
actual fun addDocumentChangeListener(id: String, listener: DocumentChangeListener): ListenerToken(source)

Deprecated

Use defaultCollection.addDocumentChangeListener()

Replace with

defaultCollection.addDocumentChangeListener(id, listener)
Content copied to clipboard
actual fun addDocumentChangeListener(id: String, context: CoroutineContext, listener: DocumentChangeSuspendListener): ListenerToken(source)

Deprecated

Use defaultCollection.addDocumentChangeListener()

Replace with

defaultCollection.addDocumentChangeListener(id, context, listener)
Content copied to clipboard
actual fun addDocumentChangeListener(id: String, scope: CoroutineScope, listener: DocumentChangeSuspendListener)(source)

Deprecated

Use defaultCollection.addDocumentChangeListener()

Replace with

defaultCollection.addDocumentChangeListener(id, scope, listener)
Content copied to clipboard