QueryPlatform class abstract
Represents a query over the data at a particular location.
- Inheritance
-
- Object
- PlatformInterface
- QueryPlatform
- Implementers
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.
getter/setter pair
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
Methods
-
endAt(
List 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(
List 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(
List orders, List 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(
List< 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}) → Stream< QuerySnapshotPlatform> - Notifies of query results at this location
-
startAfter(
List 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(
List 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(
List orders, List 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.
-
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.
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited
Static Methods
-
verifyExtends(
QueryPlatform instance) → void -
Throws an AssertionError if
instance
does not extend QueryPlatform.