UIKit iOS v3
UIKit iOS
UIKit
iOS
Home
/
UIKit
/
iOS
This is the new Docs for UIKit v3 for iOS. To see the previous Docs, click here.

Invite users

In UIKit for iOS, you can invite users to a group channel through the SBUInviteUserViewController class. The view controller uses the SBUUserCell class to display a list of users who aren't in the channel and invite them. Unless you have a specific list of users you selected, all users who are using your chat service is displayed in the user list by default.

Note: If you set the starting point of your chat service to be the channel list, group or open channel, channel settings or member list, you can seamlessly guide your users to the invite users view.


Initialize

You can start building an invite users view through the SBUInviteUserViewController class. Use either the init(channelUrl:users:) or init(channel:users:) initializer to create the instance and display the view as shown below.

// Case 1: Use `channelUrl`.
let inviteVC = SBUInviteUserViewController(
    channelUrl: {CHANNEL_URL},
    users: [{MEMBER}]
)
let navigationController = UINavigationController(rootViewController: inviteVC)
present(navigationController, animated: true)

// Case 2: Use `channel` object.
let inviteVC = SBUInviteUserViewController(
    channel: {CHANNEL},
    users: [{MEMBER}]
)
let navigationController = UINavigationController(rootViewController: inviteVC)
present(navigationController, animated: true)

Note: If you don't set a value to the user parameter, the default value of nil is used instead.


Usage

The following items are key elements of SBUInviteUserViewController that are used to create a functional view.

Module components

In the SBUInviteUserViewController class, SBUInviteUserModule and its components are used to create and display the invite users view. The module is composed of two components: headerComponent and listComponent.

Property nameTypeDefault value

headerComponent

SBUInviteUserModule.Header

SBUModuleSet.inviteUserModule.headerComponent

listComponent

SBUInviteUserModule.List

SBUModuleSet.inviteUserModule.listComponent

Each module component is assigned a value from the SBUModuleSet class and gets added to the view in the setupView() method of the Sendbird UIKit's view life cycle. Then, the configure method of each module component is called to set the property values and display the view.

headerComponent

The headerComponent includes a channel title, a back button that takes the user to the previous view, and a text button that invites the selected users to the channel.

The following table shows the parameters of the configure method of the headerComponent.

Parameter nameType

delegate

SBUInviteUserModuleHeaderDelegate

dataSource

SBUInviteUserModuleHeaderDataSource

theme

SBUUserListTheme

Note: To learn more about the delegate, data source, and the properties of the headerComponent, go to this API reference page.

listComponent

The listComponent shows a list of all users that can be invited. If the user is already a channel member, they will not be shown on the list.

The following table shows the parameters of the configure method of the listComponent.

Parameter nameType

delegate

SBUInviteUserModuleListDelegate

dataSource

SBUInviteUserModuleListDataSource

theme

SBUUserListTheme

Note: To learn more about the delegate, data source, and the properties of the listComponent, go to this API reference page.

View model

The SBUInviteUserViewController class uses a view model that is a type of the SBUInviteUserViewModel class. The view model is created in the initializer of the view controller through the createViewModel(channel:channelUrl:channelType:users:) method. When the view model object is created, it retrieves channel list data from Chat SDK to the view controller and updates the view through the baseSelectedUserViewModel(_:didChangeUserList:needsToReload:) event.

Note: If the value of channel or channelUrl is invalid, the view model cannot retrieve the user list.

The following table shows the parameters of the createViewModel method.

Parameter nameTypeDescription

channel

BaseChannel

Specifies the channel value. (Default: nil)

channelUrl

String

Specifies the URL of the channel. (Default: nil)

channelType

ChannelType

Specifies the type of channel. This parameter needs to be specified with channelUrl. (Default: group)

users

[SBUUser]

Specifies a custom user list if you wish to use your own list of users. (Default: nil)

Note: To learn more about the methods and the event delegates of the view model, go to this API reference page.

SBUInviteUserViewController properties

For detailed information about the properties of SBUInviteUserViewController, go to this API reference page.


Customization

You can customize the invite users view by changing the view controller, module component, and view model that correspond to this key function.

View controller

There are two ways to customize the view controller: change the default view controller value in the global SBUViewControllerSet class or set a single-use custom view controller in the key function.

The custom view controller in the code below is used in the following customization examples.

class CustomInviteUserViewController: SBUInviteUserViewController {
    // Implement custom code here.
  1. Change the value of SBUViewControllerSet.InviteUserViewController.
SBUViewControllerSet.InviteUserViewController = CustomInviteUserViewController.self

// All ViewController in invite users view will now use `CustomInviteUserViewController` as the default value.
  1. Use a one-time custom view controller in the invite users view.
let inviteVC = CustomInviteUserViewController(
    channel: {CHANNEL},
    users: [{MEMBER}]
)
let navigationController = UINavigationController(rootViewController: inviteVC)
present(navigationController, animated: true)

Module component

There are two ways to customize a module component: change the default module component value in the global SBUModuleSet.inviteUserModule class or set a single-use custom module component in the view controller.

The custom header component in the code below is used in the following customization examples.

class CustomHeader: SBUModuleSet.inviteUserModule.Header {
    // Implement custom code here.
}
  1. Change the value of SBUModuleSet.inviteUserModule.headerComponent.
// The `headerComponent` in `SBUInviteUserViewController` will now use `customHeader` as the default value.

SBUModuleSet.inviteUserModule.headerComponent = CustomHeader()

let inviteVC = SBUViewControllerSet.InviteUserViewController(
    channel: {CHANNEL},
    users: [{MEMBER}]
)
  1. Change the module component in SBUInviteUserViewController.
let inviteVC = SBUViewControllerSet.InviteUserViewController(
    channel: {CHANNEL},
    users: [{MEMBER}]
)
channelSettingsVC.headerComponent = CustomHeader()

Note: To learn more about the methods of SBUInviteUserModule, go to this API reference page.

View model

In order to use a customized view model or customize the existing view model's event delegate, you must override the view controller.

  1. Use a customized view model.
class CustomViewController: SBUInviteUserViewController {
    override func createViewModel(channel: BaseChannel? = nil,
                                  channelURL: String? = nil,
                                  channelType: ChannelType = .group,
                                  users: [SBUUser]? = nil) {
        // Set `viewModel` to the `CustomViewModel` object.
        self.viewModel = CustomViewModel()

        // Implement your code here.
    }
}
  1. Customize the view model's event delegate.
extension CustomViewController: SBUInviteUserViewModelDelegate {
    override func inviteUserViewModel(
        _ viewModel: SBUInviteUserViewModel,
        didInviteUserIds userIds: [String]
    ) {
        // Implement your code here.
    }
}

Note: You can also customize the data source using the same codes as above.