Class DictionaryObject

A class representing a key-value collection that is read only

Inheritance
System.Object
DictionaryObject
MutableDictionaryObject
Implements
System.Collections.Generic.IEnumerable<System.Collections.Generic.KeyValuePair<System.String, System.Object>>
System.Collections.IEnumerable
Inherited Members
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 class DictionaryObject : IDictionaryObject, IDictionaryFragment, IEnumerable<KeyValuePair<string, object>>, IEnumerable

Properties

| Improve this Doc View Source

Count

Declaration
public int Count { get; }
Property Value
Type Description
System.Int32
| Improve this Doc View Source

Item[String]

Declaration
public IFragment this[string key] { get; }
Parameters
Type Name Description
System.String key
Property Value
Type Description
IFragment
| Improve this Doc View Source

Keys

Declaration
public ICollection<string> Keys { get; }
Property Value
Type Description
System.Collections.Generic.ICollection<System.String>

Methods

| Improve this Doc View Source

Contains(String)

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

GetArray(String)

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

GetBlob(String)

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

GetBoolean(String)

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

GetDate(String)

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

GetDictionary(String)

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

GetDouble(String)

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

GetEnumerator()

Returns an enumerator that iterates through the collection.

Declaration
public virtual IEnumerator<KeyValuePair<string, object>> GetEnumerator()
Returns
Type Description
System.Collections.Generic.IEnumerator<System.Collections.Generic.KeyValuePair<System.String, System.Object>>

An enumerator that can be used to iterate through the collection.
| Improve this Doc View Source

GetFloat(String)

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

GetInt(String)

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

GetLong(String)

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

GetString(String)

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

GetValue(String)

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

KeysChanged()

Signal that the keys of this object have changed (not possible for this class, but a subclass might)

Declaration
protected void KeysChanged()
| Improve this Doc View Source

ToDictionary()

Declaration
public Dictionary<string, object> ToDictionary()
Returns
Type Description
System.Collections.Generic.Dictionary<System.String, System.Object>
| Improve this Doc View Source

ToMutable()

Creates a copy of this object that can be mutated

Declaration
public MutableDictionaryObject ToMutable()
Returns
Type Description
MutableDictionaryObject

A mutable copy of the dictionary

Explicit Interface Implementations

| Improve this Doc View Source

IEnumerable.GetEnumerator()

Declaration
IEnumerator IEnumerable.GetEnumerator()
Returns
Type Description
System.Collections.IEnumerator

Implements

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