QueryDocumentSnapshot class
A QueryDocumentSnapshot contains data read from a document in your FirebaseFirestore database as part of a query.
A QueryDocumentSnapshot offers the same API surface as a DocumentSnapshot.
Since query results contain only existing documents, the exists property
will always be true and data() will never return null.
- Inheritance
-
- Object
- DocumentSnapshot
- QueryDocumentSnapshot
Properties
- exists → bool
-
Returns
trueif the DocumentSnapshot exists.no setteroverride - hashCode → int
-
The hash code for this object.
no setterinherited
- id → String
-
This document's given ID for this snapshot.
no setterinherited
- metadata → SnapshotMetadata
-
Metadata about this DocumentSnapshot concerning its source and if it has local
modifications.
no setterinherited
- reference → DocumentReference
-
Returns the DocumentReference of this snapshot.
no setterinherited
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
Methods
-
data(
) → Map< String, dynamic> -
Contains all the data of this DocumentSnapshot.
override
-
get(
dynamic field) → dynamic -
Gets a nested field by String or FieldPath from this DocumentSnapshot.
inherited
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
toString(
) → String -
A string representation of this object.
inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited
-
operator [](
dynamic field) → dynamic -
Gets a nested field by String or FieldPath from this DocumentSnapshot.
inherited