List users in an open channel
In UIKit, you can retrieve a list of users in an open channel through the SBUUserListViewController
class. This class is used to display a list of channel participants, operators, muted participants, and banned users using the SBUUserCell
class.
Note: If you set the starting point of your chat service to be the channel list, open channel, or channel settings, you can seamlessly guide your users to the participant list view.
Types of user list
SBUUserListViewController
is composed of four different types of user list and uses ChannelUserListType
.
Type | Description |
---|---|
.participants | A list of participants in the open channel. |
.operators | A list of operators in the channel. |
.muted | A list of muted users in the channel. |
.banned | A list of banned users from the channel. |
Initialize
You can start building a participant list view through the SBUUserListViewController
class. The same class can be used to create a view for muted participant list and ban user list. Use either the init(channelURL:channelType:users:userListType:)
or init(channel:users:userListType:)
initializer to create the instance and display the view as shown below.
Usage
The following items are key elements of SBUUserListViewController
that are used to create a functional participant list view.
Module components
In the SBUUserListViewController
class, SBUUserListModule
and its components are used to create and display the participant list view. The module is composed of two components: HeaderComponent
and ListComponent
.
Property name | Type | Default value |
---|---|---|
headerComponent | SBUUserListModule.Header | SBUModuleSet.OpenUserListModule.HeaderComponent |
ListComponent | SBUUserListModule.List | SBUModuleSet.OpenUserListModule.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 new participants to the channel. Each property corresponds to the elements in the navigation bar of SBUUserListViewController
.
The following table shows the parameters of the configure
method of the HeaderComponent
.
Parameter name | Type |
---|---|
delegate | SBUUserListModuleHeaderDelegate |
userListType | ChannelUserListType |
theme | SBUUserListTheme |
componentTheme | SBUComponentTheme |
Note: To learn more about the delegate and the properties of the
HeaderComponent
, go to the API reference page.
ListComponent
The ListComponent
shows a list of all participants of an open channel. It's also used in other moderation views to display the operator list, muted participant list, and banned user list. The following table shows the parameters of the configure
method of the ListComponent
.
Parameter name | Type |
---|---|
delegate | SBUUserListModuleListDelegate |
dataSource | SBUUserListModuleListDataSource |
userListType | ChannelUserListType |
theme | SBUUserListTheme |
componentTheme | SBUComponentTheme |
Note: To learn more about the delegate, data source, and the properties of the
ListComponent
, go to the API reference page.
View model
The SBUUserListViewController
class uses a view model that is a type of the SBUUserListViewModel
class. The view model is created in the initializer of the view controller through the createViewModel(channel:channelURL:channelType:users:type:)
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 userListViewModel(_:didChangeUsers:needsToReload:)
event.
Note: If the value of
channel
orchannelURL
is invalid, the view model cannot retrieve the participant list.
The following table shows the parameters of the createViewModel
method.
Parameter name | Type | Description |
---|---|---|
channel | BaseChannel | Specifies the channel value. (Default: |
channelURL | String | Specifies the URL of the channel. (Default: |
channelType | ChannelType | Specifies the type of channel. This parameter needs to be specified with |
users | [SBUUser] | Specifies a custom user list if you wish to use your own list of users. (Default: |
type | ChannelUserListType | Specifies the type of each user in the list. |
Note: To learn more about the methods and the event delegates of the view model, go to this API reference page.
SBUUserListViewController properties
For detailed information about the properties of SBUUserListViewController
, go to the API reference page.
Customization
You can customize the participant list 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.
- Change the value of
SBUViewControllerSet.OpenUserListViewController
.
- Use a one-time custom view controller in the participant list view.
Module component
There are two ways to customize a module component: change the default module component type in the global SBUModuleSet.OpenUserListModule
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.
- Change the value of
SBUModuleSet.OpenUserListModule.HeaderComponent
.
- Change the module component in
SBUUSerListViewController
.
Note: To learn more about the methods of
SBUUserListModule
, go to the API reference page.
View model
In order to use a custom view model or customize the existing view model's event delegate, you must override the view controller. You can also customize different query types in the view model to retrieve different types of lists. See the query types below.
List | Query type |
---|---|
Participant list | participantListQuery |
Operator list | operatorListQuery |
Muted participant list | mutedParticipantListQuery |
Banned user list | bannedUserListQuery |
- Use a customized view model.
- Customize the view model's event delegate.