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

Register members as operators

In UIKit for iOS, you can register a member as an operator using the SBURegisterOperatorViewController class. The view controller uses the SBUUserCell class to display a list of members in a group channel and appoint a member to be the operator.


Initialize

You can start building a register as operator view using the SBURegisterOperatorViewController 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 registerVC = SBURegisterOperatorViewController(
    channelUrl: {CHANNEL_URL},
    users: [{MEMBER}]
)
let navigationController = UINavigationController(rootViewController: registerVC)
present(navigationController, animated: true)

// Case 2: Use `channel` object.
let registerVC = SBURegisterOperatorViewController(
    channel: {CHANNEL},
    users: [{MEMBER}]
)
let navigationController = UINavigationController(rootViewController: registerVC)
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 SBURegisterOperatorViewController that are used to create a functional view.

Module components

In the SBURegisterOperatorViewController class, SBURegisterOperatorModule and its components are used to create and display the register as operator view. The module is composed of two components: headerComponent and listComponent.

Property nameTypeDefault value

headerComponent

SBURegisterOperatorModule.Header

SBUModuleSet.groupRegisterOperatorModule.headerComponent

listComponent

SBURegisterOperatorModule.List

SBUModuleSet.groupRegisterOperatorModule.listComponent

Each module component is assigned with 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 button that adds the selected members to the list of channel operators. The following table shows the parameters of the configure method of the headerComponent.

Parameter nameType

delegate

SBURegisterOperatorModuleHeaderDelegate

dataSource

SBURegisterOperatorModuleHeaderDataSource

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 channel members that can be registerd as operators. If the member is already an operator, they will not be shown on the list.

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

Parameter nameType

delegate

SBURegisterOperatorModuleListDelegate

dataSource

SBURegisterOperatorModuleListDataSource

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 SBURegisterOperatorViewController class uses a view model that is a type of the SBURegisterOperatorViewModel 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 participant 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 member 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 event delegates of the view model, go to this API reference page.

SBURegisterOperatorViewController properties

To learn more about the properties of SBURegisterOperatorViewController, go to this API reference page.


Customization

You can customize the register as operator 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 CustomRegisterOperatorViewController: SBURegisterOperatorViewController {
    // Implement custom code here.
}
  1. Change the value of SBUViewControllerSet.GroupChannelRegisterOperatorViewController.
SBUViewControllerSet.GroupChannelRegisterOperatorViewController = CustomRegisterOperatorViewController.self

// All ViewController in register as operator view will now use `CustomRegisterOperatorViewController` as the default value.
  1. Use a one-time custom view controller in the register as operator view.
let registerVC = CustomRegisterOperatorViewController(
    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.registerOperatorModule 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.registerOperatorModule.Header {
    // Implement custom code here.
}
  1. Change the value of SBUModuleSet.registerOperatorModule.headerComponent.
// The `headerComponent` in `SBURegisterOperatorViewController` will now use `customHeader` as the default value.

SBUModuleSet.registerOperatorModule.headerComponent = CustomHeader()

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

Note: To learn more about the methods of SBURegisterOperatorModule, 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: SBURegisterOperatorViewController {
    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: SBURegisterOperatorViewModelDelegate {
    override func registerOperatorViewModel(
        _ viewModel: SBURegisterOperatorViewModel,
        didRegisterOperatorIds operatorIds: [String]
    ) {
        // Implement your code here.
    }
}

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