Sendbird UIKit/com.sendbird.uikit.modules/ChannelSettingsModule

ChannelSettingsModule

open class ChannelSettingsModule : BaseModule

A module for channel settings. This module is composed of a header, channel information and settings. All composed components are created when the module is created. After than those components can replace.

Header component is ChannelSettingsHeaderComponent and you can set custom header component by setHeaderComponent
Info component is ChannelSettingsInfoComponent and you can set custom info component by setChannelSettingsInfoComponent
Menu component is ChannelSettingsMenuComponent and you can set custom menu component by setChannelSettingsMenuComponent

since 3.0.0

Constructors

ChannelSettingsModule

open fun ChannelSettingsModule(@NonNull context: Context)

Constructor

ChannelSettingsModule

open fun ChannelSettingsModule(@NonNull context: Context, @NonNull params: ChannelSettingsModule.Params)

Constructor

Types

Params

open class Params : BaseModule.Params

Functions

getChannelSettingsInfoComponent

@NonNull

open fun getChannelSettingsInfoComponent(): ChannelSettingsInfoComponent

Returns the channel information component.

getChannelSettingsMenuComponent

@NonNull

open fun getChannelSettingsMenuComponent(): ChannelSettingsMenuComponent

Returns the settings menu component.

onCreateView

@NonNull

open fun onCreateView( @NonNull context: Context, @NonNull inflater: LayoutInflater, @Nullable args: Bundle): View

Called after the module was created to make views to use in the Fragment or Activity.

setChannelSettingsInfoComponent

open fun <T : ChannelSettingsInfoComponent?> setChannelSettingsInfoComponent(@NonNull component: T)

Sets the channel information component.

setChannelSettingsMenuComponent

open fun <T : ChannelSettingsMenuComponent?> setChannelSettingsMenuComponent(@NonNull component: T)

Sets the settings menu component.

setHeaderComponent

open fun <T : ChannelSettingsHeaderComponent?> setHeaderComponent(@NonNull component: T)

Sets a custom header component.

setOnLoadingDialogHandler

open fun setOnLoadingDialogHandler(@Nullable loadingDialogHandler: LoadingDialogHandler)

Sets the handler for the loading dialog.

shouldDismissLoadingDialog

open fun shouldDismissLoadingDialog()

It will be called when the loading dialog needs dismissing.

shouldShowLoadingDialog

open fun shouldShowLoadingDialog(@NonNull context: Context): Boolean

It will be called when the loading dialog needs displaying.

Properties

headerComponent

@NonNull

@get:NonNull

open val headerComponent: ChannelSettingsHeaderComponent

loadingDialogHandler

@Nullable

@get:Nullable

open val loadingDialogHandler: LoadingDialogHandler

params

@NonNull

@get:NonNull

val params: ChannelSettingsModule.Params