Leave A Group

Learn how to leave a group and receive real-time events when members leave using the CometChat Flutter SDK.

AI Integration Quick Reference

// Leave a group
CometChat.leaveGroup("GROUP_GUID",
  onSuccess: (String message) => debugPrint("Left group: $message"),
  onError: (CometChatException e) => debugPrint("Error: ${e.message}"),
);

// Listen for group member left events
CometChat.addGroupListener("listener_id", GroupListener(
  onGroupMemberLeft: (Action action, User leftUser, Group leftGroup) {
    debugPrint("${leftUser.name} left ${leftGroup.name}");
  },
));

Leave a group to stop receiving messages and updates from it. Once you leave, you’ll need to rejoin to participate again.

Group owners cannot leave without first transferring ownership to another member. See Transfer Group Ownership.

Leave a Group

Use leaveGroup() to leave a group.

Available via: SDK | REST API | UI Kits

Parameters

Parameter	Type	Description
guid	String	The GUID of the group you would like to leave
onSuccess	Function(String returnResponse)?	Callback triggered on successful leave
onError	Function(CometChatException excep)?	Callback triggered on error

Dart

String GUID = "GUID";

CometChat.leaveGroup(GUID, onSuccess: ( String message) {
      debugPrint("Group Left  Successfully : $message");
    },onError: (CometChatException e) {
      debugPrint("Group Left failed  : ${e.message}");
    }); 

Response

On Success — A String message confirming the operation:

Parameter	Type	Description	Sample Value
message	string	Success confirmation message	"cometchat-guid-1 left successfully"

Error

Parameter	Type	Description	Sample Value
code	string	Error code identifier	"ERR_NOT_A_MEMBER"
message	string	Human-readable error message	"The user is not a member of this group."
details	string	Additional technical details	"Cannot leave a group that you are not a member of."

Once a group is left, the user will no longer receive any updates or messages pertaining to the group.

Real-time Group Member Left Events

In other words, as a member of a group, how do I know if someone has left it when my app is running?

If a user leaves a group, the members of the group receive a real-time event in the onGroupMemberLeft() method of the GroupListener class.

Dart

class Class_Name  with GroupListener {

//CometChat.addGroupListener("group_Listener_id", this);
@override
void onGroupMemberLeft(Action action, User leftUser, Group leftGroup) {
  print("onGroupMemberLeft ");

}
}

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 Group Member Left Events

In other words, as a member of a group, how do I know if someone has left it when my app is not running?

When you retrieve the list of previous messages if a member has left 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 left event, in the Action object received, the following fields can help you get the relevant information-

1. action - left
2. actionBy - User object containing the details of the user who left the group
3. actionFor - Group object containing the details of the group the user has left

---

Next Steps

Join a Group

Join public or password-protected groups

Delete a Group

Permanently delete a group (admin only)

Kick & Ban Members

Remove or ban members from a group

Retrieve Groups

Fetch and filter the list of groups