Gets the 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>?

collections

expect val collections: Set<Collection>

The list of collections in the replicator configuration

actual val collections: Set<Collection>

conflictResolver

expect var ~~conflictResolver~~: ConflictResolver?

The conflict resolver.

actual var ~~conflictResolver~~: ConflictResolver?

database

expect val ~~database~~: Database

The local database to replicate with the replication target.

actual val ~~database~~: Database

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>?

headers

expect var headers: Map<String, String>?

Return Extra HTTP headers to send in all requests to the remote target.

actual var headers: Map<String, String>?

heartbeat

expect var heartbeat: Int

The heartbeat interval, in seconds.

actual var heartbeat: Int

isAcceptOnlySelfSignedServerCertificate

expect var ReplicatorConfiguration.isAcceptOnlySelfSignedServerCertificate: Boolean

ENTERPRISE EDITION API

actual var ReplicatorConfiguration.isAcceptOnlySelfSignedServerCertificate: Boolean

isAcceptParentDomainCookies

expect var isAcceptParentDomainCookies: Boolean

The option to remove a restriction that does not allow a replicator to accept cookies from a remote host unless the cookie domain exactly matches the domain of the sender. For instance, when the option is set to false (the default), and the remote host, “bar.foo.com”, sends a cookie for the domain “.foo.com”, the replicator will reject it. If the option is set true, however, the replicator will accept it. This is, in general, dangerous: a host might, for instance, set a cookie for the domain ".com". It is safe only when the replicator is connecting only to known hosts. The default value of this option is false: parent-domain cookies are not accepted

actual var isAcceptParentDomainCookies: Boolean

isAutoPurgeEnabled

expect var isAutoPurgeEnabled: Boolean

Enable/disable auto-purge. Default is enabled.

actual var isAutoPurgeEnabled: Boolean

isContinuous

expect var isContinuous: Boolean

The continuous flag indicating whether the replicator should stay active indefinitely to replicate changed documents.

actual var isContinuous: Boolean

maxAttempts

expect var maxAttempts: Int

The max number of retry attempts made after connection failure. This method will return 0 when implicitly using the default: 10 total connection attempts (the initial attempt and up to 9 retries) for a one-shot replicator and a very, very large number of retries, for a continuous replicator.

actual var maxAttempts: Int

maxAttemptWaitTime

expect var maxAttemptWaitTime: Int

The max time between retry attempts (exponential backoff).

actual var maxAttemptWaitTime: Int

pinnedServerCertificate

expect var pinnedServerCertificate: ByteArray?

The remote target's SSL certificate.

actual var pinnedServerCertificate: ByteArray?

pinnedServerSecCertificate

var ReplicatorConfiguration.pinnedServerSecCertificate: SecCertificateRef?

The remote target’s SSL certificate.

pinnedServerX509Certificate

var ReplicatorConfiguration.pinnedServerX509Certificate: <Error class: unknown class>?

The remote target's SSL certificate.

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?

target

expect val target: Endpoint

The replication target to replicate with.

actual val target: Endpoint

type

expect var type: ReplicatorType

Replicator type indicating the direction of the replicator.

actual var type: ReplicatorType

Functions

addCollection

expect fun addCollection(collection: Collection, config: CollectionConfiguration?): ReplicatorConfiguration

Add a collection used for the replication with an optional collection configuration. If the collection has been added before, the previously added collection and its configuration if specified will be replaced.

actual fun addCollection(collection: Collection, config: CollectionConfiguration?): ReplicatorConfiguration

addCollections

expect fun addCollections(collections: Collection<Collection>, config: CollectionConfiguration?): ReplicatorConfiguration

Add multiple collections used for the replication with an optional shared collection configuration. If any of the collections have been added before, the previously added collections and their configuration if specified will be replaced. Adding an empty collection array is a no-op.

actual fun addCollections(collections: Collection<Collection>, config: CollectionConfiguration?): ReplicatorConfiguration

equals

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

getCollectionConfiguration

expect fun getCollectionConfiguration(collection: Collection): CollectionConfiguration?

Get the CollectionConfiguration for the passed Collection.

actual fun getCollectionConfiguration(collection: Collection): CollectionConfiguration?

hashCode

open override fun hashCode(): Int

newConfig

fun ReplicatorConfiguration?.newConfig(target: Endpoint? = null, collections: Map<out Collection<Collection>, CollectionConfiguration?>? = null, type: ReplicatorType? = null, continuous: Boolean? = null, authenticator: Authenticator? = null, headers: Map<String, String>? = null, pinnedServerCertificate: ByteArray? = null, maxAttempts: Int? = null, maxAttemptWaitTime: Int? = null, heartbeat: Int? = null, enableAutoPurge: Boolean? = null, acceptParentDomainCookies: Boolean? = null): ReplicatorConfiguration

Create a ReplicatorConfiguration, overriding the receiver's values with the passed parameters.

fun ReplicatorConfiguration?.newConfig(target: Endpoint? = null, collections: Map<out Collection<Collection>, CollectionConfiguration?>? = null, type: ReplicatorType? = null, continuous: Boolean? = null, authenticator: Authenticator? = null, headers: Map<String, String>? = null, pinnedServerCertificate: ByteArray? = null, maxAttempts: Int? = null, maxAttemptWaitTime: Int? = null, heartbeat: Int? = null, enableAutoPurge: Boolean? = null, acceptOnlySelfSignedServerCertificate: Boolean? = null, acceptParentDomainCookies: Boolean? = null): ReplicatorConfiguration

fun ReplicatorConfiguration?.~~newConfig~~(database: Database? = null, target: Endpoint? = null, type: ReplicatorType? = null, continuous: Boolean? = null, authenticator: Authenticator? = null, headers: Map<String, String>? = null, pinnedServerCertificate: ByteArray? = null, channels: List<String>? = null, documentIDs: List<String>? = null, pushFilter: ReplicationFilter? = null, pullFilter: ReplicationFilter? = null, conflictResolver: ConflictResolver? = null, maxAttempts: Int? = null, maxAttemptWaitTime: Int? = null, heartbeat: Int? = null, enableAutoPurge: Boolean? = null, acceptParentDomainCookies: Boolean? = null): ReplicatorConfiguration

fun ReplicatorConfiguration?.~~newConfig~~(database: Database? = null, target: Endpoint? = null, type: ReplicatorType? = null, continuous: Boolean? = null, authenticator: Authenticator? = null, headers: Map<String, String>? = null, pinnedServerCertificate: ByteArray? = null, channels: List<String>? = null, documentIDs: List<String>? = null, pushFilter: ReplicationFilter? = null, pullFilter: ReplicationFilter? = null, conflictResolver: ConflictResolver? = null, maxAttempts: Int? = null, maxAttemptWaitTime: Int? = null, heartbeat: Int? = null, enableAutoPurge: Boolean? = null, acceptOnlySelfSignedServerCertificate: Boolean? = null, acceptParentDomainCookies: Boolean? = null): ReplicatorConfiguration

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

removeCollection

expect fun removeCollection(collection: Collection): ReplicatorConfiguration

Remove a collection from the replication.

actual fun removeCollection(collection: Collection): ReplicatorConfiguration

setAcceptOnlySelfSignedServerCertificate

fun ReplicatorConfiguration.setAcceptOnlySelfSignedServerCertificate(selfSignedOnly: Boolean): ReplicatorConfiguration

ENTERPRISE EDITION API

setAcceptParentDomainCookies

expect fun setAcceptParentDomainCookies(acceptParentCookies: Boolean): ReplicatorConfiguration

actual fun setAcceptParentDomainCookies(acceptParentCookies: Boolean): ReplicatorConfiguration

setAuthenticator

expect fun setAuthenticator(authenticator: Authenticator?): ReplicatorConfiguration

Sets the authenticator to authenticate with a remote target server. Currently, there are two types of the authenticators, BasicAuthenticator and SessionAuthenticator, supported. The default is no authenticator.

actual fun setAuthenticator(authenticator: Authenticator?): ReplicatorConfiguration

setAutoPurgeEnabled

expect fun setAutoPurgeEnabled(enabled: Boolean): ReplicatorConfiguration

Enable/disable auto-purge. The default is auto-purge enabled.

actual fun setAutoPurgeEnabled(enabled: Boolean): ReplicatorConfiguration

setChannels

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

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>?): ReplicatorConfiguration

setConflictResolver

expect fun ~~setConflictResolver~~(conflictResolver: ConflictResolver?): ReplicatorConfiguration

Sets the conflict resolver. Default is ReplicatorConfiguration.DEFAULT_CONFLICT_RESOLVER

actual fun ~~setConflictResolver~~(conflictResolver: ConflictResolver?): ReplicatorConfiguration

setContinuous

expect fun setContinuous(continuous: Boolean): ReplicatorConfiguration

Sets whether the replicator stays active indefinitely to replicate changed documents. The default is false: the replicator will stop after it finishes replicating changed documents.

actual fun setContinuous(continuous: Boolean): ReplicatorConfiguration

setDocumentIDs

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

A collection of document IDs identifying documents to be replicated. If non-empty, only documents with IDs in this collection will be pushed and/or pulled. Default is empty: do not filter documents.

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

setHeaders

expect fun setHeaders(headers: Map<String, String>?): ReplicatorConfiguration

Sets the extra HTTP headers to send in all requests to the remote target. The default is no extra headers.

actual fun setHeaders(headers: Map<String, String>?): ReplicatorConfiguration

setHeartbeat

expect fun setHeartbeat(heartbeat: Int): ReplicatorConfiguration

Set the heartbeat interval, in seconds. The default is 5 minutes (300 seconds). Setting the parameter to 0 will restore the default.

actual fun setHeartbeat(heartbeat: Int): ReplicatorConfiguration

setMaxAttempts

expect fun setMaxAttempts(maxAttempts: Int): ReplicatorConfiguration

Set the max number of retry attempts made after a connection failure. Set to 1 for no retries and to 0 to restore default behavior. The default is 10 total connection attempts (the initial attempt and up to 9 retries) for a one-shot replicator and a very, very large number of retries, for a continuous replicator.

actual fun setMaxAttempts(maxAttempts: Int): ReplicatorConfiguration

setMaxAttemptWaitTime

expect fun setMaxAttemptWaitTime(maxAttemptWaitTime: Int): ReplicatorConfiguration

Set the max time between retry attempts, in seconds. Time between retries is initially small but backs off exponentially up to this limit. Once the limit is reached the interval between subsequent attempts will be the value set here, until max-attempts attempts have been made. The minimum value legal value is 1 second. The default is 5 minutes (300 seconds). Setting the parameter to 0 will restore the default.

actual fun setMaxAttemptWaitTime(maxAttemptWaitTime: Int): ReplicatorConfiguration

setPinnedServerCertificate

expect fun setPinnedServerCertificate(pinnedCert: ByteArray?): ReplicatorConfiguration

Sets the certificate used to authenticate the target server. A server will be authenticated if it presents a chain of certificates (possibly of length 1) in which any one of the certificates matches the one passed here. The default is no pinned certificate.

actual fun setPinnedServerCertificate(pinnedCert: ByteArray?): ReplicatorConfiguration

setPinnedServerSecCertificate

fun ReplicatorConfiguration.setPinnedServerSecCertificate(pinnedCert: SecCertificateRef?): ReplicatorConfiguration

setPinnedServerX509Certificate

fun ReplicatorConfiguration.setPinnedServerX509Certificate(pinnedCert: <Error class: unknown class>?): ReplicatorConfiguration

setPullFilter

expect fun ~~setPullFilter~~(pullFilter: ReplicationFilter?): ReplicatorConfiguration

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. Default is no filter.

actual fun ~~setPullFilter~~(pullFilter: ReplicationFilter?): ReplicatorConfiguration

setPushFilter

expect fun ~~setPushFilter~~(pushFilter: ReplicationFilter?): ReplicatorConfiguration

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

actual fun ~~setPushFilter~~(pushFilter: ReplicationFilter?): ReplicatorConfiguration

setType

expect fun setType(type: ReplicatorType): ReplicatorConfiguration

Sets the replicator type indicating the direction of the replicator. The default is ReplicatorType.PUSH_AND_PULL: bi-directional replication.

actual fun setType(type: ReplicatorType): ReplicatorConfiguration

toString

open override fun toString(): String