FirestoreDocument class

Represents a document within a Firestore collection.

The FirestoreDocument class provides a structured way to interact with Firestore documents, maintaining information about both the document's path in the database and its field data.

This class extends OperatablePathObject with Firestore-specific implementation, providing methods to access document metadata and perform operations.

Inheritance

Constructors

FirestoreDocument({required FirestoreDocumentPath path, required List<FireValue> fireValues, FireGuards fireGuards = const FireGuards()})
Creates a new FirestoreDocument instance.

Properties

adapters → FireAdapterMap
no setteroverride
collection → FirestoreCollectionPath
The collection that contains this document.
no setter
datasource → FirefastStore
no setteroverride
fields → List<FireValue>
no setterinherited
fireGuards → FireGuards
finalinherited
fireValues → List<FireValue>
finalinherited
hashCode → int
The hash code for this object.
no setterinherited
id → String
The ID of this document within its collection.
no setter
path → FirestoreDocumentPath
finalinherited
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited

Methods

delete() → Future<String?>
inherited
fromMap(Map<String, dynamic>? map, FireAdapterMap adapters) → Future<OperationOutputReader?>
inherited
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
overwrite() → Future<String?>
inherited
read() → Future<OperationOutputReader?>
inherited
readAllowed() → Future<bool>
inherited
toMap(FireAdapterMap adapters) → Future<Map<String, dynamic>>
inherited
toString() → String
A string representation of this object.
inherited
write() → Future<String?>
inherited

Operators

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