Document Class

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

Inheritance Hierarchy

SystemObject
  Couchbase.LiteReadOnlyDictionary
    Couchbase.LiteReadOnlyDocument
      Couchbase.LiteDocument

Namespace: Couchbase.Lite
Assembly: Couchbase.Lite (in Couchbase.Lite.dll) Version: 2.0.0-b0364

Syntax

Copy

public sealed class Document : ReadOnlyDocument, 
	IDictionaryObject, IReadOnlyDictionary, IReadOnlyDictionaryFragment, IEnumerable<KeyValuePair<string, Object>>, 
	IEnumerable, IDictionaryFragment

The Document type exposes the following members.

Constructors

	Name	Description
	Document	Default Constructor
	Document(IDictionaryString, Object)	Creates a document with the given properties
	Document(String)	Creates a document given an ID
	Document(String, IDictionaryString, Object)	Creates a document with the given ID and properties

Top

Properties

	Name	Description
	Count	Gets the number of entries in the dictionary (Overrides ReadOnlyDictionaryCount.)
	Database	Gets the database that this document belongs to, if any (Inherited from ReadOnlyDocument.)
	Id	Gets this document's unique ID (Inherited from ReadOnlyDocument.)
	IsDeleted	Gets whether or not this document is deleted (Inherited from ReadOnlyDocument.)
	Item	Gets the value of the given key, or lack thereof, wrapped inside of a Fragment
	Keys	Gets all the keys held by this dictionary (Inherited from ReadOnlyDictionary.)
	Sequence	Gets the sequence of this document (a unique incrementing number identifying its status in a database) (Inherited from ReadOnlyDocument.)

Top

Methods

	Name	Description
	Contains	Checks if a given key is present in the dictionary (Overrides ReadOnlyDictionaryContains(String).)
	Dispose	Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources. (Inherited from ReadOnlyDocument.)
	Equals	Determines whether the specified object is equal to the current object. (Inherited from Object.)
	GetArray	Gets the value of a given key as an IArray
	GetBlob	Gets the value of a given key as a Blob (Overrides ReadOnlyDictionaryGetBlob(String).)
	GetBoolean	Gets the value of a given key as a Boolean (Overrides ReadOnlyDictionaryGetBoolean(String).)
	GetDate	Gets the value of a given key as a DateTimeOffset (Overrides ReadOnlyDictionaryGetDate(String).)
	GetDictionary	Gets the value of a given key as a dictionary
	GetDouble	Gets the value of a given key as a Double (Overrides ReadOnlyDictionaryGetDouble(String).)
	GetEnumerator	Returns an enumerator that iterates through the collection. (Overrides ReadOnlyDictionaryGetEnumerator.)
	GetFloat	Gets the value of a given key as a Single (Overrides ReadOnlyDictionaryGetFloat(String).)
	GetHashCode	Serves as the default hash function. (Inherited from Object.)
	GetInt	Gets the value of a given key as an Int32 (Overrides ReadOnlyDictionaryGetInt(String).)
	GetLong	Gets the value of a given key as an Int64 (Overrides ReadOnlyDictionaryGetLong(String).)
	GetObject	Gets the value of a given key as an untyped object (Overrides ReadOnlyDictionaryGetObject(String).)
	GetString	Gets the value of a given key as a String (Overrides ReadOnlyDictionaryGetString(String).)
	GetType	Gets the Type of the current instance. (Inherited from Object.)
	Remove	Removes the given key from this dictionary
	Set(IDictionaryString, Object)	Replaces the contents of this dictionary with the contents of the given one
	Set(String, ArrayObject)	Sets the given key to the given value
	Set(String, Blob)	Sets the given key to the given value
	Set(String, DictionaryObject)	Sets the given key to the given value
	Set(String, Boolean)	Sets the given key to the given value
	Set(String, DateTimeOffset)	Sets the given key to the given value
	Set(String, Double)	Sets the given key to the given value
	Set(String, Int32)	Sets the given key to the given value
	Set(String, Int64)	Sets the given key to the given value
	Set(String, Object)	Sets the given key to the given value
	Set(String, Single)	Sets the given key to the given value
	Set(String, String)	Sets the given key to the given value
	ToDictionary	Converts this object to a standard .NET string to object IDictionaryTKey, TValue (Overrides ReadOnlyDictionaryToDictionary.)
	ToString	Returns a string that represents the current object. (Overrides ReadOnlyDocumentToString.)

Top

Reference

Couchbase.Lite Namespace