Groups - CometChat Docs

Overview

CometChatGroups functions as a standalone component designed to create a screen displaying a list of groups, with the added functionality of enabling groups to search for specific groups. Acting as a container component, CometChatGroups encapsulates and formats the CometChatListBase and CometChatGroupList components without introducing any additional behavior of its own.

Usage

Integration

The following code snippet illustrates how you can can launch CometChatGroups.

<com.cometchat.chatuikit.groups.CometChatGroups
    android:id="@+id/groups"
    android:layout_height="match_parent"
    android:layout_width="match_parent" />

Actions

Actions dictate how a component functions. They are divided into two types: Predefined and Group-defined. You can override either type, allowing you to tailor the behavior of the component to fit your specific needs.

setOnItemClick

Function invoked when a Group item is clicked, typically used to open a Group profile or chat screen.

Java
Kotlin

YourActivity.java

cometchatGroups.setOnItemClick((view1, position, group) -> {
            
    });

YourActivity.kt

cometchatGroups.onItemClick = OnItemClick { view, position, group ->
            
    }

setOnItemLongClick

Function executed when a Group item is long-pressed, allowing additional actions like delete or block.

Java
Kotlin

YourActivity.java

cometchatGroups.setOnItemLongClick((view1, position, group) -> {

    });

YourActivity.kt

cometchatGroups.onItemLongClick = OnItemLongClick({ view, position, group ->
            
    })

setOnBackPressListener

OnBackPressListener is triggered when you press the back button in the app bar. It has a predefined behavior; when clicked, it navigates to the previous activity. However, you can override this action using the following code snippet.

Java
Kotlin

YourActivity.java

cometchatGroups.setOnBackPressListener(() -> {
            
    });

YourActivity.kt

cometchatGroups.onBackPressListener = OnBackPress {

    }

setOnSelect

Called when a item from the fetched list is selected, useful for multi-selection features.

Java
Kotlin

YourActivity.java

cometchatGroups.setOnSelect(t -> {

    });

YourActivity.kt

cometchatGroups.setOnSelect(object : OnSelection<Group?> {
        override fun onSelection(t: MutableList<Group?>?) {
                
        }
    })

OnError

This action doesn’t change the behavior of the component but rather listens for any errors that occur in the groups component.

Java
Kotlin

YourActivity.java

cometchatGroups.setOnError(cometchatException -> {

    });

YourActivity.kt

cometchatGroups.setOnError {

    }

setOnLoad

Invoked when the list is successfully fetched and loaded, helping track component readiness.

Java
Kotlin

YourActivity.java

cometchatGroups.setOnLoad(list -> {

});

YourActivity.kt

cometchatGroups.setOnLoad(object : OnLoad<Group?> {
    override fun onLoad(list: MutableList<Group?>?) {

    }
})

setOnEmpty

Called when the list is empty, enabling custom handling such as showing a placeholder message.

Java
Kotlin

YourActivity.java

cometchatGroups.setOnEmpty(() -> {
            
    });

YourActivity.kt

cometchatGroups.setOnEmpty{
            
    }

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. GroupsRequestBuilder

The GroupsRequestBuilder enables you to filter and customize the group list based on available parameters in GroupsRequestBuilder. This feature allows you to create more specific and targeted queries when fetching groups. The following are the parameters available in GroupsRequestBuilder

Property	Description	Code
Limit	Configure the maximum number of groups to fetch in a single request, optimizing pagination for smoother navigation.	`.setLimit(Int)`
Search Keyword	Employed to retrieve groups that match the provided string, facilitating precise searches.	`.setSearchKeyWord(String)`
Joined Only	Exclusively fetches joined groups.	`.joinedOnly(boolean)`
Tags	Utilized to fetch groups containing the specified tags.	`.setTags(List<String>)`
With Tags	Utilized to retrieve groups with specific tags.	`.withTags(boolean)`

Example In the example below, we are applying a filter to the Group List based on only joined groups.

Java
Kotlin

GroupsRequest.GroupsRequestBuilder builder = new GroupsRequest.GroupsRequestBuilder().setLimit(10).joinedOnly(true);
cometchatGroups.setGroupsRequestBuilder(builder);

val builder = GroupsRequestBuilder().setLimit(10).joinedOnly(true)
cometchatGroups.setGroupsRequestBuilder(builder)

2. SearchRequestBuilder

The SearchRequestBuilder uses GroupsRequestBuilder enables you to filter and customize the search list based on available parameters in GroupsRequestBuilder. This feature allows you to keep uniformity between the displayed Groups List and searched Group List. Example

Java
Kotlin

GroupsRequest.GroupsRequestBuilder builder = new GroupsRequest.GroupsRequestBuilder().setLimit(10).setSearchKeyWord("**");
cometchatGroups.setSearchRequestBuilder(builder);

val builder = GroupsRequestBuilder().setLimit(10).setSearchKeyWord("**")
cometchatGroups.setSearchRequestBuilder(builder)

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. The list of events emitted by the Groups component is as follows.

Events	Description
`ccGroupCreated()`	This will get triggered when the logged in user creates a group
`ccGroupDeleted()`	This will get triggered when the logged in user deletes a group
`ccGroupLeft()`	This will get triggered when the logged in user leaves a group
`ccGroupMemberScopeChanged()`	This will get triggered when the logged in user changes the scope of another group member
`ccGroupMemberBanned()`	This will get triggered when the logged in user bans a group member from the group
`ccGroupMemberKicked()`	This will get triggered when the logged in user kicks another group member from the group
`ccGroupMemberUnbanned()`	This will get triggered when the logged in user unbans a user banned from the group
`ccGroupMemberJoined()`	This will get triggered when the logged in user joins a group
`ccGroupMemberAdded()`	This will get triggered when the logged in user add new members to the group
`ccOwnershipChanged`	This will get triggered when the logged in user transfer the ownership of their group to some other member

1. Add `CometChatGroupEvents` Listener’s

Java
Kotlin

CometChatGroupEvents.addGroupListener("LISTENER_TAG", new CometChatGroupEvents() {
    @Override
    public void ccGroupCreated(Group group) {
        super.ccGroupCreated(group);
    }

    @Override
    public void ccGroupDeleted(Group group) {
        super.ccGroupDeleted(group);
    }

    @Override
    public void ccGroupLeft(Action actionMessage, User leftUser, Group leftGroup) {
        super.ccGroupLeft(actionMessage, leftUser, leftGroup);
    }

    @Override
    public void ccGroupMemberJoined(User joinedUser, Group joinedGroup) {
        super.ccGroupMemberJoined(joinedUser, joinedGroup);
    }

    @Override
    public void ccGroupMemberAdded(List<Action> actionMessages, List<User> usersAdded, Group userAddedIn, User addedBy) {
        super.ccGroupMemberAdded(actionMessages, usersAdded, userAddedIn, addedBy);
    }

    @Override
    public void ccGroupMemberKicked(Action actionMessage, User kickedUser, User kickedBy, Group kickedFrom) {
        super.ccGroupMemberKicked(actionMessage, kickedUser, kickedBy, kickedFrom);
    }

    @Override
    public void ccGroupMemberBanned(Action actionMessage, User bannedUser, User bannedBy, Group bannedFrom) {
        super.ccGroupMemberBanned(actionMessage, bannedUser, bannedBy, bannedFrom);
    }

    @Override
    public void ccGroupMemberUnBanned(Action actionMessage, User unbannedUser, User unBannedBy, Group unBannedFrom) {
        super.ccGroupMemberUnBanned(actionMessage, unbannedUser, unBannedBy, unBannedFrom);
    }

    @Override
    public void ccGroupMemberScopeChanged(Action actionMessage, User updatedUser, String scopeChangedTo, String scopeChangedFrom, Group group) {
        super.ccGroupMemberScopeChanged(actionMessage, updatedUser, scopeChangedTo, scopeChangedFrom, group);
    }

    @Override
    public void ccOwnershipChanged(Group group, GroupMember newOwner) {
        super.ccOwnershipChanged(group, newOwner);
    }
});

CometChatGroupEvents.addGroupListener("LISTENER_TAG", object : CometChatGroupEvents() {
    override fun ccGroupCreated(group: Group?) {
        super.ccGroupCreated(group)
    }

    override fun ccGroupDeleted(group: Group?) {
        super.ccGroupDeleted(group)
    }

    override fun ccGroupLeft(actionMessage: Action?, leftUser: User?, leftGroup: Group?) {
        super.ccGroupLeft(actionMessage, leftUser, leftGroup)
    }

    override fun ccGroupMemberJoined(joinedUser: User?, joinedGroup: Group?) {
        super.ccGroupMemberJoined(joinedUser, joinedGroup)
    }

    override fun ccGroupMemberAdded(
        actionMessages: List<Action?>?,
        usersAdded: List<User?>?,
        userAddedIn: Group?,
        addedBy: User?
    ) {
        super.ccGroupMemberAdded(actionMessages, usersAdded, userAddedIn, addedBy)
    }

    override fun ccGroupMemberKicked(
        actionMessage: Action?,
        kickedUser: User?,
        kickedBy: User?,
        kickedFrom: Group?
    ) {
        super.ccGroupMemberKicked(actionMessage, kickedUser, kickedBy, kickedFrom)
    }

    override fun ccGroupMemberBanned(
        actionMessage: Action?,
        bannedUser: User?,
        bannedBy: User?,
        bannedFrom: Group?
    ) {
        super.ccGroupMemberBanned(actionMessage, bannedUser, bannedBy, bannedFrom)
    }

    override fun ccGroupMemberUnBanned(
        actionMessage: Action?,
        unbannedUser: User?,
        unBannedBy: User?,
        unBannedFrom: Group?
    ) {
        super.ccGroupMemberUnBanned(actionMessage, unbannedUser, unBannedBy, unBannedFrom)
    }

    override fun ccGroupMemberScopeChanged(
        actionMessage: Action?,
        updatedUser: User?,
        scopeChangedTo: String?,
        scopeChangedFrom: String?,
        group: Group?
    ) {
        super.ccGroupMemberScopeChanged(
            actionMessage,
            updatedUser,
            scopeChangedTo,
            scopeChangedFrom,
            group
        )
    }

    override fun ccOwnershipChanged(group: Group?, newOwner: GroupMember?) {
        super.ccOwnershipChanged(group, newOwner)
    }
})

2. Removing `CometChatGroupEvents` Listener’s

Java
Kotlin

CometChatGroupEvents.removeListeners();

CometChatGroupEvents.removeListeners()

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.

    <style name="CustomAvatarStyle" parent="CometChatAvatarStyle">
        <item name="cometchatAvatarStrokeRadius">8dp</item>
        <item name="cometchatAvatarBackgroundColor">#FBAA75</item>
    </style>

    <style name="CustomGroupsStyle" parent="CometChatGroupsStyle">
        <item name="cometchatGroupsAvatar">@style/CustomAvatarStyle</item>
        <item name="cometchatGroupsSeparatorColor">#F76808</item>
        <item name="cometchatGroupsTitleTextColor">#F76808</item>
    </style>

Java
Kotlin

cometchatGroups.setStyle(R.style.CustomGroupsStyle);

cometchatGroups.setStyle(R.style.CustomGroupsStyle)

To know more such attributes, visit the attributes file.

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. Below is a list of customizations along with corresponding code snippets

Methods	Description	Code
setBackIconVisibility	Used to toggle visibility for back button in the app bar	`.setBackIconVisibility(View.VISIBLE);`
setToolbarVisibility	Used to toggle visibility for back button in the app bar	`.setToolbarVisibility(View.GONE);`
setLoadingStateVisibility	Used to hide loading state while fetching groups	`.setLoadingStateVisibility(View.GONE);`
setErrorStateVisibility	Used to hide error state on fetching groups	`.setErrorStateVisibility(View.GONE);`
setEmptyStateVisibility	Used to hide empty state on fetching groups	`.setEmptyStateVisibility(View.GONE);`
setSeparatorVisibility	Used to control visibility of Separators in the list view	`.setSeparatorVisibility(View.GONE);`
setGroupTypeVisibility	Used to control visibility of status indicator shown for the group type	`.setGroupTypeVisibility(View.GONE);`
setSearchBoxVisibility	Used to hide search box shown in the tool bar	`.setSearchBoxVisibility(View.GONE);`
setSelectionMode	This method determines the selection mode for groups, enabling user to select either a single groups or multiple groups at once.	`.setSelectionMode(UIKitConstants.SelectionMode.MULTIPLE);`
setSearchkeyword	Used for fetching groups matching the passed keywords	`.setSearchkeyword("anything");`

Advanced

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.

setOptions

Defines the available actions when users interact with a group item, such as long-pressing or swiping. Use Cases:

Enable actions like “Mute Notifications”, “Leave Group”, “Pin Group”.
Provide admin-only actions like “Manage Members”, “Delete Group”.

Java
Kotlin

cometchatGroups.setOptions((context, group) -> Collections.emptyList());

cometchatGroups.options = Function2<Context?, Group?, List<CometChatPopupMenu.MenuItem?>?> { context, Group -> emptyList<CometChatPopupMenu.MenuItem?>() }

addOptions

This method extends the existing set of actions available when Groups long press a Group item. Unlike setOptionsDefines, which replaces the default options, addOptionsAdds allows developers to append additional actions without removing the default ones. Example use cases include:

Adding a “Report Spam” action
Introducing a “Save to Notes” option
Integrating third-party actions such as “Share to Cloud Storage”

This method provides flexibility in modifying Group interaction capabilities.

Java
Kotlin

cometchatGroups.addOptions((context, group) -> Collections.emptyList());

cometchatGroups.addOptions { context, group -> emptyList<CometChatPopupMenu.MenuItem?>() }

setLoadingView

Configures a custom loading view displayed while groups are being fetched. Use Cases:

Show a spinner with “Loading groups…” text.
Display a skeleton loader for a smooth UI experience.

Java
Kotlin

cometchatGroups.setLoadingView(R.layout.your_loading_view);

cometchatGroups.loadingView = R.layout.your_loading_view

setEmptyView

Defines a view that appears when no groups are available. Use Cases:

Show a message like “No groups found, create one now!”.
Display an illustration with a “Create New Group” button.

Java
Kotlin

cometchatGroups.setEmptyView(R.layout.your_empty_view);

cometchatGroups.emptyView = R.layout.your_empty_view

setErrorView

Configures the UI when an error occurs while fetching groups. Use Cases:

Display a retry button with “Failed to load groups, try again.”.
Show a friendly error illustration.

Java
Kotlin

cometchatGroups.setErrorView(R.layout.your_empty_view);

cometchatGroups.errorView = R.layout.your_error_view

setLeadingView

Sets a custom leading view that appears at the start of each group item. Use Cases:

Display the group profile picture.
Add an icon indicating Public or Private groups.

Java
Kotlin

cometchatGroups.setLeadingView(new GroupsViewHolderListener() {
            @Override
            public View createView(Context context, CometchatListBaseItemsBinding listItem) {
                return null;
            }

            @Override
            public void bindView(Context context, View createdView, Group group, RecyclerView.ViewHolder holder, List<Group> groupList, int position) {

            }
        });

cometchatGroups.setLeadingView(object: GroupsViewHolderListener {
    override fun createView(context: Context, cometChatListItem: CometChatListItem): View? {
        return null
    }

    override fun bindView(context: Context, view: View, Group: group, viewHolder: RecyclerView.ViewHolder, list: List<Group>, i: Int) {
    }
})

You can indeed create a custom layout file named custom_leading_avatar_view.xml for more complex or unique list items. Once this layout file is made, you would inflate it inside the createView() method of the GroupsViewHolderListener. 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:

custom_leading_avatar_view.xml

<?xml version="1.0" encoding="utf-8"?>
<LinearLayout xmlns:android="http://schemas.android.com/apk/res/android"
    android:id="@+id/leading_avatar_view"
    android:layout_width="@dimen/cometchat_40dp"
    android:layout_height="@dimen/cometchat_40dp"
    android:background="@drawable/group_leading_joined"
    android:orientation="vertical">

</LinearLayout>

Java
Kotlin

cometchatGroups.setLeadingView(new GroupsViewHolderListener() {
            @Override
            public View createView(Context context, CometchatListBaseItemsBinding listItem) {
                return LayoutInflater.from(context).inflate(R.layout.custom_leading_avatar_view, null);
            }

            @Override
            public void bindView(Context context,
                                 View createdView,
                                 Group group,
                                 RecyclerView.ViewHolder holder,
                                 List<Group> groupList,
                                 int position) {
                LinearLayout groupAvatar = createdView.findViewById(R.id.leading_avatar_view);
                groupAvatar.setBackground(group.isJoined() ? ResourcesCompat.getDrawable(getResources(),
                                                                                         R.drawable.group_leading_joined,
                                                                                         null) : ResourcesCompat.getDrawable(getResources(),
                                                                                                                             R.drawable.group_leading_join,
                                                                                                                             null));
                groupAvatar.setOnLongClickListener(v -> {
                    if (group.isJoined()) {
                        Toast.makeText(context, "Group already joined", Toast.LENGTH_SHORT).show();
                    } else {
                        Toast.makeText(context, "Joining group", Toast.LENGTH_SHORT).show();
                    }
                    return true;
                });
            }
        });

cometchatGroups.setLeadingView(object : GroupsViewHolderListener() {
            override fun createView(context: Context?, listItem: CometchatListBaseItemsBinding?): View {
                return LayoutInflater.from(context).inflate(R.layout.custom_leading_avatar_view, null)
            }

            override fun bindView(
                context: Context,
                createdView: View,
                group: Group,
                holder: RecyclerView.ViewHolder,
                groupList: List<Group>,
                position: Int
            ) {
                val groupAvatar = createdView.findViewById<LinearLayout>(R.id.leading_avatar_view)
                groupAvatar.background = if (group.isJoined) ResourcesCompat.getDrawable(
                    resources,
                    R.drawable.group_leading_joined,
                    null
                ) else ResourcesCompat.getDrawable(
                    resources,
                    R.drawable.group_leading_join,
                    null
                )
                groupAvatar.setOnLongClickListener { v: View? ->
                    if (group.isJoined) {
                        Toast.makeText(context, "Group already joined", Toast.LENGTH_SHORT).show()
                    } else {
                        Toast.makeText(context, "Joining group", Toast.LENGTH_SHORT).show()
                    }
                    true
                }
            }
        })

setTitleView

Customizes the title view of each group item, which typically displays the group name. Use Cases:

Style group names with custom fonts and colors.
Show a verified badge for official groups.

Java
Kotlin

cometchatGroups.setTitleView(new GroupsViewHolderListener() {
            @Override
            public View createView(Context context, CometchatListBaseItemsBinding listItem) {
                return null;
            }

            @Override
            public void bindView(Context context, View createdView, Group group, RecyclerView.ViewHolder holder, List<Group> groupList, int position) {

            }
        });

cometchatGroups.setTitleView(object: GroupsViewHolderListener {
    override fun createView(context: Context, cometChatListItem: CometChatListItem): View? {
        return null
    }

    override fun bindView(context: Context, view: View, Group: group, viewHolder: RecyclerView.ViewHolder, list: List<Group>, i: Int) {
    }
})

You can indeed create a custom layout file named custom_title_view.xml for more complex or unique list items. Once this layout file is made, you would inflate it inside the createView() method of the GroupsViewHolderListener. 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:

custom_title_view.xml

<?xml version="1.0" encoding="utf-8"?>
<LinearLayout xmlns:android="http://schemas.android.com/apk/res/android"
    android:id="@+id/user_layout"
    android:layout_width="wrap_content"
    android:layout_height="wrap_content"
    android:gravity="center_vertical"
    android:orientation="horizontal">

    <TextView
        android:id="@+id/title"
        android:layout_width="wrap_content"
        android:layout_height="wrap_content"
        android:layout_weight="1"
        android:text="teacher"
        android:textAppearance="?attr/cometchatTextAppearanceHeading4Medium" />

    <View
        android:id="@+id/type"
        android:layout_width="wrap_content"
        android:layout_height="15dp"
        android:layout_marginStart="@dimen/cometchat_16dp"
         />

</LinearLayout>

Java
Kotlin

cometchatGroups.setTitleView(new GroupsViewHolderListener() {
            @Override
            public View createView(Context context, CometchatListBaseItemsBinding listItem) {
                return LayoutInflater.from(context).inflate(R.layout.custom_group_title_view, null);
            }

            @Override
            public void bindView(Context context, View createdView, Group group, RecyclerView.ViewHolder holder, List<Group> groupList, int position) {
                LinearLayout layout = createdView.findViewById(R.id.user_layout);
                LinearLayout.LayoutParams layoutParams = new LinearLayout.LayoutParams(ViewGroup.LayoutParams.WRAP_CONTENT,
                                                                                       ViewGroup.LayoutParams.WRAP_CONTENT);
                layout.setLayoutParams(layoutParams);
                TextView name = createdView.findViewById(R.id.title);
                name.setText(group.getName());
                View type = createdView.findViewById(R.id.role);

                if (CometChatConstants.GROUP_TYPE_PUBLIC.equals(group.getType())) {
                    type.setVisibility(View.VISIBLE);
                    type.setBackground(ResourcesCompat.getDrawable(getResources(), R.drawable.public_icon, null));
                } else if (CometChatConstants.GROUP_TYPE_PASSWORD.equals(group.getType())) {
                    type.setVisibility(View.VISIBLE);
                    type.setBackground(ResourcesCompat.getDrawable(getResources(), R.drawable.passowrd_icon, null));
                } else if (CometChatConstants.GROUP_TYPE_PRIVATE.equals(roup.getType())) {
                    type.setVisibility(View.VISIBLE);
                    type.setBackground(ResourcesCompat.getDrawable(getResources(), R.drawable.private_icon, null));
                } else {
                    type.setVisibility(View.GONE);
                }

            }
        });

cometchatGroups.setTitleView(object : GroupsViewHolderListener() {
            override fun createView(context: Context?, listItem: CometchatListBaseItemsBinding?): View {
                return LayoutInflater.from(context).inflate(R.layout.custom_group_title_view, null)
            }

            override fun bindView(
                context: Context,
                createdView: View,
                group: Group,
                holder: RecyclerView.ViewHolder,
                groupList: List<Group>,
                position: Int
            ) {
                val layout = createdView.findViewById<LinearLayout>(R.id.group_layout)
                val layoutParams = LinearLayout.LayoutParams(
                    ViewGroup.LayoutParams.WRAP_CONTENT,
                    ViewGroup.LayoutParams.WRAP_CONTENT
                )
                layout.layoutParams = layoutParams
                val name = createdView.findViewById<TextView>(R.id.title)
                name.text = group.name
                val type = createdView.findViewById<View>(R.id.type)
                if (CometChatConstants.GROUP_TYPE_PUBLIC == group.groupType) {
                    type.visibility = View.VISIBLE
                    type.background = ResourcesCompat.getDrawable(resources, R.drawable.public_icon, null)
                } else if (CometChatConstants.GROUP_TYPE_PASSWORD == group.groupType) {
                    type.visibility = View.VISIBLE
                    type.background = ResourcesCompat.getDrawable(resources, R.drawable.passowrd_icon, null)
                } else if (CometChatConstants.GROUP_TYPE_PRIVATE == group.groupTyp) {
                    type.visibility = View.VISIBLE
                    type.background = ResourcesCompat.getDrawable(resources, R.drawable.private_icon, null)
                } else {
                    type.visibility = View.GONE
                }
            }
        })

setTrailingView

Allows custom elements to be added at the end of each group item, such as buttons or indicators. Use Cases:

Show unread message counts.
Add a quick Join or Leave button.

Java
Kotlin

cometchatGroups.setTrailingView(new GroupsViewHolderListener() {
            @Override
            public View createView(Context context, CometchatListBaseItemsBinding listItem) {
                return null;
            }

            @Override
            public void bindView(Context context, View createdView, Group group, RecyclerView.ViewHolder holder, List<Group> groupList, int position) {

            }
        });

cometchatGroups.setTrailingView(object: GroupsViewHolderListener {
    override fun createView(context: Context, cometChatListItem: CometChatListItem): View? {
        return null
    }

    override fun bindView(context: Context, view: View, Group: Group, viewHolder: RecyclerView.ViewHolder, list: List<Group>, i: Int) {
    }
})

You can indeed create a custom layout file named custom_tail_view.xml for more complex or unique list items. Once this layout file is made, you would inflate it inside the createView() method of the GroupsViewHolderListener. 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:

custom_tail_view.xml

<?xml version="1.0" encoding="utf-8"?>
<LinearLayout xmlns:android="http://schemas.android.com/apk/res/android"
    xmlns:app="http://schemas.android.com/apk/res-auto"
    android:layout_width="wrap_content"
    android:layout_height="wrap_content"
    android:gravity="center_vertical"
    android:orientation="horizontal">

    <com.google.android.material.button.MaterialButton
        android:id="@+id/button"
        android:layout_width="wrap_content"
        android:layout_height="wrap_content"
        android:backgroundTint="#EDEAFA"
        android:text="+ joined"
        android:textStyle="bold"
        android:textAppearance="?attr/cometchatTextAppearanceCaption2Regular"
        android:textAllCaps="true"
        android:textColor="#6852D6"
        app:cornerRadius="@dimen/cometchat_1000dp" />
</LinearLayout>

Java
Kotlin

cometchatGroups.setTrailingView(new GroupsViewHolderListener() {
            @Override
            public View createView(Context context, CometchatListBaseItemsBinding listItem) {
                return LayoutInflater.from(context).inflate(R.layout.custom_tail_view, null);
            }

            @Override
            public void bindView(Context context,
                                 View createdView,
                                 Group group,
                                 RecyclerView.ViewHolder holder,
                                 List<Group> groupList,
                                 int position) {
                 MaterialButton button = createdView.findViewById(R.id.button);
                button.setText(group.isJoined() ? "Joined" : "+ Join");
            }
        });

cometchatGroups.setTrailingView(object : GroupsViewHolderListener() {
            override fun createView(context: Context?, listItem: CometchatListBaseItemsBinding?): View {
                return LayoutInflater.from(context).inflate(R.layout.custom_tail_view, null)
            }

            override fun bindView(
                context: Context,
                createdView: View,
                group: Group,
                holder: RecyclerView.ViewHolder,
                groupList: List<Group>,
                position: Int
            ) {
                val button = createdView.findViewById<MaterialButton>(R.id.button)
                button.text = (if (group.isJoined) "Joined" else "+ Join")

            }
        })

setItemView

Assigns a fully custom ListItem layout to the Groups component, replacing the default design. Use Cases:

Add a description below the group name.
Customize layout to include additional metadata.

Java
Kotlin

cometchatGroups.setItemView(new GroupsViewHolderListener() {
    @Override
    public View createView(Context context, CometchatListBaseItemsBinding cometChatListItem) {
        return null;
    }

    @Override
    public void bindView(Context context, View view, Group group, RecyclerView.ViewHolder viewHolder, List<Group> list, int i) {

    }
});

cometchatGroups.setItemView(object : GroupsViewHolderListener() {
    override fun createView(
        context: Context?,
        CometchatListBaseItemsBinding: CometChatListItem?
    ): View? {
        return null
    }

    override fun bindView(
        context: Context?,
        view: View?,
        group: Group?,
        viewHolder: RecyclerView.ViewHolder?,
        list: List<Group?>?,
        i: Int
    ) {

    }
})

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 GroupsViewHolderListener. 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:

custom_group_list_itemd.xml

<?xml version="1.0" encoding="utf-8"?>
<LinearLayout xmlns:android="http://schemas.android.com/apk/res/android"
    xmlns:app="http://schemas.android.com/apk/res-auto"
    android:layout_width="match_parent"
    android:layout_height="wrap_content"
    android:orientation="vertical">

    <LinearLayout
        android:layout_width="match_parent"
        android:layout_height="wrap_content"
        android:orientation="horizontal">

        <TextView
            android:id="@+id/tvName"
            android:layout_width="0dp"
            android:layout_weight="1"
            android:layout_height="wrap_content"
            android:maxLines="1"
            android:textAppearance="?attr/cometchatTextAppearanceHeading4Bold"
            android:textColor="?attr/cometchatTextColorPrimary" />

        <com.google.android.material.card.MaterialCardView
            android:layout_width="wrap_content"
            android:layout_height="wrap_content"
            android:layout_marginStart="@dimen/cometchat_16dp"
            android:layout_marginTop="@dimen/cometchat_2dp"
            android:layout_marginBottom="@dimen/cometchat_2dp"
            android:elevation="0dp"
            app:cardBackgroundColor="#EDEAFA"
            app:cardCornerRadius="@dimen/cometchat_radius_max"
            app:cardElevation="0dp">

            <TextView
                android:layout_width="wrap_content"
                android:layout_height="wrap_content"
                android:layout_marginStart="@dimen/cometchat_margin_3"
                android:layout_marginTop="@dimen/cometchat_margin_1"
                android:layout_marginEnd="@dimen/cometchat_margin_3"
                android:layout_marginBottom="@dimen/cometchat_margin_1"
                android:text="JOIN"
                android:textAppearance="@style/CometChatTextAppearanceCaption1.Medium"
                android:textColor="?attr/cometchatPrimaryColor" />
        </com.google.android.material.card.MaterialCardView>
    </LinearLayout>

    <TextView
        android:id="@+id/tvSubtitle"
        android:layout_width="match_parent"
        android:layout_height="wrap_content"
        android:layout_marginTop="@dimen/cometchat_margin_1"
        android:textAppearance="?attr/cometchatTextAppearanceBodyRegular"
        android:textColor="?attr/cometchatTextColorSecondary" />
</LinearLayout>

Java
Kotlin

YourActivity.java

cometChatGroup.setItemView(new GroupsViewHolderListener() {
            @Override
            public View createView(Context context, CometchatListBaseItemsBinding listItem) {
                return View.inflate(context,R.layout.custom_group_list_item,null);
            }

            @Override
            public void bindView(Context context, View createdView, Group group, RecyclerView.ViewHolder holder, List<Group> groupList, int position) {
                TextView groupName = createdView.findViewById(R.id.tvName);
                TextView groupMemberCount = createdView.findViewById(R.id.tvSubtitle);
                LinearLayout.LayoutParams params = new LinearLayout.LayoutParams(LinearLayout.LayoutParams.MATCH_PARENT, LinearLayout.LayoutParams.WRAP_CONTENT);
                createdView.setLayoutParams(params);
                groupName.setText(group.getName());
                groupMemberCount.setText(group.getMembersCount() > 1 ? group.getMembersCount() + " members" : group.getMembersCount() + " member" + " • " + group.getDescription());
            }
        });

YourActivity.kt

cometChatGroup.setItemView(object : GroupsViewHolderListener() {
            override fun createView(
                context: Context?,
                listItem: CometchatListBaseItemsBinding?
            ): View {
                return View.inflate(context, R.layout.custom_group_list_item, null)
            }

            override fun bindView(
                context: Context,
                createdView: View,
                group: Group,
                holder: RecyclerView.ViewHolder,
                groupList: List<Group>,
                position: Int
            ) {
                val groupName = createdView.findViewById<TextView>(R.id.tvName)
                val groupMemberCount = createdView.findViewById<TextView>(R.id.tvSubtitle)
                val params = LinearLayout.LayoutParams(
                    LinearLayout.LayoutParams.MATCH_PARENT,
                    LinearLayout.LayoutParams.WRAP_CONTENT
                )
                createdView.layoutParams = params
                groupName.text = group.name
                groupMemberCount.text =
                    if (group.membersCount > 1) group.membersCount.toString() + " members" else group.membersCount.toString() + " member" + " • " + group.description
            }
        })

setSubTitleView

Customizes the subtitle view for each group item, which typically displays extra information. Use Cases:

Show last message preview.
Display the number of members.

Java
Kotlin

CometChatGroup.setSubtitleView(new GroupsViewHolderListener() {
            @Override
            public View createView(Context context, CometchatListBaseItemsBinding listItem) {
                return null;
            }

            @Override
            public void bindView(Context context, View createdView, Group group, RecyclerView.ViewHolder holder, List<Group> groupList, int position) {

            }
        });

cometChatGroup.setSubtitleView(object : GroupsViewHolderListener() {
            override fun createView(
                context: Context?,
                listItem: CometchatListBaseItemsBinding?
            ): View {
                return null
            }

            override fun bindView(
                context: Context,
                createdView: View,
                group: Group,
                holder: RecyclerView.ViewHolder,
                groupList: List<Group>,
                position: Int
            ) {
               
            }
        })

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 GroupsViewHolderListener. 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:

Java
Kotlin

YourActivity.java

cometChatGroup.setSubtitleView(new GroupsViewHolderListener() {
            @Override
            public View createView(Context context, CometchatListBaseItemsBinding listItem) {
                return new TextView(context);
            }

            @Override
            public void bindView(Context context, View createdView, Group group, RecyclerView.ViewHolder holder, List<Group> groupList, int position) {
                TextView textView = (TextView) createdView;
                textView.setText(group.getMembersCount() > 1 ? group.getMembersCount() + " members" : group.getMembersCount() + " member" + " • " + group.getDescription());

            }
        });

YourActivity.kt

group.setSubtitleView(object : GroupsViewHolderListener() {
            override fun createView(
                context: Context?,
                listItem: CometchatListBaseItemsBinding?
            ): View {
                return TextView(context)
            }

            override fun bindView(
                context: Context,
                createdView: View,
                group: Group,
                holder: RecyclerView.ViewHolder,
                groupList: List<Group>,
                position: Int
            ) {
                val textView = createdView as TextView
                textView.text =
                    if (group.membersCount > 1) group.membersCount.toString() + " members" else group.membersCount.toString() + " member" + " • " + group.description
            }
        })

SetOverflowMenu

Customizes the overflow menu (three-dot ⋮ icon) with additional options. Use Cases:

Add options like “Invite Members”, “Report Group”.
Enable admin-specific options like “Manage Group Settings”.

Java
Kotlin

cometchatGroups.setOverflowMenu(View v);

cometchatGroups.setOverflowMenu(v)

Example

You need to create a overflow_menu_layout.xml as a custom view file. Which we will inflate and pass to .setOverflowMenu().

overflow_menu_layout.xml

<?xml version="1.0" encoding="utf-8"?>
<LinearLayout xmlns:android="http://schemas.android.com/apk/res/android"
    android:layout_width="wrap_content"
    android:layout_height="wrap_content"
    android:orientation="vertical">

    <ImageView
        android:id="@+id/ivMenu"
        android:layout_width="@dimen/cometchat_24dp"
        android:layout_height="@dimen/cometchat_24dp"
        android:layout_marginStart="@dimen/cometchat_margin_4"
        android:importantForAccessibility="no"
        android:src="@drawable/ic_create_group" />

</LinearLayout>

You inflate the view and pass it to setOverflowMenu. You can get the child view reference and can handle click actions.

Java
Kotlin

YourActivity.java

View view = getLayoutInflater().inflate(R.layout.overflow_menu_layout, null);
ImageView imgRefresh = view.findViewById(R.id.ivMenu);
imgRefresh.setOnClickListener(v -> {
    Toast.makeText(requireContext(), "Clicked on Refresh", Toast.LENGTH_SHORT).show();
});
cometchatGroups.setOverflowMenu(view);

YourActivity.kt

val view: View = layoutInflater.inflate(R.layout.overflow_menu_layout, null)
val imgRefresh = view.findViewById<ImageView>(R.id.ivMenu)
imgRefresh.setOnClickListener { v: View? ->
    Toast.makeText(requireContext(), "Clicked on Refresh", Toast.LENGTH_SHORT).show()
}
cometchatGroups.setOverflowMenu(view)

​Overview

​Usage

​Integration

​Actions

setOnItemClick

setOnItemLongClick

setOnBackPressListener

setOnSelect

OnError

setOnLoad

setOnEmpty

​Filters

1. GroupsRequestBuilder

2. SearchRequestBuilder

​Events

1. Add CometChatGroupEvents Listener’s

2. Removing CometChatGroupEvents Listener’s

​Customization

​Style

​Functionality

​Advanced

​setOptions

​addOptions

​setLoadingView

​setEmptyView

​setErrorView

​setLeadingView

​setTitleView

​setTrailingView

​setItemView

​setSubTitleView

​SetOverflowMenu

Overview

Usage

Integration

Actions

Filters

Events

1. Add `CometChatGroupEvents` Listener’s

2. Removing `CometChatGroupEvents` Listener’s

Customization

Style

Functionality

Advanced

setOptions

addOptions

setLoadingView

setEmptyView

setErrorView

setLeadingView

setTitleView

setTrailingView

setItemView

setSubTitleView

SetOverflowMenu