Class MutableDocument

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

Inheritance
System.Object
Document
MutableDocument
Implements
System.IDisposable
System.Collections.Generic.IEnumerable<System.Collections.Generic.KeyValuePair<System.String, System.Object>>
System.Collections.IEnumerable
Inherited Members
System.Object.Equals(System.Object, System.Object)
System.Object.GetType()
System.Object.MemberwiseClone()
System.Object.ReferenceEquals(System.Object, System.Object)
Namespace: Couchbase.Lite
Assembly: Couchbase.Lite.dll
Syntax
public sealed class MutableDocument : Document, IDisposable, IMutableDictionary, IDictionaryObject, IDictionaryFragment, IEnumerable<KeyValuePair<string, object>>, IEnumerable, IMutableDictionaryFragment

Constructors

| Improve this Doc View Source

MutableDocument()

Default Constructor

Declaration
public MutableDocument()
| Improve this Doc View Source

MutableDocument(IDictionary<String, Object>)

Creates a document with the given properties

Declaration
public MutableDocument(IDictionary<string, object> data)
Parameters
Type Name Description
System.Collections.Generic.IDictionary<System.String, System.Object> data

The properties of the document
| Improve this Doc View Source

MutableDocument(String)

Creates a document given an ID

Declaration
public MutableDocument(string id)
Parameters
Type Name Description
System.String id

The ID for the document
| Improve this Doc View Source

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
System.String id

The ID for the document
System.Collections.Generic.IDictionary<System.String, System.Object> data

The properties for the document

Properties

| Improve this Doc View Source

Item[String]

Declaration
public IMutableFragment this[string key] { get; }
Parameters
Type Name Description
System.String key
Property Value
Type Description
IMutableFragment

Methods

| Improve this Doc View Source

GetArray(String)

Declaration
public MutableArrayObject GetArray(string key)
Parameters
Type Name Description
System.String key
Returns
Type Description
MutableArrayObject
| Improve this Doc View Source

GetDictionary(String)

Declaration
public MutableDictionaryObject GetDictionary(string key)
Parameters
Type Name Description
System.String key
Returns
Type Description
MutableDictionaryObject
| Improve this Doc View Source

Remove(String)

Declaration
public IMutableDictionary Remove(string key)
Parameters
Type Name Description
System.String key
Returns
Type Description
IMutableDictionary
| Improve this Doc View Source

SetArray(String, ArrayObject)

Declaration
public IMutableDictionary SetArray(string key, ArrayObject value)
Parameters
Type Name Description
System.String key
ArrayObject value
Returns
Type Description
IMutableDictionary
| Improve this Doc View Source

SetBlob(String, Blob)

Declaration
public IMutableDictionary SetBlob(string key, Blob value)
Parameters
Type Name Description
System.String key
Blob value
Returns
Type Description
IMutableDictionary
| Improve this Doc View Source

SetBoolean(String, Boolean)

Declaration
public IMutableDictionary SetBoolean(string key, bool value)
Parameters
Type Name Description
System.String key
System.Boolean value
Returns
Type Description
IMutableDictionary
| Improve this Doc View Source

SetData(IDictionary<String, Object>)

Declaration
public IMutableDictionary SetData(IDictionary<string, object> dictionary)
Parameters
Type Name Description
System.Collections.Generic.IDictionary<System.String, System.Object> dictionary
Returns
Type Description
IMutableDictionary
| Improve this Doc View Source

SetDate(String, DateTimeOffset)

Declaration
public IMutableDictionary SetDate(string key, DateTimeOffset value)
Parameters
Type Name Description
System.String key
System.DateTimeOffset value
Returns
Type Description
IMutableDictionary
| Improve this Doc View Source

SetDictionary(String, DictionaryObject)

Declaration
public IMutableDictionary SetDictionary(string key, DictionaryObject value)
Parameters
Type Name Description
System.String key
DictionaryObject value
Returns
Type Description
IMutableDictionary
| Improve this Doc View Source

SetDouble(String, Double)

Declaration
public IMutableDictionary SetDouble(string key, double value)
Parameters
Type Name Description
System.String key
System.Double value
Returns
Type Description
IMutableDictionary
| Improve this Doc View Source

SetFloat(String, Single)

Declaration
public IMutableDictionary SetFloat(string key, float value)
Parameters
Type Name Description
System.String key
System.Single value
Returns
Type Description
IMutableDictionary
| Improve this Doc View Source

SetInt(String, Int32)

Declaration
public IMutableDictionary SetInt(string key, int value)
Parameters
Type Name Description
System.String key
System.Int32 value
Returns
Type Description
IMutableDictionary
| Improve this Doc View Source

SetLong(String, Int64)

Declaration
public IMutableDictionary SetLong(string key, long value)
Parameters
Type Name Description
System.String key
System.Int64 value
Returns
Type Description
IMutableDictionary
| Improve this Doc View Source

SetString(String, String)

Declaration
public IMutableDictionary SetString(string key, string value)
Parameters
Type Name Description
System.String key
System.String value
Returns
Type Description
IMutableDictionary
| Improve this Doc View Source

SetValue(String, Object)

Declaration
public IMutableDictionary SetValue(string key, object value)
Parameters
Type Name Description
System.String key
System.Object value
Returns
Type Description
IMutableDictionary
| Improve this Doc View Source

ToMutable()

Declaration
public override MutableDocument ToMutable()
Returns
Type Description
MutableDocument
Overrides
| Improve this Doc View Source

ToString()

Declaration
public override string ToString()
Returns
Type Description
System.String
Overrides

Implements

System.IDisposable
System.Collections.Generic.IEnumerable<T>
System.Collections.IEnumerable