FfiCollectionReference class
A collection, which is a query over itself.
Extends the query and only implements the collection interface, as the
method-channel implementation does. Extending CollectionReferencePlatform
instead looks natural and is wrong: its constructor hands QueryPlatform an
empty parameter map rather than the seeded defaults, so the plugin's own
where reads parameters'where' as null and fails far from the cause.
Constructors
- FfiCollectionReference(CloudFirestoreFfi firestore, String path)
Properties
- collectionPath → String
-
finalinherited
- ffiFirestore → CloudFirestoreFfi
-
finalinherited
- firestore → FirebaseFirestorePlatform
-
The
FirebaseFirestorePlatforminterface for this current query.finalinherited - hashCode → int
-
The hash code for this object.
no setterinherited
- id → String
-
Identifier of the referenced collection.
no setter
- isCollectionGroupQuery → bool
-
Returns whether the current query is targeted at a collection group.
no setterinherited
- isGroup → bool
-
Searches every collection with this id, at any depth, rather than one
collection at a path.
finalinherited
-
orderClauses
→ List<
OrderBy> -
no setterinherited
-
parameters
→ Map<
String, dynamic> -
Stores the instances query modifier filters.
finalinherited
- parent → DocumentReferencePlatform?
-
For subcollections, parent returns the containing
DocumentReferencePlatform.no setter - path → String
-
A string containing the slash-separated path to this
CollectionReferencePlatform(relative to the root of the database).no setter - runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
-
whereClauses
→ List<
Where> -
no setterinherited
Methods
-
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]) → AggregateQueryPlatform -
inherited
-
average(
String field) → AggregateQueryPlatform -
Returns an
AggregateQueryPlatformwhich uses theQueryPlatformto query for metadatainherited -
count(
) → AggregateQueryPlatform -
Returns an
AggregateQueryPlatformwhich uses theQueryPlatformto query for metadatainherited -
doc(
[String? path]) → DocumentReferencePlatform -
Returns a
DocumentReferencePlatformwith the providedpath. -
endAt(
Iterable fields) → QueryPlatform -
Takes a list of
fields, creates and returns a newQueryPlatformthat ends at the provided fields relative to the order of the query.inherited -
endAtDocument(
Iterable orders, Iterable values) → QueryPlatform -
Creates and returns a new
QueryPlatformthat 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 fields) → QueryPlatform -
Takes a list of
fields, creates and returns a newQueryPlatformthat ends before the provided fields relative to the order of the query.inherited -
endBeforeDocument(
Iterable orders, Iterable values) → QueryPlatform -
Creates and returns a new
QueryPlatformthat ends before the provided document (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 = const GetOptions()]) → Future< QuerySnapshotPlatform> -
Performs a query and returns a
QuerySnapshotPlatformcontaining all documents which match the query.inherited -
limit(
int limit) → QueryPlatform -
Creates and returns a new Query that's additionally limited to only return up
to the specified number of documents.
inherited
-
limitToLast(
int limit) → QueryPlatform -
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(
Iterable< List> orders) → QueryPlatform -
Creates and returns a new
QueryPlatformthat's additionally sorted by the specifiedfield. The field may be a String representing a single field name or aFieldPath.inherited -
snapshots(
{bool includeMetadataChanges = false, required ListenSource listenSource}) → Stream< QuerySnapshotPlatform> -
Notifies of query results at this location
inherited
-
startAfter(
Iterable fields) → QueryPlatform -
Takes a list of
fields, creates and returns a newQueryPlatformthat starts after the provided fields relative to the order of the query.inherited -
startAfterDocument(
List orders, List values) → QueryPlatform -
Creates and returns a new
QueryPlatformthat starts after the provided document (exclusive). 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 -
startAt(
Iterable fields) → QueryPlatform -
Takes a list of
fields, creates and returns a newQueryPlatformthat starts at the provided fields relative to the order of the query.inherited -
startAtDocument(
Iterable orders, Iterable values) → QueryPlatform -
Creates and returns a new
QueryPlatformthat 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 -
sum(
String field) → AggregateQueryPlatform -
Returns an
AggregateQueryPlatformwhich uses theQueryPlatformto query for metadatainherited -
toString(
) → String -
A string representation of this object.
inherited
-
where(
List< List> conditions) → QueryPlatform -
Creates and returns a new
QueryPlatformwith additional filter on specifiedfield.fieldrefers to a field in a document.inherited -
whereFilter(
FilterPlatformInterface filter) → QueryPlatform -
inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited