Class ReplicatorConfiguration
A class representing configuration options for a Replicator
Inheritance
Inherited Members
Namespace: Couchbase.Lite.Sync
Assembly: Couchbase.Lite.dll
Syntax
public sealed class ReplicatorConfiguration
Constructors
| Improve this Doc View SourceReplicatorConfiguration(Database, IEndpoint)
Constructs a new builder object with the required properties
Declaration
public ReplicatorConfiguration(Database database, IEndpoint target)
Parameters
Type | Name | Description |
---|---|---|
Database | database | The database that will serve as the local side of the replication |
IEndpoint | target | The endpoint to replicate to, either local or remote |
Exceptions
Type | Condition |
---|---|
System.ArgumentException | Thrown if an unsupported IEndpoint implementation
is provided as |
Properties
| Improve this Doc View SourceAcceptOnlySelfSignedServerCertificate
Get or set the way that the replicator will validate TLS certificates. This property will be overriden if the PinnedServerCertificate property is set.
Declaration
public bool AcceptOnlySelfSignedServerCertificate { get; set; }
Property Value
Type | Description |
---|---|
System.Boolean |
Authenticator
Gets or sets the class which will authenticate the replication
Declaration
public Authenticator Authenticator { get; set; }
Property Value
Type | Description |
---|---|
Authenticator |
Channels
A set of Sync Gateway channel names to pull from. Ignored for push replicatoin. 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.
Declaration
public IList<string> Channels { get; set; }
Property Value
Type | Description |
---|---|
System.Collections.Generic.IList<System.String> |
ConflictResolver
The implemented custom conflict resolver object can be registered to the replicator at ConflictResolver property. The default value of the conflictResolver is null. When the value is null, the default conflict resolution will be applied.
Declaration
public IConflictResolver ConflictResolver { get; set; }
Property Value
Type | Description |
---|---|
IConflictResolver |
Continuous
Gets or sets whether or not the Replicator should stay
active indefinitely. The default is false
Declaration
public bool Continuous { get; set; }
Property Value
Type | Description |
---|---|
System.Boolean |
Database
Gets the local database participating in the replication.
Declaration
public Database Database { get; }
Property Value
Type | Description |
---|---|
Database |
DocumentIDs
A set of document IDs to filter by. If not null, only documents with these IDs will be pushed and/or pulled
Declaration
public IList<string> DocumentIDs { get; set; }
Property Value
Type | Description |
---|---|
System.Collections.Generic.IList<System.String> |
Headers
Extra HTTP headers to send in all requests to the remote target
Declaration
public IDictionary<string, string> Headers { get; set; }
Property Value
Type | Description |
---|---|
System.Collections.Generic.IDictionary<System.String, System.String> |
Heartbeat
Gets or sets the replicator heartbeat keep-alive interval.
Declaration
public TimeSpan Heartbeat { get; set; }
Property Value
Type | Description |
---|---|
System.TimeSpan |
PinnedServerCertificate
Gets or sets a certificate to trust. All other certificates received by a Replicator with this configuration will be rejected.
Declaration
public X509Certificate2 PinnedServerCertificate { get; set; }
Property Value
Type | Description |
---|---|
System.Security.Cryptography.X509Certificates.X509Certificate2 |
PullFilter
Func delegate that takes Document input parameter and bool output parameter Document pull will be allowed if output is true, othewise, Document pull will not be allowed
Declaration
public Func<Document, DocumentFlags, bool> PullFilter { get; set; }
Property Value
Type | Description |
---|---|
System.Func<Document, DocumentFlags, System.Boolean> |
PushFilter
Func delegate that takes Document input parameter and bool output parameter Document push will be allowed if output is true, othewise, Document push will not be allowed
Declaration
public Func<Document, DocumentFlags, bool> PushFilter { get; set; }
Property Value
Type | Description |
---|---|
System.Func<Document, DocumentFlags, System.Boolean> |
ReplicatorType
A value indicating the direction of the replication. The default is PushAndPull which is bidirectional
Declaration
public ReplicatorType ReplicatorType { get; set; }
Property Value
Type | Description |
---|---|
ReplicatorType |
Target
Gets the target to replicate with (either Database or System.Uri
Declaration
public IEndpoint Target { get; }
Property Value
Type | Description |
---|---|
IEndpoint |