CollRef<D extends DocData> class
CollectionReference
- Inheritance
-
- Object
- TypedQuery<
D> - CollRef
Properties
- firestore → TypedFirestore
-
no setterinherited
- hashCode → int
-
The hash code for this object.
no setteroverride
- id → String
-
ID of the referenced collection.
no setter
- path → String
-
A string containing the slash-separated path to this CollectionReference (relative to the root of the database).
no setter
- raw → CollectionReference
-
final
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
Methods
-
add(
D data) → Future< DocRef< D> > - Returns a DocumentReference with an auto-generated ID, after populating it with provided data.
-
doc(
[String? path]) → DocRef< D> - Returns a DocumentReference with the provided path.
-
endAt(
List values) → TypedQuery< D> -
Takes a list of
values, creates and returns a newQuerythat ends at the provided fields relative to the order of the query.inherited -
endBefore(
List values) → TypedQuery< D> -
Takes a list of
values, creates and returns a newQuerythat ends before the provided fields relative to the order of the query.inherited -
getDocs(
[GetOptions? options]) → Future< TypedQuerySnapshot< D> > -
Fetch the documents for this query
inherited
-
limit(
int length) → TypedQuery< D> -
Creates and returns a new Query that's additionally limited to only return up to the specified number of documents.
inherited
-
map(
Mapper< D, D> mapper) → TypedQuery<D> -
mapperis called after fetching documents.inherited -
mapList<
T extends DocData> (Mapper< List< mapper) → TypedQuery<DocSnapshot< , List<D> >DocSnapshot< >T> >T> -
mapperis called after fetching documents.inherited -
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
orderBy(
String field, {bool descending = false}) → TypedQuery< D> -
Creates and returns a new Query that's additionally sorted by the specified field.
inherited
-
parent<
P extends DocData> () → DocRef< P> ? -
For subcollections, parent returns the containing
DocumentReference. -
snapshots(
{bool includeMetadataChanges = false}) → Stream< TypedQuerySnapshot< D> > -
Notifies of query results at this location
inherited
-
startAfter(
List values) → TypedQuery< D> -
Takes a list of
values, creates and returns a newQuerythat starts after the provided fields relative to the order of the query.inherited -
startAt(
List values) → TypedQuery< D> -
Takes a list of
values, creates and returns a newQuerythat starts at the provided fields relative to the order of the query.inherited -
toString(
) → String -
A string representation of this object.
inherited
-
where(
String field, {dynamic isEqualTo, dynamic isLessThan, dynamic isLessThanOrEqualTo, dynamic isGreaterThan, dynamic isGreaterThanOrEqualTo, dynamic arrayContains, bool? isNull}) → TypedQuery< D> -
Creates and returns a new Query with additional filter on specified field.
inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator.
override