firebase-firestore/dev.gitlive.firebase.firestore/DocumentReference

DocumentReference

@Serializable(with = DocumentReferenceSerializer::class)
data class DocumentReference(source)

A class representing a Firebase DocumentReference.

Properties

Link copied to clipboard
val DocumentReference.android: DocumentReference
val DocumentReference.android: DocumentReference
Link copied to clipboard
val id: String
Link copied to clipboard
val DocumentReference.ios: <Error class: unknown class>
Link copied to clipboard
val DocumentReference.js: DocumentReference
Link copied to clipboard
Link copied to clipboard
val path: String
Link copied to clipboard

Functions

Link copied to clipboard
fun collection(collectionPath: String): CollectionReference
Link copied to clipboard
suspend fun delete()
Link copied to clipboard
suspend fun get(source: Source = Source.DEFAULT): DocumentSnapshot
Link copied to clipboard
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 = {})
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, 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(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 = {})
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)
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 = {})
Link copied to clipboard
fun snapshots(includeMetadataChanges: Boolean = false): Flow<DocumentSnapshot>
Link copied to clipboard
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")
inline suspend fun update(vararg fieldsAndValues: Pair<FieldPath, Any?>, buildSettings: EncodeSettings.Builder.() -> Unit = {})
@JvmName(name = "updateFields")
inline 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 = {})