DocumentReference class

Inheritance

Constructors

DocumentReference(FirestoreGateway gateway, String path)

Properties

exists Future<bool>
Check if a document exists.
no setter
fullPath String
no setterinherited
hashCode int
The hash code for this object.
no setterinherited
id String
no setterinherited
path String
finalinherited
runtimeType Type
A representation of the runtime type of the object.
no setterinherited
stream Stream<Document?>
no setter

Methods

collection(String id) CollectionReference
create(Map<String, dynamic> map) Future<Document>
Create a document if it doesn't exist, otherwise throw exception.
delete() Future<void>
Deletes a document.
get() Future<Document>
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
set(Map<String, dynamic> map) Future<void>
Create or update a document. In the case of an update, any fields not referenced in the payload will be deleted.
subscribe() Stream<Document?>
toString() String
A string representation of this object.
inherited
update(Map<String, dynamic> map) Future<void>
Create or update a document. In case of an update, fields not referenced in the payload will remain unchanged.

Operators

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