SearchControllerState class

It stores the state of the SearchController at any time.

Constructors

SearchControllerState({Aggregations? aggregationData, Results? results, RequestStatus? requestStatus, dynamic error, dynamic value, List<Map>? query, dynamic dataField, int? size, int? from, dynamic fuzziness, List<String>? includeFields, List<String>? excludeFields, SortType? sortBy, Map<String, dynamic>? react, Map defaultQuery(SearchController searchController)?, Map customQuery(SearchController searchController)?})

Properties

aggregationData → Aggregations?
An object that contains the aggregations data for QueryType.term queries.
final
customQuery → (Map Function(SearchController searchController)?)
It takes SearchController instance as parameter and returns the query to be applied to the dependent widgets by react prop, as defined in Elasticsearch Query DSL.
final
dataField → dynamic
The index field(s) to be connected to the component’s UI view.
final
defaultQuery → (Map Function(SearchController searchController)?)
It is a callback function that takes the SearchController instance as parameter and returns the data query to be applied to the source component, as defined in Elasticsearch Query DSL, which doesn't get leaked to other components.
final
error → dynamic
Represents the error response returned by elasticsearch.
final
excludeFields → List<String>?
It allows to define fields to be excluded in search results.
final
from → int?
To define from which page to start the results, it is important to implement pagination.
final
fuzziness → dynamic
Useful for showing the correct results for an incorrect search parameter by taking the fuzziness into account.
final
hashCode → int
The hash code for this object.
no setterinherited
includeFields → List<String>?
It allows to define fields to be included in search results.
final
query → List<Map>?
Represents a map of reactivesearch queries associated to the widget.
final
react → Map<String, dynamic>?
Here, we are specifying that the results should update whenever one of the blacklist items is not present and simultaneously any one of the city or topics matches.
final
requestStatus → RequestStatus?
It represents the current status of the request.
final
results → Results?
It is an object that represents the elasticsearch query response.
final
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
size → int?
Number of suggestions and results to fetch per request.
final
sortBy → SortType?
Sorts the results by either SortType.asc, SortType.desc or SortType.count order.
final
value → dynamic
Represents the value for a particular QueryType.
final

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