QueryDocumentSnapshot extension type

A QueryDocumentSnapshot contains data read from a document in your Firestore database as part of a query. The document is guaranteed to exist and its data can be extracted with .data() or .get(<field>) to get a specific field.

A QueryDocumentSnapshot offers the same API surface as a DocumentSnapshot. Since query results contain only existing documents, the exists property will always be true and data() will never return 'undefined'.

on

• JSObject

Implemented types

• DocumentSnapshot

Available extensions

• FirebaseJsInteropJSObjectExtension
• JSObjectUnsafeUtilExtension

Properties

createTime → Timestamp

The time the document was created.

no setter, override

exists → bool

True if the document exists.

no setter, inherited

hashCode → int

The hash code for this object.

no setter, inherited

id → String

The ID of the document for which this DocumentSnapshot contains data.

no setter, inherited

readTime → Timestamp

The time this snapshot was read.

no setter, inherited

ref → DocumentReference

A DocumentReference to the document location.

no setter, inherited

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

updateTime → Timestamp

The time the document was last updated (at the time the snapshot was generated).

no setter, override

Methods

data() → JSObject

Retrieves all fields in the document as an Object.

override

get(JSAny fieldPath) → JSObject

Retrieves the field specified by fieldPath.

inherited

isEqual(DocumentSnapshot other) → bool

Returns true if the document's data and path in this DocumentSnapshot is equal to the provided one.

inherited

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