Replication Class |
A Couchbase Lite pull or push Replication
between a local and a remote Database.
Inheritance HierarchyNamespace: Couchbase.Lite
Assembly: Couchbase.Lite (in Couchbase.Lite.dll) Version: 1.4.1-b107
SyntaxC#
public abstract class Replication
The Replication type exposes the following members.
Properties| Name | Description | |
|---|---|---|
 | ActiveTaskInfo |
Gets the active task info for thie replication
|
| Authenticator |
Gets or sets the authenticator.
|
| ChangesCount |
If the Replication is active, gets the number of changes to be processed, otherwise 0.
|
| Channels |
Gets or sets the list of Sync Gateway channel names to filter by for pull Replication.
|
| CompletedChangesCount |
If the Replication is active, gets the number of completed changes that have been processed, otherwise 0.
|
| Continuous |
Gets or sets whether the Replication operates continuously,
replicating changes as the source Database is modified.
|
| CreateTarget |
Gets or sets whether the target Database should be created
if it doesn't already exist. This only has an effect if the target supports it.
|
| DocIds |
Gets or sets the ids of the Documents to replicate.
|
| Filter |
Gets or sets the name of an optional filter function to run on the source
Database. Only documents for which the function
returns true are replicated.
|
| FilterParams |
Gets or sets the parameters to pass to the filter function.
|
| Headers |
Gets or sets the extra HTTP headers to send in Replication
requests to the remote Database.
|
| IsPull |
Gets whether the Replication pulls from,
as opposed to pushes to, the target.
|
| IsRunning |
Gets whether the Replication is running.
Continuous Replications never actually stop,
instead they go idle waiting for new data to appear.
|
| LastError |
Gets the last error, if any, that occurred since the Replication was started.
|
| LocalDatabase |
Gets the local Database being replicated to/from.
|
| Options | Obsolete.
Gets or sets custom options on this replication
|
| RemoteUrl |
Gets the remote URL being replicated to/from.
|
| ReplicationOptions |
Gets or sets the replication options.
|
| Status |
Gets the Replication's current status.
|
| TransformationFunction |
Gets or sets the transformation function used on the properties of the documents
being replicated
|
| Username |
If applicable, will store the username of the logged in user once
they are authenticated
|
Methods| Name | Description | |
|---|---|---|
 | ClearAuthenticationStores |
Deletes any persistent credentials (passwords, auth tokens...) associated with this
replication's Authenticator. Also removes session cookies from the cookie store.
|
| DeleteCookie |
Deletes a cookie specified by name
|
| GetPendingDocumentIDs |
Gets a collection of document IDs that have been scheduled for replication
but not yet completed.
|
| IsDocumentPending |
Checks if the specified document is pending replication
|
| Restart |
Restarts the Replication.
|
| SetCookie | Sets an HTTP cookie for the Replication. |
| Start |
Starts the Replication.
|
| Stop |
Stops the Replication.
|
Events| Name | Description | |
|---|---|---|
 | Changed |
Adds or Removed a Database change delegate
that will be called whenever the Replication
changes.
|
Fields| Name | Description | |
|---|---|---|
  | SYNC_PROTOCOL_VERSION | Obsolete.
The protocol version to use when syncing with Sync Gateway.
This value is also included in all HTTP requests as the
User-Agent version.
|
| SyncProtocolVersion |
The protocol version to use when syncing with Sync Gateway.
This value is also included in all HTTP requests as the
User-Agent version.
|
See Also