Skip to main content

Overview

CometChatBannedMembers is a crucial Component that showcases users who have been restricted from participating in specific groups or conversations. Once banned, users lose access to content and discussions within the affected group. Administrators or owners wield the authority to ban members from groups they oversee, enabling them to monitor user activity and behavior closely. With CometChatBannedMembers, administrators can take swift and appropriate actions to maintain group integrity and uphold community standards.
The BannedMembers component is composed of the following BaseComponents:

Usage

Integration

CometChatBannedMembers, as a Composite Component, offers flexible integration options, allowing it to be launched directly via button clicks or any user-triggered action. Additionally, it seamlessly integrates into tab view controllers. With banned members, users gain access to a wide range of parameters and methods for effortless customization of its user interface. The following code snippet exemplifies how you can seamlessly integrate the BannedMembers component into your application.
If you’re defining the Group members within the XML code, you’ll need to extract them and set them on the Group object using the appropriate method.

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. SetOnItemClick
This method proves valuable when users seek to override onItemClick functionality within CometChatBannedMembers, empowering them with greater control and customization options. The setOnItemClick action doesn’t have a predefined behavior. You can override this action using the following code snippet.

2. SetOnError
You can customize this behavior by using the provided code snippet to override the On Error and improve error handling.

3. OnSelection
The OnSelection event is triggered upon the completion of a selection in SelectionMode. It does not have a default behavior. However, you can override its behavior using the following code snippet.
YourActivity.java

4. AddOnBackPressListener
You can customize this behavior by using the provided code snippet to override the addOnBackPressListener and improve error handling.

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. BannedGroupMembersRequestBuilder
The BannedGroupMembersRequestBuilder enables you to filter and customize the Banned Members list based on available parameters in BannedGroupMembersRequestBuilder. This feature allows you to create more specific and targeted queries when fetching banned members. The following are the parameters available in BannedGroupMembersRequestBuilder Example In the example below, we are applying a filter to the banned members by setting the limit to 1.

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.

Events

Events are emitted by a 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. Events emitted by the Join Group component is as follows.
Remove the added listener

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 the BannedMembersStyle to the Banned Members Component to customize the styling.
List of properties exposed by BannedMembersStyle
2. Avatar Style
To apply customized styles to the Avatar component in the Banned Members Component, you can use the following code snippet. For further insights on Avatar Styles refer

3. StatusIndicator Style
To apply customized styles to the Status Indicator component in the Group Member Component, You can use the following code snippet. For further insights on Status Indicator Styles refer

4. ListItem Style
To apply customized styles to the List Item component in the Group Member Component, you can use the following code snippet. For further insights on List Item Styles refer

Functionality

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.
List of Functionality exposed by CometChatBannedMembers

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.

SetListItemView

With this function, you can assign a custom ListItem to the List View Component.
Example
You can indeed create a custom layout file named item_list.xml for more complex or unique list items. Once this layout file is made, you would inflate it inside the createView() method of the BannedMembersViewHolderListeners. The inflation process prepares the layout for use in your application: Following this, you would use the bindView() method to initialize and assign values to your individual views. This could include setting text on TextViews, images on ImageViews, and so on based on the properties of the Group object:
item_list.xml
YourActivity.java

SetSubTitleView

You can customize the subtitle view for each user list item to meet your requirements
Example
You can indeed create a custom layout file named subtitle_layout.xml for more complex or unique list items. Once this layout file is made, you would inflate it inside the createView() method of the BannedMembersViewHolderListeners. The inflation process prepares the layout for use in your application: Following this, you would use the bindView() method to initialize and assign values to your individual views. This could include setting text on TextViews, images on ImageViews, and so on based on the properties of the Group object:
subtitle_layout.xml
YourActivity.java

SetTailView

Used to generate a custom trailing view for the GroupList item. You can add a Tail view using the following method.
Example
You can indeed create a custom layout file named tail_view_layout.xml for more complex or unique list items. Once this layout file is made, you would inflate it inside the createView() method of the BannedMembersViewHolderListeners. The inflation process prepares the layout for use in your application: Following this, you would use the bindView() method to initialize and assign values to your individual views. This could include setting text on TextViews, images on ImageViews, and so on based on the properties of the Group object:
tail_view_layout.xml
YourActivity.java

SetMenu

You can set the Custom Menu view to add more options to the Groups component.
Example
You need to create a view_menu.xml as a custom view file. Which we will inflate and pass to .setMenu().
view_menu.xml
You inflate the view and pass it to setMenu. You can get the child view reference and can handle click actions.
YourActivity.java

SetOptions

You can set a List of CometChatOption for a Banned Members to add your custom actions to the Members. These options will be visible when swiping any Banned Members item.
Example
YourActivity.java

SetLoadingStateView

You can set a custom loader view using setLoadingStateView to match the loading view of your app.
Example
We have added a ContentLoadingProgressBar to loading_view_layout.xml. You can choose any view you prefer. This view should be inflated and passed to the setLoadingStateView() method.
loading_view_layout.xml
YourActivity.java

SetEmptyStateView

You can set a custom EmptyStateView using setEmptyStateView to match the empty view of your app.
Examples We have added an error view to empty_view_layout.xml. You can choose any view you prefer. This view should be inflated and passed to the setEmptyStateView() method.
empty_view_layout.xml
YourActivity.java

SetErrorStateView

You can set a custom ErrorStateView using setErrorStateView to match the error view of your app.
Example
We have added an error view to error_state_view_layout.xml. You can choose any view you prefer. This view should be inflated and passed to the setErrorStateView() method.
error_state_view_layout.xml
YourActivity.java