logo
In-app Chat
SDK Error Codes
Powered Byspreading
On this page

Manage groups


ZEGOCLOUD's In-app Chat (the ZIM SDK) provides the capability of group management, allowing you to create a group, ungroup, join and leave a group, and maintain the group relation chain.

With the group management feature, you can create different types of group chats as needed, such as colleague groups, social groups, fan groups, and more.

Create a group

After user A logs in to the ZIM SDK on a client, the user can call the createGroup method to create a group with advanced settings. In this case, user A logged on this client is the group owner, and users on other clients can join this group using the groupID.

You can check whether the group is created through the ZIMGroupCreatedCallback callback. For more information about error codes, see Error codes.

Warning
  • You can specify custom rules for groupID generation. A group ID can contain only digits, letters, and the following characters: '!', '#', '$', '%', '&', '(', ')', '+', '-', ':', ';', '<', '=', '.', '>', '?', '@', '[', ']', '^', '_', '{', '}', '|', '~', and cannot start with a pound sign (#). If this parameter is empty, the ZIM server automatically generates a value. We recommend that you set a meaningful group ID generation rule. You can associate the group ID with your business account system.
  • If a user calls the createGroup method to create a group, the user automatically joins the group without calling the joinGroup method.
  • The user creating a group is the group owner. For more information about group ownership transfer, see Transfer the group ownership.
Untitled
// Create a group
// groupID is a string with a maximum of 32 bytes. Only numbers, English characters, and the following special characters are supported: '!', '#', '$', '%', '&', '(', ')', '+', '-', ':', ';', '<', '=', '.', '>', '?', '@', '[', ']', '^', '_', '{', '}', '|', '~'. It cannot start with '#'.
// groupName is a string with a maximum of 50 bytes, no special character restrictions
ZIMGroupInfo groupInfo = ZIMGroupInfo();
groupInfo.groupID = 'groupID';
groupInfo.groupName = 'groupName';
List<String> inviteUserIDs = ['userID1', 'userID2'];
ZIMGroupAdvancedConfig advancedConfig = ZIMGroupAdvancedConfig();
// Active joining mode
advancedConfig.joinMode = ZIMGroupJoinMode.any;
// Invitation verification mode
advancedConfig.inviteMode = ZIMGroupInviteMode.any;
// Be invited verification mode
advancedConfig.beInviteMode = ZIMGroupBeInviteMode.none;
// Member count limit
advancedConfig.maxMemberCount = 300;
try{
    await ZIM.getInstance()!.createGroup(groupInfo, inviteUserIDs,advancedConfig);
    // Write your business logic after creating the group here
} on PlatformException catch(onError){
    onError.code;
    onError.message;
}
1
Copied!

Join a group

Note

If you want users to automatically obtain group history messages after joining a group, please contact the ZEGOCLOUD technical support team for configuration.

After logging in to the ZIM SDK, users can apply to join or be invited to join a group created by user A.

If a user successfully joins the group, all group members (including the user) receive the onGroupMemberStateChanged and onGroupStateChanged callbacks.

Untitled
// Callback for group member state change
ZIMEventHandler.onGroupMemberStateChanged = (
    ZIM zim,
    ZIMGroupMemberState state,
    ZIMGroupMemberEvent event,
    List<ZIMGroupMemberInfo> userList,
    ZIMGroupOperatedInfo operatedInfo,
    String groupID
){};

// Callback for group state change
ZIMEventHandler.onGroupStateChanged = (
    ZIM zim,
    ZIMGroupState state,
    ZIMGroupEvent event,
    ZIMGroupOperatedInfo operatedInfo,
    ZIMGroupFullInfo groupInfo
){};
1
Copied!

Method 1: Apply to join a group

The user calls the corresponding method to apply to join a group based on the joinMode of the group.

  • If the joinMode is set to 0 (ANY), the user calls the joinGroup method and passes in the groupID to join the group without approval. If the groupID does not exist, the operation fails.

Developers can determine whether the user successfully joins the group through ZIMGroupJoinedResult.

Untitled
    // Other clients join the group directly
    ZIM.getInstance()
    !.joinGroup('groupID')
    .then((value){
        // Triggered when successful
    })
    .catchError((onError) {
        // Triggered when failed
    });
1
Copied!
  • If the joinMode is set to 1 (AUTH):
  1. The user calls the sendGroupJoinApplication method to send an application.
Untitled
ZIMGroupJoinApplicationSendConfig sendConfig = ZIMGroupJoinApplicationSendConfig();
sendConfig.wording = 'Please let me join the group';
try{
    var result = await ZIM.getInstance()!.sendGroupJoinApplication('groupID', sendConfig);
} on PlatformException catch (onError){
    onError.code;
    onError.message;
}
1
Copied!
  1. The group owner or administrator receives the application notification by listening for the onGroupApplicationListChanged event.
Untitled
ZIMEventHandler.onGroupApplicationListChanged = (ZIM zim,
    List<ZIMGroupApplicationInfo> applicationList,
    ZIMGroupApplicationListChangeAction action){}; 
1
Copied!
  1. The group owner or administrator handles the application.
Untitled
// Approve the application
try{
    ZIMGroupJoinApplicationAcceptConfig acceptConfig = ZIMGroupJoinApplicationAcceptConfig();
    var result = await ZIM.getInstance()!.acceptGroupJoinApplication('userID', 'groupID', acceptConfig);    
} on PlatformException catch (onError){
    onError.code;
    onError.message;
}
1
Copied!
Untitled
// Reject the application
try{
    ZIMGroupJoinApplicationRejectConfig rejectConfig = ZIMGroupJoinApplicationRejectConfig();
    var result = await ZIM.getInstance()!.rejectGroupJoinApplication('userID', 'groupID', rejectConfig);
} on PlatformException catch (onError){
    onError.code;
    onError.message;
}
1
Copied!
  1. The user applying to join the group, the group owner or administrator, and the method caller receive the onGroupApplicationUpdated callback.
Untitled
// Listen to the onGroupApplicationUpdated event
ZIMEventHandler.onGroupApplicationUpdated = (ZIM zim,
    List<ZIMGroupApplicationInfo> applicationList){

};
1
Copied!

Method 2: Invite a user to a group

  1. A group member can invite a user to the group by calling one of the following methods.
Warning

Make sure that the invitee has been registered by calling the login method; otherwise, the operation fails.

Developers can use ZIMGroupUsersInvitedResult to determine whether the user has been successfully added to the group.

Untitled
        // Add members to the group from within the group
        List<String> userIDs = ['userID1', 'userID2'];
        ZIM.getInstance()
        !.inviteUsersIntoGroup(userIDs, 'groupID')
        .then((value) => {
            // Call this if successful
        })
        .catchError((onError) {
            // Call this if failed
        });
1
Copied!
Untitled
// Send an invitation to join the group
ZIMGroupInviteApplicationSendConfig config = ZIMGroupInviteApplicationSendConfig();
config.wording = 'xxx invites you to join the group chat';
ZIMGroupInviteApplicationSendConfig applicationSendConfig = ZIMGroupInviteApplicationSendConfig();
try{
    var result = await ZIM.getInstance()!.sendGroupInviteApplications(['userID1','userID2'], 'groupID', config);
} on PlatformException catch (onError) {
    onError.code;
    onError.message;
}
1
Copied!

The following table describes the operation results of different methods called by different roles in a group in inviteMode and beInviteMode modes.

beInviteModeinviteModeMethodCallerResult
0: None0: AnyinviteUsersIntoGroupAll group membersThe invitee joins the group without approval.
sendGroupInviteApplicationsToUserIDsThe invitee joins the group without approval, with no application generated.
1: AdmininviteUsersIntoGroupOrdinary membersFailed.
Group owner or administratorThe invitee joins the group without approval.
sendGroupInviteApplicationsToUserIDsOrdinary membersFailed.
Group owner or administratorThe invitee joins the group without approval, with no application generated.
1: Auth0: AnyinviteUsersIntoGroupAll group membersAn application is generated and sent to the invitee for approval.
sendGroupInviteApplicationsToUserIDsAn application is generated and sent to the invitee for approval. If the caller is the group owner or administrator, the groupApplicationListChanged callback is generated.
1: AdmininviteUsersIntoGroupOrdinary membersFailed.
Group owner or administratorAn application is generated and sent to the invitee for approval.
sendGrsendGroupInviteApplicationsToUserIDsoupInviteApplicationsOrdinary membersFailed.
Group owner or administratorAn application is generated and sent to the invitee for approval. If the caller is the group owner or administrator, the groupApplicationListChanged callback is generated.
  1. If the beInviteMode is set to 1 (AUTH), the invitee and inviter (the group owner or administrator) receive the notification in the onGroupApplicationListChanged callback. The invitee can perform the following operations on the application:
Untitled
try{
    ZIMGroupInviteApplicationAcceptConfig acceptConfig = ZIMGroupInviteApplicationAcceptConfig();
    var result = await ZIM.getInstance()!.acceptGroupInviteApplication('inviterUserID', 'groupID', acceptConfig); 
} on PlatformException catch(onError){
    onError.code;
    onError.message;
}
1
Copied!
Untitled
try{
    ZIMGroupInviteApplicationRejectConfig rejectConfig = ZIMGroupInviteApplicationRejectConfig();
    var reuslt = await ZIM.getInstance()!.rejectGroupInviteApplication('inviterUserID', 'groupID', rejectConfig);
} on PlatformException catch(onError){
    onError.code;
    onError.message;
}
1
Copied!
  1. If the beInviteMode is set to 1 (AUTH), the invitee and inviter (the group owner or administrator) receive the approval notification in the onGroupApplicationUpdated callback.
Untitled
ZIMEventHandler.onGroupApplicationUpdated = (ZIM zim,
List<ZIMGroupApplicationInfo> applicationList){

};
1
Copied!

Leave a group

A group member can leave a group or be removed from a group.

Warning

After a group member leaves a group, the local list of conversations is retained, and historical group messages can be viewed.

Method 1: A group member leaves the group

After logging in to the ZIM SDK, the group member calls the leaveGroup method and passes in the groupID. If the groupID does not exist, the operation fails. After the group member leaves the group, all group members receive the onGroupMemberStateChanged callback.

Note

If the group owner leaves the group, the group ownership is automatically transferred to the first group member. If all group members leave the group, the group is automatically disbanded.

Developers can use ZIMGroupLeftResult to determine whether the member successfully left the group.

Untitled
// Voluntarily leave a group
ZIM.getInstance()
  !.leaveGroup('groupID')
   .then((value){
       // Triggered on success
   })
   .catchError((onError) {
       // Triggered on failure
   });
1
Copied!

Method 2: The group owner removes a group member from the group

The group owner calls the kickGroupMembers method and passes in the groupID and userIDList (list of users to be removed). If the groupID does not exist, the operation fails. After one or more group members are removed, all group members (including the group owner and the removed group members) receive the onGroupMemberStateChanged callback.

Developers can use ZIMGroupMemberKickedResult to determine whether the user has been successfully removed.

Warning
  • Only the group owner or administrator can call the kickGroupMembers method to remove a group member, who does not need to be logged in or approve the removal.
  • The userID of the user to be removed must be in the list of group members; otherwise, the operation fails.
Untitled
// Remove members from the group by the group owner
ZIM.getInstance()
  !.kickGroupMembers(userIDs, 'groupID')
   .then((value){
       // Triggered when successful
   })
   .catchError((onError) {
       // Triggered when failed
   });
1
Copied!

Disband a group

After logging in to the ZIM SDK, the group owner calls the dismissGroup method to disband a group. After the group is disbanded, all group members receive the onGroupStateChanged callback.

Developers can use ZIMGroupDismissedResult to determine whether the group has been successfully dissolved.

Note
  • Only the group owner can call the dismissGroup method to disband a group.
  • If all group members leave a group, the group is automatically disbanded.
  • After a group is disbanded, the local list of conversations is retained, and historical messages can be viewed.
Untitled
// Dismiss group by group owner
ZIM.getInstance()
  .dismissGroup('groupID')
   .then((value){
       // Triggered when successful
   })
   .catchError((onError) {
       // Triggered when failed
   });
1
Copied!

More features

Query the list of joined groups

After logging in to the ZIM SDK, a user calls the queryGroupList method to query the list of joined groups.

Developers can get the query result through ZIMGroupListQueriedResult.

Untitled
// User queries the groups they have joined
ZIM.getInstance()
  .queryGroupList()
   .then((value){
       // Triggered when successful
   })
   .catchError((onError) {
       // Triggered when failed
   });
1
Copied!

Search for joined groups

After logging in to the ZIM SDK, a user calls the searchLocalGroups method and passes in the config and callback parameters to search for joined groups by condition.

The search result is returned in the ZIMGroupsSearchedResult callback.

Untitled
// Search for joined groups that contain "zego" in the name
ZIMGroupSearchConfig config =  ZIMGroupSearchConfig();
config.count = 10;
config.nextFlag = 0;
config.isAlsoMatchGroupMemberNickname = true; // If the group member nickname contains "zego", the search result will include that group.
config.isAlsoMatchGroupMemberUserName = true; // If the group member username contains "zego", the search result will include that group.
config.keywords.add("zego");
ZIM.getInstance()!.searchLocalGroups(config).then((result){
    // Developers can get the group information from groupSearchInfoList    
}).catchError((onError){
    // Handle according to the official error code table
});
1
Copied!

Mute or unmute a group

If a group is muted, group members cannot send messages to the group.

After logging in to the ZIM SDK, a user can mute or unmute a group on which the user has management permission by calling the muteGroup method and passing in parameters to specify the group ID, mute mode, duration, and role.

The ZIM SDK supports three mute modes:

  • All group members are muted.
  • All ordinary group members (whose role value is 3) are muted.
  • Group members of specified roles are muted.

The result is returned in the ZIMGroupMutedResult callback.

Note

If you want to block specific group members from posting, please refer to Set mute status for group members - Manage group members.

Untitled
// Set the group mute configuration
try {
    // Set the group mute configuration
    ZIMGroupMuteConfig config = ZIMGroupMuteConfig();
    // Set the mute mode to mute group members with specified roles
    config.mode = ZIMGroupMuteMode.custom;
    // Set the mute duration to 30 seconds
    config.duration = 30;
    // Mute group members with roles 3 and 5
    config.roles = [3,5];
    // Enable mute
    bool isMute = true;
    ZIMGroupMutedResult result = await ZIM.getInstance()!.muteGroup(isMute, 'group_id', config);
} on PlatformException catch (onError){
    onError.code;// Handle according to the error code table
    onError.message;// Error message
}
1
Copied!

After a group is muted or unmuted, all group members receive the onGroupMutedInfoUpdated callback and know which roles are muted or unmuted.

Untitled
ZIMEventHandler.onGroupMutedInfoUpdated = (ZIM zim, ZIMGroupMuteInfo groupMuteInfo, ZIMGroupOperatedInfo operatedInfo, String groupID){
    // Listen to the information of group mute status changes here and handle accordingly
};
1
Copied!

Check whether a user is in a group

To check whether a user is in a group, call any of the following methods:

For group chats, the result is indicated by the isDisabled property of ZIMGroupConversation.

Valid values of isDisabled:

  • true: The user is not in the group. If the user leaves the group or is removed from the group, or the group is disbanded, the value of isDisabled is false.
  • false: The user is in the group.

Update the group joining mode

After logging in to the ZIM SDK, the group owner or administrator calls the updateGroupJoinMode method to update the group joining mode.

After the mode is updated, all group members receive the onGroupVerifyInfoUpdated callback.

Untitled
// Listen to the onGroupVerifyInfoUpdated event
ZIMEventHandler.onGroupVerifyInfoUpdated = (ZIM zim,
    ZIMGroupVerifyInfo verifyInfo,
    ZIMGroupOperatedInfo operatedInfo,
    String groupID){};

// Update the group join mode
try{
    var result = await ZIM.getInstance()!.updateGroupJoinMode(ZIMGroupJoinMode.auth, 'groupID');
} on PlatformException catch(onError){
    onError.code;
    onError.message;
}
1
Copied!

Update inviteMode of a group

After logging in to the ZIM SDK, the group owner or administrator calls the updateGroupInviteMode method to update inviteMode of the group.

After the mode is updated, all group members receive the onGroupVerifyInfoUpdated callback.

Untitled
// Listen to the onGroupVerifyInfoUpdated event
ZIMEventHandler.onGroupVerifyInfoUpdated = (ZIM zim,
    ZIMGroupVerifyInfo verifyInfo,
    ZIMGroupOperatedInfo operatedInfo,
    String groupID){};

// Update the group invite mode
try{
    var result = await ZIM.getInstance()!.updateGroupInviteMode(ZIMGroupInviteMode.any, 'groupID');
} on PlatformException catch(onError){
    onError.code;
    onError.message;
}
1
Copied!

Update beInviteMode

After logging in to the ZIM SDK, the group owner or administrator calls the updateGroupBeInviteMode method to update beInviteMode.

After the mode is updated, all group members receive the onGroupVerifyInfoUpdated callback.

Untitled
// Listen to the onGroupVerifyInfoUpdated event
ZIMEventHandler.onGroupVerifyInfoUpdated = (ZIM zim,
    ZIMGroupVerifyInfo verifyInfo,
    ZIMGroupOperatedInfo operatedInfo,
    String groupID){};

// Update the mode for verifying the target user when being invited to a group
try{
    var result = await ZIM.getInstance()!.updateGroupBeInviteMode(ZIMGroupBeInviteMode.auth, 'groupID');
} on PlatformException catch(onError){
    onError.code;
    onError.message;
}
1
Copied!

Query the list of group joining applications

After logging in to the ZIM SDK, a user calls the queryGroupApplicationList method to query the list of group joining applications. The query result contains applications sent to the user.from and to the user.

Untitled
try{
    ZIMGroupApplicationListQueryConfig queryConfig = ZIMGroupApplicationListQueryConfig();
    queryConfig.count = 100;
    queryConfig.nextFlag = 0;
    var result = await ZIM.getInstance()!.queryGroupApplicationList(queryConfig);
} on PlatformException catch(onError){
    onError.code;
    onError.message;
}
1
Copied!

Previous

Manage room user attributes

Next

Manage group info