Click or drag to resize

Couchbase.Lite Namespace

 
Classes
  ClassDescription
Public classArrayObject
A class representing a readonly ordered collection of objects
Public classBlob
A class representing an arbitrary piece of binary data
Public classCouchbaseException
An exception representing one of the types of exceptions that can occur during Couchbase use
Public classCouchbaseFleeceException
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
Public classCouchbaseLiteException
An exception that is thrown when a CouchbaseLiteError is detected. This class will always have the CouchbaseLite domain set.
Public classCouchbaseNetworkException
An exception that is thrown when there is an abnormal network condition detected. This exception has a domain of CouchbaseLite
Public classCouchbasePosixException
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
Public classCouchbaseSQLiteException
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
Public classCouchbaseWebsocketException
An exception that is thrown when there is an abnormal websocket condition detected. This exception has a domain of CouchbaseLite.
Public classDatabase
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 prepopulated data if desired.
Public classDatabaseChangedEventArgs
The parameters of a database changed event
Public classDatabaseConfiguration
A struct containing configuration for creating or opening database data
Public classDictionaryObject
A class representing a key-value collection that is read only
Public classDocument
A class representing a document which cannot be altered
Public classDocumentChangedEventArgs
Public classDocumentFragment
DocumentFragment provides access to a Document object. It also provides subscript access by key to the data values of the wrapped document.
Public classMutableArrayObject
A class representing an editable collection of objects
Public classMutableDictionaryObject
A class representing a writeable string to object dictionary
Public classMutableDocument
A class representing an entry in a Couchbase Lite Database. It consists of some metadata, and a collection of user-defined properties
Public classPosixBase
The base codes that are guaranteed to be the same on any POSIX system
Public classPosixLinux
Public classPosixMac
Public classPosixWindows
Public classRuntimeException
An exception that is thrown in rare circumstances where the runtime returns an unexpected value for a method (usually null)
Structures
Interfaces
  InterfaceDescription
Public interfaceIArray
An interface representing a read-only linear collection of objects
Public interfaceIArrayFragment
An interface representing a readonly entry in a key path that is able to be indexed by position (e.g. object[0][1])
Public interfaceIDictionaryFragment
An interface representing a readonly entry in a key path that is able to be indexed by String (e.g. object["key1"]["key2"])
Public interfaceIDictionaryObject
An interface representing a readonly key-value collection with type-safe accessors
Public interfaceIFragment
An interface representing a readonly entry in a key-value path on an object.
Public interfaceIMutableArray
An interface representing a writeable collection of objects
Public interfaceIMutableArrayFragment
An interface representing a writeable object capable of being indexed via Int32
Public interfaceIMutableDictionary
An interface representing a writeable key value collection
Public interfaceIMutableDictionaryFragment
An interface representing a writeable object capable of being indexed via String
Public interfaceIMutableFragment
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.
Enumerations
  EnumerationDescription
Public enumerationConcurrencyControl
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)
Public enumerationCouchbaseLiteError
Public enumerationCouchbaseLiteErrorType
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.