Interface IMutableArray

An interface representing a writable collection of objects

Inherited Members

IArray.Count

IArray.GetBlob(Int32)

IArray.GetBoolean(Int32)

IArray.GetDate(Int32)

IArray.GetDouble(Int32)

IArray.GetFloat(Int32)

IArray.GetInt(Int32)

IArray.GetLong(Int32)

IArray.GetString(Int32)

IArray.GetValue(Int32)

IArray.ToList()

Namespace: Couchbase.Lite

Assembly: Couchbase.Lite.dll

Syntax

public interface IMutableArray : IArray, IArrayFragment, IEnumerable<object>, IMutableArrayFragment

Properties

Item[Int32]

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

Declaration

IMutableFragment this[int index] { get; }

Parameters

Type	Name	Description
System.Int32	index	The index to check

Property Value

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

Methods

AddArray(ArrayObject)

Adds an entry to this collection

Declaration

IMutableArray AddArray(ArrayObject value)

Parameters

Type	Name	Description
ArrayObject	value	The value to add

Returns

Type	Description
IMutableArray	The array for further processing

AddBlob(Blob)

Adds an entry to this collection

Declaration

IMutableArray AddBlob(Blob value)

Parameters

Type	Name	Description
Blob	value	The value to add

Returns

Type	Description
IMutableArray	The array for further processing

AddBoolean(Boolean)

Adds an entry to this collection

Declaration

IMutableArray AddBoolean(bool value)

Parameters

Type	Name	Description
System.Boolean	value	The value to add

Returns

Type	Description
IMutableArray	The array for further processing

AddDate(DateTimeOffset)

Adds an entry to this collection

Declaration

IMutableArray AddDate(DateTimeOffset value)

Parameters

Type	Name	Description
DateTimeOffset	value	The value to add

Returns

Type	Description
IMutableArray	The array for further processing

AddDictionary(DictionaryObject)

Adds an entry to this collection

Declaration

IMutableArray AddDictionary(DictionaryObject value)

Parameters

Type	Name	Description
DictionaryObject	value	The value to add

Returns

Type	Description
IMutableArray	The array for further processing

AddDouble(Double)

Adds an entry to this collection

Declaration

IMutableArray AddDouble(double value)

Parameters

Type	Name	Description
System.Double	value	The value to add

Returns

Type	Description
IMutableArray	The array for further processing

AddFloat(Single)

Adds an entry to this collection

Declaration

IMutableArray AddFloat(float value)

Parameters

Type	Name	Description
System.Single	value	The value to add

Returns

Type	Description
IMutableArray	The array for further processing

AddInt(Int32)

Adds an entry to this collection

Declaration

IMutableArray AddInt(int value)

Parameters

Type	Name	Description
System.Int32	value	The value to add

Returns

Type	Description
IMutableArray	The array for further processing

AddLong(Int64)

Adds an entry to this collection

Declaration

IMutableArray AddLong(long value)

Parameters

Type	Name	Description
System.Int64	value	The value to add

Returns

Type	Description
IMutableArray	The array for further processing

AddString(String)

Adds an entry to this collection

Declaration

IMutableArray AddString(string value)

Parameters

Type	Name	Description
System.String	value	The value to add

Returns

Type	Description
IMutableArray	The array for further processing

AddValue(Object)

Adds an entry to this collection

Declaration

IMutableArray AddValue(object value)

Parameters

Type	Name	Description
System.Object	value	The value to add

Returns

Type	Description
IMutableArray	The array for further processing

GetArray(Int32)

Gets the value at the given index as an array

Declaration

MutableArrayObject GetArray(int index)

Parameters

Type	Name	Description
System.Int32	index	The index to lookup

Returns

Type	Description
MutableArrayObject	The value at the index, or null

GetDictionary(Int32)

Gets the value at the given index as a dictionary

Declaration

MutableDictionaryObject GetDictionary(int index)

Parameters

Type	Name	Description
System.Int32	index	The index to lookup

Returns

Type	Description
MutableDictionaryObject	The value at the index, or null

InsertArray(Int32, ArrayObject)

Inserts a given value at the given index

Declaration

IMutableArray InsertArray(int index, ArrayObject value)

Parameters

Type	Name	Description
System.Int32	index	The index to insert the item at
ArrayObject	value	The item to insert

Returns

Type	Description
IMutableArray	The array for further processing

InsertBlob(Int32, Blob)

Inserts a given value at the given index

Declaration

IMutableArray InsertBlob(int index, Blob value)

Parameters

Type	Name	Description
System.Int32	index	The index to insert the item at
Blob	value	The item to insert

Returns

Type	Description
IMutableArray	The array for further processing

InsertBoolean(Int32, Boolean)

Inserts a given value at the given index

Declaration

IMutableArray InsertBoolean(int index, bool value)

Parameters

Type	Name	Description
System.Int32	index	The index to insert the item at
System.Boolean	value	The item to insert

Returns

Type	Description
IMutableArray	The array for further processing

InsertDate(Int32, DateTimeOffset)

Inserts a given value at the given index

Declaration

IMutableArray InsertDate(int index, DateTimeOffset value)

Parameters

Type	Name	Description
System.Int32	index	The index to insert the item at
DateTimeOffset	value	The item to insert

Returns

Type	Description
IMutableArray	The array for further processing

InsertDictionary(Int32, DictionaryObject)

Inserts a given value at the given index

Declaration

IMutableArray InsertDictionary(int index, DictionaryObject value)

Parameters

Type	Name	Description
System.Int32	index	The index to insert the item at
DictionaryObject	value	The item to insert

Returns

Type	Description
IMutableArray	The array for further processing

InsertDouble(Int32, Double)

Inserts a given value at the given index

Declaration

IMutableArray InsertDouble(int index, double value)

Parameters

Type	Name	Description
System.Int32	index	The index to insert the item at
System.Double	value	The item to insert

Returns

Type	Description
IMutableArray	The array for further processing

InsertFloat(Int32, Single)

Inserts a given value at the given index

Declaration

IMutableArray InsertFloat(int index, float value)

Parameters

Type	Name	Description
System.Int32	index	The index to insert the item at
System.Single	value	The item to insert

Returns

Type	Description
IMutableArray	The array for further processing

InsertInt(Int32, Int32)

Inserts a given value at the given index

Declaration

IMutableArray InsertInt(int index, int value)

Parameters

Type	Name	Description
System.Int32	index	The index to insert the item at
System.Int32	value	The item to insert

Returns

Type	Description
IMutableArray	The array for further processing

InsertLong(Int32, Int64)

Inserts a given value at the given index

Declaration

IMutableArray InsertLong(int index, long value)

Parameters

Type	Name	Description
System.Int32	index	The index to insert the item at
System.Int64	value	The item to insert

Returns

Type	Description
IMutableArray	The array for further processing

InsertString(Int32, String)

Inserts a given value at the given index

Declaration

IMutableArray InsertString(int index, string value)

Parameters

Type	Name	Description
System.Int32	index	The index to insert the item at
System.String	value	The item to insert

Returns

Type	Description
IMutableArray	The array for further processing

InsertValue(Int32, Object)

Inserts a given value at the given index

Declaration

IMutableArray InsertValue(int index, object value)

Parameters

Type	Name	Description
System.Int32	index	The index to insert the item at
System.Object	value	The item to insert

Returns

Type	Description
IMutableArray	The array for further processing

RemoveAt(Int32)

Removes the item at the given index

Declaration

IMutableArray RemoveAt(int index)

Parameters

Type	Name	Description
System.Int32	index	The index at which to remove the item

Returns

Type	Description
IMutableArray	The array for further processing

SetArray(Int32, ArrayObject)

Overwrites the value at the given index with the given value

Declaration

IMutableArray SetArray(int index, ArrayObject value)

Parameters

Type	Name	Description
System.Int32	index	The index to overwrite
ArrayObject	value	The value to insert

Returns

Type	Description
IMutableArray	The array for further processing

SetBlob(Int32, Blob)

Overwrites the value at the given index with the given value

Declaration

IMutableArray SetBlob(int index, Blob value)

Parameters

Type	Name	Description
System.Int32	index	The index to overwrite
Blob	value	The value to insert

Returns

Type	Description
IMutableArray	The array for further processing

SetBoolean(Int32, Boolean)

Overwrites the value at the given index with the given value

Declaration

IMutableArray SetBoolean(int index, bool value)

Parameters

Type	Name	Description
System.Int32	index	The index to overwrite
System.Boolean	value	The value to insert

Returns

Type	Description
IMutableArray	The array for further processing

SetData(IList)

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

Declaration

IMutableArray SetData(IList array)

Parameters

Type	Name	Description
IList	array	The contents to replace the current contents

Returns

Type	Description
IMutableArray	The array for further processing

SetDate(Int32, DateTimeOffset)

Overwrites the value at the given index with the given value

Declaration

IMutableArray SetDate(int index, DateTimeOffset value)

Parameters

Type	Name	Description
System.Int32	index	The index to overwrite
DateTimeOffset	value	The value to insert

Returns

Type	Description
IMutableArray	The array for further processing

SetDictionary(Int32, DictionaryObject)

Overwrites the value at the given index with the given value

Declaration

IMutableArray SetDictionary(int index, DictionaryObject value)

Parameters

Type	Name	Description
System.Int32	index	The index to overwrite
DictionaryObject	value	The value to insert

Returns

Type	Description
IMutableArray	The array for further processing

SetDouble(Int32, Double)

Overwrites the value at the given index with the given value

Declaration

IMutableArray SetDouble(int index, double value)

Parameters

Type	Name	Description
System.Int32	index	The index to overwrite
System.Double	value	The value to insert

Returns

Type	Description
IMutableArray	The array for further processing

SetFloat(Int32, Single)

Overwrites the value at the given index with the given value

Declaration

IMutableArray SetFloat(int index, float value)

Parameters

Type	Name	Description
System.Int32	index	The index to overwrite
System.Single	value	The value to insert

Returns

Type	Description
IMutableArray	The array for further processing

SetInt(Int32, Int32)

Overwrites the value at the given index with the given value

Declaration

IMutableArray SetInt(int index, int value)

Parameters

Type	Name	Description
System.Int32	index	The index to overwrite
System.Int32	value	The value to insert

Returns

Type	Description
IMutableArray	The array for further processing

SetJSON(String)

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

Declaration

IMutableArray SetJSON(string json)

Parameters

Type	Name	Description
System.String	json	The json string to replace the current contents with

Returns

Type	Description
IMutableArray	The array for further processing

Remarks

json string must be constructed from ToJSON()

SetLong(Int32, Int64)

Overwrites the value at the given index with the given value

Declaration

IMutableArray SetLong(int index, long value)

Parameters

Type	Name	Description
System.Int32	index	The index to overwrite
System.Int64	value	The value to insert

Returns

Type	Description
IMutableArray	The array for further processing

SetString(Int32, String)

Overwrites the value at the given index with the given value

Declaration

IMutableArray SetString(int index, string value)

Parameters

Type	Name	Description
System.Int32	index	The index to overwrite
System.String	value	The value to insert

Returns

Type	Description
IMutableArray	The array for further processing

SetValue(Int32, Object)

Overwrites the value at the given index with the given value

Declaration

IMutableArray SetValue(int index, object value)

Parameters

Type	Name	Description
System.Int32	index	The index to overwrite
System.Object	value	The value to insert

Returns

Type	Description
IMutableArray	The array for further processing