Update A Group

Update group details such as name, type, icon, and description using the CometChat iOS SDK.

AI Integration Quick Reference

// Update group details
let group = Group(guid: "GUID", name: "New Name", groupType: .public, password: nil)
CometChat.updateGroup(group: group,
    onSuccess: { group in }, onError: { error in })

Update a group’s name, icon, description, or metadata. The GUID and group type cannot be changed after creation. See the Group Class reference for all editable fields.

Update Group

Use updateGroup() to modify group details. Pass a Group object with the updated values.

Swift

let GUID = "GUID";
let groupName = "Hello Group!";
let groupType: CometChat.groupType = .public;

let groupTobeUpdated = Group(guid: GUID, name: groupName, groupType: groupType, password: nil)

CometChat.updateGroup(group: groupTobeUpdated, onSuccess: { (group) in

  print("Groups details updated successfully. " + group.stringValue())

}) { (error) in

   print("Group details update failed with error: " + error!.errorDescription);
}

Objective C

NSString *guid = @"cometchat-guid-101";
NSString *name = @"TestGroup1";
NSString *password = nil ; // mandatory in case of password protected group type
NSInteger limit = 30;

Group *groupToBeUpdated = [[Group alloc]initWithGuid:guid name:name groupType:groupTypePublic password:password];

[CometChat updateGroupWithGroup:groupToBeUpdated onSuccess:^(Group * group) {

    NSLog(@"Groups details updated successfully. %@",[group stringValue]);

} onError:^(CometChatException * error) {

    NSLog(@"Group details update failed with error: %@",[error errorDescription]);
}];

Parameter	Description
group	An instance of Group class with updated values

On success, returns a Group object with the updated details.

Real-time Events

When a group is updated, all members receive the onGroupUpdated event via CometChatGroupDelegate:

Swift

extension YourClass: CometChatGroupDelegate {
    func onGroupUpdated(action: ActionMessage, updatedGroup: Group, updatedBy: User) {
        print("Group updated: \(updatedGroup.name ?? "")")
        print("Updated by: \(updatedBy.name ?? "")")
    }
}

---

Next Steps

Delete Group

Permanently delete a group

Retrieve Groups

Fetch and filter groups with pagination