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

DocumentReference

@Serializable(with = DocumentReferenceSerializer::class)

data class DocumentReference(source)

A class representing a Firebase DocumentReference.

Types

Companion

object Companion

Properties

android

val DocumentReference.android: DocumentReference

The underlying Firebase Android SDK object.

compat

val compat: DocumentReference

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

val id: String

ios

val DocumentReference.ios: FIRDocumentReference

The underlying Firebase iOS SDK object.

val DocumentReference.js: DocumentReference

The underlying Firebase JS SDK object.

val DocumentReference.js: DocumentReference

The underlying Firebase JS SDK object.

parent

val parent: CollectionReference

path

val path: String

snapshots

val snapshots: Flow<DocumentSnapshot>

Functions

collection

fun collection(collectionPath: String): CollectionReference

delete

suspend fun delete()

get

suspend fun get(source: Source = Source.DEFAULT): DocumentSnapshot

set

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

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

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

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

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

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

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

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

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

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

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

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

snapshots

fun snapshots(includeMetadataChanges: Boolean = false): Flow<DocumentSnapshot>

update

@JvmName(name = "updateFieldPaths")

suspend fun update(vararg fieldsAndValues: Pair<FieldPath, Any?>)

@JvmName(name = "updateFields")

suspend fun ~~update~~(vararg fieldsAndValues: Pair<String, Any?>)

inline suspend fun <T : Any> ~~update~~(data: T, encodeDefaults: Boolean)

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

@JvmName(name = "updateFieldPaths")

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

@JvmName(name = "updateFields")

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

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

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

updateFields

suspend fun updateFields(fieldsAndValuesUpdateDSL: FieldsAndValuesUpdateDSL.() -> Unit)

Updates Fields/FieldPath using a FieldsAndValuesUpdateDSL.