Leave A Group

AI Integration Quick Reference

// Leave a group
CometChat.leaveGroup(GUID: "GUID", onSuccess: { response in }, onError: { error in })

// Listen for member left events
// Conform to CometChatGroupDelegate
func onGroupMemberLeft(action: ActionMessage, leftUser: User, leftGroup: Group) { }

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.

Use leaveGroup() to leave a group.

Parameter	Description
`GUID`	The GUID of the group you would like to leave

Swift
Objective C

let guid = "cometchat-guid-11"

CometChat.leaveGroup(GUID: guid, onSuccess: { (response) in
    print("Left group successfully.")
}, onError: { (error) in
    print("Group leaving failed with error:" + error!.errorDescription)
})

NSString *guid = @"cometchat-guid-101";

[CometChat leaveGroupWithGUID:guid onSuccess:^(NSString * response) {
    NSLog(@"Left group successfully. %@", response);
} onError:^(CometChatException * error) {
    NSLog(@"Group leaving failed with error: %@", [error errorDescription]);
}];

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

Swift
Objective C

class ViewController: UIViewController, CometChatGroupDelegate {
    
    override func viewDidLoad() {
        super.viewDidLoad()
        CometChat.groupdelegate = self
    }
    
    func onGroupMemberLeft(action: ActionMessage, leftUser: User, leftGroup: Group) {
        print("\(leftUser.name ?? "") left the group \(leftGroup.name ?? "").")
    }
}

@interface ViewController ()<CometChatGroupDelegate>
@end

@implementation ViewController

- (void)viewDidLoad {
    [super viewDidLoad];
    [CometChat setGroupdelegate:self];
}

- (void)onGroupMemberLeftWithAction:(ActionMessage *)action leftUser:(User *)leftUser leftGroup:(Group *)leftGroup {
    // User left the group
}

@end

Set delegate in viewDidLoad(): CometChat.groupdelegate = self. Remove delegate when view is dismissed to avoid memory leaks.

Missed Group Member Left Events

When fetching message history, leave events appear as Action messages (a subclass of BaseMessage) with:

Field	Value/Type	Description
`action`	`"left"`	The action type
`actionBy`	`User`	The user who left
`actionFor`	`Group`	The group that was left

Next Steps

Join a Group

Join public or password-protected groups

Delete a Group

Permanently delete a group

Kick & Ban Members

Remove or ban members from a group

Retrieve Groups

Fetch and filter the list of groups

​Leave a Group

​Real-time Group Member Left Events

​Missed Group Member Left Events

​Next Steps

Join a Group

Delete a Group

Kick & Ban Members

Retrieve Groups

Leave a Group

Real-time Group Member Left Events

Missed Group Member Left Events

Next Steps