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

OpenChannelFragment

open class OpenChannelFragment : BaseModuleFragment<MT, VM>

Fragment that provides chat in OpenChannel

Types

Builder

open class Builder

This is a Builder that is able to create the OpenChannel fragment.

Functions

deleteMessage

protected open fun deleteMessage(@NonNull message: BaseMessage)

Delete a message

getChannelUrl

@NonNull

protected open fun getChannelUrl(): String

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

makeMessageContextMenu

@NonNull

protected open fun makeMessageContextMenu(@NonNull message: BaseMessage): List<DialogListItem>

Make context menu items that are shown when the message is long clicked.

onBeforeReady

protected open fun onBeforeReady( @NonNull status: ReadyStatus, @NonNull module: OpenChannelModule, @NonNull viewModel: OpenChannelViewModel)

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

onBeforeSendFileMessage

protected open fun onBeforeSendFileMessage(@NonNull params: FileMessageCreateParams)

It will be called before sending message.

onBeforeSendUserMessage

protected open fun onBeforeSendUserMessage(@NonNull params: UserMessageCreateParams)

It will be called before sending message.

onBeforeUpdateUserMessage

protected open fun onBeforeUpdateUserMessage(@NonNull params: UserMessageUpdateParams)

It will be called before updating message.

onBindChannelHeaderComponent

protected open fun onBindChannelHeaderComponent( @NonNull headerComponent: OpenChannelHeaderComponent, @NonNull viewModel: OpenChannelViewModel, @Nullable channel: OpenChannel)

Called to bind events to the OpenChannelHeaderComponent.

onBindMessageInputComponent

protected open fun onBindMessageInputComponent( @NonNull inputComponent: OpenChannelMessageInputComponent, @NonNull viewModel: OpenChannelViewModel, @Nullable channel: OpenChannel)

Called to bind events to the OpenChannelMessageInputComponent.

onBindMessageListComponent

protected open fun onBindMessageListComponent( @NonNull messageListComponent: OpenChannelMessageListComponent, @NonNull viewModel: OpenChannelViewModel, @Nullable channel: OpenChannel)

Called to bind events to the OpenChannelMessageListComponent.

onBindStatusComponent

protected open fun onBindStatusComponent( @NonNull statusComponent: StatusComponent, @NonNull viewModel: OpenChannelViewModel, @Nullable channel: OpenChannel)

Called to bind events to the StatusComponent.

onConfigurationChanged

open fun onConfigurationChanged(@NonNull newConfig: Configuration)

onConfigureParams

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

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

onCreate

open fun onCreate(@Nullable savedInstanceState: Bundle)

Create a module and a view model, and proceed with the authentication process in the view model.

onCreateModule

@NonNull

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

Called to do initial creation of a module.

onCreateViewModel

@NonNull

open fun onCreateViewModel(): OpenChannelViewModel

Returns a OpenChannelViewModel.

onDestroy

open fun onDestroy()

onMessageClicked

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

Called when the item of the message list is clicked.

onMessageContextMenuItemClicked

protected open fun onMessageContextMenuItemClicked( @NonNull message: BaseMessage, @NonNull view: View, position: Int, @NonNull item: DialogListItem): Boolean

It will be called when the message context menu was clicked.

onMessageLongClicked

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

Called when the item of the message list is long-clicked.

onMessageProfileClicked

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

Called when the profile view of the message is clicked.

onReady

protected open fun onReady( @NonNull status: ReadyStatus, @NonNull module: OpenChannelModule, @NonNull viewModel: OpenChannelViewModel)

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

onViewCreated

open fun onViewCreated(@NonNull view: View, @Nullable savedInstanceState: Bundle)

resendMessage

protected open fun resendMessage(@NonNull message: BaseMessage)

Resends a failed message.

saveFileMessage

protected open fun saveFileMessage(@NonNull message: FileMessage)

Download FileMessage into external storage.

sendFileMessage

protected open fun sendFileMessage(@NonNull uri: Uri)

Sends a file with given file information.

sendUserMessage

protected open fun sendUserMessage(@NonNull params: UserMessageCreateParams)

Sends a user message.

shouldDismissLoadingDialog

protected open fun shouldDismissLoadingDialog()

It will be called when the loading dialog needs dismissing.

shouldShowLoadingDialog

protected open fun shouldShowLoadingDialog(): Boolean

It will be called when the loading dialog needs displaying.

showMediaSelectDialog

protected open fun showMediaSelectDialog()

It will be called when the input message's left button is clicked.

takeCamera

open fun takeCamera()

Call taking camera application.

takeFile

open fun takeFile()

Call taking file chooser application.

takePhoto

open fun takePhoto()

Call taking gallery application.

takeVideo

open fun takeVideo()

Call taking camera application for video capture.

updateUserMessage

protected open fun updateUserMessage(messageId: Long, @NonNull params: UserMessageUpdateParams)

Updates a UserMessage that was previously sent in the channel.