Overview
CometChatBannedMembers
is a Component that displays all the users who have been restricted or prohibited from participating in specific groups or conversations. When the user is banned, they are no longer able to access or engage with the content and discussions within the banned group. Group administrators or owners have the authority to ban members from specific groups they manage. They can review user activity, monitor behavior, and take appropriate actions, including banning users when necessary.

Usage
Integration
The following code snippet illustrates how you can directly incorporate the Banned Members component into your Application.Actions
Actions dictate how a component functions. They are divided into two types: Predefined and User-defined. You can override either type, allowing you to tailor the behavior of the component to fit your specific needs.1. onSelect
TheonSelect
action is activated when you select the done icon while in selection mode. This returns a list of all the banned members that you have selected.
This action does not come with any predefined behavior. However, you have the flexibility to override this event and tailor it to suit your needs using the following code snippet.
2. OnBack
OnBack
is triggered when you click on the back button of the Banned Members component. You can override this action using the following code snippet.
3. onClose
onClose
is triggered when you click on the close button of the Banned Members component. You can override this action using the following code snippet.
4. onError
This action doesn’t change the behavior of the component but rather listens for any errors that occur in the Banned Members component.Filters
Filters allow you to customize the data displayed in a list within a Component. You can filter the list based on your specific criteria, allowing for a more customized. Filters can be applied using RequestBuilders of Chat SDK.1. BannedMembersRequestBuilder
The BannedMembersRequestBuilder enables you to filter and customize the Banned Members list based on available parameters in BannedMembersRequestBuilder. This feature allows you to create more specific and targeted queries when fetching banned members. The following are the parameters available in BannedMembersRequestBuilderMethods | Type | Description |
---|---|---|
setLimit | number | sets the number of banned members that can be fetched in a single request, suitable for pagination |
setSearchKeyword | String | used for fetching banned members matching the passed string |
setScopes | Array<String> | used for fetching banned members based on multiple scopes |
2. SearchRequestBuilder
The SearchRequestBuilder uses BannedMembersRequestBuilder enables you to filter and customize the search list based on available parameters in BannedMembersRequestBuilder. This feature allows you to keep uniformity between the displayed Banned Members list and searched Banned Members. ExampleEvents
Events are emitted by aComponent
. By using event you can extend existing functionality. Being global events, they can be applied in Multiple Locations and are capable of being Added or Removed.
The Banned Members
component does not produce any events.
Customization
To fit your app’s design requirements, you can customize the appearance of the Groups component. We provide exposed methods that allow you to modify the experience and behavior according to your specific needs.Style
Using Style you can customize the look and feel of the component in your app, These parameters typically control elements such as the color, size, shape, and fonts used within the component.1. BannedMembers Style
You can set theBannedMembersStyle
to the Banned Members Component to customize the styling.

Property | Description | Code |
---|---|---|
border | Used to set border | border?: string, |
borderRadius | Used to set border radius | borderRadius?: string; |
background | Used to set background colour | background?: string; |
height | Used to set height | height?: string; |
width | Used to set width | width?: string; |
titleTextFont | Used to set title text font | titleTextFont?: string, |
titleTextColor | Used to set title text color | titleTextColor?: string; |
searchPlaceholderTextFont | Used to set search placeholder font | searchPlaceholderTextFont?: string; |
searchPlaceholderTextColor | Used to set search placeholder color | searchPlaceholderTextColor?: string; |
searchTextFont | Used to set search text font | searchTextFont?: string; |
searchTextColor | Used to set search text color | searchTextColor?: string; |
emptyStateTextFont | Used to set empty state text font | emptyStateTextFont?: string; |
emptyStateTextColor | Used to set empty state text color | emptyStateTextColor?: string; |
errorStateTextFont | Used to set error state text font | errorStateTextFont?: string; |
errorStateTextColor | Used to set error state text color | errorStateTextColor?: string; |
loadingIconTint | Used to set loading icon tint | loadingIconTint?: string; |
searchIconTint | Used to set search icon tint | searchIconTint?: string; |
searchBorder | Used to set search border | searchBorder?: string; |
searchBorderRadius | Used to set search border radius | searchBorderRadius?: string; |
searchBackground | Used to set search background color | searchBackground?: string; |
onlineStatusColor | Used to set online status color | onlineStatusColor?: string; |
separatorColor | Used to set separator color | separatorColor?: string; |
boxShadow | Used to set box shadow | boxShadow?: string; |
backButtonIconTint | Used to set back button icon tint | backButtonIconTint?: string; |
closeButtonIconTint | Used to set close button icon tint | closeButtonIconTint?: string; |
unbanIconTint | Used to set unban icon tint | unbanIconTint?: string; |
padding | Used to set padding | padding?: string; |
2. Avatar Style
To apply customized styles to theAvatar
component in the Banned Members Component, you can use the following code snippet. For further insights on Avatar
Styles refer
3. LisItem Style
To apply customized styles to theList Item
component in the Banned Members
Component, you can use the following code snippet. For further insights on List Item
Styles refer
4. StatusIndicator Style
To apply customized styles to the Status Indicator component in the Banned Members Component, You can use the following code snippet. For further insights on Status Indicator Styles referFunctionality
These are a set of small functional customizations that allow you to fine-tune the overall experience of the component. With these, you can change text, set custom icons, and toggle the visibility of UI elements.

Property | Description | Code |
---|---|---|
title | Used to set title in the app heading | [title]="'Your Custom Title'" |
errorStateText | Used to set a custom text response when some error occurs on fetching the list of banned members | [errorStateText]="'your custom error state text'" |
emptyStateText | Used to set a custom text response when fetching the banned members has returned an empty list | [emptyStateText]="'your custom empty state text'" |
searchPlaceholder | Used to set custom search placeholder text | [searchPlaceholder]="'Custom Search PlaceHolder'" |
unbanIconURL | Used to set the Unban button Icon in the banned user lists | [unbanIconURL]="unbanIconURL" |
searchIconURL | Used to set search Icon in the search field | [searchIconURL]="searchIconURL" |
loadingIconURL | Used to set loading Icon | [loadingIconURL]="loadingIconURL" |
closeButtonIconURL | Used to set close button Icon | [closeButtonIconURL]="closeButtonIconURL" |
backButtonIconURL | Used to set the back button Icon | [backButtonIconURL]="backButtonIconURL" |
hideError | Used to hide error on fetching banned members | [hideError]="true" |
hideSearch | Used to toggle visibility for search box | [hideSearch]="true" |
hideSeparator | Used to hide the divider separating the banned member items | [hideSeparator]="true" |
disableUsersPresence | Used to toggle functionality to show user’s presence | [disableUsersPresence]="true" |
showBackButton | Hides / shows the back button as per the boolean value | [showBackButton]="true" |
selectionMode | set the number of banned members that can be selected, SelectionMode can be single, multiple or none. | [selectionMode]="selectionMode" |
titleAlignment | Alignment of the heading text for the component | [titleAlignment]="titleAlignment" |
group | Used to pass group object of which group members will be shown | [group]="groupObject" |
Advance
For advanced-level customization, you can set custom views to the component. This lets you tailor each aspect of the component to fit your exact needs and application aesthetics. You can create and define your views, layouts, and UI elements and then incorporate those into the component.ListItemView
With this property, you can assign a custom ListItem to the Banned Members Component. Example Default:

SubtitleView
You can customize the subtitle view for each banned members to meet your requirements Default:

LoadingStateView
You can set a custom loader view usingloadingStateView
to match the loading view of your app.
Default:


EmptyStateView
You can set a customEmptyStateView
using emptyStateView
to match the empty view of your app.
Default:


ErrorStateView
You can set a customErrorStateView
using errorStateView
to match the error view of your app.
Default:


Menus
You can set the Custom Menu view to add more options to the Banned Members component.
Options
You can set the Custom options to the Banned Members component.