Documentation Index
Fetch the complete documentation index at: https://cometchat-22654f5b-docs-android-v6-beta2.mintlify.app/llms.txt
Use this file to discover all available pages before exploring further.
Overview
CometChatGroupMembers is a versatile Component designed to showcase all users who are either added to or invited to a group, thereby enabling them to participate in group discussions, access shared content, and engage in collaborative activities. Group members have the capability to communicate in real-time through messaging, voice and video calls, and various other interactions. Additionally, they can interact with each other, share files, and join calls based on the permissions established by the group administrator or owner.

CometChatGroupMembers component is composed of the following BaseComponents:
| Components | Description |
|---|---|
| CometChatListBase | CometChatListBase serves as a container component equipped with a title (navigationBar), search functionality (search-bar), background settings, and a container for embedding a list view. |
| CometChatListItem | This component renders information extracted from a User object onto a tile, featuring a title, subtitle, leading view, and trailing view. experience, facilitating seamless navigation and interaction within the component. |
Usage
Integration
CometChatGroupMembers, as a custom view controller, 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 group 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 GroupMembers component into your application.
- Swift
If you are already using a navigation controller, you can use the pushViewController function instead of presenting the view controller.
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 CometChatGroupMembers, empowering them with greater control and customization options. ThesetOnItemClick action doesn’t have a predefined behavior. You can override this action using the following code snippet.
- Swift
2. SetOnItemLongClick
This method becomes invaluable when users seek to override long-click functionality within CometChatGroupMembers, offering them enhanced control and flexibility in their interactions. ThesetOnItemLongClick action doesn’t have a predefined behavior. You can override this action using the following code snippet.
- Swift
3. SetOnError
You can customize this behavior by using the provided code snippet to override theOn Error and improve error handling.
- Swift
4. SetOnBack
Enhance your application’s functionality by leveraging theSetOnBack feature. This capability allows you to customize the behavior associated with navigating back within your app. Utilize the provided code snippet to override default behaviors and tailor the user experience according to your specific requirements.
- Swift
Filters
Filters allow you to customize the data displayed in a list within aComponent. 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| Methods | Type | Description |
|---|---|---|
| setLimit | Int | Configure the maximum number of groups to fetch in a single request, optimizing pagination for smoother navigation. |
| setSearchKeyword | String | Employed to retrieve groups that match the provided string, facilitating precise searches. |
| scopes | [String] | used for fetching group members based on multiple scopes |
- Swift
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- Swift
Events
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.
Events emitted by the Join Group component is as follows.
| Event | Description |
|---|---|
| onGroupMemberBan | Triggers when the group member banned from the group successfully |
| onGroupMemberKick | Triggers when the group member kicked from the group successfully |
| onGroupMemberChangeScope | Triggers when the group member scope is changed in the group |
- Add Listener
Emitting Group Events
- Remove Listener
View controller
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. GroupMembers Style
You can set theGroupMembersStyle to the Group Memebers Component to customize the styling.
- Swift
| Property | Description | Code |
|---|---|---|
| Background | Sets the background color for Add Members | set(background: UIColor) |
| CornerRadius | Sets the corner radius for Add Members | set(cornerRadius: CometChatCornerStyle) |
| BorderWidth | Sets the border width for Add Members | set(borderWidth: CGFloat) |
| TitleColor | Sets the title color for Add Members | set(titleColor: UIColor) |
| TitleFont | Sets the title font for Add Members | set(titleFont: UIFont) |
| LargeTitleFont | Sets the large title font for Add Members | set(largeTitleFont: UIFont) |
| BackIconTint | Sets the back button tint color for Add Members | set(backIconTint: UIColor) |
| SearchIconTint | Sets the search icon tint color for Add Members | set(searchIconTint: UIColor) |
| SearchTextFont | Sets the search text font for Add Members | set(searchTextFont: UIFont) |
| SearchTextColor | Sets the search text color for Add Members | set(searchTextColor: UIColor) |
| SearchCancelButtonTint | Sets the search cancel icon tint for Add Members | set(searchCancelButtonTint: UIColor) |
| SearchPlaceholderFont | Sets the search placeholder font for Add Members | set(searchPlaceholderFont: UIFont) |
| SearchPlaceholderColor | Sets the search placeholder color for Add Members | set(searchPlaceholderColor: UIColor) |
| AddButtonTint | Sets add button color for Add Members | set(addButtonTint: UIColor) |
| AddButtonFont | Sets add button font for Add Members | set(addButtonFont: UIFont) |
2. Avatar Style
To apply customized styles to theAvatar component in the Group Member Component, you can use the following code snippet. For further insights on Avatar Styles refer
- Swift
Swift
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- Swift
4. ListItem Style
To apply customized styles to theListItemStyle component in the Group Member Component, you can use the following code snippet. For further insights on ListItemStyle Styles refer

- Swift
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.- Swift
| Property | Description | Code |
|---|---|---|
| Title | Custom title for the component | .set(title: String, mode: UINavigationItem.LargeTitleDisplayMode) |
| BackButtonTitle | Custom text for the back button | .set(backButtonTitle: String?) |
| SearchPlaceholderText | Custom placeholder text for search field | .set(searchPlaceholder: String) |
| ShowBackButton | Whether to hide the back button | .show(backButton: Bool) |
| ErrorStateText | Custom error state text | .set(errorStateText: String) |
| BackButtonIcon | Custom back button icon | .set(backButtonIcon: UIImage) |
| PasswordPlaceHolderText | Custom placeholder text | .set(passwordPlaceholderText: String) |
| HideContinueButton | Whether to hide the continue button | .hide(continueButton: Bool) |
| SearchPlaceholder | Set the placeholder for search bar in CometChatGroupMembers | set(searchPlaceholder: String) |
| SearchIcon | Sets the icon for the search bar in CometChatGroupMembers | set(searchIcon:UIImage) |
| SearchClearIcon | Sets the clear icon for the search bar in CometChatGroupMembers | set(searchClearIcon:UIImage) |
| SearchBarHeight | Set the height for the search bar in CometChatGroupMembers | set(searchBarHeight: CGFloat) |
| HideSearch | Hide / unhide the search bar as per boolean value | hide(search: Bool) |
| SelectionMode | This enables a selection, it has three modes: .single, .multiple | selectionMode(mode: SelectionMode) |
| HideSeparator | This method will hide the separator in CometChatGroupMembers | hide(separator: Bool) |
| DisableUserPresence | This method disables user’s online/offline status in CometChatGroupMembers | disable(userPresence: Bool) |
| ClearList | This method will clear the users locally in CometChatGroupMembers | clearList() |
| UpdateGroupMember | This method specifies the option to update member object locally in CometChatGroupMembers | update(groupMember: GroupMember) |
| RemoveGroupMember | This method specifies the option to remove member object locally from CometChatGroupMembers | remove(groupMember: GroupMember) |
| GetSize | This method specifies the count of members displayed in CometChatGroupMembers | size() |
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 own views, layouts, and UI elements and then incorporate those into the component. TheJoin Group component does not provide additional functionalities beyond this level of customization.
ListItemView
Utilize this property to assign a custom ListItem to the GroupMembers Component, allowing for enhanced customization and flexibility in its rendering.- Swift

CustomListItemGroupView and pass it inside the setListItemView() method.
CustomListItemGroupView
- Swift
Ensure to pass and present
CometChatGroupMembers. If a navigation controller is already in use, utilize the pushViewController function instead of directly presenting the view controller.SubtitleView
You can set your custom Subtitle view using the.setSubtitleView() method. But keep in mind, by using this you will override the default Subtitle view functionality.
- Swift
- You can customize the subtitle view for each GroupMembers item to meet your requirements

Custom_Subtitle_GroupMember_Viewa UIView file.
Custom_Subtitle_GroupMember_View
- Swift
Ensure to pass and present
CometChatGroupMembers. If a navigation controller is already in use, utilize the pushViewController function instead of directly presenting the view controller.EmptyView report
You can set a custom EmptyView using.set(emptyView: UIView) to match the empty view of your app.
- Swift
Custom_Empty_State_GroupViewa UIView file.
- Swift
Ensure to pass and present
CometChatGroupMembers. If a navigation controller is already in use, utilize the pushViewController function instead of directly presenting the view controller.ErrorView
You can set a custom ErrorView using.set(errorView: UIView) to match the error view of your app.
- Swift

Custom_ErrorState_GroupView and pass it inside the .set(errorView: UIView) method.
Custom_ErrorState_GroupView
- Swift
Ensure to pass and present
CometChatGroupMembers. If a navigation controller is already in use, utilize the pushViewController function instead of directly presenting the view controller.Menus
You can set the Custom Menus to add more options to the Groups component.- Swift
- You can customize the menus for groups to meet your requirements

CometChatGroupMembers, enhancing its interface with a personalized menu for a more user-friendly experience.
- Swift
Ensure to pass and present
CometChatGroupMembers. If a navigation controller is already in use, utilize the pushViewController function instead of directly presenting the view controller.TailView
You can set a custom Tailview using.setTailView() to match the TailView view of your app.
- Swift

Custom_Tail_GroupView and pass it inside the .setTailView() method.
Custom_Tail_GroupView
- Swift
Ensure to pass and present
CometChatGroupMembers. If a navigation controller is already in use, utilize the pushViewController function instead of directly presenting the view controller.Options
Enhance your GroupsMembers component by setting Custom Options to incorporate additional functionalities when swiping- Swift
- You can customize the options for group members to meet your requirements

CometChatGroupMembers by introducing a tailored feature. By adding a custom option, such as “Delete” with a corresponding trash icon, users can now enjoy a more interactive and user-friendly experience.
- Swift
Ensure to pass and present
CometChatGroupMembers. If a navigation controller is already in use, utilize the pushViewController function instead of directly presenting the view controller.