Class ArrayObject

A class representing a readonly ordered collection of objects

Inheritance
System.Object
ArrayObject
MutableArrayObject
Implements
IEnumerable<System.Object>
Namespace: Couchbase.Lite
Assembly: Couchbase.Lite.dll
Syntax
public class ArrayObject : object, IArray, IArrayFragment, IEnumerable<object>, IJSON

Properties

| Improve this Doc View Source

Count

Gets the number of elements in this array

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

Item[Int32]

Gets the value of the given index, or lack thereof, wrapped inside of a IFragment

Declaration
public IFragment this[int index] { get; }
Parameters
Type Name Description
System.Int32 index

The index to check
Property Value
Type Description
IFragment

The value of the given index, or lack thereof

Methods

| Improve this Doc View Source

GetArray(Int32)

Gets the value at the given index as a read only array

Declaration
public ArrayObject GetArray(int index)
Parameters
Type Name Description
System.Int32 index

The index to lookup
Returns
Type Description
ArrayObject

The value at the index, or null
| Improve this Doc View Source

GetBlob(Int32)

Gets the value at the given index as a Blob

Declaration
public Blob GetBlob(int index)
Parameters
Type Name Description
System.Int32 index

The index to lookup
Returns
Type Description
Blob

The value at the index, or null
| Improve this Doc View Source

GetBoolean(Int32)

Gets the value at the given index as a

Declaration
public bool GetBoolean(int index)
Parameters
Type Name Description
System.Int32 index

The index to lookup
Returns
Type Description
System.Boolean

The value at the index, or its converted equivalent
Remarks

Any non-zero object will be treated as true, so don't rely on any sort of parsing

| Improve this Doc View Source

GetDate(Int32)

Gets the value at the given index as a

Declaration
public DateTimeOffset GetDate(int index)
Parameters
Type Name Description
System.Int32 index

The index to lookup
Returns
Type Description
DateTimeOffset

The value at the index, or a default
| Improve this Doc View Source

GetDictionary(Int32)

Gets the value at the given index as a DictionaryObject

Declaration
public DictionaryObject GetDictionary(int index)
Parameters
Type Name Description
System.Int32 index

The index to lookup
Returns
Type Description
DictionaryObject

The value at the index, or null
| Improve this Doc View Source

GetDouble(Int32)

Gets the value at the given index as a

Declaration
public double GetDouble(int index)
Parameters
Type Name Description
System.Int32 index

The index to lookup
Returns
Type Description
System.Double

The value at the index, or its converted equivalent
Remarks

true will be converted to 1.0, and everything else that is non-numeric will be 0.0

| Improve this Doc View Source

GetEnumerator()

Returns an enumerator that iterates through the collection.

Declaration
public virtual IEnumerator<object> GetEnumerator()
Returns
Type Description
IEnumerator<System.Object>

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

GetFloat(Int32)

Gets the value at the given index as a

Declaration
public float GetFloat(int index)
Parameters
Type Name Description
System.Int32 index

The index to lookup
Returns
Type Description
System.Single

The value at the index, or its converted equivalent
Remarks

true will be converted to 1.0f, and everything else that is non-numeric will be 0.0f

| Improve this Doc View Source

GetInt(Int32)

Gets the value at the given index as an

Declaration
public int GetInt(int index)
Parameters
Type Name Description
System.Int32 index

The index to lookup
Returns
Type Description
System.Int32

The value at the index, or its converted equivalent
Remarks

true will be converted to 1, a value will be rounded, and everything else non-numeric will be 0

| Improve this Doc View Source

GetLong(Int32)

Gets the value at the given index as an

Declaration
public long GetLong(int index)
Parameters
Type Name Description
System.Int32 index

The index to lookup
Returns
Type Description
System.Int64

The value at the index, or its converted equivalent
Remarks

true will be converted to 1, a value will be rounded, and everything else non-numeric will be 0

| Improve this Doc View Source

GetString(Int32)

Gets the value at the given index as a

Declaration
public string GetString(int index)
Parameters
Type Name Description
System.Int32 index

The index to lookup
Returns
Type Description
System.String

The value at the index, or null
| Improve this Doc View Source

GetValue(Int32)

Gets the value at the given index as an untyped object

Declaration
public object GetValue(int index)
Parameters
Type Name Description
System.Int32 index

The index to lookup
Returns
Type Description
System.Object

The value at the index, or null
Remarks

This method should be avoided for numeric types, whose underlying representation is subject to change and thus s

| Improve this Doc View Source

ToJSON()

Converts this object to JSON format string.

Declaration
public string ToJSON()
Returns
Type Description
System.String

The contents of this object in JSON format string
| Improve this Doc View Source

ToList()

Similar to the LINQ method, but returns all objects converted to standard .NET types

Declaration
public List<object> ToList()
Returns
Type Description
List<System.Object>

A list of standard .NET typed objects in the array
| Improve this Doc View Source

ToMutable()

Creates a copy of this object that can be mutated

Declaration
public MutableArrayObject ToMutable()
Returns
Type Description
MutableArrayObject

A mutable copy of the array

Implements

IEnumerable<>