Snapshot

Snapshot class

A snapshot of a Document version.

An example of getting a snapshot: final document = database.collection('recipes').document('tiramisu'); final snapshot = await document.get();

You can also build a snapshot with SnaphotBuilder.

Constructors

Snapshot({@required Document document, @required Map<String, Object> data, bool exists: true, String versionId, Object vendorData})
Snapshot.notFound(Document document, {Object vendorData})

data → Map<String, Object>: Optional data of the snapshot.
final
document → Document: Document that produced this snapshot.
final
exists → bool: Whether the document exists.
final
hashCode → int: The hash code for this object. [...]
read-only, override
runtimeType → Type: A representation of the runtime type of the object.
read-only, inherited
vendorData → Object: Optional vendor-specific data received from the database. For example, a database adapter for Elasticsearch could expose JSON response received from the REST API of Elasticsearch.
final
versionId → String: Optional version ID. Only some databases return version IDs.
final

noSuchMethod(Invocation invocation) → dynamic: Invoked when a non-existent method or property is accessed. [...]
inherited
toBuilder() → SnaphotBuilder
toString() → String: Returns a string representation of this object.
override