DocumentSnapshot
public classDocumentSnapshot
QueryDocumentSnapshot | A |
ADocumentSnapshot contains data read from a document in your Cloud Firestore database. The data can be extracted with thegetData orget methods.
If theDocumentSnapshot points to a non-existing document,getData and its corresponding methods will returnnull. You can always explicitly check for a document's existence by callingexists.
Subclassing Note: Cloud Firestore classes are not meant to be subclassed except for use in test mocks. Subclassing is not supported in production code and new SDK releases may break code that does so.
Summary
Nested types |
|---|
public enumDocumentSnapshot.ServerTimestampBehaviorControls the return value for server timestamps that have not yet been set to their final value. |
Public fields | |
|---|---|
finalSnapshotMetadata |
Public methods | |
|---|---|
boolean | Returns whether or not the field exists in the document. |
boolean | Returns whether or not the field exists in the document. |
boolean | |
boolean | exists() |
@NullableObject | Returns the value at the field or |
@NullableObject | Returns the value at the field or |
@NullableObject | get(Returns the value at the field or |
@Nullable T | Returns the value at the field, converted to a POJO, or |
@NullableObject | get(Returns the value at the field or |
@Nullable T | Returns the value at the field, converted to a POJO, or |
@Nullable T | <T>get(Returns the value at the field, converted to a POJO, or |
@Nullable T | <T>get(Returns the value at the field, converted to a POJO, or |
@NullableBlob | Returns the value of the field as a Blob. |
@NullableBoolean | getBoolean(@NonNullString field)Returns the value of the field as a boolean. |
@NullableMap<String, Object> | getData()Returns the fields of the document as a Map or |
@NullableMap<String, Object> | getData(Returns the fields of the document as a Map or |
@NullableDate | Returns the value of the field as a Date. |
@NullableDate | getDate(Returns the value of the field as a Date. |
@NullableDocumentReference | getDocumentReference(@NonNullString field)Returns the value of the field as a DocumentReference. |
@NullableDouble | Returns the value of the field as a double. |
@NullableGeoPoint | getGeoPoint(@NonNullString field)Returns the value of the field as a GeoPoint. |
@NonNullString | getId() |
@NullableLong | Returns the value of the field as a long. |
@NonNullSnapshotMetadata | |
@NonNullDocumentReference | Gets the reference to the document. |
@NullableString | Returns the value of the field as a String. |
@NullableTimestamp | getTimestamp(@NonNullString field)Returns the value of the field as a |
@NullableTimestamp | getTimestamp(Returns the value of the field as a |
@NullableVectorValue | getVectorValue(@NonNullString field)Returns the value of the field as a |
int | hashCode() |
@Nullable T | Returns the contents of the document converted to a POJO or |
@Nullable T | <T>toObject(Returns the contents of the document converted to a POJO or |
@NonNullString | toString() |
Extension functions | |
|---|---|
final T | <T extends Object>FirestoreKt.getField(Returns the value at the field, converted to a POJO, or null if the field or document doesn't exist. |
final T | <T extends Object>FirestoreKt.getField(Returns the value at the field, converted to a POJO, or null if the field or document doesn't exist. |
final T | <T extends Object>FirestoreKt.getField(Returns the value at the field, converted to a POJO, or null if the field or document doesn't exist. |
final T | <T extends Object>FirestoreKt.getField(Returns the value at the field, converted to a POJO, or null if the field or document doesn't exist. |
final T | <T extends Object>FirestoreKt.toObject(@NonNullDocumentSnapshot receiver)Returns the contents of the document converted to a POJO or null if the document doesn't exist. |
final T | <T extends Object>FirestoreKt.toObject(Returns the contents of the document converted to a POJO or null if the document doesn't exist. |
Public fields
Public methods
contains
public boolean contains(@NonNullString field)
Returns whether or not the field exists in the document. Returns false if the document does not exist.
| Returns | |
|---|---|
boolean | true iff the field exists. |
contains
public boolean contains(@NonNullFieldPath fieldPath)
Returns whether or not the field exists in the document. Returns false if the document does not exist.
| Returns | |
|---|---|
boolean | true iff the field exists. |
get
public @NullableObject get(@NonNullString field)
Returns the value at the field ornull if the field doesn't exist.
get
public @NullableObject get(@NonNullFieldPath fieldPath)
Returns the value at the field ornull if the field or document doesn't exist.
get
public @NullableObject get(
@NonNullString field,
@NonNullDocumentSnapshot.ServerTimestampBehavior serverTimestampBehavior
)
Returns the value at the field ornull if the field doesn't exist.
| Parameters | |
|---|---|
@NonNullString field | The path to the field |
@NonNullDocumentSnapshot.ServerTimestampBehavior serverTimestampBehavior | Configures the behavior for server timestamps that have not yet been set to their final value. |
get
public @Nullable T <T>get(@NonNullString field, @NonNullClass<T> valueType)
Returns the value at the field, converted to a POJO, ornull if the field or document doesn't exist.
| Parameters | |
|---|---|
@NonNullString field | The path to the field |
@NonNullClass<T> valueType | The Java class to convert the field value to. |
| Returns | |
|---|---|
@Nullable T | The value at the given field or |
get
public @NullableObject get(
@NonNullFieldPath fieldPath,
@NonNullDocumentSnapshot.ServerTimestampBehavior serverTimestampBehavior
)
Returns the value at the field ornull if the field or document doesn't exist.
| Parameters | |
|---|---|
@NonNullFieldPath fieldPath | The path to the field |
@NonNullDocumentSnapshot.ServerTimestampBehavior serverTimestampBehavior | Configures the behavior for server timestamps that have not yet been set to their final value. |
get
public @Nullable T <T>get(@NonNullFieldPath fieldPath, @NonNullClass<T> valueType)
Returns the value at the field, converted to a POJO, ornull if the field or document doesn't exist.
| Parameters | |
|---|---|
@NonNullFieldPath fieldPath | The path to the field |
@NonNullClass<T> valueType | The Java class to convert the field value to. |
| Returns | |
|---|---|
@Nullable T | The value at the given field or |
get
public @Nullable T <T>get(
@NonNullString field,
@NonNullClass<T> valueType,
@NonNullDocumentSnapshot.ServerTimestampBehavior serverTimestampBehavior
)
Returns the value at the field, converted to a POJO, ornull if the field or document doesn't exist.
| Parameters | |
|---|---|
@NonNullString field | The path to the field |
@NonNullClass<T> valueType | The Java class to convert the field value to. |
@NonNullDocumentSnapshot.ServerTimestampBehavior serverTimestampBehavior | Configures the behavior for server timestamps that have not yet been set to their final value. |
| Returns | |
|---|---|
@Nullable T | The value at the given field or |
get
public @Nullable T <T>get(
@NonNullFieldPath fieldPath,
@NonNullClass<T> valueType,
@NonNullDocumentSnapshot.ServerTimestampBehavior serverTimestampBehavior
)
Returns the value at the field, converted to a POJO, ornull if the field or document doesn't exist.
| Parameters | |
|---|---|
@NonNullFieldPath fieldPath | The path to the field |
@NonNullClass<T> valueType | The Java class to convert the field value to. |
@NonNullDocumentSnapshot.ServerTimestampBehavior serverTimestampBehavior | Configures the behavior for server timestamps that have not yet been set to their final value. |
| Returns | |
|---|---|
@Nullable T | The value at the given field or |
getBlob
public @NullableBlob getBlob(@NonNullString field)
Returns the value of the field as a Blob.
| Throws | |
|---|---|
java.lang.RuntimeException java.lang.RuntimeException | if the value is not a Blob. |
getBoolean
public @NullableBoolean getBoolean(@NonNullString field)
Returns the value of the field as a boolean. If the value is not a boolean this will throw a runtime exception.
getData
public @NullableMap<String, Object> getData()
Returns the fields of the document as a Map ornull if the document doesn't exist. Field values will be converted to their native Java representation.
getData
public @NullableMap<String, Object> getData(
@NonNullDocumentSnapshot.ServerTimestampBehavior serverTimestampBehavior
)
Returns the fields of the document as a Map ornull if the document doesn't exist. Field values will be converted to their native Java representation.
| Parameters | |
|---|---|
@NonNullDocumentSnapshot.ServerTimestampBehavior serverTimestampBehavior | Configures the behavior for server timestamps that have not yet been set to their final value. |
getDate
public @NullableDate getDate(@NonNullString field)
Returns the value of the field as a Date.
| Throws | |
|---|---|
java.lang.RuntimeException java.lang.RuntimeException | if the value is not a Date. |
getDate
public @NullableDate getDate(
@NonNullString field,
@NonNullDocumentSnapshot.ServerTimestampBehavior serverTimestampBehavior
)
Returns the value of the field as a Date.
| Parameters | |
|---|---|
@NonNullString field | The path to the field. |
@NonNullDocumentSnapshot.ServerTimestampBehavior serverTimestampBehavior | Configures the behavior for server timestamps that have not yet been set to their final value. |
| Throws | |
|---|---|
java.lang.RuntimeException java.lang.RuntimeException | if the value is not a Date. |
getDocumentReference
public @NullableDocumentReference getDocumentReference(@NonNullString field)
Returns the value of the field as a DocumentReference.
| Returns | |
|---|---|
@NullableDocumentReference | The value of the field |
| Throws | |
|---|---|
java.lang.RuntimeException java.lang.RuntimeException | if the value is not a DocumentReference. |
getDouble
public @NullableDouble getDouble(@NonNullString field)
Returns the value of the field as a double.
| Throws | |
|---|---|
java.lang.RuntimeException java.lang.RuntimeException | if the value is not a number. |
getGeoPoint
public @NullableGeoPoint getGeoPoint(@NonNullString field)
Returns the value of the field as a GeoPoint.
| Throws | |
|---|---|
java.lang.RuntimeException java.lang.RuntimeException | if the value is not a GeoPoint. |
getLong
public @NullableLong getLong(@NonNullString field)
Returns the value of the field as a long.
| Throws | |
|---|---|
java.lang.RuntimeException java.lang.RuntimeException | if the value is not a number. |
getMetadata
public @NonNullSnapshotMetadata getMetadata()
| Returns | |
|---|---|
@NonNullSnapshotMetadata | The metadata for this document snapshot. |
getReference
public @NonNullDocumentReference getReference()
Gets the reference to the document.
| Returns | |
|---|---|
@NonNullDocumentReference | The reference to the document. |
getString
public @NullableString getString(@NonNullString field)
Returns the value of the field as a String.
| Throws | |
|---|---|
java.lang.RuntimeException java.lang.RuntimeException | if the value is not a String. |
getTimestamp
public @NullableTimestamp getTimestamp(@NonNullString field)
Returns the value of the field as acom.google.firebase.Timestamp.
| Throws | |
|---|---|
java.lang.RuntimeException java.lang.RuntimeException | if this is not a timestamp field. |
getTimestamp
public @NullableTimestamp getTimestamp(
@NonNullString field,
@NonNullDocumentSnapshot.ServerTimestampBehavior serverTimestampBehavior
)
Returns the value of the field as acom.google.firebase.Timestamp.
| Parameters | |
|---|---|
@NonNullString field | The path to the field. |
@NonNullDocumentSnapshot.ServerTimestampBehavior serverTimestampBehavior | Configures the behavior for server timestamps that have not yet been set to their final value. |
| Throws | |
|---|---|
java.lang.RuntimeException java.lang.RuntimeException | if the value is not a timestamp field. |
getVectorValue
public @NullableVectorValue getVectorValue(@NonNullString field)
Returns the value of the field as aVectorValue ornull if the field does not exist in the document.
| Returns | |
|---|---|
@NullableVectorValue | The value of the field. |
| Throws | |
|---|---|
java.lang.RuntimeException java.lang.RuntimeException | if the value is not a |
toObject
public @Nullable T <T>toObject(@NonNullClass<T> valueType)
Returns the contents of the document converted to a POJO ornull if the document doesn't exist.
| Returns | |
|---|---|
@Nullable T | The contents of the document in an object of type T or |
toObject
public @Nullable T <T>toObject(
@NonNullClass<T> valueType,
@NonNullDocumentSnapshot.ServerTimestampBehavior serverTimestampBehavior
)
Returns the contents of the document converted to a POJO ornull if the document doesn't exist.
| Parameters | |
|---|---|
@NonNullClass<T> valueType | The Java class to create |
@NonNullDocumentSnapshot.ServerTimestampBehavior serverTimestampBehavior | Configures the behavior for server timestamps that have not yet been set to their final value. |
| Returns | |
|---|---|
@Nullable T | The contents of the document in an object of type T or |
Extension functions
FirestoreKt.getField
public final T <T extends Object>FirestoreKt.getField(
@NonNullDocumentSnapshot receiver,
@NonNullString field
)
Returns the value at the field, converted to a POJO, or null if the field or document doesn't exist.
| Parameters | |
|---|---|
<T extends Object> | The type to convert the field value to. |
@NonNullString field | The path to the field. |
| Returns | |
|---|---|
T | The value at the given field or null. |
FirestoreKt.getField
public final T <T extends Object>FirestoreKt.getField(
@NonNullDocumentSnapshot receiver,
@NonNullString field,
@NonNullDocumentSnapshot.ServerTimestampBehavior serverTimestampBehavior
)
Returns the value at the field, converted to a POJO, or null if the field or document doesn't exist.
| Parameters | |
|---|---|
<T extends Object> | The type to convert the field value to. |
@NonNullString field | The path to the field. |
@NonNullDocumentSnapshot.ServerTimestampBehavior serverTimestampBehavior | Configures the behavior for server timestamps that have not yet beensettotheirfinalvalue. The value at the given field or null. |
FirestoreKt.getField
public final T <T extends Object>FirestoreKt.getField(
@NonNullDocumentSnapshot receiver,
@NonNullFieldPath fieldPath
)
Returns the value at the field, converted to a POJO, or null if the field or document doesn't exist.
| Parameters | |
|---|---|
<T extends Object> | The type to convert the field value to. |
@NonNullFieldPath fieldPath | The path to the field. |
| Returns | |
|---|---|
T | The value at the given field or null. |
FirestoreKt.getField
public final T <T extends Object>FirestoreKt.getField(
@NonNullDocumentSnapshot receiver,
@NonNullFieldPath fieldPath,
@NonNullDocumentSnapshot.ServerTimestampBehavior serverTimestampBehavior
)
Returns the value at the field, converted to a POJO, or null if the field or document doesn't exist.
| Parameters | |
|---|---|
<T extends Object> | The type to convert the field value to. |
@NonNullFieldPath fieldPath | The path to the field. |
@NonNullDocumentSnapshot.ServerTimestampBehavior serverTimestampBehavior | Configures the behavior for server timestamps that have not yet beensettotheirfinalvalue. The value at the given field or null. |
FirestoreKt.toObject
public final T <T extends Object>FirestoreKt.toObject(@NonNullDocumentSnapshot receiver)
Returns the contents of the document converted to a POJO or null if the document doesn't exist.
| Parameters | |
|---|---|
<T extends Object> | The type of the object to create. |
| Returns | |
|---|---|
T | The contents of the document in an object of type T or null if the document doesn't exist. |
FirestoreKt.toObject
public final T <T extends Object>FirestoreKt.toObject(
@NonNullDocumentSnapshot receiver,
@NonNullDocumentSnapshot.ServerTimestampBehavior serverTimestampBehavior
)
Returns the contents of the document converted to a POJO or null if the document doesn't exist.
| Parameters | |
|---|---|
<T extends Object> | The type of the object to create. |
@NonNullDocumentSnapshot.ServerTimestampBehavior serverTimestampBehavior | Configures the behavior for server timestamps that have not yet beensettotheirfinalvalue. The contents of the document in an object of type T or null if the document doesn't exist. |
Except as otherwise noted, the content of this page is licensed under theCreative Commons Attribution 4.0 License, and code samples are licensed under theApache 2.0 License. For details, see theGoogle Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2026-01-15 UTC.