firebase-firestore/com.google.firebase.firestore/FieldValue/Companion

Companion

actual object Companion(source)

expect object Companion(source)

actual object Companion(source)

Functions

arrayRemove

@JvmStatic

actual fun arrayRemove(vararg elements: Any): FieldValue

Removes elements from the array field.

expect fun arrayRemove(vararg elements: Any): FieldValue

Removes elements from the array field.

actual fun arrayRemove(vararg elements: Any): FieldValue

Removes elements from the array field.

arrayUnion

@JvmStatic

actual fun arrayUnion(vararg elements: Any): FieldValue

Adds elements to the array field, without duplicates.

expect fun arrayUnion(vararg elements: Any): FieldValue

Adds elements to the array field, without duplicates.

actual fun arrayUnion(vararg elements: Any): FieldValue

Adds elements to the array field, without duplicates.

delete

@JvmStatic

actual fun delete(): FieldValue

Deletes the field (in an update or merge).

expect fun delete(): FieldValue

Deletes the field (in an update or merge).

actual fun delete(): FieldValue

Deletes the field (in an update or merge).

increment

@JvmStatic

actual fun increment(d: Double): FieldValue

Adds d to the numeric field.

@JvmStatic

actual fun increment(l: Long): FieldValue

Adds l to the numeric field.

expect fun increment(d: Double): FieldValue

Adds d to the numeric field.

expect fun increment(l: Long): FieldValue

Adds l to the numeric field.

actual fun increment(d: Double): FieldValue

Adds d to the numeric field.

actual fun increment(l: Long): FieldValue

Adds l to the numeric field.

maximum

@JvmStatic

actual fun maximum(d: Double): FieldValue

Sets the numeric field to the larger of its value and d; a field that is absent or not a number is set to d.

@JvmStatic

actual fun maximum(l: Long): FieldValue

Sets the numeric field to the larger of its value and l; a field that is absent or not a number is set to l.

expect fun maximum(d: Double): FieldValue

Sets the numeric field to the larger of its value and d; a field that is absent or not a number is set to d.

expect fun maximum(l: Long): FieldValue

Sets the numeric field to the larger of its value and l; a field that is absent or not a number is set to l.

actual fun maximum(d: Double): FieldValue

Sets the numeric field to the larger of its value and d; a field that is absent or not a number is set to d.

actual fun maximum(l: Long): FieldValue

Sets the numeric field to the larger of its value and l; a field that is absent or not a number is set to l.

minimum

@JvmStatic

actual fun minimum(d: Double): FieldValue

Sets the numeric field to the smaller of its value and d; a field that is absent or not a number is set to d.

@JvmStatic

actual fun minimum(l: Long): FieldValue

Sets the numeric field to the smaller of its value and l; a field that is absent or not a number is set to l.

expect fun minimum(d: Double): FieldValue

Sets the numeric field to the smaller of its value and d; a field that is absent or not a number is set to d.

expect fun minimum(l: Long): FieldValue

Sets the numeric field to the smaller of its value and l; a field that is absent or not a number is set to l.

actual fun minimum(d: Double): FieldValue

Sets the numeric field to the smaller of its value and d; a field that is absent or not a number is set to d.

actual fun minimum(l: Long): FieldValue

Sets the numeric field to the smaller of its value and l; a field that is absent or not a number is set to l.

serverTimestamp

@JvmStatic

actual fun serverTimestamp(): FieldValue

The time the write reaches the backend.

expect fun serverTimestamp(): FieldValue

The time the write reaches the backend.

actual fun serverTimestamp(): FieldValue

The time the write reaches the backend.

vector

@JvmStatic

actual fun vector(values: DoubleArray): VectorValue

A VectorValue of a copy of values, such as an embedding for vector search.

expect fun vector(values: DoubleArray): VectorValue

A VectorValue of a copy of values, such as an embedding for vector search.

actual fun vector(values: DoubleArray): VectorValue

A VectorValue of a copy of values, such as an embedding for vector search.