MutableDocument 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-b0469
SyntaxC#
public sealed class MutableDocument : Document, IMutableDictionary, IDictionaryObject, IDictionaryFragment, IReadOnlyCollection<KeyValuePair<string, Object>>, IEnumerable<KeyValuePair<string, Object>>, IEnumerable, IMutableDictionaryFragment
The MutableDocument type exposes the following members.
Constructors| Name | Description | |
|---|---|---|
 | MutableDocument |
Default Constructor
|
| MutableDocument(IDictionaryString, Object) |
Creates a document with the given properties
|
| MutableDocument(String) |
Creates a document given an ID
|
| MutableDocument(String, IDictionaryString, Object) |
Creates a document with the given ID and properties
|
Properties| Name | Description | |
|---|---|---|
 | Count | Gets the number of elements in the collection. (Inherited from Document.) |
| Database |
Gets the database that this document belongs to, if any
(Inherited from Document.) |
| Id |
Gets this document's unique ID
(Inherited from Document.) |
| IsDeleted |
Gets whether or not this document is deleted
(Inherited from Document.) |
| Item |
Gets the value of the given key, or lack thereof,
wrapped inside of a IMutableFragment |
| Keys |
Gets all the keys held by this dictionary
(Inherited from Document.) |
| Sequence |
Gets the sequence of this document (a unique incrementing number
identifying its status in a database)
(Inherited from Document.) |
Methods| Name | Description | |
|---|---|---|
| Contains |
Checks if a given key is present in the dictionary
(Inherited from Document.) |
| Dispose |
Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.
(Inherited from Document.) |
| Equals | Determines whether the specified object is equal to the current object. (Inherited from Document.) |
| GetArray |
Gets the value of a given key as an IMutableArray |
| GetBlob |
Gets the value of a given key as a Blob (Inherited from Document.) |
| GetBoolean |
Gets the value of a given key as a Boolean (Inherited from Document.) |
| GetDate |
Gets the value of a given key as a DateTimeOffset (Inherited from Document.) |
| GetDictionary |
Gets the value of a given key as a dictionary
|
| GetDouble |
Gets the value of a given key as a Double (Inherited from Document.) |
| GetEnumerator | Returns an enumerator that iterates through the collection. (Inherited from Document.) |
| GetFloat |
Gets the value of a given key as a Single (Inherited from Document.) |
| GetHashCode | Serves as the default hash function. (Inherited from Document.) |
| GetInt |
Gets the value of a given key as an Int32 (Inherited from Document.) |
| GetLong |
Gets the value of a given key as an Int64 (Inherited from Document.) |
| GetString |
Gets the value of a given key as a String (Inherited from Document.) |
| GetType | Gets the Type of the current instance. (Inherited from Object.) |
| GetValue |
Gets the value of a given key as an untyped object
(Inherited from Document.) |
| Remove |
Removes the given key from this dictionary
|
| SetArray |
Sets the given key to the given value
|
| SetBlob |
Sets the given key to the given value
|
| SetBoolean |
Sets the given key to the given value
|
| SetData |
Replaces the contents of this dictionary with the contents of the
given one
|
| SetDate |
Sets the given key to the given value
|
| SetDictionary |
Sets the given key to the given value
|
| SetDouble |
Sets the given key to the given value
|
| SetFloat |
Sets the given key to the given value
|
| SetInt |
Sets the given key to the given value
|
| SetLong |
Sets the given key to the given value
|
| SetString |
Sets the given key to the given value
|
| SetValue |
Sets the given key to the given value
|
| ToDictionary |
Converts this object to a standard .NET string to object
DictionaryTKey, TValue (Inherited from Document.) |
| ToMutable |
Creates a mutable version of a document (i.e. one that
can be edited)
(Overrides DocumentToMutable.) |
| ToString | Returns a string that represents the current object. (Overrides DocumentToString.) |
Extension Methods| Name | Description | |
|---|---|---|
 | RecursiveEqual |
Tests for equality between two untyped objects, and if they are collections
recursively checks for equality on each entry.
(Defined by Extensions.) |
See Also