Configure group channel settings
In UIKit, you can configure channel settings in group channels through the SBUGroupChannelSettingsViewController
class. In the group channel settings view, you can change the channel name and cover image, see the member list, and more.
Note: If you set the starting point of your chat service to be the channel list or group channel, you can seamlessly guide your users to the channel settings view.
Initialize
You can start building a group channel settings view through the SBUGroupChannelSettingsViewController
class. Use either the init(channelURL:)
or init(channel:)
initializer to create the instance and display the view as shown below.
Usage
The following items are key elements of SBUGroupChannelSettingsViewController
that are used to create a functional group channel settings view.
Module components
In the SBUGroupChannelSettingsViewController
class, SBUGroupChannelSettingsModule
and its components are used to create and display the group channel settings view. The module is composed of two components: HeaderComponent
and ListComponent
.
Property name | Type | Default value |
---|---|---|
HeaderComponent | SBUGroupChannelSettingsModule.Header | SBUModuleSet.GroupChannelSettingsModule.HeaderComponent |
ListComponent | SBUGroupChannelSettingsModule.List | SBUModuleSet.GroupChannelSettingsModule.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 an edit button that allows the user to make edits to the channel information. Each property corresponds to the elements in the navigation bar of SBUGroupChannelSettingsViewController
.
The following table shows the parameters of the configure
method of the headerComponent
.
Parameter name | Type |
---|---|
delegate | SBUGroupChannelSettingsModuleHeaderDelegate |
dataSource | SBUGroupChannelSettingsModuleHeaderDataSource |
theme | SBUChannelSettingsTheme |
Note: To learn more about the delegate, data source, and the properties of the
headerComponent
, go to the API reference page.
listComponent
The listComponent
shows a settings menu, which includes a toggle button that turns on or off functions such as push notifications, a channel member list, an option to search in channel, and the option to leave the channel. For channel operators, the moderations menu is also available.
The following table shows the parameters of the configure
method of the listComponent
.
Parameter name | Type |
---|---|
delegate | SBUGroupChannelSettingsModuleListDelegate |
dataSource | SBUGroupChannelSettingsModuleListDataSource |
theme | SBUChannelSettingsTheme |
Note: To learn more about the delegate, data source, and the properties of the
listComponent
, go to the API reference page.
View model
The SBUGroupChannelSettingsViewController
class uses a view model that is a type of the SBUGroupChannelSettingsViewModel
class. The view model is created in the initializer of the view controller through the createViewModel(channel:channelURL:)
method. When the view model object is created, it retrieves channel information from Chat SDK to the view controller and updates the view through the baseChannelSettingsViewModel(_:didChangeChannel:withContext:)
event.
Note: If the value of
channel
orchannelURL
is invalid, the view model cannot retrieve channel information.
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: |
Note: To learn more about the methods and the event delegates of the view model, go to this API reference page.
SBUGroupChannelSettingsViewController properties
To learn more about the properties of SBUGroupChannelSettingsViewController
, go to the API reference page.
Customization
You can customize the group channel settings 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.GroupChannelSettingsViewController
.
- Use a one-time custom view controller in the group channel settings view.
Module component
There are two ways to customize a module component: change the default module component type in the global SBUModuleSet.GroupChannelSettingsModule
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.GroupChannelSettingsModule.headerComponent
.
- Change the module component in
SBUGroupChannelSettingsViewController
.
Note: To learn more about the methods of
SBUGroupChannelSettingsModule
, go to the 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.
- Use a customized view model.
- Customize the view model's event delegate.