A banned user list in a group channel is a complete list of users that are banned from the channel. Only an operator of the channel can ban users. The banned user list is created through GroupChannelBannedUsersFragment
.
You can start building a banned user list screen by first creating a fragment. To do so, call the createGroupChannelBannedUsersFragment
method. Once a group channel banned users fragment is built, you need to set up the navigation props and register the screen to a navigation library. Refer to the code below.
The following table lists the properties of GroupChannelBannedUsersFragment
.
Properties
Required | Type | Description |
---|---|---|
channel | object | Specifies the group channel that the current user is a member of. |
onPressHeaderLeft | function | Specifies the prop to execute a custom navigation operation when the button on the top left corner of the header component is selected. By default, the screen goes back to the previous screen. |
Optional | Type | Description |
---|---|---|
renderUser | function | Renders a customized view of the user profile. |
To store and handle data that are used to build the banned user list screen, Sendbird UIKit provides GroupChannelBannedUsersContexts
, which includes the Fragment
context object.
To retrieve data from the Chat SDK on the current user's banned user list screen, you need to call the useContext
hook and pass GroupChannelBannedUsersContexts.Fragment
as a parameter. The data is then used to render the group channel banned users module and its components.
A banned user list screen is composed of five module components: header, list, loading status, error status, and empty status. These components make up the GroupChannelBannedUsersModule
and are used to create and display the UI of the screen.
The header component displays the title of the group channel, a button on the top left corner, and another button on the top right corner. By default, the left button allows you to go back to the previous screen and when selected, the onPressHeaderLeft
navigation prop is called. When the right button is selected, onPressHeaderRight
is called and the group channel settings screen appears.
The following table lists the properties of GroupChannelBannedUsersModule.Header
.
Property name | Type | Description |
---|---|---|
onPressHeaderLeft | function | Specifies the prop to execute a custom navigation operation when the button on the top left corner of the header component is selected. By default, the screen goes back to the previous screen. |
The list component shows a list of profile images and names of banned users of the channel.
The following table lists the properties of GroupChannelBannedUsersModule.List
.
Property name | Type | Description |
---|---|---|
bannedUsers | array of objects | Specifies a list of banned users. |
onLoadNext | function | Specifies the prop to execute custom operations when loading more user list items. |
renderUser | function | Renders a customized view of the user profile. |
ListEmptyComponent | ReactElement | Renders a customized view of the empty user list. |
The StatusLoading
component lets the user know if the list is loading.
The StatusEmpty
component lets the user know if the list is empty.
The StatusError
component lets the user know if the list fetching has failed.
In the list banned users in group channel key function, you can customize the default GroupChannelBannedUsersFragment
to change various elements of the screen such as the module and its components. See the code below on how to replace the default header component with a custom header component in GroupChannelBannedUsersFragment
as an example.
Note: To learn more about how to customize a fragment, go to the Fragment page.