CollectionReferencePlatform class abstract
A CollectionReferencePlatform can be used for adding documents, getting document references, and querying for documents (using the methods inherited from QueryPlatform). Note: QueryPlatform extends PlatformInterface already.
- Inheritance
-
- Object
- PlatformInterface
- QueryPlatform
- CollectionReferencePlatform
Constructors
- CollectionReferencePlatform(FirebaseFirestorePlatform firestore, String path)
-
Create a CollectionReferencePlatform from a
path
Properties
- firestore → FirebaseFirestorePlatform
-
The FirebaseFirestorePlatform interface for this current query.
finalinherited
- hashCode → int
-
The hash code for this object.
no setteroverride
- id → String
-
Identifier of the referenced collection.
no setter
- isCollectionGroupQuery → bool
-
Returns whether the current query is targetted at a collection group.
no setterinherited
-
parameters
↔ Map<
String, dynamic> -
Stores the instances query modifier filters.
getter/setter pairinherited
- 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
Methods
-
doc(
[String? path]) → DocumentReferencePlatform -
Returns a DocumentReferencePlatform with the provided
path
. -
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.inherited -
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.
inherited
-
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.inherited -
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.
inherited
-
get(
[GetOptions options = const GetOptions()]) → Future< QuerySnapshotPlatform> -
Performs a query and returns a QuerySnapshotPlatform containing
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(
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.inherited -
snapshots(
{bool includeMetadataChanges = false}) → Stream< QuerySnapshotPlatform> -
Notifies of query results at this location
inherited
-
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.inherited -
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.
inherited
-
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.inherited -
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.
inherited
-
toString(
) → String -
A string representation of this object.
override
-
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.inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator.
override