couchbase-lite-ee/kotbase/CollectionConfiguration

CollectionConfiguration

expect class CollectionConfiguration(channels: List<String>? = null, documentIDs: List<String>? = null, pullFilter: ReplicationFilter? = null, pushFilter: ReplicationFilter? = null, conflictResolver: ConflictResolver? = null)(source)

The collection configuration that can be configured specifically for the replication.

actual class CollectionConfiguration : DelegatedClass<<Error class: unknown class>> (source)

actual class CollectionConfiguration(var channels: List<String>?, var documentIDs: List<String>?, var pullFilter: ReplicationFilter?, var pushFilter: ReplicationFilter?, var conflictResolver: ConflictResolver?)(source)

Constructors

CollectionConfiguration

expect constructor(channels: List<String>? = null, documentIDs: List<String>? = null, pullFilter: ReplicationFilter? = null, pushFilter: ReplicationFilter? = null, conflictResolver: ConflictResolver? = null)

actual constructor(channels: List<String>?, documentIDs: List<String>?, pullFilter: ReplicationFilter?, pushFilter: ReplicationFilter?, conflictResolver: ConflictResolver?)

Properties

channels

expect var channels: List<String>?

A collection of Sync Gateway channel names from which to pull Documents. If unset, all accessible channels will be pulled. Default is empty: pull from all accessible channels.

actual var channels: List<String>?

conflictResolver

expect var conflictResolver: ConflictResolver?

The conflict resolver.

actual var conflictResolver: ConflictResolver?

documentIDs

expect var documentIDs: List<String>?

A collection of document IDs to filter: if not null, only documents with these IDs will be pushed and/or pulled.

actual var documentIDs: List<String>?

pullFilter

expect var pullFilter: ReplicationFilter?

The filter used to determine whether a document will be pulled from the remote endpoint.

actual var pullFilter: ReplicationFilter?

pushFilter

expect var pushFilter: ReplicationFilter?

The filter used to determine whether a document will be pushed to the remote endpoint.

actual var pushFilter: ReplicationFilter?

Functions

equals

open operator override fun equals(other: Any?): Boolean

hashCode

open override fun hashCode(): Int

newConfig

fun CollectionConfiguration?.newConfig(channels: List<String>? = null, documentIDs: List<String>? = null, pullFilter: ReplicationFilter? = null, pushFilter: ReplicationFilter? = null, conflictResolver: ConflictResolver? = null): CollectionConfiguration

Create a CollectionConfiguration, overriding the receiver's values with the passed parameters:

setChannels

expect fun setChannels(channels: List<String>?): CollectionConfiguration

Sets a collection of Sync Gateway channel names from which to pull Documents. If unset, all accessible channels will be pulled. Default is empty: pull from all accessible channels.

actual fun setChannels(channels: List<String>?): CollectionConfiguration

setConflictResolver

expect fun setConflictResolver(conflictResolver: ConflictResolver?): CollectionConfiguration

Sets the conflict resolver.

actual fun setConflictResolver(conflictResolver: ConflictResolver?): CollectionConfiguration

setDocumentIDs

expect fun setDocumentIDs(documentIDs: List<String>?): CollectionConfiguration

Sets a collection of document IDs to filter by: if given, only documents with these IDs will be pushed and/or pulled.

actual fun setDocumentIDs(documentIDs: List<String>?): CollectionConfiguration

setPullFilter

expect fun setPullFilter(pullFilter: ReplicationFilter?): CollectionConfiguration

Sets a filter object for validating whether the documents can be pulled from the remote endpoint. Only documents for which the object returns true are replicated.

actual fun setPullFilter(pullFilter: ReplicationFilter?): CollectionConfiguration

setPushFilter

expect fun setPushFilter(pushFilter: ReplicationFilter?): CollectionConfiguration

Sets a filter object for validating whether the documents can be pushed to the remote endpoint.

actual fun setPushFilter(pushFilter: ReplicationFilter?): CollectionConfiguration

toString

open override fun toString(): String