Banned Members

Banned Members — CometChat documentation.

This component lists 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.

Here are a few key points related to banned members:

1. Administrative Control: 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.
2. Restrictions on Participation: Banned members are denied access to the group they were banned from. They cannot view or interact with the group’s messages, shared content, or other group members. Banning effectively removes their presence and contribution from the group.

Properties

Group Information

Group details associated with the group members.

Name	Type	Description
group	Group Class	Ban members of this particular CometChat group

Title

Heading text for the component

Name	Type	Description
title	string	Heading text for the component
titleAlignment	string	Alignment of the heading text for the component

Search

This involves keywords, phrases, or criteria into the search bar and retrieving relevant results based on the search query.

Name	Type	Description
searchPlaceholder	string	Sample text that appears in the search input as a prompt or suggestion
searchIconURL	string	Asset URL for the search icon.
hideSearch	boolean	When set to true, hides the search input.

Loading state

This refers to the state of the groups component when it is actively retrieving or fetching data.

Name	Type	Description
loadingIconURL	string	Asset URL for the loading indicator icon
loadingStateView	view	User-defined component to customise the loading indicator

Empty state

This refers to the state of the groups component when it has no content or data to display

Name	Type	Description
emptyStateText	string	The textual content displayed in the empty state of the component.
emptyStateView	view	User-defined component to customise the empty state of the component.

Error state

This refers to the state of the groups component when an error occurs during the retrieval of the data.

Name	Type	Description
errorStateText	string	The textual content displayed in the error state of the component.
errorStateView	view	User-defined component to customise the error state of the component.

RequestBuilder

This provides set of methods that allow developers to easily create and configure group members before fetching them for the intended recipients.

Name	Type	Description
searchRequestBuilder	CometChat.BannedMembersRequestBuilder	Class that allows you to set various parameters to the BannedMembersRequestBuilder class based on which the group members are searched
bannedMembersRequestBuilder	CometChat.BannedMembersRequestBuilder	Class that allows you to set various parameters to the BannedMembersRequestBuilder class based on which the group members are fetched

Asset URLs

Custom asset URL used for graphical representation

Name	Type	Description
unbanIconURL	string	Asset URL for the unban icon

Toggle

Switch to hide or show the separators, and error message.

Name	Type	Description
hideError	boolean	When set to true, hides the error messages displayed within the component
hideSeparator	boolean	When set to true, hides the separator between the individual elements in the list.
disableUsersPresence	boolean	When set to true, Users will not be able to see whether a particular user is currently online or offline.

selectionMode

Allows user to choose individual or multiple items.

Name	Type	Description
selectionMode	SelectionMode	Allows user to select individual or multiple items for applying specific operations.
onSelect	Function as PropType<(bannedMember: CometChat.GroupMember[]) => void>	Method invoked which returns the selected group members.

Custom view

UI component created and customised by the developer to meet your design or functional requirements.

Name	Type	Description
subtitleView	Function as PropType<(bannedMember: CometChat.GroupMember) => ViewType>	User-defined component to customise the secondary text shown in the banned member profile.
tailView	Function as PropType<(bannedMember: CometChat.GroupMember) => ViewType>	User-defined component to customise the trailing view of the banned member profile.

Menu

UI component created and customised by the developer to meet your design or functional requirements representing the button actions in the header section.

Name	Type	Description
menu	view	User-defined component to showcase options related to the group members in the header section.

Actions

This includes action buttons or icons that allow users to perform common actions or tasks, such as muting the notification etc.

Name	Type	Description
options	Function as PropType<(bannedMember: CometChat.GroupMember) => CometChatOption[]>	User-defined actions which appears for each banned member on mouseover.

Function Callback

Functions that can be invoked by the user in response to a specific event or condition.

Name	Type	Description
onBack	Function as PropType<()=>void>	Override the method that is invoked when the user clicks on the back button.
onError	Function as PropType<(error: CometChat.CometChatException) => void>	Override the method that is invoked when an error is encountered within the component

Back button

This allows users to navigate to the previous screen or page they were viewing.

Name	Type	Description
backButtonIconURL	string	Asset URL for the back button icon
showBackButton	boolean	When set to true, displays the back button

Style

Styling properties and values of the groups component

Name	Type	Description
avatarStyle	AvatarStyle	Styling properties and values of the Avatar component
statusIndicatorStyle	StatusIndicator	Styling properties and values of the StatusIndicator component
listItemStyle	ListItemStyle	Styling properties and values of the ListItem component
bannedMembersStyle	BannedMembersStyle	Styling properties and values of the Banned Members component

Events

To handle events supported by CometChatBannedMembers component you have to add the listeners mentioned here.

Vue

onBeforeMount(() => {
  CometChatGroupEvents.ccGroupMemberBanned.subscribe(
    ({ item: IGroupMemberKickedBanned }) => {
      //Proceed with UI updates
    }
  );

  CometChatGroupEvents.ccGroupMemberUnbanned.subscribe(
    ({ item: IGroupMemberKickedBanned }) => {
      //Proceed with UI updates
    }
  );
});

onBeforeUnmount(() => {
  CometChatGroupEvents.ccGroupMemberBanned.unsubscribe();
  CometChatGroupEvents.ccGroupMemberUnbanned.unsubscribe();
});

Usage

Vue

//custom request builder
const requestBuilder:CometChat.BannedMembersRequestBuilder =  new CometChat.BannedMembersRequestBuilder()
.setLimit(30)
.setSearchKeyword("xyz")
.build();

//apply custom request builder to CometChatBannedMembers component
<CometChatBannedMembers :bannedMembersRequestBuilder="requestBuilder"></CometChatBannedMembers>