Add Members To A Group

Learn how to add members to a group, receive real-time member added events, and handle missed events using the CometChat Flutter SDK.

AI Integration Quick Reference

// Add members to a group
List<GroupMember> members = [
  GroupMember.fromUid(uid: "UID", scope: CometChatMemberScope.participant, name: "User 1"),
];

CometChat.addMembersToGroup(
  guid: "GUID",
  groupMembers: members,
  onSuccess: (Map<String?, String?> result) {
    debugPrint("Members added: $result");
  },
  onError: (CometChatException e) {
    debugPrint("Error: ${e.message}");
  },
);

// Listen for member added events
class MyGroupListener with GroupListener {
  @override
  void onMemberAddedToGroup(Action action, User addedby, User userAdded, Group addedTo) {
    debugPrint("Member added: ${userAdded.name}");
  }
}
CometChat.addGroupListener("listenerId", MyGroupListener());

Add users to a group programmatically. Only admins and moderators can add members. The added users receive a notification and are immediately part of the group.

Add Members to Group

Available via: SDK | REST API | UI Kits

Use addMembersToGroup() to add members to a Group.

Parameter	Type	Description
guid	String	The GUID of the group to add members to
groupMembers	List<GroupMember>	List of GroupMember objects (UID and scope required)
onSuccess	Function(Map<String?, String?>)	Callback with a map of UIDs to result status
onError	Function(CometChatException)	Callback triggered on failure

In order to add members, you need to create an object of the GroupMember class. The UID and the scope of the GroupMember are mandatory.

Dart

List<GroupMember> groupMembers = [];
GroupMember firstMember = GroupMember.fromUid(
scope: CometChatMemberScope.participant,
uid: "cometchat-uid-3",name: "name");
GroupMember secondMember = GroupMember.fromUid(scope: CometChatMemberScope.admin,
uid: "cometchat-uid-4",name: "name");

groupMembers = [firstMember, secondMember];

CometChat.addMembersToGroup( guid: conversationWith,
        groupMembers: groupMembers,
        onSuccess: (Map<String?,String?> result) {
          debugPrint("Group Member added Successfully : $result");
        },
        onError: (CometChatException e) {
          debugPrint("Group Member addition failed with exception: ${e.message}");
        });

Response

On Success — A Map<String?, String?> where each key is the UID of the user and the value is either "success" or an error message:

Parameter	Type	Description	Sample Value
cometchat-uid-3	string	Result for the first member added	"success"
cometchat-uid-4	string	Result for the second member added	"success"

Error

Parameter	Type	Description	Sample Value
code	string	Error code identifier	"ERR_GUID_NOT_FOUND"
message	string	Human-readable error message	"The specified group does not exist."
details	string	Additional technical details	"Please provide a valid group GUID."

In the onSuccess() callback, you will receive a Map 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 failed.

Real-Time Group Member Added Events

When a group member is added by another member, this event is triggered. When a user joins a group on their own, the joined event is triggered.

Implement onMemberAddedToGroup() in GroupListener to receive real-time notifications when members are added.

Dart

class Class_Name  with GroupListener {

//CometChat.addGroupListener("group_Listener_id", this);
@override
void onMemberAddedToGroup(Action action, User addedby, User userAdded, Group addedTo) {
  print("onMemberAddedToGroup");
}
}

Callback Parameter	Type	Description
action	Action	The action object containing details of the event
addedby	User	The user who added the member
userAdded	User	The user who was added to the group
addedTo	Group	The group the member was added to

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

CometChat.removeGroupListener("group_Listener_id");

Missed Member Added Events

When you retrieve the list of previous messages, if a member has been added to any group that the logged-in user is a member of, the list of messages will contain an Action message. An Action message is a sub-class of BaseMessage class.

For the group member added event, in the Action object received, the following fields can help you get the relevant information:

Field	Value/Type	Description
action	"added"	The action type
actionOn	User	The user who was added
actionBy	User	The user who added the member
actionFor	Group	The group the member was added to

---

Next Steps

Kick & Ban Members

Remove or ban members from a group

Change Member Scope

Promote or demote group members

Retrieve Group Members

Fetch the list of members in a group

Join a Group

Allow users to join public or password-protected groups