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. |
CometChatGroupMembers
, 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 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.
setItemClickListener
action doesn’t have a predefined behavior. You can override this action using the following code snippet.
setOnLongClickListener
action doesn’t have a predefined behavior. You can override this action using the following code snippet.
On Error
and improve error handling.
addOnBackPressListener
and improve error handling.
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.
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.
Property | Description | Code |
---|---|---|
Limit | Sets the number of group members that can be fetched in a single request, suitable for pagination. | .setLimit(int) |
Search Keyword | Used for fetching group members matching the passed string. | .setSearchKeyword(String) |
Scopes | Used for fetching group members having matching scopes which may be of participant, moderator, admin, and owner. | .setScopes(List<String>) |
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.
Event | Description |
---|---|
ccGroupMemberBanned | Triggers when the group member banned from the group successfully |
ccGroupMemberKicked | Triggers when the group member kicked from the group successfully |
ccGroupMemberScopeChanged | Triggers when the group member scope is changed in the group |
GroupMembersStyle
to the Group Memebers
Component to customize the styling.
Property | Description | Code |
---|---|---|
Background | Used to set the background color | .setBackground(@ColorInt int) |
Border Width | Used to set border | .setBorderWidth(int) |
Border Color | Used to set border color | .setBorderColor(@ColorInt int) |
Corner Radius | Used to set border radius | .setCornerRadius(float) |
Background | Used to set background Drawable | .setBackground(Drawable) |
Title Appearance | Used to customise the appearance of the title in the app bar | .setTitleAppearance(@StyleRes int) |
BackIcon Tint | Used to set the color of the back icon in the app bar | .setBackIconTint(@ColorInt int) |
Search Background | Used to set the background color of the search box | .setSearchBackground(@ColorInt int) |
Search Border Radius | Used to set the border radius of the search box | .setSearchBorderRadius(int) |
Search Icon Tint | Used to set the color of the search icon in the search box | .setSearchIconTint(@ColorInt int) |
Search Border Width | Used to set the border width of the search box | .setSearchBorderWidth(int) |
Search Text Appearance | Used to set the style of the text in the search box | .setSearchTextAppearance(@StyleRes int) |
Loading Icon Tint | Used to set the color of the icon shown while the list of group members is being fetched | .setLoadingIconTint(@ColorInt int) |
Empty Text Appearance | Used to set the style of the response text shown when fetching the list of group members has returned an empty list | .setEmptyTextAppearance(@StyleRes int) |
Error Text Appearance | Used to set the style of the response text shown in case some error occurs while fetching the list of group members | .setErrorTextAppearance(@StyleRes int) |
Online Status Color | Used to set the color of the status indicator shown if a group member is online | .setOnlineStatusColor(@ColorInt int) |
Separator Color | Used to set the color of the divider separating the group member items | .setSeparatorColor(@ColorInt int) |
Avatar
component in the Group Member Component, you can use the following code snippet. For further insights on Avatar
Styles refer
List Item
component in the Group Member
Component, you can use the following code snippet. For further insights on List Item
Styles refer
Property | Description | Code |
---|---|---|
Group | The group for which the group members will be listed. A required parameter. | .setGroup(Group) |
Title | Used to set title in the app bar | .setTitle(String) |
Style | Used to set styling properties | .setStyle(GroupMembersStyle) |
Avatar Style | Used to customise the Avatar of the group member | .setAvatarStyle(AvatarStyle) |
Status Indicator Style | Used to customise the status indicator shown if a group member is online | .setStatusIndicatorStyle(StatusIndicatorStyle) |
Search Placeholder Text | Used to set search placeholder text | .setSearchPlaceholderText(String) |
Back Icon | Used to set back button widget | .backIcon(@DrawableRes int res) |
Show Back Button | Used to toggle visibility for back button | .showBackButton(boolean) |
Search Box Icon | Used to set search Icon in the search field | .setSearchBoxIcon(@DrawableRes int res) |
Hide Search | Used to toggle visibility for search box | .hideSearch(boolean) |
Hide Error | Used to hide error on fetching group members | .hideError(boolean) |
Hide Separator | Used to hide the divider separating the group member items | .hideSeparator(boolean) |
Disable Users Presence | Used to control visibility of group member indicator shown if group member is online | .disableUsersPresence(boolean) |
List Item Style | Used to set style to Tile which displays data obtained from a GroupMember object | .setListItemStyle(ListItemStyle) |
Selection Icon | Used to override the of the default item selection icon | .setSelectionIcon(@DrawableRes int selectionIcon) |
Submit Icon | Used to override the default selection complete icon | .setSubmitIcon(@DrawableRes int submitIcon) |
Selection Mode | Used to set the number of group members that can be selected if activateSelection is not null. SelectionMode can be single, multiple or none. | .setSelectionMode(SelectionMode) |
Error State Text | Used to set a custom text response when some error occurs on fetching the list of group members | .errorStateText(String) |
Group Memebers
component does not provide additional functionalities beyond this level of customization.
CometChatOption
for a Members to add your custom actions to the Members. These options will be visible when swiping any Members item.
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:
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:
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 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:
view_menu.xml
as a custom view file. Which we will inflate and pass to .setMenu()
.
setMenu
. You can get the child view reference and can handle click actions.
setLoadingStateView
to match the loading view of your app.
ContentLoadingProgressBar
to loading_view_layout.xml
. You can choose any view you prefer. This view should be inflated and passed to the setLoadingStateView()
method.
EmptyStateView
using setEmptyStateView
to match the empty view of your app.
empty_view_layout.xml
. You can choose any view you prefer. This view should be inflated and passed to the setEmptyStateView()
method.
ErrorStateView
using setErrorStateView
to match the error view of your app.
error_state_view_layout.xml
. You can choose any view you prefer. This view should be inflated and passed to the setErrorStateView()
method.