API Reference / InstantSearch Android / Multi Hits

About this widget

Components that display a paginated list of search results from multiple indices.

To add MultiHits to your search experience, use these components:

  • MultiSearcher: The Searcher that handles your searches.
  • Paginator: Pagination utility that will load hits incrementally..
  • PagingConfig: Loading behavior configuration.
  • T, U, … : Data Classes representing each kind of search result.
  • FilterState: So the paginated list refreshes when filters change.

Examples

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
class MyActivity : AppCompatActivity() {

    val multiSearcher = MultiSearcher(
        applicationID = ApplicationID("YourApplicationID"),
        apiKey = APIKey("YourAPIKey")
    )
    val movieSearcher = multiSearcher.addHitsSearcher(indexName = IndexName("IndexMovie"))
    val moviesSearcher = multiSearcher.addHitsSearcher(indexName = IndexName("IndexActor"))
    val pagingConfig = PagingConfig(pageSize = 10)
    val moviePaginator = Paginator(
        searcher = movieSearcher,
        pagingConfig = pagingConfig,
        transformer = { it.deserialize(Movie.serializer()) }
    )
    val actorPaginator = Paginator(
        searcher = moviesSearcher,
        pagingConfig = pagingConfig,
        transformer = { it.deserialize(Actor.serializer()) }
    )
    val adapterMovie = MovieAdapter()
    val adapterActor = ActorAdapter()
    val filterState = FilterState()
    val connection = ConnectionHandler()

    override fun onCreate(savedInstanceState: Bundle?) {
        super.onCreate(savedInstanceState)

        connection += filterState.connectPaginator(moviePaginator)
        connection += filterState.connectPaginator(actorPaginator)

        moviePaginator.liveData.observe(this) { adapterMovie.submitData(lifecycle, it) }
        actorPaginator.liveData.observe(this) { adapterActor.submitData(lifecycle, it) }

        multiSearcher.searchAsync()
    }

    override fun onDestroy() {
        super.onDestroy()
        multiSearcher.cancel()
        connection.disconnect()
    }
}

@Serializable
data class Movie(
    val title: String
)

@Serializable
data class Actor(
    val name: String
)

class MovieViewHolder(val view: TextView) : RecyclerView.ViewHolder(view) {

    fun bind(data: Movie) {
        view.text = data.title
    }
}

class ActorViewHolder(val view: TextView) : RecyclerView.ViewHolder(view) {

    fun bind(data: Actor) {
        view.text = data.name
    }
}

class ActorAdapter : PagingDataAdapter<Actor, ActorViewHolder>(ActorAdapter) {

    override fun onCreateViewHolder(parent: ViewGroup, viewType: Int): ActorViewHolder {
        return ActorViewHolder(TextView(parent.context))
    }

    override fun onBindViewHolder(holder: ActorViewHolder, position: Int) {
        val actor = getItem(position)

        if (actor != null) {
            holder.bind(actor)
        }
    }

    companion object : DiffUtil.ItemCallback<Actor>() {

        override fun areItemsTheSame(oldItem: Actor, newItem: Actor): Boolean {
            return oldItem == newItem
        }

        override fun areContentsTheSame(oldItem: Actor, newItem: Actor): Boolean {
            return oldItem.name == newItem.name
        }
    }
}

class MovieAdapter : PagingDataAdapter<Movie, MovieViewHolder>(MovieAdapter) {

    override fun onCreateViewHolder(parent: ViewGroup, viewType: Int): MovieViewHolder {
        return MovieViewHolder(TextView(parent.context))
    }

    override fun onBindViewHolder(holder: MovieViewHolder, position: Int) {
        val movie = getItem(position)

        if (movie != null) holder.bind(movie)
    }

    companion object : DiffUtil.ItemCallback<Movie>() {

        override fun areItemsTheSame(oldItem: Movie, newItem: Movie): Boolean {
            return oldItem == newItem
        }

        override fun areContentsTheSame(oldItem: Movie, newItem: Movie): Boolean {
            return oldItem.title == newItem.title
        }
    }
}
Did you find this page helpful?