firebase-firestore/dev.gitlive.firebase.firestore/FieldsAndValuesUpdateDSL

FieldsAndValuesUpdateDSL

class FieldsAndValuesUpdateDSL : EncodeSettings.Builder(source)

A builder for generating a collection of updates to a document. Updates can be applied to either a String field or to a FieldPath. Within this builder custom serialization can be applied to the update.

val update: FieldsAndValuesUpdateBuilder.() -> Unit = {
   "path" to 1
   FieldPath("subpath", "field") to "value"
   "otherPath".to(strategy, value)
}

Properties

encodeDefaults

open override var encodeDefaults: Boolean

serializersModule

open override var serializersModule: SerializersModule

Functions

infix inline fun <T> FieldPath.to(value: T)

fun <T : Any> FieldPath.to(strategy: SerializationStrategy<T>, value: T)

Updates a FieldPath to a given value The value will be encoded according to the EncodeSettings set by this builder.

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

fun <T : Any> String.to(strategy: SerializationStrategy<T>, value: T)

Updates the field represented by a String to a given value The value will be encoded according to the EncodeSettings set by this builder.

withEncodeSettings

fun withEncodeSettings(dls: FieldsAndValuesUpdateDSL.() -> Unit)

Provides an accessor for encoding values with EncodeSettings