> ## Documentation Index
> Fetch the complete documentation index at: https://algolia.com/llms.txt
> Use this file to discover all available pages before exploring further.
# Searcher
> Manages search sessions and requests.
export const UserToken = () =>
user token
;
export const SearchRequest = () =>
search request
;
export const SearchQuery = () =>
search query
;
export const Records = () =>
records
;
export const Index = () =>
index
;
export const Facet = () =>
facet
;
export const Events = () =>
events
;
export const FlavorSwitcher = ({current, baseHref = "", options = [], label = "InstantSearch framework"}) => {
if (options.length === 0) {
return
FlavorSwitcher requires at least one option.
;
}
const selected = options.find(option => option.value === current) ?? options[0];
return ;
};
{/* vale Algolia.HeadingPronouns = NO */}
## About this widget
This component is handled by objects that implement the [`Searcher` interface](https://github.com/algolia/instantsearch-android/blob/master/instantsearch-core/src/commonMain/kotlin/com/algolia/instantsearch/core/searcher/Searcher.kt).
These objects manage the search session and process each as it occurs.
Algolia provides you with several out of the box searchers to help build your InstantSearch experience:
* `HitsSearcher`: searches a single .
* `FacetSearcher`: searches for values.
* `MultiSearcher`: searches in multiple indices.
This is useful for a federated search, or query suggestions search experience.
Browse the Searcher example code on GitHub.
## Examples
Instantiating a `HitsSearcher`:
```kotlin Kotlin icon=code theme={"system"}
val searcher = HitsSearcher(
applicationID = "YourApplicationID",
apiKey = "YourSearchOnlyAPIKey",
indexName = "index_name",
isAutoSendingHitsViewEvents = true
)
```
Instantiating a `FacetSearcher`:
```kotlin Kotlin icon=code theme={"system"}
val searcher = FacetsSearcher(
applicationID = "YourApplicationID",
apiKey = "YourSearchOnlyAPIKey",
indexName = "index_name",
attribute = "color"
)
```
Instantiating a `MultiSearcher`:
```kotlin Kotlin icon=code theme={"system"}
val multiSearcher = MultiSearcher(
applicationID = "YourApplicationID",
apiKey = "YourSearchOnlyAPIKey",
)
val hitsSearcher = multiSearcher.addHitsSearcher(indexName = "index_name1")
val facetsSearcher = multiSearcher.addFacetsSearcher(
indexName = "index_name1",
attribute = "facet_name"
)
```
## HitsSearcher
The index to search into.
```kotlin Kotlin icon=code theme={"system"}
val indexName = "index_name"
val searcher = HitsSearcher(
applicationID = "YourApplicationID",
apiKey = "YourSearchOnlyAPIKey",
indexName = indexName
)
```
A .
```kotlin Kotlin icon=code theme={"system"}
val query = SearchParamsObject(analytics = false)
val searcher = HitsSearcher(
applicationID = "YourApplicationID",
apiKey = "YourSearchOnlyAPIKey",
indexName = "index_name",
query = query
)
```
Flag defining whether the automatic hits view Insights sending is enabled.
The default value was `true` until version 3.3.1.
```kotlin Kotlin icon=code theme={"system"}
val searcher = HitsSearcher(
applicationID = "YourApplicationID",
apiKey = "YourSearchOnlyAPIKey",
indexName = "index_name",
isAutoSendingHitsViewEvents = true,
)
```
The user token assigned to automatically send click and conversion events in the `HitsSearcher` component.
If not explicitly set during initialization,
the `HitsSearcher` generates and assigns a default user token.
RequestOptions that apply to the search.
```kotlin Kotlin icon=code theme={"system"}
val requestOptions = RequestOptions(
headers = mapOf("X-Forwarded-For" to "1.2.3.4")
)
val searcher = HitsSearcher(
applicationID = "YourApplicationID",
apiKey = "YourSearchOnlyAPIKey",
indexName = "index_name",
requestOptions = requestOptions
)
```
## FacetSearcher
The index to search into.
```kotlin Kotlin icon=code theme={"system"}
val indexName = "index_name"
val searcher = FacetsSearcher(
applicationID = "YourApplicationID",
apiKey = "YourSearchOnlyAPIKey",
indexName = indexName,
attribute = "color"
)
```
An attribute to search facet values for.
```kotlin Kotlin icon=code theme={"system"}
val attribute = "color"
val searcher = FacetsSearcher(
applicationID = "YourApplicationID",
apiKey = "YourSearchOnlyAPIKey",
indexName = "index_name",
attribute = attribute
)
```
A query used to perform the search.
```kotlin Kotlin icon=code theme={"system"}
val query = SearchParamsObject(analytics = true)
val searcher = FacetsSearcher(
applicationID = "YourApplicationID",
apiKey = "YourSearchOnlyAPIKey",
indexName = "index_name",
attribute = "color",
query = query
)
```
`RequestOptions` that apply to the search.
```kotlin Kotlin icon=code theme={"system"}
val requestOptions = RequestOptions(
headers = mapOf("X-Forwarded-For" to "1.2.3.4")
)
val searcher = FacetsSearcher(
applicationID = "YourApplicationID",
apiKey = "YourSearchOnlyAPIKey",
indexName = "index_name",
attribute = "facet_name",
requestOptions = requestOptions
)
```
## MultiSearcher
The strategy of the query.
Can be one of the following values:
* `None`. Execute the sequence of queries until the end.
This is recommended when each query is of equal importance, meaning all
of all queries need to be returned.
* `StopIfEnoughMatches`. Execute queries one by one, but stop as soon
as the cumulated number of hits is at least `hitsPerPage`.
This is recommended when each query is an alternative,
and where, if the first returns enough records,
there is no need to perform the remaining queries.
```kotlin Kotlin icon=code theme={"system"}
val multiSearcher = MultiSearcher(
applicationID = "YourApplicationID",
apiKey = "YourSearchOnlyAPIKey",
strategy = MultipleQueriesStrategy.None
)
```
`RequestOptions` that apply to the search.
```kotlin Kotlin icon=code theme={"system"}
val requestOptions = RequestOptions(
headers = mapOf("X-Forwarded-For" to "1.2.3.4")
)
val multiSearcher = MultiSearcher(
applicationID = "YourApplicationID",
apiKey = "YourSearchOnlyAPIKey",
requestOptions = requestOptions
)
```
## Methods
Triggers the search and returns a search response.
```kotlin Kotlin icon=code theme={"system"}
searcher.search()
```
Triggers the search.
Notifies all listeners of the results.
```kotlin Kotlin icon=code theme={"system"}
searcher.searchAsync()
```
Cancels the ongoing search requests.
```kotlin Kotlin icon=code theme={"system"}
searcher.cancel()
```
Sets the query to the string provided.
```kotlin Kotlin icon=code theme={"system"}
searcher.setQuery("foo")
```
## Events
Triggered when the status of the search request is changed.
```kotlin Kotlin icon=code theme={"system"}
searcher.onLoadingChanged += { loading ->
print(if (loading) "Currently loading search response" else "Done loading")
}
```
Triggered when a new response has arrived.
```kotlin Kotlin icon=code theme={"system"}
searcher.onResponseChanged += { response ->
val hits = response.hits.deserialize(MovieHit.serializer())
// Do something with hits...
}
```
The deserialize extension is deprecated in 4.x.
Consider parsing hits directly from `SearchResponse.hits`, which returns `List` from the Algolia client.
Triggered when an error was encountered during a search request.
```kotlin Kotlin icon=code theme={"system"}
searcher.onErrorChanged += {
errorTextView.text = it.localizedMessage
}
```