A set of Sync Gateway channel names to pull from. Ignored for push replication. The default value is null, meaning that all accessible channels will be pulled. Note: channels that are not accessible to the user will be ignored by Sync Gateway.

actual var channels: List<String>?

conflictResolver

expect var conflictResolver: ConflictResolver?

Return the conflict resolver.

actual var conflictResolver: ConflictResolver?

database

expect val database: Database

Return the local database to replicate with the replication target.

actual val database: Database

documentIDs

expect var documentIDs: List<String>?

A set of document IDs to filter by: if not nil, 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

Return 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

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

actual var isContinuous: Boolean

maxAttempts

expect var maxAttempts: Int

Return the max number of retry attempts made after connection failure.

actual var maxAttempts: Int

maxAttemptWaitTime

expect var maxAttemptWaitTime: Int

Return the max time between retry attempts (exponential backoff).

actual var maxAttemptWaitTime: Int

pinnedServerCertificate

expect var pinnedServerCertificate: ByteArray?

Return the remote target's SSL certificate.

actual var pinnedServerCertificate: ByteArray?

pullFilter

expect var pullFilter: ReplicationFilter?

Gets a filter object for validating whether the documents can be pulled from the remote endpoint.

actual var pullFilter: ReplicationFilter?

pushFilter

expect var pushFilter: ReplicationFilter?

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

actual var pushFilter: ReplicationFilter?

target

expect val target: Endpoint

Return the replication target to replicate with.

actual val target: Endpoint

type

expect var type: ReplicatorType

Return Replicator type indicating the direction of the replicator.

actual var type: ReplicatorType

Functions

equals

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

hashCode

open override fun hashCode(): Int

newConfig

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:

setAcceptOnlySelfSignedServerCertificate

fun ReplicatorConfiguration.setAcceptOnlySelfSignedServerCertificate(acceptOnlySelfSignedServerCertificate: 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.

actual fun setAuthenticator(authenticator: Authenticator): ReplicatorConfiguration

setAutoPurgeEnabled

expect fun setAutoPurgeEnabled(enabled: Boolean): ReplicatorConfiguration

Enable/disable auto-purge.

actual fun setAutoPurgeEnabled(enabled: Boolean): ReplicatorConfiguration

setChannels

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

Sets a set of Sync Gateway channel names to pull from. Ignored for push replication. If unset, all accessible channels will be pulled. Note: channels that are not accessible to the user will be ignored by Sync Gateway.

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

setConflictResolver

expect fun setConflictResolver(conflictResolver: ConflictResolver?): ReplicatorConfiguration

Sets the 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 value is false, which means that the replicator will stop after it finishes replicating the changed documents.

actual fun setContinuous(continuous: Boolean): ReplicatorConfiguration

setDocumentIDs

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

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

setHeaders

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

Sets the extra HTTP headers to send in all requests to the remote target.

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

setHeartbeat

expect fun setHeartbeat(heartbeat: Int): ReplicatorConfiguration

Set the heartbeat interval, in seconds. Set to 0 for default values

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 0 for default values. Set to 1 for no retries.

actual fun setMaxAttempts(maxAttempts: Int): ReplicatorConfiguration

setMaxAttemptWaitTime

expect fun setMaxAttemptWaitTime(maxAttemptWaitTime: Int): ReplicatorConfiguration

Set the max time between retry attempts (exponential backoff). Set to 0 for default values.

actual fun setMaxAttemptWaitTime(maxAttemptWaitTime: Int): ReplicatorConfiguration

setPinnedServerCertificate

expect fun setPinnedServerCertificate(pinnedCert: ByteArray?): ReplicatorConfiguration

Sets the target server's SSL certificate.

actual fun setPinnedServerCertificate(pinnedCert: ByteArray?): 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.

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.

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 value is .pushAndPull which is bi-directional.

actual fun setType(type: ReplicatorType): ReplicatorConfiguration

toString

open override fun toString(): String