Click or drag to resize

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

Namespace:  Couchbase.Lite
Assembly:  Couchbase.Lite (in Couchbase.Lite.dll) Version: 2.0.0-b0364
Syntax
C#
public sealed class Document : ReadOnlyDocument, 
	IDictionaryObject, IReadOnlyDictionary, IReadOnlyDictionaryFragment, IEnumerable<KeyValuePair<string, Object>>, 
	IEnumerable, IDictionaryFragment

The Document type exposes the following members.

Constructors
Properties
  NameDescription
Public propertyCount
Gets the number of entries in the dictionary
(Overrides ReadOnlyDictionaryCount.)
Public propertyDatabase
Gets the database that this document belongs to, if any
(Inherited from ReadOnlyDocument.)
Public propertyId
Gets this document's unique ID
(Inherited from ReadOnlyDocument.)
Public propertyIsDeleted
Gets whether or not this document is deleted
(Inherited from ReadOnlyDocument.)
Public propertyItem
Gets the value of the given key, or lack thereof, wrapped inside of a Fragment
Public propertyKeys
Gets all the keys held by this dictionary
(Inherited from ReadOnlyDictionary.)
Public propertySequence
Gets the sequence of this document (a unique incrementing number identifying its status in a database)
(Inherited from ReadOnlyDocument.)
Top
Methods
  NameDescription
Public methodContains
Checks if a given key is present in the dictionary
(Overrides ReadOnlyDictionaryContains(String).)
Public methodDispose
Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.
(Inherited from ReadOnlyDocument.)
Public methodEquals
Determines whether the specified object is equal to the current object.
(Inherited from Object.)
Public methodGetArray
Gets the value of a given key as an IArray
Public methodGetBlob
Gets the value of a given key as a Blob
(Overrides ReadOnlyDictionaryGetBlob(String).)
Public methodGetBoolean
Gets the value of a given key as a Boolean
(Overrides ReadOnlyDictionaryGetBoolean(String).)
Public methodGetDate
Gets the value of a given key as a DateTimeOffset
(Overrides ReadOnlyDictionaryGetDate(String).)
Public methodGetDictionary
Gets the value of a given key as a dictionary
Public methodGetDouble
Gets the value of a given key as a Double
(Overrides ReadOnlyDictionaryGetDouble(String).)
Public methodGetEnumerator
Returns an enumerator that iterates through the collection.
(Overrides ReadOnlyDictionaryGetEnumerator.)
Public methodGetFloat
Gets the value of a given key as a Single
(Overrides ReadOnlyDictionaryGetFloat(String).)
Public methodGetHashCode
Serves as the default hash function.
(Inherited from Object.)
Public methodGetInt
Gets the value of a given key as an Int32
(Overrides ReadOnlyDictionaryGetInt(String).)
Public methodGetLong
Gets the value of a given key as an Int64
(Overrides ReadOnlyDictionaryGetLong(String).)
Public methodGetObject
Gets the value of a given key as an untyped object
(Overrides ReadOnlyDictionaryGetObject(String).)
Public methodGetString
Gets the value of a given key as a String
(Overrides ReadOnlyDictionaryGetString(String).)
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Public methodRemove
Removes the given key from this dictionary
Public methodSet(IDictionaryString, Object)
Replaces the contents of this dictionary with the contents of the given one
Public methodSet(String, ArrayObject)
Sets the given key to the given value
Public methodSet(String, Blob)
Sets the given key to the given value
Public methodSet(String, DictionaryObject)
Sets the given key to the given value
Public methodSet(String, Boolean)
Sets the given key to the given value
Public methodSet(String, DateTimeOffset)
Sets the given key to the given value
Public methodSet(String, Double)
Sets the given key to the given value
Public methodSet(String, Int32)
Sets the given key to the given value
Public methodSet(String, Int64)
Sets the given key to the given value
Public methodSet(String, Object)
Sets the given key to the given value
Public methodSet(String, Single)
Sets the given key to the given value
Public methodSet(String, String)
Sets the given key to the given value
Public methodToDictionary (Overrides ReadOnlyDictionaryToDictionary.)
Public methodToString
Returns a string that represents the current object.
(Overrides ReadOnlyDocumentToString.)
Top
See Also