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 HierarchyNamespace: Couchbase.Lite
Assembly: Couchbase.Lite (in Couchbase.Lite.dll) Version: 2.0.0-b0382
SyntaxC#
public sealed class Document : ReadOnlyDocument, IDictionaryObject, IReadOnlyDictionary, IReadOnlyDictionaryFragment, IReadOnlyCollection<KeyValuePair<string, Object>>, 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
|
Properties| Name | Description | |
|---|---|---|
 | Count |
Gets the number of top level entries in this document
(Inherited from ReadOnlyDocument.) |
| 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 present in this document
(Inherited from ReadOnlyDocument.) |
| Sequence |
Gets the sequence of this document (a unique incrementing number
identifying its status in a database)
(Inherited from ReadOnlyDocument.) |
Methods| Name | Description | |
|---|---|---|
| Contains | (Inherited from ReadOnlyDocument.) |
| 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 | (Inherited from ReadOnlyDocument.) |
| GetBoolean | (Inherited from ReadOnlyDocument.) |
| GetDate | (Inherited from ReadOnlyDocument.) |
| GetDictionary |
Gets the value of a given key as a dictionary
|
| GetDouble | (Inherited from ReadOnlyDocument.) |
| GetEnumerator | (Inherited from ReadOnlyDocument.) |
| GetFloat | (Inherited from ReadOnlyDocument.) |
| GetHashCode | Serves as the default hash function. (Inherited from Object.) |
| GetInt | (Inherited from ReadOnlyDocument.) |
| GetLong | (Inherited from ReadOnlyDocument.) |
| GetObject | (Inherited from ReadOnlyDocument.) |
| GetString | (Inherited from ReadOnlyDocument.) |
| 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 | (Inherited from ReadOnlyDocument.) |
| ToString |
Returns a string that represents the current object.
(Overrides ReadOnlyDocumentToString.) |
See Also