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.
onSelect
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.
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.
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.
Methods | 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 |
Component
. 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.
BannedMembersStyle
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; |
Avatar
component in the Banned Members Component, you can use the following code snippet. For further insights on Avatar
Styles refer
List Item
component in the Banned Members
Component, you can use the following code snippet. For further insights on List Item
Styles refer
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" |
loadingStateView
to match the loading view of your app.
Default:
EmptyStateView
using emptyStateView
to match the empty view of your app.
Default:
ErrorStateView
using errorStateView
to match the error view of your app.
Default: