Class MutableDocument
A class representing an entry in a Couchbase Lite Database.
It consists of some metadata, and a collection of user-defined properties
Implements
Inherited Members
Namespace: Couchbase.Lite
Assembly: Couchbase.Lite.dll
Syntax
public sealed class MutableDocument : Document, IJSON, IDisposable, IMutableDictionary, IDictionaryObject, IDictionaryFragment, IEnumerable<KeyValuePair<string, object>>, IEnumerable, IMutableDictionaryFragment
Constructors
| Improve this Doc View SourceMutableDocument()
Default Constructor
Declaration
public MutableDocument()
MutableDocument(IDictionary<string, object>)
Creates a document with the given properties
Declaration
public MutableDocument(IDictionary<string, object> data)
Parameters
Type | Name | Description |
---|---|---|
IDictionary<string, object> | data | The properties of the document |
MutableDocument(string, IDictionary<string, object>)
Creates a document with the given ID and properties
Declaration
public MutableDocument(string id, IDictionary<string, object> data)
Parameters
Type | Name | Description |
---|---|---|
string | id | The ID for the document |
IDictionary<string, object> | data | The properties for the document |
MutableDocument(string, string)
Creates a document with the given ID and json string
Declaration
public MutableDocument(string id, string json)
Parameters
Type | Name | Description |
---|---|---|
string | id | The ID for the document |
string | json | The json contains the properties for the document |
MutableDocument(string)
Creates a document given an ID
Declaration
public MutableDocument(string id)
Parameters
Type | Name | Description |
---|---|---|
string | id | The ID for the document |
Properties
| Improve this Doc View Sourcethis[string]
Gets the value of the given key, or lack thereof, wrapped inside of a IMutableFragment
Declaration
public IMutableFragment this[string key] { get; }
Parameters
Type | Name | Description |
---|---|---|
string | key | The key to check |
Property Value
Type | Description |
---|---|
IMutableFragment | The value of the given key, or lack thereof |
Methods
| Improve this Doc View SourceGetArray(string)
Gets the value of a given key as an IMutableArray
Declaration
public MutableArrayObject GetArray(string key)
Parameters
Type | Name | Description |
---|---|---|
string | key | The key to check the value for |
Returns
Type | Description |
---|---|
MutableArrayObject | The contained value, or |
GetDictionary(string)
Gets the value of a given key as a dictionary
Declaration
public MutableDictionaryObject GetDictionary(string key)
Parameters
Type | Name | Description |
---|---|---|
string | key | The key to check the value for |
Returns
Type | Description |
---|---|
MutableDictionaryObject | The contained value, or |
Remove(string)
Removes the given key from this dictionary
Declaration
public IMutableDictionary Remove(string key)
Parameters
Type | Name | Description |
---|---|---|
string | key | The key to remove |
Returns
Type | Description |
---|---|
IMutableDictionary | Itself for further processing |
SetArray(string, ArrayObject)
Sets the given key to the given value
Declaration
public IMutableDictionary SetArray(string key, ArrayObject value)
Parameters
Type | Name | Description |
---|---|---|
string | key | The key to set |
ArrayObject | value | The value to set |
Returns
Type | Description |
---|---|
IMutableDictionary | Itself for further processing |
SetBlob(string, Blob)
Sets the given key to the given value
Declaration
public IMutableDictionary SetBlob(string key, Blob value)
Parameters
Type | Name | Description |
---|---|---|
string | key | The key to set |
Blob | value | The value to set |
Returns
Type | Description |
---|---|
IMutableDictionary | Itself for further processing |
SetBoolean(string, bool)
Sets the given key to the given value
Declaration
public IMutableDictionary SetBoolean(string key, bool value)
Parameters
Type | Name | Description |
---|---|---|
string | key | The key to set |
bool | value | The value to set |
Returns
Type | Description |
---|---|
IMutableDictionary | Itself for further processing |
SetData(IDictionary<string, object>)
Replaces the contents of this dictionary with the contents of the given one
Declaration
public IMutableDictionary SetData(IDictionary<string, object> dictionary)
Parameters
Type | Name | Description |
---|---|---|
IDictionary<string, object> | dictionary | The dictionary to replace the current contents with |
Returns
Type | Description |
---|---|
IMutableDictionary | Itself for further processing |
SetDate(string, DateTimeOffset)
Sets the given key to the given value
Declaration
public IMutableDictionary SetDate(string key, DateTimeOffset value)
Parameters
Type | Name | Description |
---|---|---|
string | key | The key to set |
DateTimeOffset | value | The value to set |
Returns
Type | Description |
---|---|
IMutableDictionary | Itself for further processing |
SetDictionary(string, DictionaryObject)
Sets the given key to the given value
Declaration
public IMutableDictionary SetDictionary(string key, DictionaryObject value)
Parameters
Type | Name | Description |
---|---|---|
string | key | The key to set |
DictionaryObject | value | The value to set |
Returns
Type | Description |
---|---|
IMutableDictionary | Itself for further processing |
SetDouble(string, double)
Sets the given key to the given value
Declaration
public IMutableDictionary SetDouble(string key, double value)
Parameters
Type | Name | Description |
---|---|---|
string | key | The key to set |
double | value | The value to set |
Returns
Type | Description |
---|---|
IMutableDictionary | Itself for further processing |
SetFloat(string, float)
Sets the given key to the given value
Declaration
public IMutableDictionary SetFloat(string key, float value)
Parameters
Type | Name | Description |
---|---|---|
string | key | The key to set |
float | value | The value to set |
Returns
Type | Description |
---|---|
IMutableDictionary | Itself for further processing |
SetInt(string, int)
Sets the given key to the given value
Declaration
public IMutableDictionary SetInt(string key, int value)
Parameters
Type | Name | Description |
---|---|---|
string | key | The key to set |
int | value | The value to set |
Returns
Type | Description |
---|---|
IMutableDictionary | Itself for further processing |
SetJSON(string)
Replaces the contents of this dictionary with the contents of the given json string
Declaration
public IMutableDictionary SetJSON(string json)
Parameters
Type | Name | Description |
---|---|---|
string | json | The json string to replace the current contents with |
Returns
Type | Description |
---|---|
IMutableDictionary | Itself for further processing |
Remarks
json string must be constructed from ToJSON
SetLong(string, long)
Sets the given key to the given value
Declaration
public IMutableDictionary SetLong(string key, long value)
Parameters
Type | Name | Description |
---|---|---|
string | key | The key to set |
long | value | The value to set |
Returns
Type | Description |
---|---|
IMutableDictionary | Itself for further processing |
SetString(string, string)
Sets the given key to the given value
Declaration
public IMutableDictionary SetString(string key, string value)
Parameters
Type | Name | Description |
---|---|---|
string | key | The key to set |
string | value | The value to set |
Returns
Type | Description |
---|---|
IMutableDictionary | Itself for further processing |
SetValue(string, object)
Sets the given key to the given value
Declaration
public IMutableDictionary SetValue(string key, object value)
Parameters
Type | Name | Description |
---|---|---|
string | key | The key to set |
object | value | The value to set |
Returns
Type | Description |
---|---|
IMutableDictionary | Itself for further processing |
ToMutable()
Creates a mutable version of a document (i.e. one that can be edited)
Declaration
public override MutableDocument ToMutable()
Returns
Type | Description |
---|---|
MutableDocument | A mutable version of the document |
Overrides
Exceptions
Type | Condition |
---|---|
InvalidOperationException | InvalidOperationException thrown when trying edit Documents from a replication filter. |
ToString()
Declaration
public override string ToString()
Returns
Type | Description |
---|---|
string |