firebase-firestore/io.github.corneloaie.firebase.firestore/WriteBatch

WriteBatch

data class WriteBatch(source)

Types

object Companion

Properties

val WriteBatch.android: WriteBatch

The underlying Firebase Android SDK object.

val compat: WriteBatch

The Android-SDK-shaped com.google.firebase.firestore.WriteBatch this wraps.

val WriteBatch.ios: FIRWriteBatch

The underlying Firebase iOS SDK object.

val WriteBatch.js: WriteBatch

The underlying Firebase JS SDK object.

val WriteBatch.js: WriteBatch

The underlying Firebase JS SDK object.

Functions

suspend fun commit()

fun delete(documentRef: DocumentReference): WriteBatch

inline fun <T : Any> ~~set~~(documentRef: DocumentReference, data: T, encodeDefaults: Boolean, merge: Boolean = false): WriteBatch

inline fun <T : Any> set(documentRef: DocumentReference, data: T, merge: Boolean = false, buildSettings: EncodeSettings.Builder.() -> Unit = {}): WriteBatch

inline fun <T : Any> ~~set~~(documentRef: DocumentReference, data: T, encodeDefaults: Boolean, vararg mergeFieldPaths: FieldPath): WriteBatch

inline fun <T : Any> ~~set~~(documentRef: DocumentReference, data: T, encodeDefaults: Boolean, vararg mergeFields: String): WriteBatch

inline fun <T : Any> set(documentRef: DocumentReference, data: T, vararg mergeFieldPaths: FieldPath, buildSettings: EncodeSettings.Builder.() -> Unit = {}): WriteBatch

inline fun <T : Any> set(documentRef: DocumentReference, data: T, vararg mergeFields: String, buildSettings: EncodeSettings.Builder.() -> Unit = {}): WriteBatch

fun <T : Any> ~~set~~(documentRef: DocumentReference, strategy: SerializationStrategy<T>, data: T, encodeDefaults: Boolean, merge: Boolean = false): WriteBatch

inline fun <T : Any> set(documentRef: DocumentReference, strategy: SerializationStrategy<T>, data: T, merge: Boolean = false, buildSettings: EncodeSettings.Builder.() -> Unit = {}): WriteBatch

fun <T : Any> ~~set~~(documentRef: DocumentReference, strategy: SerializationStrategy<T>, data: T, encodeDefaults: Boolean, vararg mergeFieldPaths: FieldPath): WriteBatch

fun <T : Any> ~~set~~(documentRef: DocumentReference, strategy: SerializationStrategy<T>, data: T, encodeDefaults: Boolean, vararg mergeFields: String): WriteBatch

inline fun <T : Any> set(documentRef: DocumentReference, strategy: SerializationStrategy<T>, data: T, vararg mergeFieldPaths: FieldPath, buildSettings: EncodeSettings.Builder.() -> Unit = {}): WriteBatch

inline fun <T : Any> set(documentRef: DocumentReference, strategy: SerializationStrategy<T>, data: T, vararg mergeFields: String, buildSettings: EncodeSettings.Builder.() -> Unit = {}): WriteBatch

@JvmName(name = "updateFieldPath")

fun ~~update~~(documentRef: DocumentReference, vararg fieldsAndValues: Pair<FieldPath, Any?>): WriteBatch

@JvmName(name = "updateField")

fun ~~update~~(documentRef: DocumentReference, vararg fieldsAndValues: Pair<String, Any?>): WriteBatch

inline fun <T : Any> ~~update~~(documentRef: DocumentReference, data: T, encodeDefaults: Boolean): WriteBatch

inline fun <T : Any> update(documentRef: DocumentReference, data: T, buildSettings: EncodeSettings.Builder.() -> Unit = {}): WriteBatch

@JvmName(name = "updateFieldPath")

fun ~~update~~(documentRef: DocumentReference, vararg fieldsAndValues: Pair<FieldPath, Any?>, buildSettings: EncodeSettings.Builder.() -> Unit): WriteBatch

@JvmName(name = "updateField")

fun ~~update~~(documentRef: DocumentReference, vararg fieldsAndValues: Pair<String, Any?>, buildSettings: EncodeSettings.Builder.() -> Unit): WriteBatch

fun <T : Any> ~~update~~(documentRef: DocumentReference, strategy: SerializationStrategy<T>, data: T, encodeDefaults: Boolean): WriteBatch

inline fun <T : Any> update(documentRef: DocumentReference, strategy: SerializationStrategy<T>, data: T, buildSettings: EncodeSettings.Builder.() -> Unit = {}): WriteBatch

fun updateFields(documentRef: DocumentReference, fieldsAndValuesUpdateDSL: FieldsAndValuesUpdateDSL.() -> Unit): WriteBatch

Updates Fields/FieldPath of a DocumentReference using a FieldsAndValuesUpdateDSL.