Interface IMutableDictionary

An interface representing a writeable key value collection

Inherited Members

IDictionaryObject.Count

IDictionaryObject.Keys

IDictionaryObject.Contains(String)

IDictionaryObject.GetBlob(String)

IDictionaryObject.GetBoolean(String)

IDictionaryObject.GetDate(String)

IDictionaryObject.GetDouble(String)

IDictionaryObject.GetFloat(String)

IDictionaryObject.GetInt(String)

IDictionaryObject.GetLong(String)

IDictionaryObject.GetValue(String)

IDictionaryObject.GetString(String)

IDictionaryObject.ToDictionary()

System.Collections.Generic.IEnumerable<System.Collections.Generic.KeyValuePair<System.String, System.Object>>.GetEnumerator()

System.Collections.IEnumerable.GetEnumerator()

Namespace: Couchbase.Lite

Assembly: Couchbase.Lite.dll

Syntax

public interface IMutableDictionary : IDictionaryObject, IDictionaryFragment, IEnumerable<KeyValuePair<string, object>>, IEnumerable, IMutableDictionaryFragment

Properties

Item[String]

Gets the value of the given key, or lack thereof, wrapped inside of a IMutableFragment

Declaration

IMutableFragment this[string key] { get; }

Parameters

Type	Name	Description
System.String	key	The key to check

Property Value

Type	Description
IMutableFragment	The value of the given key, or lack thereof

Methods

GetArray(String)

Gets the value of a given key as an IMutableArray

Declaration

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

GetDictionary(String)

Gets the value of a given key as a dictionary

Declaration

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

Remove(String)

Removes the given key from this dictionary

Declaration

IMutableDictionary Remove(string key)

Parameters

Type	Name	Description
System.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

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

SetBlob(String, Blob)

Sets the given key to the given value

Declaration

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

SetBoolean(String, Boolean)

Sets the given key to the given value

Declaration

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

SetData(IDictionary<String, Object>)

Replaces the contents of this dictionary with the contents of the given one

Declaration

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

SetDate(String, DateTimeOffset)

Sets the given key to the given value

Declaration

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

SetDictionary(String, DictionaryObject)

Sets the given key to the given value

Declaration

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

SetDouble(String, Double)

Sets the given key to the given value

Declaration

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

SetFloat(String, Single)

Sets the given key to the given value

Declaration

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

SetInt(String, Int32)

Sets the given key to the given value

Declaration

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

SetJSON(String)

Replaces the contents of this dictionary with the contents of the given json string

Declaration

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

SetLong(String, Int64)

Sets the given key to the given value

Declaration

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

SetString(String, String)

Sets the given key to the given value

Declaration

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

SetValue(String, Object)

Sets the given key to the given value

Declaration

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