Class CollectionConfiguration

A configuration object for setting the details of how to treat a collection when used inside of a Replicator

Inheritance

System.Object

CollectionConfiguration

Inherited Members

System.Object.Equals(System.Object)

System.Object.Equals(System.Object, System.Object)

System.Object.GetHashCode()

System.Object.GetType()

System.Object.MemberwiseClone()

System.Object.ReferenceEquals(System.Object, System.Object)

System.Object.ToString()

Namespace: Couchbase.Lite.Sync

Assembly: Couchbase.Lite.dll

Syntax

public sealed class CollectionConfiguration

Constructors

CollectionConfiguration()

The default constructor

Declaration

public CollectionConfiguration()

Properties

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. Zero length lists are not allowed, and will be replaced with null 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>

Remarks

Note: Channels property is only applicable in the replications with Sync Gateway.

ConflictResolver

The implemented custom conflict resolver object can be registered to the replicator at ConflictResolver property. When the value is null, the default conflict resolution will be applied. The default value is Default.

Declaration

public IConflictResolver ConflictResolver { get; set; }

Property Value

Type	Description
IConflictResolver

DocumentIDs

A set of document IDs to filter by. If not null, only documents with these IDs will be pushed and/or pulled. Zero length lists are not allowed, and will be replaced with null

Declaration

public IList<string> DocumentIDs { get; set; }

Property Value

Type	Description
System.Collections.Generic.IList<System.String>

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>