CollectionReference<T extends Object? > class
abstract
Implemented types
Annotations
Methods
add (T data )
→ Future <DocumentReference <T > >
Returns a DocumentReference
with an auto-generated ID, after
populating it with provided data
.
aggregate (AggregateField aggregateField1 , [AggregateField ? aggregateField2 , AggregateField ? aggregateField3 , AggregateField ? aggregateField4 , AggregateField ? aggregateField5 , AggregateField ? aggregateField6 , AggregateField ? aggregateField7 , AggregateField ? aggregateField8 , AggregateField ? aggregateField9 , AggregateField ? aggregateField10 , AggregateField ? aggregateField11 , AggregateField ? aggregateField12 , AggregateField ? aggregateField13 , AggregateField ? aggregateField14 , AggregateField ? aggregateField15 , AggregateField ? aggregateField16 , AggregateField ? aggregateField17 , AggregateField ? aggregateField18 , AggregateField ? aggregateField19 , AggregateField ? aggregateField20 , AggregateField ? aggregateField21 , AggregateField ? aggregateField22 , AggregateField ? aggregateField23 , AggregateField ? aggregateField24 , AggregateField ? aggregateField25 , AggregateField ? aggregateField26 , AggregateField ? aggregateField27 , AggregateField ? aggregateField28 , AggregateField ? aggregateField29 , AggregateField ? aggregateField30 ])
→ AggregateQuery
Calculates the specified aggregations over the documents in the
result set of the given query, without actually downloading the documents.
inherited
count ()
→ AggregateQuery
inherited
doc ([String ? path ])
→ DocumentReference <T >
Returns a DocumentReference
with the provided path.
endAt (Iterable <Object ? > values )
→ Query <T >
Takes a list of values
, creates and returns a new Query that ends at the
provided fields relative to the order of the query.
inherited
endAtDocument (DocumentSnapshot <Object ? > documentSnapshot )
→ Query <T >
Creates and returns a new Query that ends at the provided document
(inclusive). The end position is relative to the order of the query.
The document must contain all of the fields provided in the orderBy of
this query.
inherited
endBefore (Iterable <Object ? > values )
→ Query <T >
Takes a list of values
, creates and returns a new Query that ends before
the provided fields relative to the order of the query.
inherited
endBeforeDocument (DocumentSnapshot <Object ? > documentSnapshot )
→ Query <T >
Creates and returns a new Query that ends before the provided document
snapshot (exclusive). The end position is relative to the order of the query.
The document must contain all of the fields provided in the orderBy of
this query.
inherited
get ([GetOptions ? options ])
→ Future <QuerySnapshot <T > >
Fetch the documents for this query.
inherited
limit (int limit )
→ Query <T >
Creates and returns a new Query that's additionally limited to only return up
to the specified number of documents.
inherited
limitToLast (int limit )
→ Query <T >
Creates and returns a new Query that only returns the last matching documents.
inherited
noSuchMethod (Invocation invocation )
→ dynamic
Invoked when a nonexistent method or property is accessed.
inherited
orderBy (Object field , {bool descending = false })
→ Query <T >
Creates and returns a new Query that's additionally sorted by the specified
field
.
The field may be a String representing a single field name or a FieldPath .
inherited
snapshots ({bool includeMetadataChanges = false , ListenSource source = ListenSource.defaultSource })
→ Stream <QuerySnapshot <T > >
Notifies of query results at this location.
inherited
startAfter (Iterable <Object ? > values )
→ Query <T >
Takes a list of values
, creates and returns a new Query that starts
after the provided fields relative to the order of the query.
inherited
startAfterDocument (DocumentSnapshot <Object ? > documentSnapshot )
→ Query <T >
Creates and returns a new Query that starts after the provided document
(exclusive). The starting position is relative to the order of the query.
The documentSnapshot
must contain all of the fields provided in the orderBy of
this query.
inherited
startAt (Iterable <Object ? > values )
→ Query <T >
Takes a list of values
, creates and returns a new Query that starts at
the provided fields relative to the order of the query.
inherited
startAtDocument (DocumentSnapshot <Object ? > documentSnapshot )
→ Query <T >
Creates and returns a new Query that starts at the provided document
(inclusive). The starting position is relative to the order of the query.
The document must contain all of the fields provided in the orderBy of
this query.
inherited
toString ()
→ String
A string representation of this object.
inherited
where (Object field , {Object ? isEqualTo , Object ? isNotEqualTo , Object ? isLessThan , Object ? isLessThanOrEqualTo , Object ? isGreaterThan , Object ? isGreaterThanOrEqualTo , Object ? arrayContains , Iterable <Object ? > ? arrayContainsAny , Iterable <Object ? > ? whereIn , Iterable <Object ? > ? whereNotIn , bool ? isNull })
→ Query <T >
Creates and returns a new Query with additional filter on specified
field
. field
refers to a field in a document.
inherited
withConverter <R extends Object ? > ({required FromFirestore <R > fromFirestore , required ToFirestore <R > toFirestore })
→ CollectionReference <R >
Transforms a CollectionReference to manipulate a custom object instead
of a Map<String, dynamic>
.
override