firebase-firestore/com.google.firebase.firestore/DocumentSnapshot

DocumentSnapshot

actual open class DocumentSnapshot(source)

The data of a document read from Firestore, mirroring com.google.firebase.firestore.DocumentSnapshot from the Firebase Android SDK. Field values are the Firestore types: Boolean, Long, Double, String, Timestamp, GeoPoint, Blob, DocumentReference, VectorValue, List and Map, and the BSON types BsonObjectId, BsonTimestamp, Decimal128Value, Int32Value, MaxKey, MinKey and RegexValue, as on Android; a document that does not exist has no data.

Not mirrored: the reflective mapping to custom classes (toObject, get(field, Class)) and the Date accessors (see api/android-sdk/exclusions.txt); use the reified toObject and getField of the Kotlin extensions and getTimestamp instead.

Types

ServerTimestampBehavior

actual enum ServerTimestampBehavior : Enum<DocumentSnapshot.ServerTimestampBehavior>

How a server timestamp that has not been written to the backend yet is read.

actual enum ServerTimestampBehavior : Enum<DocumentSnapshot.ServerTimestampBehavior>

How a server timestamp that has not been written to the backend yet is read.

expect enum ServerTimestampBehavior : Enum<DocumentSnapshot.ServerTimestampBehavior>

How a server timestamp that has not been written to the backend yet is read.

actual enum ServerTimestampBehavior : Enum<DocumentSnapshot.ServerTimestampBehavior>

How a server timestamp that has not been written to the backend yet is read.

actual enum ServerTimestampBehavior : Enum<DocumentSnapshot.ServerTimestampBehavior>

How a server timestamp that has not been written to the backend yet is read.

Properties

data

actual val data: Map<String, Any?>?

The fields as a map, or null when the document does not exist.

actual val data: Map<String, Any?>?

The fields as a map, or null when the document does not exist.

expect val data: Map<String, Any?>?

The fields as a map, or null when the document does not exist.

actual val data: Map<String, Any?>?

The fields as a map, or null when the document does not exist.

actual val data: Map<String, Any?>?

The fields as a map, or null when the document does not exist.

actual val id: String

The document id.

actual val id: String

The document id.

expect val id: String

The document id.

actual val id: String

The document id.

actual val id: String

The document id.

ios

open val ios: FIRDocumentSnapshot

The underlying Firebase iOS SDK object.

open val js: DocumentSnapshot

The underlying Firebase JS SDK object.

open val js: DocumentSnapshot

The underlying Firebase JS SDK object.

metadata

actual val metadata: SnapshotMetadata

Whether the snapshot is from the cache or has pending writes.

actual val metadata: SnapshotMetadata

Whether the snapshot is from the cache or has pending writes.

expect val metadata: SnapshotMetadata

Whether the snapshot is from the cache or has pending writes.

actual val metadata: SnapshotMetadata

Whether the snapshot is from the cache or has pending writes.

actual val metadata: SnapshotMetadata

Whether the snapshot is from the cache or has pending writes.

reference

actual val reference: DocumentReference

The reference of the document.

actual val reference: DocumentReference

The reference of the document.

expect val reference: DocumentReference

The reference of the document.

actual val reference: DocumentReference

The reference of the document.

actual val reference: DocumentReference

The reference of the document.

Functions

contains

actual fun contains(fieldPath: FieldPath): Boolean

Whether the document has fieldPath.

actual fun contains(field: String): Boolean

Whether the document has field (a .-separated path).

actual fun contains(fieldPath: FieldPath): Boolean

Whether the document has fieldPath.

actual fun contains(field: String): Boolean

Whether the document has field (a .-separated path).

expect fun contains(fieldPath: FieldPath): Boolean

Whether the document has fieldPath.

expect fun contains(field: String): Boolean

Whether the document has field (a .-separated path).

actual fun contains(fieldPath: FieldPath): Boolean

Whether the document has fieldPath.

actual fun contains(field: String): Boolean

Whether the document has field (a .-separated path).

actual fun contains(fieldPath: FieldPath): Boolean

Whether the document has fieldPath.

actual fun contains(field: String): Boolean

Whether the document has field (a .-separated path).

equals

open operator override fun equals(other: Any?): Boolean

The JS SDK creates a new object per read, so snapshots are equal when they are of the same document and data.

open operator override fun equals(other: Any?): Boolean

The JS SDK creates a new object per read, so snapshots are equal when they are of the same document and data.

exists

actual fun exists(): Boolean

Whether the document exists.

actual fun exists(): Boolean

Whether the document exists.

expect fun exists(): Boolean

Whether the document exists.

actual fun exists(): Boolean

Whether the document exists.

actual fun exists(): Boolean

Whether the document exists.

get

actual fun get(fieldPath: FieldPath): Any?

The value of fieldPath, or null.

actual fun get(field: String): Any?

The value of field (a .-separated path), or null.

actual fun get(fieldPath: FieldPath, serverTimestampBehavior: DocumentSnapshot.ServerTimestampBehavior): Any?

The value of fieldPath with server timestamps resolved per serverTimestampBehavior.

actual fun get(field: String, serverTimestampBehavior: DocumentSnapshot.ServerTimestampBehavior): Any?

The value of field with server timestamps resolved per serverTimestampBehavior.

actual fun get(fieldPath: FieldPath): Any?

The value of fieldPath, or null.

actual fun get(field: String): Any?

The value of field (a .-separated path), or null.

actual fun get(fieldPath: FieldPath, serverTimestampBehavior: DocumentSnapshot.ServerTimestampBehavior): Any?

The value of fieldPath with server timestamps resolved per serverTimestampBehavior.

actual fun get(field: String, serverTimestampBehavior: DocumentSnapshot.ServerTimestampBehavior): Any?

The value of field with server timestamps resolved per serverTimestampBehavior.

expect fun get(fieldPath: FieldPath): Any?

The value of fieldPath, or null.

expect fun get(field: String): Any?

The value of field (a .-separated path), or null.

expect fun get(fieldPath: FieldPath, serverTimestampBehavior: DocumentSnapshot.ServerTimestampBehavior): Any?

The value of fieldPath with server timestamps resolved per serverTimestampBehavior.

expect fun get(field: String, serverTimestampBehavior: DocumentSnapshot.ServerTimestampBehavior): Any?

The value of field with server timestamps resolved per serverTimestampBehavior.

actual fun get(fieldPath: FieldPath): Any?

The value of fieldPath, or null.

actual fun get(field: String): Any?

The value of field (a .-separated path), or null.

actual fun get(fieldPath: FieldPath, serverTimestampBehavior: DocumentSnapshot.ServerTimestampBehavior): Any?

The value of fieldPath with server timestamps resolved per serverTimestampBehavior.

actual fun get(field: String, serverTimestampBehavior: DocumentSnapshot.ServerTimestampBehavior): Any?

The value of field with server timestamps resolved per serverTimestampBehavior.

actual fun get(fieldPath: FieldPath): Any?

The value of fieldPath, or null.

actual fun get(field: String): Any?

The value of field (a .-separated path), or null.

actual fun get(fieldPath: FieldPath, serverTimestampBehavior: DocumentSnapshot.ServerTimestampBehavior): Any?

The value of fieldPath with server timestamps resolved per serverTimestampBehavior.

actual fun get(field: String, serverTimestampBehavior: DocumentSnapshot.ServerTimestampBehavior): Any?

The value of field with server timestamps resolved per serverTimestampBehavior.

getBlob

actual fun getBlob(field: String): Blob?

expect fun getBlob(field: String): Blob?

actual fun getBlob(field: String): Blob?

getBoolean

actual fun getBoolean(field: String): Boolean?

expect fun getBoolean(field: String): Boolean?

actual fun getBoolean(field: String): Boolean?

getBsonObjectId

actual fun getBsonObjectId(field: String): BsonObjectId?

The BsonObjectId at field, or null; throws a ClassCastException when the field holds another type, as on Android.

actual fun getBsonObjectId(field: String): BsonObjectId?

The BsonObjectId at field, or null; throws a ClassCastException when the field holds another type, as on Android.

expect fun getBsonObjectId(field: String): BsonObjectId?

The BsonObjectId at field, or null; throws a ClassCastException when the field holds another type, as on Android.

actual fun getBsonObjectId(field: String): BsonObjectId?

The BsonObjectId at field, or null; throws a ClassCastException when the field holds another type, as on Android.

actual fun getBsonObjectId(field: String): BsonObjectId?

The BsonObjectId at field, or null; throws a ClassCastException when the field holds another type, as on Android.

getBsonTimestamp

actual fun getBsonTimestamp(field: String): BsonTimestamp?

The BsonTimestamp at field, or null; throws a ClassCastException when the field holds another type, as on Android.

actual fun getBsonTimestamp(field: String): BsonTimestamp?

The BsonTimestamp at field, or null; throws a ClassCastException when the field holds another type, as on Android.

expect fun getBsonTimestamp(field: String): BsonTimestamp?

The BsonTimestamp at field, or null; throws a ClassCastException when the field holds another type, as on Android.

actual fun getBsonTimestamp(field: String): BsonTimestamp?

The BsonTimestamp at field, or null; throws a ClassCastException when the field holds another type, as on Android.

actual fun getBsonTimestamp(field: String): BsonTimestamp?

The BsonTimestamp at field, or null; throws a ClassCastException when the field holds another type, as on Android.

getData

actual fun getData(serverTimestampBehavior: DocumentSnapshot.ServerTimestampBehavior): Map<String, Any?>?

The fields as a map with server timestamps resolved per serverTimestampBehavior, or null when the document does not exist.

actual fun getData(serverTimestampBehavior: DocumentSnapshot.ServerTimestampBehavior): Map<String, Any?>?

The fields as a map with server timestamps resolved per serverTimestampBehavior, or null when the document does not exist.

expect fun getData(serverTimestampBehavior: DocumentSnapshot.ServerTimestampBehavior): Map<String, Any?>?

The fields as a map with server timestamps resolved per serverTimestampBehavior, or null when the document does not exist.

actual fun getData(serverTimestampBehavior: DocumentSnapshot.ServerTimestampBehavior): Map<String, Any?>?

The fields as a map with server timestamps resolved per serverTimestampBehavior, or null when the document does not exist.

actual fun getData(serverTimestampBehavior: DocumentSnapshot.ServerTimestampBehavior): Map<String, Any?>?

The fields as a map with server timestamps resolved per serverTimestampBehavior, or null when the document does not exist.

getDecimal128Value

actual fun getDecimal128Value(field: String): Decimal128Value?

The Decimal128Value at field, or null; throws a ClassCastException when the field holds another type, as on Android.

actual fun getDecimal128Value(field: String): Decimal128Value?

The Decimal128Value at field, or null; throws a ClassCastException when the field holds another type, as on Android.

expect fun getDecimal128Value(field: String): Decimal128Value?

The Decimal128Value at field, or null; throws a ClassCastException when the field holds another type, as on Android.

actual fun getDecimal128Value(field: String): Decimal128Value?

The Decimal128Value at field, or null; throws a ClassCastException when the field holds another type, as on Android.

actual fun getDecimal128Value(field: String): Decimal128Value?

The Decimal128Value at field, or null; throws a ClassCastException when the field holds another type, as on Android.

getDocumentReference

actual fun getDocumentReference(field: String): DocumentReference?

expect fun getDocumentReference(field: String): DocumentReference?

actual fun getDocumentReference(field: String): DocumentReference?

getDouble

actual fun getDouble(field: String): Double?

expect fun getDouble(field: String): Double?

actual fun getDouble(field: String): Double?

getField

inline fun <T> DocumentSnapshot.getField(fieldPath: FieldPath): T?

inline fun <T> DocumentSnapshot.getField(fieldPath: FieldPath, serverTimestampBehavior: DocumentSnapshot.ServerTimestampBehavior): T?

The value of fieldPath as T; on Apple platforms and JS a cast of DocumentSnapshot.get.

inline fun <T> DocumentSnapshot.getField(field: String): T?

inline fun <T> DocumentSnapshot.getField(field: String, serverTimestampBehavior: DocumentSnapshot.ServerTimestampBehavior): T?

The value of field as T; on Apple platforms and JS a cast of DocumentSnapshot.get.

getGeoPoint

actual fun getGeoPoint(field: String): GeoPoint?

expect fun getGeoPoint(field: String): GeoPoint?

actual fun getGeoPoint(field: String): GeoPoint?

getInt32Value

actual fun getInt32Value(field: String): Int32Value?

The Int32Value at field, or null; throws a ClassCastException when the field holds another type, as on Android.

actual fun getInt32Value(field: String): Int32Value?

The Int32Value at field, or null; throws a ClassCastException when the field holds another type, as on Android.

expect fun getInt32Value(field: String): Int32Value?

The Int32Value at field, or null; throws a ClassCastException when the field holds another type, as on Android.

actual fun getInt32Value(field: String): Int32Value?

The Int32Value at field, or null; throws a ClassCastException when the field holds another type, as on Android.

actual fun getInt32Value(field: String): Int32Value?

The Int32Value at field, or null; throws a ClassCastException when the field holds another type, as on Android.

getLong

actual fun getLong(field: String): Long?

expect fun getLong(field: String): Long?

actual fun getLong(field: String): Long?

getMaxKey

actual fun getMaxKey(field: String): MaxKey?

The MaxKey at field, or null; throws a ClassCastException when the field holds another type, as on Android.

actual fun getMaxKey(field: String): MaxKey?

The MaxKey at field, or null; throws a ClassCastException when the field holds another type, as on Android.

expect fun getMaxKey(field: String): MaxKey?

The MaxKey at field, or null; throws a ClassCastException when the field holds another type, as on Android.

actual fun getMaxKey(field: String): MaxKey?

The MaxKey at field, or null; throws a ClassCastException when the field holds another type, as on Android.

actual fun getMaxKey(field: String): MaxKey?

The MaxKey at field, or null; throws a ClassCastException when the field holds another type, as on Android.

getMinKey

actual fun getMinKey(field: String): MinKey?

The MinKey at field, or null; throws a ClassCastException when the field holds another type, as on Android.

actual fun getMinKey(field: String): MinKey?

The MinKey at field, or null; throws a ClassCastException when the field holds another type, as on Android.

expect fun getMinKey(field: String): MinKey?

The MinKey at field, or null; throws a ClassCastException when the field holds another type, as on Android.

actual fun getMinKey(field: String): MinKey?

The MinKey at field, or null; throws a ClassCastException when the field holds another type, as on Android.

actual fun getMinKey(field: String): MinKey?

The MinKey at field, or null; throws a ClassCastException when the field holds another type, as on Android.

getRegexValue

actual fun getRegexValue(field: String): RegexValue?

The RegexValue at field, or null; throws a ClassCastException when the field holds another type, as on Android.

actual fun getRegexValue(field: String): RegexValue?

The RegexValue at field, or null; throws a ClassCastException when the field holds another type, as on Android.

expect fun getRegexValue(field: String): RegexValue?

The RegexValue at field, or null; throws a ClassCastException when the field holds another type, as on Android.

actual fun getRegexValue(field: String): RegexValue?

The RegexValue at field, or null; throws a ClassCastException when the field holds another type, as on Android.

actual fun getRegexValue(field: String): RegexValue?

The RegexValue at field, or null; throws a ClassCastException when the field holds another type, as on Android.

getString

actual fun getString(field: String): String?

expect fun getString(field: String): String?

actual fun getString(field: String): String?

getTimestamp

actual fun getTimestamp(field: String): Timestamp?

actual fun getTimestamp(field: String, serverTimestampBehavior: DocumentSnapshot.ServerTimestampBehavior): Timestamp?

actual fun getTimestamp(field: String): Timestamp?

actual fun getTimestamp(field: String, serverTimestampBehavior: DocumentSnapshot.ServerTimestampBehavior): Timestamp?

expect fun getTimestamp(field: String): Timestamp?

expect fun getTimestamp(field: String, serverTimestampBehavior: DocumentSnapshot.ServerTimestampBehavior): Timestamp?

actual fun getTimestamp(field: String): Timestamp?

actual fun getTimestamp(field: String, serverTimestampBehavior: DocumentSnapshot.ServerTimestampBehavior): Timestamp?

actual fun getTimestamp(field: String): Timestamp?

actual fun getTimestamp(field: String, serverTimestampBehavior: DocumentSnapshot.ServerTimestampBehavior): Timestamp?

getVectorValue

actual fun getVectorValue(field: String): VectorValue?

The VectorValue at field, or null; throws a ClassCastException when the field holds another type, as on Android.

actual fun getVectorValue(field: String): VectorValue?

The VectorValue at field, or null; throws a ClassCastException when the field holds another type, as on Android.

expect fun getVectorValue(field: String): VectorValue?

The VectorValue at field, or null; throws a ClassCastException when the field holds another type, as on Android.

actual fun getVectorValue(field: String): VectorValue?

The VectorValue at field, or null; throws a ClassCastException when the field holds another type, as on Android.

actual fun getVectorValue(field: String): VectorValue?

The VectorValue at field, or null; throws a ClassCastException when the field holds another type, as on Android.

hashCode

open override fun hashCode(): Int

toObject

inline fun <T> DocumentSnapshot.toObject(): T?

The document as T; on Apple platforms and JS a cast of DocumentSnapshot.data.

inline fun <T> DocumentSnapshot.toObject(serverTimestampBehavior: DocumentSnapshot.ServerTimestampBehavior): T?

The document as T; on Apple platforms and JS a cast of DocumentSnapshot.getData.

toString

open override fun toString(): String

DocumentSnapshot

Inheritors

Inheritors

Inheritors

Inheritors

Inheritors

Types

Properties

Functions