couchbase-lite-ktx/kotbase.ktx/DocumentBuilder

DocumentBuilder

Functions

fun getArray(key: String): MutableArray?

Get a property's value as an Array, which is a mapping object of an array value. Returns null if the property doesn't exist, or its value is not an array.

getDictionary

fun getDictionary(key: String): MutableDictionary?

Get a property's value as a Dictionary, which is a mapping object of a dictionary value. Returns null if the property doesn't exist, or its value is not a dictionary.

remove

fun remove(key: String): MutableDocument

Removes the mapping for a key from this Dictionary

setArray

fun setArray(key: String, value: Array?): MutableDocument

Set an Array value for the given key

setBlob

fun setBlob(key: String, value: Blob?): MutableDocument

Set a Blob value for the given key

setBoolean

fun setBoolean(key: String, value: Boolean): MutableDocument

Set a boolean value for the given key

setData

fun setData(data: Map<String, Any?>): MutableDocument

Populate a document with content from a Map. Allowed value types are List, Date, Map, Number, null, String, Array, Blob, and Dictionary. If present, Lists, Maps and Dictionaries may contain only the above types. Setting the document content will replace the current data including the existing Array and Dictionary objects.

setDate

fun setDate(key: String, value: Instant?): MutableDocument

Set a Date value for the given key

setDictionary

fun setDictionary(key: String, value: Dictionary?): MutableDocument

Set a Dictionary value for the given key

setDouble

fun setDouble(key: String, value: Double): MutableDocument

Set a double value for the given key

setFloat

fun setFloat(key: String, value: Float): MutableDocument

Set a float value for the given key

setInt

fun setInt(key: String, value: Int): MutableDocument

Set an integer value for the given key

setJSON

fun setJSON(json: String): MutableDocument

Populate a document with content from a JSON string. Allowed value types are List, Date, Map, Number, null, String, Array, Blob, and Dictionary. If present, Lists, Maps and Dictionaries may contain only the above types. Setting the document content will replace the current data including the existing Array and Dictionary objects.

setLong

fun setLong(key: String, value: Long): MutableDocument

Set a long value for the given key

setNumber

fun setNumber(key: String, value: Number): MutableDocument

Set a Number value for the given key

setString

fun setString(key: String, value: String): MutableDocument

Set a String value for the given key

setValue

fun setValue(key: String, value: Any?): MutableDocument

Set an object value by key. Allowed value types are List, Date, Map, Number, null, String, Array, Blob, and Dictionary. If present, Lists, Maps and Dictionaries may contain only the above types. A Date object will be converted to an ISO-8601 format string.

infix fun <T> String.to(value: T)

Determines the key-to-value relation between the receiver string and the provided value.