QueryDocumentSnapshot | Doclava
public class

QueryDocumentSnapshot

extends DocumentSnapshot
java.lang.Object
   ↳ com.google.firebase.firestore.DocumentSnapshot
     ↳ com.google.firebase.firestore.QueryDocumentSnapshot

Class Overview

A QueryDocumentSnapshot contains data read from a document in your Firestore database as part of a query. The document is guaranteed to exist and its data can be extracted using the getData() or get() methods.

QueryDocumentSnapshot offers the same API surface as DocumentSnapshot. Since query results contain only existing documents, the exists() method will always return true and getData() will never be null.

Subclassing Note: 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

Public Methods
Map<String, Object> getData()
Returns the fields of the document as a Map.
<T> T toObject(Class<T> valueType)
Returns the contents of the document converted to a POJO.
[Expand]
Inherited Methods
From class com.google.firebase.firestore.DocumentSnapshot
From class java.lang.Object

Public Methods

public Map<String, Object> getData ()

Returns the fields of the document as a Map. Field values will be converted to their native Java representation.

Returns
Map<String, Object> The fields of the document as a Map.

public T toObject (Class<T> valueType)

Returns the contents of the document converted to a POJO.

Parameters
valueType Class: The Java class to create
Returns
T The contents of the document in an object of type T