QuerySnapshot extension type
A QuerySnapshot
contains zero or more QueryDocumentSnapshot
objects
representing the results of a query. The documents can be accessed as an
array via the docs
property or enumerated using the forEach
method. The
number of documents can be determined via the empty
and size
properties.
- on
- Implemented types
- Available extensions
Properties
-
docs
↔ JSArray<
QueryDocumentSnapshot> -
An array of all the documents in the QuerySnapshot.
getter/setter pair
- empty ↔ bool
-
True if there are no documents in the QuerySnapshot.
getter/setter pair
- hashCode → int
-
The hash code for this object.
no setterinherited
- query ↔ Query
-
The query on which you called
get
oronSnapshot
in order to get thisQuerySnapshot
.getter/setter pair - readTime → Timestamp
-
The time this query snapshot was obtained.
no setter
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
- size ↔ int
-
The number of documents in the QuerySnapshot.
getter/setter pair
Methods
-
docChanges(
) → JSArray< DocumentChange> - Returns an array of the documents changes since the last snapshot. If this is the first snapshot, all documents will be in the list as added changes.
-
forEach(
JSFunction callback, [JSAny thisArg]) → void - Enumerates all of the documents in the QuerySnapshot.
-
isEqual(
QuerySnapshot other) → bool -
Returns true if the document data in this
QuerySnapshot
is equal to the provided one. -
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