QueryPlatform class abstract

Represents a query over the data at a particular location.

Inheritance
  • Object
  • PlatformInterface
  • QueryPlatform
Implementers
Annotations

Constructors

QueryPlatform(FirebaseFirestorePlatform firestore, Map<String, dynamic>? params)
Create a QueryPlatform instance

Properties

firestore → FirebaseFirestorePlatform
The FirebaseFirestorePlatform interface for this current query.
final
hashCode → int
The hash code for this object.
no setterinherited
isCollectionGroupQuery → bool
Returns whether the current query is targetted at a collection group.
no setter
parameters → Map<String, dynamic>
Stores the instances query modifier filters.
final
runtimeType → Type
A representation of the runtime type of the object.
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
average(String field) → AggregateQueryPlatform
Returns an AggregateQueryPlatform which uses the QueryPlatform to query for metadata
count() → AggregateQueryPlatform
Returns an AggregateQueryPlatform which uses the QueryPlatform to query for metadata
endAt(Iterable fields) → QueryPlatform
Takes a list of fields, creates and returns a new QueryPlatform that ends at the provided fields relative to the order of the query.
endAtDocument(List orders, List values) → QueryPlatform
Creates and returns a new QueryPlatform 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.
endBefore(Iterable fields) → QueryPlatform
Takes a list of fields, creates and returns a new QueryPlatform that ends before the provided fields relative to the order of the query.
endBeforeDocument(Iterable orders, Iterable values) → QueryPlatform
Creates and returns a new QueryPlatform that 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.
get([GetOptions options = const GetOptions()]) → Future<QuerySnapshotPlatform>
Performs a query and returns a QuerySnapshotPlatform containing all documents which match the query.
limit(int limit) → QueryPlatform
Creates and returns a new Query that's additionally limited to only return up to the specified number of documents.
limitToLast(int limit) → QueryPlatform
Creates and returns a new Query that only returns the last matching documents.
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
orderBy(Iterable<List> orders) → QueryPlatform
Creates and returns a new QueryPlatform that's additionally sorted by the specified field. The field may be a String representing a single field name or a FieldPath.
snapshots({bool includeMetadataChanges = false, ListenSource source = ListenSource.defaultSource}) → Stream<QuerySnapshotPlatform>
Notifies of query results at this location
startAfter(Iterable fields) → QueryPlatform
Takes a list of fields, creates and returns a new QueryPlatform that starts after the provided fields relative to the order of the query.
startAfterDocument(List orders, List values) → QueryPlatform
Creates and returns a new QueryPlatform that 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.
startAt(Iterable fields) → QueryPlatform
Takes a list of fields, creates and returns a new QueryPlatform that starts at the provided fields relative to the order of the query.
startAtDocument(Iterable orders, Iterable values) → QueryPlatform
Creates and returns a new QueryPlatform 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.
sum(String field) → AggregateQueryPlatform
Returns an AggregateQueryPlatform which uses the QueryPlatform to query for metadata
toString() → String
A string representation of this object.
inherited
where(List<List> conditions) → QueryPlatform
Creates and returns a new QueryPlatform with additional filter on specified field. field refers to a field in a document.
whereFilter(FilterPlatformInterface filter) → QueryPlatform

Operators

operator ==(Object other) → bool
The equality operator.
inherited

Static Methods

verify(QueryPlatform instance) → void
Throws an AssertionError if instance does not extend QueryPlatform.
override