CollectionRef class
A CollectionRef object can be used for adding documents, getting DocumentRefs, and querying for documents.
- Implemented types
Constructors
- CollectionRef(String id, [CollectionRef? parent, DocumentRef? delegate])
-
Returns an instance using the default CollectionRef.
factory
Properties
- hashCode → int
-
The hash code for this object.
no setterinherited
- parent → CollectionRef?
-
The parent CollectionRef of this document.
no setter
- path → String
-
A string representing the path of the referenced document (relative to the
root of the database).
no setter
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
-
stream
→ Stream<
Map< String, dynamic> > -
Notifies of query results at this collection.
no setteroverride
Methods
-
doc(
[String? id]) → DocumentRef -
Returns a
DocumentRefwith the provided id.override -
get(
) → Future< Map< String, dynamic> ?> -
Fetch the documents for this collection
override
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
toString(
) → String -
A string representation of this object.
inherited
-
where(
dynamic field, {dynamic isEqualTo}) → CollectionRef -
Creates and returns a new CollectionRef with additional filter on
specified
field.fieldrefers to a field in a document.override
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited