Show / Hide Table of Contents

Class MutableDictionaryObject

A class representing a writeable string to object dictionary

Inheritance
System.Object
DictionaryObject
MutableDictionaryObject
Implements
IJSON
IMutableDictionary
IDictionaryObject
IDictionaryFragment
System.Collections.Generic.IEnumerable<System.Collections.Generic.KeyValuePair<System.String, System.Object>>
System.Collections.IEnumerable
IMutableDictionaryFragment
Inherited Members
DictionaryObject.Count
DictionaryObject.Keys
DictionaryObject.ToMutable()
DictionaryObject.KeysChanged()
DictionaryObject.Contains(String)
DictionaryObject.GetBlob(String)
DictionaryObject.GetBoolean(String)
DictionaryObject.GetDate(String)
DictionaryObject.GetDouble(String)
DictionaryObject.GetFloat(String)
DictionaryObject.GetInt(String)
DictionaryObject.GetLong(String)
DictionaryObject.GetValue(String)
DictionaryObject.GetString(String)
DictionaryObject.ToDictionary()
DictionaryObject.IEnumerable.GetEnumerator()
DictionaryObject.GetEnumerator()
DictionaryObject.ToJSON()
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.GetHashCode()
System.Object.GetType()
System.Object.MemberwiseClone()
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.ToString()
Namespace: Couchbase.Lite
Assembly: Couchbase.Lite.dll
Syntax
public sealed class MutableDictionaryObject : DictionaryObject, IJSON, IMutableDictionary, IDictionaryObject, IDictionaryFragment, IEnumerable<KeyValuePair<string, object>>, IEnumerable, IMutableDictionaryFragment

Constructors

| Improve this Doc View Source

MutableDictionaryObject()

Default Constructor

Declaration
public MutableDictionaryObject()
| Improve this Doc View Source

MutableDictionaryObject(IDictionary<String, Object>)

Creates a dictionary given the initial set of keys and values from an existing dictionary

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

The dictionary to copy the keys and values from

| Improve this Doc View Source

MutableDictionaryObject(String)

Creates a dictionary given the initial set of keys and values from an json dictionary string

Declaration
public MutableDictionaryObject(string json)
Parameters
Type Name Description
System.String json

The json dictionary string to copy the keys and values from

Properties

| Improve this Doc View Source

Item[String]

Gets the fragment value for the given key in this dictionary

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

The key whose value to retrieve

Property Value
Type Description
IMutableFragment

The fragment representing the value at the given key

Methods

| Improve this Doc View Source

GetArray(String)

Gets the value of a given key as an IMutableArray

Declaration
public MutableArrayObject GetArray(string key)
Parameters
Type Name Description
System.String key

The key to check the value for

Returns
Type Description
MutableArrayObject

The contained value, or null

| Improve this Doc View Source

GetDictionary(String)

Gets the value of a given key as a dictionary

Declaration
public MutableDictionaryObject GetDictionary(string key)
Parameters
Type Name Description
System.String key

The key to check the value for

Returns
Type Description
MutableDictionaryObject

The contained value, or null

| Improve this Doc View Source

Remove(String)

Removes the given key from this dictionary

Declaration
public IMutableDictionary Remove(string key)
Parameters
Type Name Description
System.String key

The key to remove

Returns
Type Description
IMutableDictionary

Itself for further processing

| Improve this Doc View Source

SetArray(String, ArrayObject)

Sets the given key to the given value

Declaration
public IMutableDictionary SetArray(string key, ArrayObject value)
Parameters
Type Name Description
System.String key

The key to set

ArrayObject value

The value to set

Returns
Type Description
IMutableDictionary

Itself for further processing

| Improve this Doc View Source

SetBlob(String, Blob)

Sets the given key to the given value

Declaration
public IMutableDictionary SetBlob(string key, Blob value)
Parameters
Type Name Description
System.String key

The key to set

Blob value

The value to set

Returns
Type Description
IMutableDictionary

Itself for further processing

| Improve this Doc View Source

SetBoolean(String, Boolean)

Sets the given key to the given value

Declaration
public IMutableDictionary SetBoolean(string key, bool value)
Parameters
Type Name Description
System.String key

The key to set

System.Boolean value

The value to set

Returns
Type Description
IMutableDictionary

Itself for further processing

| Improve this Doc View Source

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
System.Collections.Generic.IDictionary<System.String, System.Object> dictionary

The dictionary to replace the current contents with

Returns
Type Description
IMutableDictionary

Itself for further processing

| Improve this Doc View Source

SetDate(String, DateTimeOffset)

Sets the given key to the given value

Declaration
public IMutableDictionary SetDate(string key, DateTimeOffset value)
Parameters
Type Name Description
System.String key

The key to set

System.DateTimeOffset value

The value to set

Returns
Type Description
IMutableDictionary

Itself for further processing

| Improve this Doc View Source

SetDictionary(String, DictionaryObject)

Sets the given key to the given value

Declaration
public IMutableDictionary SetDictionary(string key, DictionaryObject value)
Parameters
Type Name Description
System.String key

The key to set

DictionaryObject value

The value to set

Returns
Type Description
IMutableDictionary

Itself for further processing

| Improve this Doc View Source

SetDouble(String, Double)

Sets the given key to the given value

Declaration
public IMutableDictionary SetDouble(string key, double value)
Parameters
Type Name Description
System.String key

The key to set

System.Double value

The value to set

Returns
Type Description
IMutableDictionary

Itself for further processing

| Improve this Doc View Source

SetFloat(String, Single)

Sets the given key to the given value

Declaration
public IMutableDictionary SetFloat(string key, float value)
Parameters
Type Name Description
System.String key

The key to set

System.Single value

The value to set

Returns
Type Description
IMutableDictionary

Itself for further processing

| Improve this Doc View Source

SetInt(String, Int32)

Sets the given key to the given value

Declaration
public IMutableDictionary SetInt(string key, int value)
Parameters
Type Name Description
System.String key

The key to set

System.Int32 value

The value to set

Returns
Type Description
IMutableDictionary

Itself for further processing

| Improve this Doc View Source

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

| Improve this Doc View Source

SetLong(String, Int64)

Sets the given key to the given value

Declaration
public IMutableDictionary SetLong(string key, long value)
Parameters
Type Name Description
System.String key

The key to set

System.Int64 value

The value to set

Returns
Type Description
IMutableDictionary

Itself for further processing

| Improve this Doc View Source

SetString(String, String)

Sets the given key to the given value

Declaration
public IMutableDictionary SetString(string key, string value)
Parameters
Type Name Description
System.String key

The key to set

System.String value

The value to set

Returns
Type Description
IMutableDictionary

Itself for further processing

| Improve this Doc View Source

SetValue(String, Object)

Sets the given key to the given value

Declaration
public IMutableDictionary SetValue(string key, object value)
Parameters
Type Name Description
System.String key

The key to set

System.Object value

The value to set

Returns
Type Description
IMutableDictionary

Itself for further processing

Implements

IJSON
IMutableDictionary
IDictionaryObject
IDictionaryFragment
System.Collections.Generic.IEnumerable<T>
System.Collections.IEnumerable
IMutableDictionaryFragment
  • Improve this Doc
  • View Source
In This Article
Back to top Generated by DocFX