searchbase library
Classes
- AggregationDataChanges
-
Represents the AggregationData change object with
prev
andnext
values. - Aggregations
- Represents the elasticsearch aggregations response for QueryType.term type of SearchController.
- AppbaseSettings
- AppbaseSettings allows you to customize the analytics experience when appbase.io is used as a backend.
- BooleanTypeChanges
-
Represents the bool type change object with
prev
andnext
values. - Changes
-
Represents the change object with
prev
andnext
values. - ChangesController
- DefaultQueryTypeChanges
-
Represents the DefaultQuery type change object with
prev
andnext
values. - DynamicMapTypeChanges
- Represents the Map
- GenerateQueryResponse
- IntegerChanges
-
Represents the Integer type change object with
prev
andnext
values. - Option
- Allows to configure the effects after executing a query.
- Options
- Allows to configure the effects of an update in a particular property.
- ReactTypeChanges
-
Represents the React type change object with
prev
andnext
values. - RecentSearchesChanges
-
Represents the RecentSeaches change object with
prev
andnext
values. - RecentSearchOptions
- Options to configure the recent searches request.
- RequestStatusChanges
-
Represents the RequestStatus change object with
prev
andnext
values. - Results
- Represents the response for QueryType.search, QueryType.geo and QueryType.range type of SearchController.
- ResultsChanges
-
Represents the Results change object with
prev
andnext
values. - SearchBase
- The SearchBase class holds the state for all the active SearchController and can be used to provide the global configuration to the registered SearchController.
- SearchController
- The SearchController class can be used to bind to different kinds of search UI widgets.
- SearchControllerState
- It stores the state of the SearchController at any time.
- SearchStateController
- It allows you to access the current state of your widgets along with the search results. For instance, you can use this class to access the previous and the next(latest) state of your app widget tree.
- SortTypeChanges
-
Represents the SortType type change object with
prev
andnext
values. - StringListChanges
- Represents the List
- Suggestion
- Represents a suggestion object.
Enums
- CompoundClauseType
- KeysToSubscribe
- QueryType
-
Represents the type of the query which is defaults to QueryType.search, valid values are
search
,term
,range
&geo
. You can read more here. - RequestStatus
- Represents the current status of the elasticsearch request
- SortType
Extensions
Constants
- DataFieldAsArray → const String
- ErrorMessages → const Map
- InvalidComponentId → const String
- InvalidCredentials → const String
- InvalidDataField → const String
- InvalidIndex → const String
- InvalidURL → const String
- suggestionQueryID → const String
Typedefs
- SubscriptionFunction = dynamic Function(ChangesController change)
-
TransformRequest
= Future<
Object> Function(Map requestOptions) - TransformResponse = Future Function(dynamic response)
Exceptions / Errors
- HttpError
- Exception class representing an HTTP error with an associated status code and an optional message.
- HttpTimeout
- Exception class representing an HTTP request timeout.
- NoInternet
- Exception class representing the absence of an internet connection.