DocumentSnapshotPlatform class

Contains data read from a document in your Firestore database.

The data can be extracted by calling data() or by calling get() to get a specific field.

Inheritance
  • Object
  • PlatformInterface
  • DocumentSnapshotPlatform

Constructors

DocumentSnapshotPlatform(FirebaseFirestorePlatform _firestore, String path, Map<String, dynamic> _data)
Constructs a DocumentSnapshotPlatform using the provided FirebaseFirestorePlatform.

Properties

exists → bool
Signals whether or not the data exists.
read-only
hashCode → int
The hash code for this object. [...]
read-only, inherited
id → String
The database ID of the snapshot's document.
read-only
metadata SnapshotMetadataPlatform
Metadata about this snapshot concerning its source and if it has local modifications.
read-only
reference DocumentReferencePlatform
The reference that produced this snapshot.
read-only
runtimeType → Type
A representation of the runtime type of the object.
read-only, inherited

Methods

data() → Map<String, dynamic>
Contains all the data of this snapshot.
get(dynamic field) → dynamic
Gets a nested field by String or FieldPath from the snapshot. [...]
noSuchMethod(Invocation invocation) → dynamic
Invoked when a non-existent method or property is accessed. [...]
inherited
toString() → String
Returns a string representation of this object.
inherited

Operators

operator ==(Object other) → bool
The equality operator. [...]
inherited
operator [](dynamic field) → dynamic
Gets a nested field by String or FieldPath from the snapshot. [...]

Static Methods

verifyExtends(DocumentSnapshotPlatform instance) → dynamic
Throws an AssertionError if instance does not extend DocumentSnapshotPlatform. [...]