stream-chat-android-ui-components/io.getstream.chat.android.ui.viewmodel.search/SearchViewModel

SearchViewModel

class SearchViewModel(chatClient: ChatClient = ChatClient.instance()) : ViewModel

ViewModel responsible for searching for messages that match a particular search query.

Constructors

constructor(chatClient: ChatClient = ChatClient.instance())

Types

data class State(val query: String = "", val canLoadMore: Boolean = true, val results: List<MessageResult> = emptyList(), val isLoading: Boolean = false, val isLoadingMore: Boolean = false)

Represents the search screen state, used to render the required UI.

Properties

errorEvents

val errorEvents: LiveData<Event<Unit>>

One shot error events when search fails.

state

val state: LiveData<SearchViewModel.State>

The current state of the search screen.

Functions

loadMore

fun loadMore()

Loads more data when the user reaches the end of the found message list.

setQuery

fun setQuery(query: String)

Changes the current query state. An empty search query

Inherited functions

addCloseable

open fun addCloseable(closeable: AutoCloseable)

fun addCloseable(key: String, closeable: AutoCloseable)

bindView

@JvmName(name = "bind")

fun SearchViewModel.bindView(view: SearchResultListView, lifecycleOwner: LifecycleOwner)

Binds SearchResultListView with SearchViewModel, updating the view's state based on data provided by the ViewModel, and propagating view events to the ViewModel as needed.

getCloseable

fun <T : AutoCloseable> getCloseable(key: String): T?