Add Members

Add members to groups with specific roles using the Android SDK

AI Integration Quick Reference

// Add members to a group
val members = listOf(
    GroupMember("uid1", CometChatConstants.SCOPE_MODERATOR),
    GroupMember("uid2", CometChatConstants.SCOPE_PARTICIPANT)
)

CometChat.addMembersToGroup("GUID", members, null, 
    object : CallbackListener<HashMap<String, String>>() {
        override fun onSuccess(result: HashMap<String, String>) { }
        override fun onError(e: CometChatException) { }
    })

Note: Only admins and moderators can add members. The result HashMap contains UID as key and “success” or error message as value.

Add Members to Group

Use addMembersToGroup() with the group GUID, a list of GroupMember objects, and an optional list of UIDs to ban.

Java

List<GroupMember> members = new ArrayList<>();
members.add(new GroupMember("uid1",CometChatConstants.SCOPE_MODERATOR));
members.add(new GroupMember("uid2", CometChatConstants.SCOPE_ADMIN));

CometChat.addMembersToGroup("GUID", members, null, new CometChat.CallbackListener<HashMap<String, String>>(){
  @Override
  public void onSuccess(HashMap<String, String> successMap) {
    Log.d("CometChatActivity", success);
  }

  @Override
  public void onError(CometChatException e) {
    Toast.makeText(CometChatActivity.this, e.getMessage(),Toast.LENGTH_LONG).show();
  }
});

Kotlin

val member:MutableList<GroupMember> = arrayListOf()
member.add(GroupMember(UID,CometChatConstants.SCOPE_PARTICIPANT))

CometChat.addMembersToGroup(GUID,member,null,object :CometChat.CallbackListener<HashMap<String,String>>(){

  override fun onSuccess(p0: HashMap<String, String>?) {

  }

  override fun onError(p0: CometChatException?) {

  }
})

In the onSuccess() method of the CallbackListener, you will receive a HashMap which will contain the UID of the users and the value will either be success or an error message describing why the operation to add the user to the group or ban the user failed.

Real-Time Group Member Added Events

When a member is added to a group, existing members receive a real-time event in onMemberAddedToGroup() of the GroupListener class. The callback provides an Action object, the adding User, the added User, and the Group.

When a member is added by another user, onMemberAddedToGroup() fires. When a user joins on their own, onGroupMemberJoined() fires instead.

Java

CometChat.addGroupListener("UNIQUE_ID", new CometChat.GroupListener() {
  @Override
  public void onMemberAddedToGroup(Action action, User addedby, User userAdded, Group addedTo) {
    Log.d("onMemberAddedToGroup", action.getMessage());
  }
});

Kotlin

CometChat.addGroupListener("UNIQUE_ID", object : CometChat.GroupListener() {
  override fun onMemberAddedToGroup(action: Action, addedby: User, userAdded: User, addedTo: Group) {
    Log.d("onMemberAddedToGroup", action.message)
  }
})

Member Added to Group event in Message History

When fetching message history, if a member was added to a group the logged-in user is part of, the list will contain an Action message with these fields:

1. action - added
2. actionOn - User object containing the details of the user who was added to the group
3. actionBy - User object containing the details of the user who added the member to the group
4. actionFor - Group object containing the details of the group to which the member was added

Always remove group listeners when they’re no longer needed (e.g., in onDestroy() or when navigating away). Failing to remove listeners can cause memory leaks and duplicate event handling.

GroupMember Payload Structure

GroupMember Object

The GroupMember object extends User and contains all User fields plus group-specific fields:

Parameter	Type	Description
uid	String	Unique identifier of the user
name	String	Display name of the user
avatar	String	URL to user’s profile picture
link	String	URL to user’s profile page
role	String	User role for access control
metadata	JSONObject	Custom data set by developer
status	String	User online status. Values: "online", "offline"
statusMessage	String	Custom status message
lastActiveAt	long	Unix timestamp of last activity
hasBlockedMe	boolean	Whether this user has blocked the logged-in user
blockedByMe	boolean	Whether the logged-in user has blocked this user
tags	Array<String>	List of tags for user identification
deactivatedAt	long	Unix timestamp when user was deactivated (0 if active)
scope	String	Member’s scope in the group. Values: "admin", "moderator", "participant"
joinedAt	long	Unix timestamp when member joined the group

Sample GroupMember Object:

{
  "uid": "user_123",
  "name": "John Doe",
  "avatar": "https://example.com/avatar.png",
  "link": "https://example.com/profile",
  "role": "default",
  "metadata": {
    "department": "Engineering",
    "title": "Senior Developer"
  },
  "status": "online",
  "statusMessage": "Available",
  "lastActiveAt": 1699900000,
  "hasBlockedMe": false,
  "blockedByMe": false,
  "tags": ["premium", "verified"],
  "deactivatedAt": 0,
  "scope": "admin",
  "joinedAt": 1699850000
}

---

Next Steps

Kick Member

Remove members from groups

Change Member Scope

Update member roles and permissions

Retrieve Members

Fetch list of group members

Group Listeners

Handle real-time group events