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?, Object?> ? _data, PigeonSnapshotMetadata _metadata) - Constructs a DocumentSnapshotPlatform using the provided FirebaseFirestorePlatform.
Properties
- exists → bool
-
Signals whether or not the data exists.
no setter
- hashCode → int
-
The hash code for this object.
no setterinherited
- id → String
-
The database ID of the snapshot's document.
no setter
- metadata → SnapshotMetadataPlatform
-
Metadata about this snapshot concerning its source and if it has local
modifications.
no setter
- reference → DocumentReferencePlatform
-
The reference that produced this snapshot.
no setter
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
Methods
-
data(
) → Map< String, dynamic> ? - Contains all the data of this snapshot.
-
get(
Object field) → dynamic - Gets a nested field by String or FieldPath from the snapshot.
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
toString(
) → String -
A string representation of this object.
inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited
-
operator [](
Object field) → dynamic - Gets a nested field by String or FieldPath from the snapshot.
Static Methods
-
verify(
DocumentSnapshotPlatform instance) → void -
Throws an AssertionError if
instancedoes not extend DocumentSnapshotPlatform.override