QueryCursor class

A position in a query's total order — the sort key of the last row of a page. Opaque to callers: obtain one from a returned page and feed it back to the same query to fetch the next page.

The total order is (order-by value, document id), so a cursor stays valid across a reopen and points at the same boundary on every converged device.

Constructors

QueryCursor({required Object? orderValue, required String docId})
Creates a cursor. Engines and the query builder construct these; treat them as opaque elsewhere.
const

Properties

docId → String
The row's document id, the tiebreak component of the sort key.
final
hashCode → int
The hash code for this object.
no setterinherited
orderValue → Object?
The resolved order-by value of the row, in the engine's comparison form (null, a number, or text). null when the query has no orderBy or the document lacks the field.
final
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited

Methods

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