Namespace Couchbase.Lite

Classes

ArrayObject

A class representing a readonly ordered collection of objects

Blob

A class representing an arbitrary piece of binary data

Conflict

Conflict contains information of the conflicted documents, including local and remote document’s content. The null content means that the document is deleted.

ConflictResolver

ConflictResolver provides access to the default conflict resolver used by the replicator.

CouchbaseException

An exception representing one of the types of exceptions that can occur during Couchbase use

An exception that is thrown when a Fleece error is detected. Fleece is the library used to serialize and deserialize data. Any error of this type is not reactable by the user and so the error codes are not enumerated. This type of exception should be reported. This class has a domain type of Fleece

CouchbaseLiteException

An exception that is thrown when a CouchbaseLiteError is detected. This class will always have the CouchbaseLite domain set.

CouchbaseNetworkException

An exception that is thrown when there is an abnormal network condition detected. This exception has a domain of CouchbaseLite

CouchbasePosixException

An exception that is thrown when a POSIX error code is received during operation. This exception has a domain of POSIX. The Error values are dependent on the OS being run on. They are defined in PosixWindows, PosixMac and PosixLinux

CouchbaseSQLiteException

An exception used to indicate a SQLite operation error. The possible errors are enumerated as SQLiteStatus for convenience. This class has a domain type of SQLite

CouchbaseWebsocketException

An exception that is thrown when there is an abnormal websocket condition detected. This exception has a domain of CouchbaseLite.

Database

A Couchbase Lite database. This class is responsible for CRUD operations revolving around Document instances. It is portable between platforms if the file is retrieved, and can be seeded with pre-populated data if desired.

DatabaseChangedEventArgs

The parameters of a database changed event

DatabaseConfiguration

A struct containing configuration for creating or opening database data

DictionaryObject

A class representing a key-value collection that is read only

Document

A class representing a document which cannot be altered

DocumentChangedEventArgs

The arguments for the AddDocumentChangeListener(String, EventHandler<DocumentChangedEventArgs>) event

DocumentFragment

DocumentFragment provides access to a Document object. It also provides subscript access by key to the data values of the wrapped document.

EncryptionKey

Basic AES encryption. Uses a 256-bit (32-byte) key.

MutableArrayObject

A class representing an editable collection of objects

MutableDictionaryObject

A class representing a writeable string to object dictionary

MutableDocument

A class representing an entry in a Couchbase Lite Database.
It consists of some metadata, and a collection of user-defined properties

PosixBase

The base codes that are guaranteed to be the same on any POSIX system

PosixLinux

A class containing POSIX codes that are unique to the Linux kernel

PosixMac

A class containing POSIX codes that are unique to macOS

PosixWindows

POSIX codes that are specific to Windows

RuntimeException

An exception that is thrown in rare circumstances where the runtime returns an unexpected value for a method (usually null)

Structs

ListenerToken

A token that stores information about an event handler that is registered on a Couchbase Lite object (for example AddChangeListener(EventHandler<DatabaseChangedEventArgs>))

Interfaces

IArray

An interface representing a read-only linear collection of objects

IArrayFragment

An interface representing a readonly entry in a key path that is able to be indexed by position (e.g. object[0][1])

IConflictResolver

Conflict Resolver Interface

IDictionaryFragment

An interface representing a readonly entry in a key path that is able to be indexed by System.String (e.g. object["key1"]["key2"])

IDictionaryObject

An interface representing a readonly key-value collection with type-safe accessors

IFragment

An interface representing a readonly entry in a key-value path on an object.

IMutableArray

An interface representing a writable collection of objects

IMutableArrayFragment

An interface representing a writeable object capable of being indexed via System.Int32

IMutableDictionary

An interface representing a writeable key value collection

IMutableDictionaryFragment

An interface representing a writeable object capable of being indexed via System.String

IMutableFragment

An interface describing a mutable entry in a key-value path on an object. Note that if the key-value path does not exist, then setting the value will throw an exception.

Enums

ConcurrencyControl

Specifies the way that the library should behave when it encounters a situation when the database has been altered since the last read (e.g. a local operation read a document, modified it, and while it was being modified a replication committed a change to the document, and then the local document was saved after that)

CouchbaseLiteError

This set of error codes applies to CouchbaseLiteException, CouchbaseNetworkException and CouchbaseWebsocketException

CouchbaseLiteErrorType

These are the domains into which a CouchbaseException can fall. Each domain has one or more corresponding exception subclasses. You can trap a CouchbaseException and check its Domain to see which kind of subclass you should cast to, if desirable. Subclasses have a fixed domain.

MaintenanceType

Maintenance Type used when performing database maintenance .