firebase-firestore/com.google.firebase.firestore/WriteBatch

WriteBatch

actual class WriteBatch(source)

A batch of writes, mirroring com.google.firebase.firestore.WriteBatch from the Firebase Android SDK: applied atomically by commit.

actual class WriteBatch(source)

expect class WriteBatch(source)

A batch of writes, mirroring com.google.firebase.firestore.WriteBatch from the Firebase Android SDK: applied atomically by commit.

actual class WriteBatch(source)

actual class WriteBatch(source)

Types

actual fun interface Function

A function that fills a WriteBatch, for FirebaseFirestore.runBatch.

actual fun interface Function

A function that fills a WriteBatch, for FirebaseFirestore.runBatch.

expect fun interface Function

A function that fills a WriteBatch, for FirebaseFirestore.runBatch.

actual fun interface Function

A function that fills a WriteBatch, for FirebaseFirestore.runBatch.

actual fun interface Function

A function that fills a WriteBatch, for FirebaseFirestore.runBatch.

Properties

val ios: FIRWriteBatch

The underlying Firebase iOS SDK object.

val js: WriteBatch

The underlying Firebase JS SDK object.

val js: WriteBatch

The underlying Firebase JS SDK object.

Functions

actual fun commit(): Task<Nothing?>

Applies the writes atomically.

actual fun commit(): Task<Nothing?>

Applies the writes atomically.

expect fun commit(): Task<Nothing?>

Applies the writes atomically.

actual fun commit(): Task<Nothing?>

Applies the writes atomically.

actual fun commit(): Task<Nothing?>

Applies the writes atomically.

actual fun delete(documentRef: DocumentReference): WriteBatch

Deletes documentRef.

actual fun delete(documentRef: DocumentReference): WriteBatch

Deletes documentRef.

expect fun delete(documentRef: DocumentReference): WriteBatch

Deletes documentRef.

actual fun delete(documentRef: DocumentReference): WriteBatch

Deletes documentRef.

actual fun delete(documentRef: DocumentReference): WriteBatch

Deletes documentRef.

actual fun set(documentRef: DocumentReference, data: Any): WriteBatch

Writes data (a map of field values) to documentRef, replacing the document.

actual fun set(documentRef: DocumentReference, data: Any, options: SetOptions): WriteBatch

Writes data (a map of field values) to documentRef according to options.

actual fun set(documentRef: DocumentReference, data: Any): WriteBatch

Writes data (a map of field values) to documentRef, replacing the document.

actual fun set(documentRef: DocumentReference, data: Any, options: SetOptions): WriteBatch

Writes data (a map of field values) to documentRef according to options.

expect fun set(documentRef: DocumentReference, data: Any): WriteBatch

Writes data (a map of field values) to documentRef, replacing the document.

expect fun set(documentRef: DocumentReference, data: Any, options: SetOptions): WriteBatch

Writes data (a map of field values) to documentRef according to options.

actual fun set(documentRef: DocumentReference, data: Any): WriteBatch

Writes data (a map of field values) to documentRef, replacing the document.

actual fun set(documentRef: DocumentReference, data: Any, options: SetOptions): WriteBatch

Writes data (a map of field values) to documentRef according to options.

actual fun set(documentRef: DocumentReference, data: Any): WriteBatch

Writes data (a map of field values) to documentRef, replacing the document.

actual fun set(documentRef: DocumentReference, data: Any, options: SetOptions): WriteBatch

Writes data (a map of field values) to documentRef according to options.

actual fun update(documentRef: DocumentReference, data: Map<String, Any?>): WriteBatch

Updates the fields in data of documentRef; fails if the document does not exist.

actual fun update(documentRef: DocumentReference, fieldPath: FieldPath, value: Any?, vararg moreFieldsAndValues: Any?): WriteBatch

Updates fieldPath of documentRef to value and the further field path/value pairs in moreFieldsAndValues.

actual fun update(documentRef: DocumentReference, field: String, value: Any?, vararg moreFieldsAndValues: Any?): WriteBatch

Updates field of documentRef to value and the further field/value pairs in moreFieldsAndValues.

actual fun update(documentRef: DocumentReference, data: Map<String, Any?>): WriteBatch

Updates the fields in data of documentRef; fails if the document does not exist.

actual fun update(documentRef: DocumentReference, fieldPath: FieldPath, value: Any?, vararg moreFieldsAndValues: Any?): WriteBatch

Updates fieldPath of documentRef to value and the further field path/value pairs in moreFieldsAndValues.

actual fun update(documentRef: DocumentReference, field: String, value: Any?, vararg moreFieldsAndValues: Any?): WriteBatch

Updates field of documentRef to value and the further field/value pairs in moreFieldsAndValues.

expect fun update(documentRef: DocumentReference, data: Map<String, Any?>): WriteBatch

Updates the fields in data of documentRef; fails if the document does not exist.

expect fun update(documentRef: DocumentReference, fieldPath: FieldPath, value: Any?, vararg moreFieldsAndValues: Any?): WriteBatch

Updates fieldPath of documentRef to value and the further field path/value pairs in moreFieldsAndValues.

expect fun update(documentRef: DocumentReference, field: String, value: Any?, vararg moreFieldsAndValues: Any?): WriteBatch

Updates field of documentRef to value and the further field/value pairs in moreFieldsAndValues.

actual fun update(documentRef: DocumentReference, data: Map<String, Any?>): WriteBatch

Updates the fields in data of documentRef; fails if the document does not exist.

actual fun update(documentRef: DocumentReference, fieldPath: FieldPath, value: Any?, vararg moreFieldsAndValues: Any?): WriteBatch

Updates fieldPath of documentRef to value and the further field path/value pairs in moreFieldsAndValues.

actual fun update(documentRef: DocumentReference, field: String, value: Any?, vararg moreFieldsAndValues: Any?): WriteBatch

Updates field of documentRef to value and the further field/value pairs in moreFieldsAndValues.

actual fun update(documentRef: DocumentReference, data: Map<String, Any?>): WriteBatch

Updates the fields in data of documentRef; fails if the document does not exist.

actual fun update(documentRef: DocumentReference, fieldPath: FieldPath, value: Any?, vararg moreFieldsAndValues: Any?): WriteBatch

Updates fieldPath of documentRef to value and the further field path/value pairs in moreFieldsAndValues.

actual fun update(documentRef: DocumentReference, field: String, value: Any?, vararg moreFieldsAndValues: Any?): WriteBatch

Updates field of documentRef to value and the further field/value pairs in moreFieldsAndValues.