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

OpenChannelSettingsModule

open class OpenChannelSettingsModule : BaseModule

A module for open 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 OpenChannelSettingsHeaderComponent and you can set custom header component by setHeaderComponent
Info component is OpenChannelSettingsInfoComponent and you can set custom info component by setOpenChannelSettingsInfoComponent
Menu component is OpenChannelSettingsMenuComponent and you can set custom menu component by setOpenChannelSettingsMenuComponent

since 3.0.0

Constructors

OpenChannelSettingsModule

open fun OpenChannelSettingsModule(@NonNull context: Context)

Constructor

OpenChannelSettingsModule

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

Constructor

Types

Params

open class Params : BaseModule.Params

Functions

getOpenChannelSettingsInfoComponent

@NonNull

open fun getOpenChannelSettingsInfoComponent(): OpenChannelSettingsInfoComponent

Returns the open channel information component.

getOpenChannelSettingsMenuComponent

@NonNull

open fun getOpenChannelSettingsMenuComponent(): OpenChannelSettingsMenuComponent

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.

setHeaderComponent

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

Sets a custom header component.

setOnLoadingDialogHandler

open fun setOnLoadingDialogHandler(@Nullable loadingDialogHandler: LoadingDialogHandler)

Sets the handler for the loading dialog.

setOpenChannelSettingsInfoComponent

open fun <T : OpenChannelSettingsInfoComponent?> setOpenChannelSettingsInfoComponent(@NonNull component: T)

Sets the open channel information component.

setOpenChannelSettingsMenuComponent

open fun <T : OpenChannelSettingsMenuComponent?> setOpenChannelSettingsMenuComponent(@NonNull component: T)

Sets the settings menu component.

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: OpenChannelSettingsHeaderComponent

loadingDialogHandler

@Nullable

@get:Nullable

open val loadingDialogHandler: LoadingDialogHandler

params

@NonNull

@get:NonNull

val params: OpenChannelSettingsModule.Params