couchbase-lite-ee/kotbase/CollectionConfiguration

CollectionConfiguration

actual class CollectionConfiguration(    channels: List<String>?,     documentIDs: List<String>?,     pullFilter: ReplicationFilter?,     pushFilter: ReplicationFilter?,     conflictResolver: ConflictResolver?) : DelegatedClass<CBLCollectionConfiguration> (source)
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

Link copied to clipboard
actual constructor(    channels: List<String>?,     documentIDs: List<String>?,     pullFilter: ReplicationFilter?,     pushFilter: ReplicationFilter?,     conflictResolver: ConflictResolver?)
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?)
actual constructor(    channels: List<String>?,     documentIDs: List<String>?,     pullFilter: ReplicationFilter?,     pushFilter: ReplicationFilter?,     conflictResolver: ConflictResolver?)

Properties

Link copied to clipboard
actual var channels: List<String>?
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>?
actual var channels: List<String>?
Link copied to clipboard
actual var conflictResolver: ConflictResolver?
expect var conflictResolver: ConflictResolver?

The conflict resolver.

actual var conflictResolver: ConflictResolver?
actual var conflictResolver: ConflictResolver?
Link copied to clipboard
actual var documentIDs: List<String>?
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>?
actual var documentIDs: List<String>?
Link copied to clipboard
actual var pullFilter: ReplicationFilter?
expect var pullFilter: ReplicationFilter?

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

actual var pullFilter: ReplicationFilter?
actual var pullFilter: ReplicationFilter?
Link copied to clipboard
actual var pushFilter: ReplicationFilter?
expect var pushFilter: ReplicationFilter?

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

actual var pushFilter: ReplicationFilter?
actual var pushFilter: ReplicationFilter?

Functions

Link copied to clipboard
open operator override fun equals(other: Any?): Boolean
open operator override fun equals(other: Any?): Boolean
Link copied to clipboard
open override fun hashCode(): Int
open override fun hashCode(): Int
Link copied to clipboard
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:

Link copied to clipboard
actual fun setChannels(channels: List<String>?): CollectionConfiguration
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
actual fun setChannels(channels: List<String>?): CollectionConfiguration
Link copied to clipboard
actual fun setConflictResolver(conflictResolver: ConflictResolver?): CollectionConfiguration
expect fun setConflictResolver(conflictResolver: ConflictResolver?): CollectionConfiguration

Sets the conflict resolver.

actual fun setConflictResolver(conflictResolver: ConflictResolver?): CollectionConfiguration
actual fun setConflictResolver(conflictResolver: ConflictResolver?): CollectionConfiguration
Link copied to clipboard
actual fun setDocumentIDs(documentIDs: List<String>?): CollectionConfiguration
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
actual fun setDocumentIDs(documentIDs: List<String>?): CollectionConfiguration
Link copied to clipboard
actual fun setPullFilter(pullFilter: ReplicationFilter?): CollectionConfiguration
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
actual fun setPullFilter(pullFilter: ReplicationFilter?): CollectionConfiguration
Link copied to clipboard
actual fun setPushFilter(pushFilter: ReplicationFilter?): CollectionConfiguration
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
actual fun setPushFilter(pushFilter: ReplicationFilter?): CollectionConfiguration
Link copied to clipboard
open override fun toString(): String
open override fun toString(): String