Query class
Represents a query over the data at a particular location.
- Implementers
Properties
- hashCode → int
-
The hash code for this object.
no setterinherited
-
onChildAdded
→ Stream<
DatabaseEvent> -
Fires when children are added.
no setter
-
onChildChanged
→ Stream<
DatabaseEvent> -
Fires when children are changed.
no setter
-
onChildMoved
→ Stream<
DatabaseEvent> -
Fires when children are moved.
no setter
-
onChildRemoved
→ Stream<
DatabaseEvent> -
Fires when children are removed.
previousChildKey
is null.no setter -
onValue
→ Stream<
DatabaseEvent> -
Fires when the data at this location is updated.
previousChildKey
is null.no setter - path → String
-
Slash-delimited path representing the database location of this query.
no setter
- ref → DatabaseReference
-
Obtains a DatabaseReference corresponding to this query's location.
no setter
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
Methods
-
endAt(
Object? value, {String? key}) → Query - Create a query constrained to only return child nodes with a value less than or equal to the given value, using the given orderBy directive or priority as default, and optionally only child nodes with a key less than or equal to the given key.
-
endBefore(
Object? value, {String? key}) → Query - Creates a Query with the specified ending point (exclusive) The ending point is exclusive. If only a value is provided, children with a value less than the specified value will be included in the query. If a key is specified, then children must have a value lesss than or equal to the specified value and a key name less than the specified key.
-
equalTo(
Object? value, {String? key}) → Query -
Create a query constrained to only return child nodes with the given
value
(andkey
, if provided). -
get(
) → Future< DataSnapshot> - Gets the most up-to-date result for this query.
-
keepSynced(
bool value) → Future< void> - By calling keepSynced(true) on a location, the data for that location will automatically be downloaded and kept in sync, even when no listeners are attached for that location. Additionally, while a location is kept synced, it will not be evicted from the persistent disk cache.
-
limitToFirst(
int limit) → Query - Create a query with limit and anchor it to the start of the window.
-
limitToLast(
int limit) → Query - Create a query with limit and anchor it to the end of the window.
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
once(
[DatabaseEventType eventType = DatabaseEventType.value]) → Future< DatabaseEvent> -
Listens for exactly one event of the specified event type, and then stops listening.
Defaults to DatabaseEventType.value if no
eventType
provided. -
orderByChild(
String path) → Query - Generate a view of the data sorted by values of a particular child path.
-
orderByKey(
) → Query - Generate a view of the data sorted by key.
-
orderByPriority(
) → Query - Generate a view of the data sorted by priority.
-
orderByValue(
) → Query - Generate a view of the data sorted by value.
-
startAfter(
Object? value, {String? key}) → Query - Creates a Query with the specified starting point (exclusive). Using startAt, startAfter, endBefore, endAt and equalTo allows you to choose arbitrary starting and ending points for your queries.
-
startAt(
Object? value, {String? key}) → Query - Create a query constrained to only return child nodes with a value greater than or equal to the given value, using the given orderBy directive or priority as default, and optionally only child nodes with a key greater than or equal to the given key.
-
toString(
) → String -
A string representation of this object.
inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited