Filter class

A helper class to dynamically construct realtime database queries.

You can use one of the three factory constructors of this class, Filter.property, Filter.key or Filter.value to generate a FilterBuilder. This will define how elements are ordere by the server before filters are applied. You can then use the returned builder to apply filters and finally build the actual filter that can be passed to API methods.

Important: This does not affect the ordering of the received data - after filters have been applied, the data can be returned by the server in any order - if you only (or in addition) need to sort returned data, do so on the client side.

Annotations
  • @freezed

Properties

copyWith → $FilterCopyWith<Filter>
no setterinherited
filters Map<String, String>
no setterinherited
hashCode int
The hash code for this object.
no setterinherited
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

Static Methods

key() FilterBuilder<String>
Order elements by their key before filtering them.
property<T>(String property) FilterBuilder<T>
Order elements by a certain child value before filtering them.
value<T>() FilterBuilder<T>
Order elements by their value before filtering them.