DocRef<D extends DocData> class
DocumentReference
Properties
- hashCode → int
-
The hash code for this object.
no setteroverride
- id → String
-
This document's given or generated ID in the collection.
no setter
- path → String
-
Slash-delimited path representing the database location of this query.
no setter
- raw → DocumentReference
-
final
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
Methods
-
collection<
T extends DocData> (String path) → CollRef< T> - Returns the reference of a collection contained inside of this document.
-
delete(
) → Future< void> - Returns the reference of a collection contained inside of this document.
-
get(
[GetOptions? options]) → Future< DocSnapshot< D> > - Reads the document referenced by this DocumentReference
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
parent(
) → CollRef< D> -
Parent returns the containing
CollectionReference. -
set(
D data, [SetOptions? options]) → Future< void> - Writes to the document referred to by this DocumentReference.
-
snapshots(
{bool includeMetadataChanges = false}) → Stream< DocSnapshot< D> > -
toString(
) → String -
A string representation of this object.
inherited
-
update(
D data) → Future< void> - Updates fields in the document referred to by this DocumentReference.
Operators
-
operator ==(
Object other) → bool -
The equality operator.
override