Couchbase.Lite Namespace

Classes

	Class	Description
	Attachment	A Couchbase Lite Document Attachment.
	Body	A request/response/document body, stored as either JSON, IDictionary>String,Object>, or IList>object>
	CompressedContent	An HttpContent class that works with gzipped or zipped content
	CouchbaseLiteException	The main class of exception used for indicating Couchbase Lite errors
	Database	A Couchbase Lite Database.
	DatabaseChangeEventArgs	The event raised when a Database changes
	DatabaseOptions	Options for opening a database. All properties default to false or null.
	Document	A Couchbase Lite Document.
	DocumentDocumentChangeEventArgs	The type of event raised when a Document changes. This event is not raised in response to local Document changes.
	DocumentChange	Provides details about a Document change.
	GenericEqualityComparerT	A simple equality comparer that just calls default functions
	HttpResponseException	An exception for encapsulating HTTP errors
	LiveQuery	A Couchbase Lite View Query that automatically refreshes every time the Database changes in a way that would affect the results.
	Manager	The top-level object that manages Couchbase Lite Databases.
	ManagerOptions	Option flags for Manager initialization.
	NetworkReachabilityChangeEventArgs	Network reachability change event arguments.
	Query	A Couchbase Lite View Query.
	QueryChangeEventArgs	Query change event arguments.
	QueryCompletedEventArgs	Query completed event arguments.
	QueryEnumerator	An enumerator for Couchbase Lite View Query results.
	QueryOptions	Standard query options for views.
	QueryRow	A result row for a Couchbase Lite View Query.
	Replication	A Couchbase Lite pull or push Replication between a local and a remote Database.
	ReplicationChangeEventArgs
	ReplicationOptions	A class for specifying options applicable to replication
	ReplicationOptionsDictionary	Obsolete. A class for holding replication options
	Revision	A Couchbase Lite Document Revision.
	SavedRevision	A saved Couchbase Lite Document Revision.
	Status	A class for encapsulating a status code, and querying various information about it
	UnsavedRevision	An unsaved Couchbase Lite Document Revision.
	View	A Couchbase Lite View. A View defines a persistent index managed by map/reduce.

Structures

	Structure	Description
	AttachmentMetadataDictionaryKeys	Contains the keys associated with attachment metadata (i.e. entries in _attachments)
	JsonSerializationSettings	A struct containing options for JSON serialization and deserialization
	ReplicationOptionsDictionaryKeys	Obsolete. Contains the keys for a replication options dictionary
	StorageEngineTypes	Contains the identifiers for supported storage engines for Couchbase Lite

Interfaces

	Interface	Description
	IFilterCompiler	An interface for compiling filters on queries in languages other than C#
	IJsonSerializer	An interface describing a class that can serialize .NET objects to and from their JSON representation
	IValidationContext	Context passed to a ValidateDelegate.
	IViewCompiler	An object that can be used to compile source code into map and reduce delegates.

Delegates

	Delegate	Description
	DocumentUpdateDelegate	A delegate that can be used to update a Document.
	EmitDelegate	A delegate that can be invoked to add key/values to a View during a MapDelegate call.
	FilterDelegate	A delegate that can be used to include/exclude Revisions during push Replication.
	MapDelegate	A delegate that is invoked when a Document is being added to a View.
	PropertyTransformationDelegate	The signature of a method that transforms a set of properties
	ReduceDelegate	A delegate that can be invoked to summarize the results of a View.
	RunAsyncDelegate	A delegate that can be run asynchronously on a Database.
	RunInTransactionDelegate	A delegate that can be run in a transaction on a Database.
	TypedEventHandlerTSenderType, TArgType	An event handler that sends a typed sender instead of object
	ValidateChangeDelegate	A delegate that can validate a key/value change.
	ValidateDelegate	A delegate that can be used to accept/reject new Revisions being added to a Database.

Enumerations

Enumeration

Description

AllDocsMode

Options for specifying the mode that an all documents query should run in

DateTimeHandling

Specifies methods for deserializing date times that are written as strings

DocumentContentOptions

Options for what metadata to include in document bodies

IndexUpdateMode

Used to specify when a View index is updated when running a Query.

Name	Description
Before	If needed, update the index before running the Query (default). This guarantees up-to-date results at the expense of a potential delay in receiving results.
Never	Never update the index when running a Query. This guarantees receiving results the fastest at the expense of potentially out-of-date results.
After	If needed, update the index asynchronously after running the Query. This guarantees receiving results the fastest, at the expense of potentially out-of-date results, and that subsequent Queries will return more accurate results.

JsonToken

An enum representing the current Token being parsed in a JSON stream

NetworkReachabilityStatus

The current status of the network

ReplicationStatus

Describes the status of a Replication.

Name	Description
Stopped	The Replication is finished or hit a fatal error.
Offline	The remote host is currently unreachable.
Idle	The continuous Replication is caught up and waiting for more changes.
Active	The Replication is actively transferring data.

StatusCode

A list of statuses indicating various results and/or errors for Couchbase Lite operations

ViewCollation

Indicates the collation to use for sorted items in the view