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

ChannelSettingsFragment

open class ChannelSettingsFragment : BaseModuleFragment<MT, VM>

Fragment displaying the information of GroupChannel.

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.

leaveChannel

protected open fun leaveChannel()

Leaves this channel.

onBeforeReady

protected open fun onBeforeReady( @NonNull status: ReadyStatus, @NonNull module: ChannelSettingsModule, @NonNull viewModel: ChannelSettingsViewModel)

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

onBeforeUpdateGroupChannel

protected open fun onBeforeUpdateGroupChannel(@NonNull params: GroupChannelUpdateParams)

It will be called before updating group channel.

onBindHeaderComponent

protected open fun onBindHeaderComponent( @NonNull headerComponent: ChannelSettingsHeaderComponent, @NonNull viewModel: ChannelSettingsViewModel, @Nullable channel: GroupChannel)

Called to bind events to the ChannelSettingsHeaderComponent.

onBindSettingsInfoComponent

protected open fun onBindSettingsInfoComponent( @NonNull infoComponent: ChannelSettingsInfoComponent, @NonNull viewModel: ChannelSettingsViewModel, @Nullable channel: GroupChannel)

Called to bind events to the ChannelSettingsInfoComponent.

onBindSettingsMenuComponent

protected open fun onBindSettingsMenuComponent( @NonNull menuComponent: ChannelSettingsMenuComponent, @NonNull viewModel: ChannelSettingsViewModel, @Nullable channel: GroupChannel)

Called to bind events to the ChannelSettingsMenuComponent.

onConfigureParams

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

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

onCreateModule

@NonNull

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

Called to do initial creation of a module.

onCreateViewModel

@NonNull

protected open fun onCreateViewModel(): ChannelSettingsViewModel

Called to do initial creation of a view model.

onDestroy

open fun onDestroy()

onReady

protected open fun onReady( @NonNull status: ReadyStatus, @NonNull module: ChannelSettingsModule, @NonNull viewModel: ChannelSettingsViewModel)

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

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.

updateGroupChannel

protected open fun updateGroupChannel(@NonNull params: GroupChannelUpdateParams)

Update this channel with GroupChannelParams.