Chat UIKit iOS v2
Chat UIKit iOS
Chat UIKit
iOS
Version 2
Sendbird Chat UIKit v2 for iOS is no longer supported as a new version is released. Check out our latest Chat UIKit v3

Moderation

Copy link

To protect members from unsafe content and harmful language, Sendbird provides a variety of moderation methods. These methods include the ability to mute members, ban members, freeze channels and assign channel operators.


Mute is a feature that allows operators to mute certain members in a channel. Muted members can stay in the channel and are allowed to view the messages, but they can’t send any messages until the operators unmute them. In order to use this feature, a channel must have at least one operator. Sendbird UIKit for iOS provides you with customizable UI elements of the mute feature. These elements are found in the channel view, channel member list view, muted member list view and moderations view.

Customize the UI for mute in channel view

Copy link

The SBUChannelViewController class allows you to compose a channel view. Muted members can see that they are muted in the channel when they try to type a message in the messageInput component of the SBUChannelViewController class.

SBUStringSet

Copy link

You can customize the UI for mute shown in the messageInput component through SBUStringSet. The SBUStringSet is a set of strings used to compose the screen. You need to modify the stringSet values in advance if you want to make changes to the screen.

Property nameDescription

MessageInput_Text_Muted

A placeholder to indicate that a message can't be entered in the input box when the channel member is muted.

Customize the UI for mute and unmute in member list view

Copy link

The SBUMemberListViewController class allows you to retrieve a list of members in a specific group channel. An operator can mute or unmute members in the channel member list view. Those members will also appear in the muted member list view. The UI elements related to this feature are customizable.

SBUStringSet

Copy link

You can customize the UI for mute and unmute in the member list view through SBUStringSet. The SBUStringSet is a set of strings used to compose the screen. You need to modify the stringSet values in advance if you want to make changes to the screen.

Property nameDescription

MemberList_Mute

A text for Mute.

MemberList_Unmute

A text for Unmute.

MemberList_Title_Muted_Members

A text for Muted members.

Empty_No_Muted_Members

A text for No muted members in list.

SBUUserCellTheme

Copy link

You can also customize the UI for mute using the SBUUserCellTheme in the SBUUserCell class. The following table shows customizable theme properties in the SBUTheme.

CategoryPropertyDescription

Member state

mutedStateBackgroundColor

The Background color of muted members.

Member state

mutedStateIconColor

The tint color of the muted icon.

SBUIconSet

Copy link

The following table shows a customizable mute icon.

IconImageDescription

iconMute

Muted state

Customize the UI for mute in moderations view

Copy link

The SBUModerationsViewController class allows you to compose a moderations view where channels and members can be managed. A list of muted members can also be found in this view. For further information, refer to the Moderate channels and members page.

SBUStringSet

Copy link

You can customize the UI for mute in the moderations view through SBUStringSet. The SBUStringSet is a set of strings used to compose the screen.

Property nameDescription

ChannelSettings_Muted_Members

A text for Muted members.

SBUIconSet

Copy link

The following table shows a customizable mute icon.

IconImageDescription

iconMute

Muted state


Ban is a feature that allows operators to kick certain members out of the channel and prevent them from entering. Banned members expelled from a channel aren't allowed to enter the channel again until the operator unbans them. In order to use this feature, a channel must have at least one operator. Sendbird UIKit for iOS provides you with customizable UI elements of the ban feature. These elements are found in the channel member list view, banned member list view and moderations view.

Customize the UI for ban in member list view

Copy link

The SBUMemberListViewController class allows you to retrieve a list of members in a specific group channel. An operator can ban members in the channel member list view. The banned members will be removed from the channel member list and moved to the banned member list. If operators wish to unban members, they can do so in the banned member list view. The UI elements related to this feature are customizable.

SBUStringSet

Copy link

You can customize the UI for ban and unban in the member list view through SBUStringSet. The SBUStringSet is a set of strings used to compose the screen. The SBUStringSet is a set of strings used to compose the screen.

Property nameDescription

MemberList_Ban

A text for Ban.

MemberList_Unban

A text for Unban.

MemberList_Title_Banned_Members

A text for Banned members.

Empty_No_Banned_Members

A text for No banned members in list.

Customize the UI for ban in moderations view

Copy link

The SBUModerationsViewController class allows you to compose a moderations view where channels and members can be managed. A list of banned members can be found in this view. For further information, refer to the Moderate channels and members page.

SBUStringSet

Copy link

You can customize the UI for ban in the moderations view through SBUStringSet. The SBUStringSet is a set of strings used to compose the screen.

Property nameDescription

ChannelSettings_Banned_Members

A text for Banned members.

SBUIconSet

Copy link

The following table shows a customizable ban icon.

IconImageDescription

iconBan

Banned state


Channel operator

Copy link

Channel operator is a feature that allows you to assign an operator for a channel. The operator is authorized to ban and mute members as well as freeze channels. They play an important role in moderating members of a group channel with abnormal activities. Sendbird UIKit for iOS provides you with customizable UI elements of the channel operator feature. These elements are found in the channel member list view, operator list view and moderations view.

Customize the UI for channel operator in member list view

Copy link

The SBUMemberListViewController class allows you to retrieve a list of members in a specific group channel. You can assign or unassign a member to be an operator in the channel member list view. When a member is assigned to be an operator, the operator label will appear next to the member’s name on the channel member list. They'll also be added to the operator list. The UI elements related to this feature are customizable.

SBUStringSet

Copy link

You can customize the operator UI in the member list view through SBUStringSet. The SBUStringSet is a set of strings used to compose the screen.

Property nameDescription

MemberList_Promote_Operator

A text for Promote to operator

MemberList_Dismiss_Operator

A text for Dismiss operator

MemberList_Title_Operators

A text for Operators

Customize the UI for channel operator in moderations view

Copy link

The SBUModerationsViewController class allows you to compose a moderations view where channels and members can be managed. A list of channel operators can be found in this view. For further information, refer to the Moderate channels and members page.

SBUStringSet

Copy link

You can customize the operator UI in the moderations view through SBUStringSet. The SBUStringSet is a set of strings used to compose the screen.

CategoryPropertyDescription

Channel Settings

ChannelSettings_Operator

A text for Operators.

User

User_Operator

A text used when the user is an operator.

SBUIconSet

Copy link

The following table shows a customizable channel operator icon.

IconImageDescription

iconOperator

Channel operator


Freeze

Copy link

Freeze is a feature that pauses channels and only allows operators to talk within them. When a channel is in a frozen state, only channel operators can send a message while all chat functions are temporarily turned off for the rest of the members who are not operators. Sendbird UIKit for iOS provides you with customizable UI elements of the freeze feature. These elements are found in the channel view, channel list view, and moderations view.

Customize the UI for freeze in channel view

Copy link

The SBUChannelViewController class allows you to compose a channel view. Frozen channels have a state banner component of the SBUChannelViewController class that indicates that the channels are frozen.

SBUChannelTheme

Copy link

You can customize the UI for freeze shown in the state banner component using SBUChannelTheme in the SBUTheme class. The state banner, which indicates that a channel is frozen, can be customized through the SBUChannelTheme. The following table shows its customizable theme properties.

CategoryPropertyDescription

State banner

channelStateBannerFont

The text font of the state banner.

State banner

channelStateBannerTextColor

The text color of the state banner.

State banner

channelStateBannerBackgroundColor

The background color of the state banner.

SBUStringSet

Copy link

You can customize the UI for freeze in the channel view through SBUStringSet. The SBUStringSet is a set of strings used to compose the screen.

Property nameDescription

MessageInput_Text_Unavailable

A placeholder to indicate that a message can't be entered in the input box when the channel is frozen.

Channel_State_Banner_Frozen

A text to be displayed in the state banner for a frozen channel.

Customize the UI for freeze in channel list view

Copy link

The SBUChannelListViewController class allows you to compose a channel list view. members can see which channels are in a frozen state in the List component of SBUChannelListViewController. The UI elements related to this feature are customizable.

SBUChannelCellTheme

Copy link

You can customize the UI for freeze in the channel list view using SBUChannelCellTheme in the SBUTheme class. The following table shows customizable theme properties in the SBUChannelCellTheme.

CategoryPropertyDescription

Channel State

freezeStateTintColor

The tint color of the freeze state mark element.

SBUIconSet

Copy link

The SBUIconSet contains the icons that are used to compose the screen.

IconImageDescription

iconFreeze

Frozen state

Customize the UI for freeze in moderations view

Copy link

The SBUModerationsViewController class allows you to compose a moderations view where channels and members can be managed. An option to freeze or unfreeze a channel can be found in this view. For further information, refer to the Moderate channels and members page under Group channel.

SBUStringSet

Copy link

You can customize the UI for freeze in the moderations view through SBUStringSet. The SBUStringSet is a set of strings used to compose the screen.

Property nameDescription

ChannelSettings_Freeze_Channel

A text for Freeze channel.

SBUIconSet

Copy link

The following table shows a customizable freeze icon.

IconImageDescription

iconFreeze

Frozen state