CloudQueryDef class final

A query of a cloud collection, as a data-bound list (listView.query) or a cloud data action stores it:

{"enabled": true, "collectionPath": "tasks", "limit": 20,
 "whereFilters": [{"field": "done", "operator": "equal", "value": "false"}],
 "orderByFilters": [{"field": "due", "sortOrder": "descending"}],
 "loadRelated": ["author"],
 "joins": [{"collection": "user_state", "as": "state", "id": "${auth.uid}_${item.id}"}]}
Annotations
  • @immutable

Constructors

CloudQueryDef({bool enabled = false, String collectionPath = '', List<WhereFilter> where = const [], List<OrderBy> orderBy = const [], int? limit, QueryPaging paging = QueryPaging.scroll, List<String> loadRelated = const [], List<CloudJoin> joins = const [], Json extra = const {}})
const

Properties

collectionPath → String
The collection's path (users/${auth.uid}/tasks); may hold ${...}.
final
enabled → bool
Whether the list reads from the cloud database.
final
extra → Json
Keys this version doesn't model (a status variable...), kept.
final
hashCode → int
The hash code for this object.
no setteroverride
isEmpty → bool
no setter
joins → List<CloudJoin>
Documents of other collections attached to each result (CloudJoin).
final
limit → int?
Documents per page; null for all.
final
loadRelated → List<String>
Reference fields whose documents load with each result.
final
orderBy → List<OrderBy>
final
paging → QueryPaging
final
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
where → List<WhereFilter>
final

Methods

noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
toJson() → Json
toString() → String
A string representation of this object.
override

Operators

operator ==(Object other) → bool
The equality operator.
override

Static Methods

fromJson(Object? json) → CloudQueryDef