Sendbird UIKit/com.sendbird.uikit.fragments/MessageSearchFragment

MessageSearchFragment

open class MessageSearchFragment : BaseModuleFragment<MT, VM>

Fragment that provides message search

Types

Builder

open class Builder

Functions

getChannelUrl

@NonNull

protected open fun getChannelUrl(): String

Returns the URL of the channel with the required data to use this fragment.

onBeforeReady

protected open fun onBeforeReady( @NonNull status: ReadyStatus, @NonNull module: MessageSearchModule, @NonNull viewModel: MessageSearchViewModel)

After authenticate ()} is finished, onReady will be called with the result of authentication and all preparations will be ready to use.

onBindHeaderComponent

protected open fun onBindHeaderComponent( @NonNull headerComponent: MessageSearchHeaderComponent, @NonNull viewModel: MessageSearchViewModel, @Nullable channel: GroupChannel)

Called to bind events to the MessageSearchHeaderComponent.

onBindMessageSearchListComponent

protected open fun onBindMessageSearchListComponent( @NonNull listComponent: MessageSearchListComponent, @NonNull viewModel: MessageSearchViewModel, @Nullable channel: GroupChannel)

Called to bind events to the MessageSearchListComponent.

onBindStatusComponent

protected open fun onBindStatusComponent( @NonNull statusComponent: StatusComponent, @NonNull viewModel: MessageSearchViewModel, @Nullable channel: GroupChannel)

Called to bind events to the StatusComponent.

onConfigureParams

protected open fun onConfigureParams(@NonNull module: MessageSearchModule, @NonNull args: Bundle)

Called to initialize the module's params or components' params.

onCreateModule

@NonNull

protected open fun onCreateModule(@NonNull args: Bundle): MessageSearchModule

Called to do initial creation of a module.

onCreateViewModel

@NonNull

open fun onCreateViewModel(): MessageSearchViewModel

Called to do initial creation of a view model.

onItemClicked

protected open fun onItemClicked( @NonNull view: View, position: Int, @NonNull message: BaseMessage)

Called when a message item has been clicked.

onReady

protected open fun onReady( @NonNull status: ReadyStatus, @NonNull module: MessageSearchModule, @NonNull viewModel: MessageSearchViewModel)

Called to start the operation of the fragment after authentication and module setup.

onSearchResultReceived

protected open fun onSearchResultReceived(@NonNull searchResults: List<BaseMessage>)

It called when the search results exists.

protected open fun search(@NonNull keyword: String)

It called when the search request occurs with the written keyword.

shouldDismissLoadingDialog

open fun shouldDismissLoadingDialog()

It will be called when the loading dialog needs dismissing.

shouldShowLoadingDialog

open fun shouldShowLoadingDialog(): Boolean

It will be called when the loading dialog needs displaying.