Manage group properties
ZEGOCLOUD's In-app Chat (the ZIM SDK) provides the capability of group properties management, allowing you to customize the group properties and fields, such as the group profile, group status, and more.
- Before you use this feature, you must join a group first. To join a group, refer to the Chapter Join a group of Manage groups.
- All in-group members (group owner included) can use this feature.
Set group properties
To set group properties after joining a group, call the setGroupAttributes method.
The group properties you set are stored as key-value.
- When Key does not exist: Setting group property means adding room property.
- When the Key already exists: Setting the group property means updating the value of the existing room property.
- Leaves the
Key-Valueempty means no group properties to be set.
- Up to 10 group properties can be set in a group. The group property is stored in the format of
Key-Value. For more customizable group properties, contact ZEGOCLOUD Technical Support. - The customized group properties you set will be cleared after the group is destroyed.
You can receive a notification through the callback ZIMGroupAttributesOperatedCallback after the group properties set successfully.
// Set group properties.
[zim setGroupAttributes:newAttributes groupID:groupID callback:^(NSString * _Nonnull groupID, NSArray<NSString *> * _Nonnull errorKeys, ZIMError * _Nonnull errorInfo) {
//Implement the event callback for setting the group properties here.
}];Delete group properties
To delete group properties after joining a group, call the deleteGroupAttributesByKeys method.
You can receive a notification through the callback ZIMGroupAttributesOperatedCallback after the group properties are deleted successfully.
// Delete group properties
[zim deleteGroupAttributesByKeys:deleteAttributesKeys groupID:groupID callback:^(NSString * _Nonnull groupID, NSArray<NSString *> * _Nonnull errorKeys, ZIMError * _Nonnull errorInfo) {
//Implement the event callback for deleting the group properties here.
}];Get a group property
To query a group property after joining a group, call the queryGroupAttributesByKeys method.
You can receive a notification through the callback ZIMGroupAttributesOperatedCallback after the query succeeds.
// Get a group property
[zim queryGroupAttributesByKeys:attributesKeys groupID:groupID callback:^(NSString * _Nonnull groupID, NSDictionary<NSString *,NSString *> * _Nonnull groupAttributes, ZIMError * _Nonnull errorInfo) {
//Implement the event callback for querying the group property here.
}];Get all group properties
To query all group properties after joining a group, call the queryGroupAllAttributesByGroupID method.
You can receive a notification through the callback ZIMGroupAttributesOperatedCallback after the query succeeds.
// Get all group properties.
[zim queryGroupAllAttributes:groupID callback:^(NSString * _Nonnull groupID, NSDictionary<NSString *,NSString *> * _Nonnull groupAttributes, ZIMError * _Nonnull errorInfo) {
//Implement the event callback for querying all group properties here.
}];