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

InviteUserFragment

open class InviteUserFragment : BaseModuleFragment<MT, VM>

Fragment displaying the user list to invite to the channel.

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.

getDisabledUserIds

@NonNull

protected open fun getDisabledUserIds(@NonNull channel: GroupChannel): List<String>

Returns the lists of user ids that you want to disable.

inviteUser

protected open fun inviteUser(@NonNull userIds: List<String>)

Invites users.

onBeforeInviteUsers

protected open fun onBeforeInviteUsers(@NonNull userIds: List<String>)

It will be called before inviting users.

onBeforeReady

protected open fun onBeforeReady( @NonNull status: ReadyStatus, @NonNull module: InviteUserModule, @NonNull viewModel: InviteUserViewModel)

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: SelectUserHeaderComponent, @NonNull viewModel: InviteUserViewModel, @Nullable channel: GroupChannel)

Called to bind events to the SelectUserHeaderComponent.

onBindInviteUserListComponent

protected open fun onBindInviteUserListComponent( @NonNull listComponent: InviteUserListComponent, @NonNull viewModel: InviteUserViewModel, @Nullable channel: GroupChannel)

Called to bind events to the InviteUserListComponent.

onBindStatusComponent

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

Called to bind events to the StatusComponent.

onConfigureParams

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

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

onCreateModule

@NonNull

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

Called to do initial creation of a module.

onCreateViewModel

@NonNull

protected open fun onCreateViewModel(): InviteUserViewModel

Called to do initial creation of a view model.

onNewUserInvited

protected open fun onNewUserInvited(@NonNull channel: GroupChannel)

It will be called when the new users have been invited.

onReady

protected open fun onReady( @NonNull status: ReadyStatus, @NonNull module: InviteUserModule, @NonNull viewModel: InviteUserViewModel)

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

onUserSelectionCompleted

protected open fun onUserSelectionCompleted(@NonNull selectedUsers: List<String>)

Called when the user selection completed.

onViewCreated

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