CometChatAddMembers
is a Component that empowers administrators or group owners with the ability to expand group membership by seamlessly adding new participants. This component facilitates effortless management of group membership and enhances collaboration within the group’s discussions and activities. Administrators can meticulously select desired users to join the group, whether by targeted search or from a list of available users. Selected users receive notifications, streamlining the process of joining the group and ensuring smooth integration into the community.
CometChatAddMembers
component is composed of the following BaseComponents:
Components | Description |
---|---|
CometChatUsers | CometChatUsers is a standalone component that presents a user list and enables targeted user searches. As a container inheriting from CometChatListBase , it seamlessly incorporates the CometChatUserList component. This setup streamlines user browsing and search capabilities, enhancing overall usability and facilitating efficient interactions. |
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. |
CometChatAddMembers
, 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 add 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.
setOnItemClick
action doesn’t have a predefined behavior. You can override this action using the following code snippet.
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.
On Error
and improve error handling.
addOnBackPressListener
and improve error handling.
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 | 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) |
Tags | Used for fetching users containing the passed tags. | .setTags(List<String>) |
Roles | Used for fetching users containing the passed roles. | .setRoles(List<String>) |
UIDs | Used for fetching users containing the passed UIDs. | .setUIDs(List<String>) |
User Status | Used for fetching users by their status online or offline. | .setUserStatus(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 |
---|---|
ccGroupMemberAdded | Triggers when a user added to a group successfully |
AddMembers
component in the Group Member Component, you can use the following code snippet.
AddMembersStyle
Methods | Type | Description |
---|---|---|
Background | @ColorInt int | Used to set the background color |
Border Width | int | Used to set border |
Border Color | @ColorInt int | Used to set border color |
Corner Radius | float | Used to set border radius |
Background | Drawable | Used to set background Drawable |
Title Appearance | @StyleRes int | Used to customise the appearance of the title in the app bar |
Back Icon Tint | @ColorInt int | Used to set the color of the back icon in the app bar |
Search Background | @ColorInt int | Used to set the background color of the search box |
Search Border Radius | int | Used to set the border radius of the search box |
Search Icon Tint | @ColorInt int | Used to set the color of the search icon in the search box |
Search Border Width | int | Used to set the border width of the search box |
Search Text Appearance | @StyleRes int | Used to set the style of the text in the search box |
Loading Icon Tint | @ColorInt int | Used to set the color of the icon shown while the list of group members is being fetched |
Empty Text Appearance | @StyleRes int | Used to set the style of the response text shown when fetchig the list of group members has returned an empty list |
Error Text Appearance | @StyleRes int | Used to set the style of the response text shown in case some error occurs while fetching the list of group members |
Online Status Color | @ColorInt int | Used to set the color of the status indicator shown if a group member is online |
Separator Color | @ColorInt int | Used to set the color of the divider separating the group member items |
Section Header TextAppearance | @StyleRes int | Used to customise the appearance of the section header text. |
Section Header TextColor | @ColorInt int | Used to set the color of the section header text. |
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
CometChatAddMembers
| Property | Description | Code | | --------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------ | --- | | Group | The group to which the users selected will be added. A required parameter. | .setGroup(Group)
| | Title | Used to set title in the app bar | .setTitle(String)
| | Style | Used to set styling properties | .setStyle(AddMembersStyle)
| | 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 icon | .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 users and failing to add selected users to the group. | .hideError(boolean)
| | Hide Separator | Used to hide the divider separating the user items | .hideSeparator(boolean)
| | Hide Section Separator | Used to hide the text separating grouped user items | .hideSectionSeparator(boolean)
| | Disable Users Presence | Used to control visibility of user indicator shown if user is online | .disableUsersPresence(boolean)
| | Selection Icon | Used to override the default selection complete icon | .setSelectionIcon(@DrawableRes int res)
| | Submit Icon | Used to override the default selection complete icon | .setSubmitIcon(@DrawableRes int res)
| | Selection Mode | Used to set the number of users that can be selected. By default it is SelectionMode.multiple
. SelectionMode can be single, multiple or none. | .setSelectionMode(SelectionMode)
| |
Add Members
component does not provide additional functionalities beyond this level of customization.
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 UsersViewHolderListener
. 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 UsersViewHolderListener
. 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 UsersViewHolderListener
. 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.