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.
- 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.
- To specify the maximum number of group members and the group joining mode (including the approval mode, invitation mode, and whether the invitation needs to be approved by the invitee), integrate ZIM SDK 2.15.0 or later.
// Create a group.
// The groupID parameter can contain up to 32 bytes in length, including digits, letters, and the following characters: '!', '#', '$', '%', '&', '(', ')', '+', '-', ':', ';', '<', '=', '.', '>', '?', '@', '[', ']', '^', '_', '{', '}', '|', '~'. It cannot start with a pound sign (#).
// The groupName parameter can contain up to 50 bytes in length, with no limit on characters.
ZIMGroupInfo groupInfo = new ZIMGroupInfo();
groupInfo.groupID = "group_id";
groupInfo.groupName = "groupName";
groupInfo.groupAvatarUrl = "groupAvatarUrl";
ZIMGroupAdvancedConfig config = new ZIMGroupAdvancedConfig();
HashMap<String, String> attributes = new HashMap<>();
attributes.put("key_0", "value_0");
attributes.put("key_1", "value_1");
attributes.put("key_2", "value_2");
config.groupAttributes = attributes;
// // The mode where a user sends a group joining application.
config.joinMode = ZIMGroupJoinMode.ANY;
// The mode where a group member invites a user to a group.
config.inviteMode = ZIMGroupInviteMode.ANY;
// The mode where a user is invited to a group.
config.beInviteMode = ZIMGroupBeInviteMode.NONE;
// The maximum number of members in the group.
config.maxMemberCount = 300;
ArrayList<String> userList = new ArrayList<>();
userList.add("user_1");
userList.add("user_2");
zim.createGroup(groupInfo, userList, config, new ZIMGroupCreatedCallback() {
@Override
public void onGroupCreated(ZIMGroupFullInfo groupInfo, ArrayList<ZIMGroupMemberInfo> userIDs, ArrayList<ZIMErrorUserInfo> errorUserList, ZIMError errorInfo) {
// Get the result of creating a group through errorInfo.code
}
});
1
// 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
// Create a group.
// The groupID parameter can contain up to 32 bytes in length, including digits, letters, and the following characters: '!', '#', '$', '%', '&', '(', ')', '+', '-', ':', ';', '<', '=', '.', '>', '?', '@', '[', ']', '^', '_', '{', '}', '|', '~'. It cannot start with a pound sign (#).
// The groupName parameter can contain up to 50 bytes in length, with no limit on characters.
zim::ZIMGroupInfo group_info;
group_info.groupID = "group_id";
group_info.groupName = "groupName";
group_info.groupAvatarUrl = "groupAvatarUrl";
zim::ZIMGroupAdvancedConfig config;
config.groupAttributes.emplace("key_0", "value_0");
config.groupAttributes.emplace("key_1", "value_1");
config.groupAttributes.emplace("key_2", "value_2");
/**
* Group entry verification mode, only supports ZIM SDK version 2.15.0 and above
* ZIM_GROUP_JOIN_MODE_ANY: 0, default value, anyone can join the group directly.
* ZIM_GROUP_JOIN_MODE_AUTH: 1, group owner or administrator approval is required to join the group.
* ZIM_GROUP_JOIN_MODE_FORBID: 2, prohibit other users from joining the group.
*/
config.joinMode = zim::ZIMGroupJoinMode::ZIM_GROUP_JOIN_MODE_AUTH;
/**
* Invite mode, only supports ZIM SDK version 2.15.0 and above
* ZIM_GROUP_INVITE_MODE_ANY: 0, default value, any group member can invite external members to join the group.
* ZIM_GROUP_INVITE_MODE_ADMIN: 1, only group owners or administrators can invite external members to join the group
*/
config.inviteMode = zim::ZIMGroupInviteMode::ZIM_GROUP_INVITE_MODE_ADMIN;
/**
* Invite target user verification mode, only supports ZIM SDK version 2.15.0 and above
* ZIM_GROUP_BEINVITE_MODE_NONE: 0, default value, no need for the invitee's consent, the user automatically becomes a group member.
* ZIM_GROUP_BEINVITE_MODE_AUTH: 1, the invitee becomes a group member after consent.
*/
config.beInviteMode = zim::ZIMGroupBeInviteMode::ZIM_GROUP_BE_INVITE_MODE_AUTH;
/**
* The upper limit of the number of group members, only supports ZIM SDK version 2.15.0 and above
* Value range: [0, the default maximum number of group members for the package].
*/
config.maxMemberCount = 100;
std::vector<std::string> user_list;
user_list.push_back("user_1");
user_list.push_back("user_2");
zim_->createGroup(group_info, user_list, config,
[=](const zim::ZIMGroupFullInfo &groupInfo,
const std::vector<zim::ZIMGroupMemberInfo> &userList,
const std::vector<zim::ZIMErrorUser> &errorUserList,
zim::ZIMError errorInfo {
int error_code = errorInfo.code;
});
1
// The groupID parameter can contain up to 32 bytes in length, including digits, letters, and the following characters: '!', '#', '$', '%', '&', '(', ')', '+', '-', ':', ';', '<', '=', '.', '>', '?', '@', '[', ']', '^', '_', '{', '}', '|', '~'. It cannot start with a pound sign (#).
// The groupName parameter can contain up to 50 bytes in length, with no limit on characters.
var groupInfo = { groupID: '', groupName: '', groupAvatarUrl: '' };
var userIDs = [];
// Set the group joining mode and the upper limit of the group number
var config1 = {
/**
* Group joining verification mode, only supports ZIM SDK version 2.15.0 and above
* 0: (Default) Anyone can join the group directly.
* 1: Group owner or administrator approval is required to join the group.
* 2: Other users are prohibited from joining the group.
*/
joinMode: 1,
/**
* Invite mode, only supports ZIM SDK version 2.15.0 and above
* 0: (Default) Any group member can invite external members to join the group.
* 1: Only group owners or administrators can invite external members to join the group.
*/
inviteMode: 1,
/**
* Invite target user verification mode, only supports ZIM SDK version 2.15.0 and above
* 0: (Default) The user automatically becomes a group member without the consent of the invitee.
* 1: The invitee becomes a group member after consent.
*/
beInviteMode: 1,
/**
* Group member limit, only supports ZIM SDK version 2.15.0 and above
* Value range: [0, the default maximum number of group members for the package].
*/
maxMemberCount: 100 // Limit the total number of group members to 100
};
zim.createGroup(groupInfo, userIDs, config1)
.then(function ({ groupInfo, userList, errorUserList }) {
// Operation successful.
})
.catch(function (err) {
// Operation failed.
});
1
// Create a group.
// The groupID parameter can contain up to 32 bytes in length, including digits, letters, and the following characters: '!', '#', '$', '%', '&', '(', ')', '+', '-', ':', ';', '<', '=', '.', '>', '?', '@', '[', ']', '^', '_', '{', '}', '|', '~'. It cannot start with a pound sign (#).
// The groupName parameter can contain up to 50 bytes in length, with no limit on characters.
ZIMGroupInfo *groupInfo = [[ZIMGroupInfo alloc] init];
groupInfo.groupID = @"groupID";
groupInfo.groupName = @"groupName";
groupInfo.groupAvatarUrl = @"groupAvatarUrl";
ZIMGroupAdvancedConfig *advancedConfig = [[ZIMGroupAdvancedConfig alloc] init];
// The mode where a user sends a group joining application.
advancedConfig.joinMode = ZIMGroupJoinModeAny;
// The mode where a group member invites a user to a group.
advancedConfig.inviteMode = ZIMGroupInviteModeAny;
// The mode where a user is invited to a group.
advancedConfig.beInviteMode = ZIMGroupBeInviteModeNone;
// The maximum number of members in the group.
advancedConfig.maxMemberCount = 300;
[[ZIM getInstance] createGroup:groupInfo userIDs:@[@"userID1",@"userID2"] config:advancedConfig callback:^(ZIMGroupFullInfo * _Nonnull groupInfo, NSArray<ZIMGroupMemberInfo *> * _Nonnull userList, NSArray<ZIMErrorUserInfo *> * _Nonnull errorUserList, ZIMError * _Nonnull errorInfo) {
// The business logic after the group is created.
}];
1
Join a group
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 groupMemberStateChanged and groupStateChanged callbacks.
// Listen for onGroupMemberStateChanged and onGroupStateChanged
zim.setEventHandler(new ZIMEventHandler(){
public void onGroupMemberStateChanged(ZIM zim, ZIMGroupMemberState state, ZIMGroupMemberEvent event, ArrayList<ZIMGroupMemberInfo> userList, ZIMGroupOperatedInfo operatedInfo, String groupID) {
// Callback notification of group member status change.
}
public void onGroupStateChanged(ZIM zim, ZIMGroupState state, ZIMGroupEvent event, ZIMGroupOperatedInfo operatedInfo, ZIMGroupFullInfo groupInfo) {
// Callback notification of group status change.
}
});
1
// 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
void onGroupMemberStateChanged(zim::ZIM *zim, zim::ZIMGroupMemberState state,
zim::ZIMGroupMemberEvent event,
const std::vector<zim::ZIMGroupMemberInfo> &userList,
const zim::ZIMGroupOperatedInfo &operatedInfo,
const std::string &groupID) override {
......
}
void onGroupStateChanged(zim::ZIM *zim, zim::ZIMGroupState state,
zim::ZIMGroupEvent event,
const zim::ZIMGroupOperatedInfo &operatedInfo,
const zim::ZIMGroupFullInfo &groupInfo) override {
......
}
1
// Callback notification of group member status change.
zim.on('groupMemberStateChanged', function (zim, { groupID, state, event, userList, operatedInfo }) {
console.log('groupMemberStateChanged', groupID, state, event, userList, operatedInfo);
});
// Callback notification of group status change.
zim.on('groupStateChanged', function (zim, { state, event, groupInfo, operatedInfo }) {
console.log('groupStateChanged', state, event, groupInfo, operatedInfo);
});
1
- (void)zim:(ZIM *)zim
groupMemberStateChanged:(ZIMGroupMemberState)state
event:(ZIMGroupMemberEvent)event
userList:(NSArray<ZIMGroupMemberInfo *> *)userList
operatedInfo:(ZIMGroupOperatedInfo *)operatedInfo
groupID:(NSString *)groupID{
}
- (void)zim:(ZIM *)zim
groupStateChanged:(ZIMGroupState)state
event:(ZIMGroupEvent)event
operatedInfo:(ZIMGroupOperatedInfo *)operatedInfo
groupInfo:(ZIMGroupFullInfo *)groupInfo{
}
1
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.
// Join the group on another client.
zim.joinGroup("groupID", new ZIMGroupJoinedCallback() {
@Override
public void onGroupJoined(ZIMGroupFullInfo groupInfo, ZIMError errorInfo) {
//Get the result of joining the group through errorInfo.code.
}
});
1
// Other clients join the group directly
ZIM.getInstance()
!.joinGroup('groupID')
.then((value){
// Triggered when successful
})
.catchError((onError) {
// Triggered when failed
});
1
// Join the group on another client.
zim_->joinGroup(group_id,
[=](const zim::ZIMGroupFullInfo &groupInfo, zim::ZIMError errorInfo) {
int error_code = errorInfo.code;
});
1
var groupID = '';
// Join the group on another client.
zim.joinGroup(groupID)
.then(function ({ groupInfo }) {
// Operation successful.
})
.catch(function (err) {
// Operation failed.
});
1
// Join the group on another client.
[zim joinGroup:GroupID callback:^(ZIMGroupFullInfo * _Nonnull groupInfo, ZIMError * _Nonnull errorInfo) {
// The business logic after the joinGroup method is called.
}];
1
- If the
joinMode
is set to 1
(AUTH
):
- The user calls the sendGroupJoinApplicationToGroupID method to send an application.
ZIMGroupJoinApplicationSendConfig config = new ZIMGroupJoinApplicationSendConfig();
config.wording = @"Let me join the group.";
zim.sendGroupJoinApplication("groupID", config, new ZIMGroupJoinApplicationSentCallback() {
@Override
public void onGroupJoinApplicationSent(String groupID, ZIMError errorInfo){
// The callback for sending the group joining application.
}];
1
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
zim::ZIMGroupJoinApplicationSendConfig config;
config.wording = "wording";
zim_->sendGroupJoinApplication(
group_id, config,
[=](const std::string &groupID, const zim::ZIMError &errorInfo) {
int error_code = errorInfo.code;
});
1
// Apply to join the group
var groupID = '';
var config = {
wording: 'XXXX applies to join the group' // Application message
};
zim.sendGroupJoinApplication(groupID, config)
.then(function ({ groupID }) {
// Operation successful.
})
.catch(function (err) {
// Operation failed.
});
1
ZIMGroupJoinApplicationSendConfig *config = [[ZIMGroupJoinApplicationSendConfig alloc] init];
config.wording = @"Let me join the group.";
[zim sendGroupJoinApplicationToGroupID:groupID config:config callback:^(NSString * _Nonnull groupID, ZIMError *errorInfo) {
// The callback for sending the group joining application.
}];
1
- The group owner or administrator receives the application notification by listening for the groupApplicationListChanged event.
// Listen for groupApplicationListChanged event.
zim.setEventHandler(new ZIMEventHandler(){
public void onGroupApplicationListChanged(ZIM zim, ArrayList<ZIMGroupApplicationInfo> applicationList, ZIMGroupApplicationListChangeAction action) {
// Group application list update callback notification.
}
});
1
ZIMEventHandler.onGroupApplicationListChanged = (ZIM zim,
List<ZIMGroupApplicationInfo> applicationList,
ZIMGroupApplicationListChangeAction action){};
1
void onGroupApplicationListChanged(
zim::ZIM * /*zim*/, const std::vector<zim::ZIMGroupApplicationInfo> & /*applicationList*/,
zim::ZIMGroupApplicationListChangeAction /*action*/) override {
......
}
1
// Listen for groupApplicationListChanged event.
zim.on('groupApplicationListChanged', (zim, { action, applicationList }) => {
// Added group application, you can now update the group application list UI.
console.log(action, applicationList);
});
1
// Listen for groupApplicationListChanged event.
- (void)zim:(ZIM *)zim
groupApplicationListChanged:(NSArray<ZIMGroupApplicationInfo *> *)applicationList
action:(ZIMGroupApplicationListChangeAction)action{
}
1
- The group owner or administrator handles the application.
// Approve the application.
ZIMGroupJoinApplicationAcceptConfig config = new ZIMGroupJoinApplicationAcceptConfig();
zim.acceptGroupJoinApplication("userID", "groupID", config, new ZIMGroupJoinApplicationAcceptedCallback(){
public void onGroupJoinApplicationAccepted(String groupID, String userID, ZIMError errorInfo){
// The callback for application approval.
}];
1
// 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
// Approve the application.
zim::ZIMGroupJoinApplicationAcceptConfig config;
zim_->acceptGroupJoinApplication(
user_id, group_id, config,
[=](const std::string &groupID, const std::string &userID,
const zim::ZIMError &errorInfo) {
int error_code = errorInfo.code;
});
1
var userID = '';
var groupID = '';
var config = {};
zim.acceptGroupJoinApplication(userID, groupID, config)
.then(function ({ groupID, userID }) {
// Operation successful.
})
.catch(function (err) {
// Operation failed.
});
1
// Approve the application.
[zim acceptGroupJoinApplicationFromUserID:userID groupID:groupID config:config callback:^(NSString * _Nonnull groupID, NSString * _Nonnull userID, ZIMError * _Nonnull errorInfo) {
// The callback for application approval.
}];
1
// Reject the application.
ZIMGroupJoinApplicationRejectConfig config = new ZIMGroupJoinApplicationRejectConfig();
zim.rejectGroupJoinApplication("userID", "groupID", config, new ZIMGroupJoinApplicationRejectedCallback(){
public void onGroupJoinApplicationRejected(String groupID, String userID, ZIMError errorInfo) { // The callback for application rejection.
}];
1
// 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
// Reject the application.
zim::ZIMGroupJoinApplicationRejectConfig config;
zim_->rejectGroupJoinApplication(
user_id, group_id, config,
[=](const std::string &groupID, const std::string &userID, const zim::ZIMError &errorInfo) {
int error_code = errorInfo.code;
});
1
var userID = '';
var groupID = '';
var config = {};
zim.rejectGroupJoinApplication(userID, groupID, config)
.then(function ({ groupID, userID }) {
// Operation successful.
})
.catch(function (err) {
// Operation failed.
});
1
// Reject the application.
[zim rejectGroupJoinApplicationFromUserID:userID groupID:groupID config:config callback:^(NSString * _Nonnull groupID, NSString * _Nonnull userID, ZIMError * _Nonnull errorInfo) {
// The callback for application rejection.
}];
1
- The user applying to join the group, the group owner or administrator, and the method caller receive the groupApplicationUpdated callback.
// Listen for onGroupApplicationUpdated event.
zim.setEventHandler(new ZIMEventHandler(){
public void onGroupApplicationUpdated(ZIM zim, ArrayList<ZIMGroupApplicationInfo> applicationList){
// Group application information update callback.
}
});
1
// Listen to the onGroupApplicationUpdated event
ZIMEventHandler.onGroupApplicationUpdated = (ZIM zim,
List<ZIMGroupApplicationInfo> applicationList){
};
1
void onGroupApplicationUpdated(
zim::ZIM * /*zim*/,
const std::vector<zim::ZIMGroupApplicationInfo> & /*applicationList*/) override {
......
}
1
// Listen for groupApplicationUpdated event.
zim.on('groupApplicationUpdated', (zim, { applicationList }) => {
// The group application has changed. You can update the group application list UI at this time
console.log(applicationList);
});
1
// Listen for groupApplicationUpdated event.
- (void)zim:(ZIM *)zim groupApplicationUpdated:(NSArray<ZIMGroupApplicationInfo *> *)applicationList{
}
1
Method 2: Invite a user to a group
- A group member can invite a user to the group by calling one of the following methods.
Make sure that the invitee has been registered by calling the loginWithUserID method; otherwise, the operation fails.
// A group member invites a user to the group.
ArrayList<String> userList = new ArrayList<>();
userList.add("user_1");
userList.add("user_2");
zim.inviteUsersIntoGroup(userList, "group_id", new ZIMGroupUsersInvitedCallback() {
@Override
public void onGroupUsersInvited(ArrayList<ZIMGroupMemberInfo> userList, ArrayList<ZIMErrorUserInfo> errorUserList, ZIMError errorInfo) {
// Get the result of adding to the group through errorInfo.code.
}
});
1
Developers can use ZIMGroupUsersInvitedResult to determine whether the user has been successfully added to the group.
// 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
// A group member invites a user to the group.
std::vector<std::string> user_list;
user_list.push_back("user_1");
user_list.push_back("user_2");
zim_->inviteUsersIntoGroup(user_list, group_id, callback);
1
var groupID = '';
// Added to the group by group members.
var userIDs = [];
zim.inviteUsersIntoGroup(userIDs, groupID)
.then(function ({ groupID, userList, errorUserList }) {
// Operation successful.
})
.catch(function (err) {
// Operation failed.
});
1
// A group member invites a user to the group.
[zim inviteUsersIntoGroup:userIDs groupID:groupID callback:^(NSArray<ZIMGroupMemberInfo *> * _Nonnull userList, NSArray<ZIMErrorUserInfo *> * _Nonnull errorUserList, ZIMError * _Nonnull errorInfo) {
// The business logic after the inviteUsersIntoGroup method is called.
}];
1
// Send the group invitation.
ZIMGroupInviteApplicationSendConfig config = new ZIMGroupInviteApplicationSendConfig();
config.wording = @"xxx invited you to join the group.";
List<String> userIDs = new ArrList<String>();
userIDs.add("user1");
userIDs.add("user2");
zim.sendGroupInviteApplications(userIDs, "groupID", config, new ZIMGroupInviteApplicationsSentCallback(){
public void onGroupInviteApplicationsSent(String groupID, ArrayList<ZIMErrorUserInfo> errorUserList, ZIMError errorInfo){
// Initiate group invitation result callback.
}
});
1
// 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
// Send the group invitation.
std::vector<std::string> user_list;
user_list.push_back("user_1");
user_list.push_back("user_2");
zim::ZIMGroupInviteApplicationSendConfig config;
config.wording = "wording";
zim_->sendGroupInviteApplications(
user_list, group_id, config,
[=](const std::string &groupID, const std::vector<zim::ZIMErrorUserInfo> &errorUserList,
const zim::ZIMError &errorInfo) {
int error_code = errorInfo.code;
});
1
// Send an invitation application.
var userIDs = [];
var groupID = '';
var config = {
wording: 'Invite to join the group' // Application message.
};
zim.sendGroupInviteApplications(userIDs, groupID, config)
.then(function ({ groupID, errorUserList }) {
// The operation is successful, and the users who failed to invite are obtained through errorUserList.
})
.catch(function (err) {
// Operation failed.
});
1
// Send the group invitation.
ZIMGroupInviteApplicationSendConfig *config = [[ZIMGroupInviteApplicationSendConfig alloc] init];
config.wording = @"xxx invited you to join the group.";
[zim sendGroupInviteApplicationsToUserIDs:@[@"userID1",@"userID2"] groupID:@"groupID" config:config callback:^(NSString * _Nonnull groupID, NSArray<ZIMErrorUserInfo *> * _Nonnull errorUserList, ZIMError * _Nonnull errorInfo) {
}];
1
The following table describes the operation results of different methods called by different roles in a group in inviteMode and beInviteMode modes.
beInviteMode | inviteMode | Method | Caller | Result |
---|
0: None | 0: Any | inviteUsersIntoGroup | All group members | The invitee joins the group without approval. |
sendGroupInviteApplicationsToUserIDs | The invitee joins the group without approval, with no application generated. |
1: Admin | inviteUsersIntoGroup | Ordinary members | Failed. |
Group owner or administrator | The invitee joins the group without approval. |
sendGroupInviteApplicationsToUserIDs | Ordinary members | Failed. |
Group owner or administrator | The invitee joins the group without approval, with no application generated. |
1: Auth | 0: Any | inviteUsersIntoGroup | All group members | An application is generated and sent to the invitee for approval. |
sendGroupInviteApplicationsToUserIDs | An 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: Admin | inviteUsersIntoGroup | Ordinary members | Failed. |
Group owner or administrator | An application is generated and sent to the invitee for approval. |
sendGrsendGroupInviteApplicationsToUserIDsoupInviteApplications | Ordinary members | Failed. |
Group owner or administrator | An application is generated and sent to the invitee for approval. If the caller is the group owner or administrator, the groupApplicationListChanged callback is generated. |
- If the
beInviteMode
is set to 1
(AUTH
), the invitee and inviter (the group owner or administrator) receive the notification in the groupApplicationListChanged callback. The invitee can perform the following operations on the application:
// Agree to join the group invitation.
ZIMGroupInviteApplicationAcceptConfig config = new ZIMGroupInviteApplicationAcceptConfig();
zim.acceptGroupInviteApplication("inviterUserID", "groupID", config, new ZIMGroupInviteApplicationAcceptedCallback(){
public void onGroupInviteApplicationAccepted(ZIMGroupFullInfo groupInfo, String inviterUserID, ZIMError errorInfo){
// Callback for agree group invitation result.
}
});
1
try{
ZIMGroupInviteApplicationAcceptConfig acceptConfig = ZIMGroupInviteApplicationAcceptConfig();
var result = await ZIM.getInstance()!.acceptGroupInviteApplication('inviterUserID', 'groupID', acceptConfig);
} on PlatformException catch(onError){
onError.code;
onError.message;
}
1
// Agree to join the group invitation.
zim::ZIMGroupInviteApplicationAcceptConfig config;
zim_->acceptGroupInviteApplication(
user_id, group_id, config,
[=](const zim::ZIMGroupFullInfo &group, const std::string &inviterUserID,
const zim::ZIMError &errorInfo) {
int error_code = errorInfo.code;
});
1
var inviterUserID = '';
var groupID = '';
// Agree to join the group invitation.
var config = {};
zim.acceptGroupInviteApplication(inviterUserID, groupID, config)
.then(function ({ groupInfo, inviterUserID }) {
// Operation successful.
})
.catch(function (err) {
// Operation failed.
});
1
[zim acceptGroupInviteApplicationFromInviterUserID:inviterUserID groupID:groupID config:config callback:^(ZIMGroupFullInfo * _Nonnull groupInfo, NSString * _Nonnull inviterUserID, ZIMError * _Nonnull errorInfo) {
}];
1
// Refuse to join the group invitation.
ZIMGroupInviteApplicationRejectConfig config = new ZIMGroupInviteApplicationRejectConfig();
zim.rejectGroupInviteApplication("inviterUserID", "groupID", config, new ZIMGroupInviteApplicationRejectedCallback(){
public void onGroupInviteApplicationRejected(String groupID, String inviterUserID, ZIMError errorInfo) {
// Reject group invitation result callback.
}
});
1
try{
ZIMGroupInviteApplicationRejectConfig rejectConfig = ZIMGroupInviteApplicationRejectConfig();
var reuslt = await ZIM.getInstance()!.rejectGroupInviteApplication('inviterUserID', 'groupID', rejectConfig);
} on PlatformException catch(onError){
onError.code;
onError.message;
}
1
Refuse to join the group invitation.
zim::ZIMGroupInviteApplicationRejectConfig config;
zim_->rejectGroupInviteApplication(
user_id, group_id, config,
[=](const std::string &groupID, const std::string &inviterUserID,
const zim::ZIMError &errorInfo) {
int error_code = errorInfo.code;
});
1
var inviterUserID = '';
var groupID = '';
// Refuse to join the group invitation.
var config = {};
zim.rejectGroupInviteApplication(inviterUserID, groupID, config)
.then(function ({ groupID, inviterUserID }) {
// Operation successful.
})
.catch(function (err) {
// Operation failed.
});
1
[zim rejectGroupInviteApplicationFromInviterUserID:inviterUserID groupID:groupID config:config callback:^(NSString * _Nonnull groupID, NSString * _Nonnull inviterUserID, ZIMError * _Nonnull errorInfo) {
}];
1
- If the
beInviteMode
is set to 1
(AUTH
), the invitee and inviter (the group owner or administrator) receive the approval notification in the groupApplicationUpdated callback.
zim.setEventHandler(new ZIMEventHandler(){
public void onGroupApplicationUpdated(ZIM zim,
ArrayList<ZIMGroupApplicationInfo> applicationList) {
// Group application update callback notification. }
});
1
ZIMEventHandler.onGroupApplicationUpdated = (ZIM zim,
List<ZIMGroupApplicationInfo> applicationList){
};
1
// Listen for onGroupApplicationUpdated
void onGroupApplicationUpdated(
zim::ZIM * /*zim*/,
const std::vector<zim::ZIMGroupApplicationInfo> & /*applicationList*/) override {
......
}
1
// Listen for groupApplicationUpdated event.
zim.on('groupApplicationUpdated', (zim, { applicationList }) => {
// If there is a change in the group application, you can update the group application list UI at this time.
console.log(applicationList);
});
1
- (void)zim:(ZIM *)zim groupApplicationUpdated:(NSArray<ZIMGroupApplicationInfo *> *)applicationList{
}
1
Leave a group
A group member can leave a group or be removed from a group.
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 groupMemberStateChanged callback.
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.
// Leave a group.
zim.leaveGroup("groupID", new ZIMGroupLeftCallback() {
@Override
public void onGroupLeft(ZIMError errorInfo) {
// Get the result of actively exiting the group through errorInfo.code.
}
});
1
Developers can use ZIMGroupLeftResult to determine whether the member successfully left the group.
// Voluntarily leave a group
ZIM.getInstance()
!.leaveGroup('groupID')
.then((value){
// Triggered on success
})
.catchError((onError) {
// Triggered on failure
});
1
// Leave a group.
zim_->leaveGroup(group_id, [=](const std::string &groupID, zim::ZIMError errorInfo){
int error_code = errorInfo.code;
});
1
var groupID = '';
// Leave a group.
zim.leaveGroup(groupID)
.then(function ({ groupID }) {
// Operation successful.
})
.catch(function (err) {
// Operation failed.
});
1
// Leave a group.
[zim leaveGroup:groupID callback:^(ZIMError * _Nonnull errorInfo) {
// The business logic after the leaveGroup method is called.
}];
1
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 groupMemberStateChanged callback.
Developers can use ZIMGroupMemberKickedResult to determine whether the user has been successfully removed.
- 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.
// The group owner removes one or more group members from the group.
ArrayList<String> user_list = new ArrayList<>();
user_list.add("user_1");
user_list.add("user_2");
zim.kickGroupMembers(user_list, "groupID", new ZIMGroupMemberKickedCallback() {
@Override
public void onGroupMemberKicked(ArrayList<String> kickedUserIDList, ArrayList<ZIMErrorUserInfo> errorUserList, ZIMError errorInfo) {
// Get the result of actively exiting the group through errorInfo.code.
}
});
1
// 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
// The group owner removes one or more group members from the group.
std::vector<std::string> user_list;
user_list.push_back("user_1");
user_list.push_back("user_2");
zim_->kickGroupMembers(user_list, group_id,
[=](const std::string &groupID, const std::vector<std::string> &kickedMemberIDs,
const std::vector<ZIMErrorUser> &errorUserList, zim::ZIMError errorInfo) {
int error_code = errorInfo.code;
});
1
var groupID = '';
// The group owner removes one or more group members from the group.
var userIDs = [];
zim.kickGroupMembers(userIDs, groupID)
.then(function ({ groupID, kickedUserIDs, errorUserList }) {
// Operation successful.
})
.catch(function (err) {
// Operation failed.
});
1
// The group owner removes one or more group members from the group.
[zim kickGroupMembers:userIDs groupID:groupID callback:^(NSArray<NSString *> * _Nonnull kickedUserIDList, NSArray<ZIMErrorUserInfo *> * _Nonnull errorUserList, ZIMError * _Nonnull errorInfo) {
// The business logic after the group owner calls the kickGroupMembers method.
}];
1
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 groupStateChanged callback.
Developers can use ZIMGroupDismissedResult to determine whether the group has been successfully dissolved.
- 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.
// The group owner disbands the group.
zim.dismissGroup("groupID", new ZIMGroupDismissedCallback() {
@Override
public void onGroupDismissed(ZIMError errorInfo) {
// Get the result of actively exiting the group through errorInfo.code.
}
});
1
// Dismiss group by group owner
ZIM.getInstance()
.dismissGroup('groupID')
.then((value){
// Triggered when successful
})
.catchError((onError) {
// Triggered when failed
});
1
// The group owner disbands the group.
zim_->dismissGroup(group_id, [=](const std::string &groupID, zim::ZIMError errorInfo) {
int error_code = errorInfo.code;
});
1
var groupID = '';
zim.dismissGroup(groupID)
.then(function ({ groupID }) {
// Operation successful.
})
.catch(function (err) {
// Operation failed.
});
// Register a callback to monitor "group status change".
zim.on('groupStateChanged', function (zim, { state, event, groupInfo, operatedInfo }) {
console.log('groupStateChanged', state, event, groupInfo, operatedInfo);
});
1
// The group owner disbands the group.
[zim dismissGroup:groupID callback:^(ZIMError * _Nonnull errorInfo) {
// The business logic after the dismissGroup method is called.
}];
1
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.
// The user queries the list of joined groups.
zim.queryGroupList(new ZIMGroupListQueriedCallback() {
@Override
public void onGroupListQueried(ArrayList<ZIMGroupInfo> groupList, ZIMError errorInfo) {
// Get the result of actively exiting the group through errorInfo.code.
}
});
1
Developers can get the query result through ZIMGroupListQueriedResult.
// User queries the groups they have joined
ZIM.getInstance()
.queryGroupList()
.then((value){
// Triggered when successful
})
.catchError((onError) {
// Triggered when failed
});
1
// The user queries the list of joined groups.
zim_->queryGroupList(
[=](const std::vector<ZIMGroupInfo> &groupList, zim::ZIMError errorInfo){
int error_code = errorInfo.code;
});
1
zim.queryGroupList()
.then(function ({ groupList }) {
// Operation successful.
})
.catch(function (err) {
// Operation failed.
});
1
// The user queries the list of joined groups.
[zim queryGroupListByGroupID:^(NSArray<ZIMGroupInfo *> * _Nonnull groupList, ZIMError * _Nonnull errorInfo) {
// The business logic after the queryGroupListByGroupID method is called.
}];
1
Search for joined groups
After logging in to the ZIM SDK, a user calls the searchLocalGroupsWithConfig method and passes in the config
and callback
parameters to search for joined groups by condition.
The search result is returned in the ZIMGroupsSearchedCallback callback.
// Search for joined groups that contain a member named "zego".
ZIM zim = getZIM();
ZIMGroupMemberSearchConfig config = new ZIMGroupMemberSearchConfig();
config.count = 10;
config.nextFlag = 0;
config.isAlsoMatchGroupMemberNickname = true; // If the nickname of a group member contains "zego", the group is returned in the search result.
config.isAlsoMatchGroupMemberUserName = true; // If the username of a group member contains "zego", the group is returned in the search result.
config.keywords.add("zego");
zim.searchLocalGroups(config, new ZIMGroupsSearchedCallback() {
@Override
public void onGroupsSearched(ArrayList<ZIMGroupSearchInfo> groupSearchInfoList, int nextFlag, ZIMError errorInfo) {
// You can obtain the group information in the groupSearchInfoList field.
}
});
1
// 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
// Search for joined groups that contain a member named "zego".
auto searchConfig = zim::ZIMGroupSearchConfig();
searchConfig.count = 10;
searchConfig.nextFlag = 0;
// If the nickname of a group member contains "zego", the group is returned in the search result.
searchConfig.isAlsoMatchGroupMemberNickname = true;
// If the username of a group member contains "zego", the group is returned in the search result.
searchConfig.isAlsoMatchGroupMemberUserName = true;
searchConfig.keywords.emplace_back("zego");
zim_->searchLocalGroups(searchConfig,
[=](const std::vector<zim::ZIMGroupSearchInfo> &groupSearchInfoList,
unsigned int nextFlag, const zim::ZIMError &errorInfo) {
// You can obtain the group information in the groupSearchInfoList field.
});
1
// Search for joined groups with names containing "zego".
var config = {
count: 10, // Number of search results.
nextFlag: 0,
keywords: ['zego'], // et the keyword to "zego", up to 5 keywords are supported. When multiple keywords are set, the search results will only display local messages that contain all keywords at the same time.
isAlsoMatchGroupMemberUserName: true, // // Search for joined groups with names containing "zego".
var config = {
count: 10, // Number of search results
nextFlag: 0,
keywords: ['zego'], // Set the keyword to "zego", up to 5 keywords are supported. When multiple keywords are set, the search results will only display local messages that contain all keywords at the same time
isAlsoMatchGroupMemberUserName: true, // If the group member user name contains "zego", the search results will include the group member
isAlsoMatchGroupMemberNickname: false,
};
zim.searchLocalGroups(config)
.then(function ({ groupSearchInfoList, nextFlag }) {
// Operation successful.
})
.catch(function (err) {
// Operation failed.
});
1
// Search for joined groups that contain a member named "zego".
ZIMGroupSearchConfig *config = [[ZIMGroupSearchConfig alloc] init];
config.count = 10;
config.nextFlag = 0;
config.isAlsoMatchGroupMemberNickname = true; // If the nickname of a group member contains "zego", the group is returned in the search result.
config.isAlsoMatchGroupMemberUserName = true; // If the username of a group member contains "zego", the group is returned in the search result.
config.keywords = @[@"zego"];
[[ZIM getInstance] searchLocalGroupsWithConfig:config callback:^(NSArray<ZIMGroupSearchInfo *> * _Nonnull groupSearchInfoList, unsigned int nextFlag, ZIMError * _Nonnull errorInfo) {
if(errorInfo.code == ZIMErrorCodeSuccess){
// You can obtain the group information in the groupSearchInfoList field.
}else{
// Handle the error based on the error code table.
}
}];
1
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 ZIMGroupMutedCallback callback.
// Configure group muting.
ZIMGroupMuteConfig config = new ZIMGroupMuteConfig();
// Group members of specified roles are muted.
config.mode = ZIMGroupMuteMode.Custom;
// These members are muted for 30 seconds.
config.duration = 30;
// Group members whose `role` value is `3` or `5` are muted.
config.roles.add(3);
config.roles.add(5);
// Enable muting
boolean isMute = true;
zim.muteGroup(isMute, "group_id", config, new ZIMGroupMutedCallback() {
@Override
public void onGroupMuted(String groupID, boolean isMute, ZIMGroupMuteInfo info, ZIMError errorInfo) {
}
});
1
// 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
// Configure group muting.
zim::ZIMGroupMuteConfig config;
// Group members of specified roles are muted.
config.mode = zim::ZIMGroupMuteMode::ZIM_GROUP_MUTE_MODE_CUSTOM;
// These members are muted for 30 seconds.
config.duration = 30;
// Group members whose `role` value is `2` or `3` are muted.
config.roles.push_back(2);
config.roles.push_back(3);
// Enable muting
bool is_mute = true;
zim_->muteGroup(is_mute, group_id, config,
[=](const std::string &groupID, bool is_muted,
const zim::ZIMGroupMuteInfo &info,
const zim::ZIMError &errorInfo) {
// Developers can get group muting information from info
});
1
// Configure group muting.
const config = {
mode: 3, //Group members of specified roles are muted.
duration: 30, //hese members are muted for 30 seconds.
roles:[3,5],//Group members whose `role` value is `3` or `5` are muted.
};
// Enable mutingvar isMute = true;
var groupID = 'group';
zim.muteGroup(isMute, groupID, config)
.then(function ({ groupID, isMute, mutedInfo }) {
// Operation successful.
})
.catch(function (err) {
// Operation failed.
});
1
// Configure group muting.
ZIMGroupMuteConfig *muteConfig = [[ZIMGroupMuteConfig alloc] init];
// Group members of specified roles are muted.
muteConfig.mode = ZIMGroupMuteModeCustom;
// These members are muted for 30 seconds.
muteConfig.duration = 30;
// Group members whose `role` value is `3` or `5` are muted.
muteConfig.roles = @[@3,@5];
[[ZIM getInstance] muteGroup:YES groupID:@"groupID" config:muteConfig callback:^(NSString * _Nonnull groupID, BOOL isMute, ZIMGroupMuteInfo * _Nonnull info, ZIMError * _Nonnull errorInfo) {
// You can obtain the group muting information in the `info` field.
}];
1
After a group is muted or unmuted, all group members receive the groupMutedInfoUpdated callback and know which roles are muted or unmuted.
zim.setEventHandler(new ZIMEventHandler(){
public void onGroupMutedInfoUpdated(ZIM zim, ZIMGroupMuteInfo muteInfo,
ZIMGroupOperatedInfo operatedInfo, String groupID) {
// Listen for the group muting status change and handle the change by inheriting the ZIMEventHandler method.
}
});
1
ZIMEventHandler.onGroupMutedInfoUpdated = (ZIM zim, ZIMGroupMuteInfo groupMuteInfo, ZIMGroupOperatedInfo operatedInfo, String groupID){
// Listen to the information of group mute status changes here and handle accordingly
};
1
void zim_event_handler::onGroupMutedInfoUpdated(zim::ZIM *, const zim::ZIMGroupMuteInfo &info,
const zim::ZIMGroupOperatedInfo &operatedInfo,
const std::string &groupID) {
// Listen for the group muting status change and handle the change by inheriting the ZIMEventHandler method.
}
});
1
zim.on('groupMutedInfoUpdated', function (zim, { groupID, mutedInfo, operatedInfo}) {
console.log('groupMutedInfoUpdated', groupID, mutedInfo, event, userList, operatedInfo);
});
1
- (void)zim:(ZIM *)zim
groupMutedInfoUpdated:(ZIMGroupMuteInfo *)muteInfo
operatedInfo:(ZIMGroupOperatedInfo *)operatedInfo
groupID:(NSString *)groupID{
// Listen for the group muting status change and handle the change by inheriting the ZIMEventHandler method.
}
1
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 groupVerifyInfoUpdated callback.
// Listen for onGroupVerifyInfoUpdated event.
zim.setEventHandler(new ZIMEventHandler(){
public void onGroupVerifyInfoUpdated(ZIM zim, ZIMGroupVerifyInfo verifyInfo,
ZIMGroupOperatedInfo operatedInfo, String groupID) {
// Update joinMode of a group.
}
});
// Update the verification mode for others to join the group
zim.updateGroupJoinMode(ZIMGroupJoinMode.AUTH, "groupID", new ZIMGroupJoinModeUpdatedCallback(){
public void onGroupJoinModeUpdated(String groupID, ZIMGroupJoinMode mode, ZIMError errorInfo){
// Update verification mode result callback notification
}
});
1
// 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
// Update the verification mode for inviting others to join the group
zim_->updateGroupJoinMode(
zim::ZIMGroupJoinMode::ZIM_GROUP_JOIN_MODE_AUTH, group_id,
[=](const std::string &groupID, zim::ZIMGroupJoinMode mode,
const zim::ZIMError &errorInfo) {
// Business code
});
1
// Listen for groupVerifyInfoUpdated event.
zim.on('groupVerifyInfoUpdated', (zim, { groupID, verifyInfo, operatedInfo }) => {
console.log(groupID, verifyInfo.joinMode);
});
var groupID = '';
// Update the verification mode for others to join the group
var joinMode = 1;
zim.updateGroupJoinMode(joinMode, groupID)
.then(function ({ groupID, mode }) {
// Operation successful.
})
.catch(function (err) {
// Operation failed.
});
1
// Listen for groupVerifyInfoUpdated event.
- (void)zim:(ZIM *)zim
groupVerifyInfoUpdated:(ZIMGroupVerifyInfo *)verifyInfo
operatedInfo:(ZIMGroupOperatedInfo *)operatedInfo
groupID:(NSString *)groupID{
}
// Update joinMode of a group.
[zim updateGroupJoinMode:ZIMGroupJoinModeAuth groupID:@"groupID" callback:^(NSString * _Nonnull groupID, ZIMGroupJoinMode mode, ZIMError * _Nonnull errorInfo) {
}];
1
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 groupVerifyInfoUpdated callback.
// Listen for onGroupVerifyInfoUpdated event.
zim.setEventHandler(new ZIMEventHandler(){
public void onGroupVerifyInfoUpdated(ZIM zim, ZIMGroupVerifyInfo verifyInfo,
ZIMGroupOperatedInfo operatedInfo, String groupID) {
// Invite mode update callback notification.
}
});
// Updated verification mode for inviting others to join the group.
zim.setEventHandler(new ZIMEventHandler(){
public void onGroupVerifyInfoUpdated(ZIM zim, ZIMGroupVerifyInfo verifyInfo,
ZIMGroupOperatedInfo operatedInfo, String groupID) {
// Update inviteMode of the group.
}
});
1
// 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
// Listen for onGroupVerifyInfoUpdated event.
void onGroupVerifyInfoUpdated(zim::ZIM * /*zim*/,
const zim::ZIMGroupVerifyInfo & /*verifyInfo*/,
const zim::ZIMGroupOperatedInfo & /*operatedInfo*/,
const std::string & /*groupID*/) override {
......
}
// Updated verification mode for inviting others to join the group.
zim_->updateGroupInviteMode(
zim::ZIMGroupInviteMode::ZIM_GROUP_INVITE_MODE_ADMIN, group_id,
[=](const std::string &groupID, zim::ZIMGroupInviteMode mode,
const zim::ZIMError &errorInfo) {
// 业务代码
});
1
// Listen for groupVerifyInfoUpdated event.
zim.on('groupVerifyInfoUpdated', (zim, { groupID, verifyInfo, operatedInfo }) => {
console.log(groupID, verifyInfo.inviteMode);
});
var groupID = '';
// Updated verification mode for inviting others to join the group.
var inviteMode = 1;
zim.updateGroupInviteMode(inviteMode, groupID)
.then(function ({ groupID, mode }) {
// Operation successful.
})
.catch(function (err) {
// Operation failed.
});
1
// Listen for onGroupVerifyInfoUpdated event.
- (void)zim:(ZIM *)zim
groupVerifyInfoUpdated:(ZIMGroupVerifyInfo *)verifyInfo
operatedInfo:(ZIMGroupOperatedInfo *)operatedInfo
groupID:(NSString *)groupID{
}
// Update inviteMode of the group.
[zim updateGroupInviteMode:ZIMGroupInviteModeNone groupID:@"groupID" callback:^(NSString * _Nonnull groupID, ZIMGroupInviteMode mode, ZIMError * _Nonnull errorInfo) {
}];
1
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 groupVerifyInfoUpdated callback.
// Listen for onGroupVerifyInfoUpdated event.
zim.setEventHandler(new ZIMEventHandler(){
public void onGroupVerifyInfoUpdated(ZIM zim, ZIMGroupVerifyInfo verifyInfo,
ZIMGroupOperatedInfo operatedInfo, String groupID) {
// Invite mode update callback notification.
}
});
// Update beInviteMode.
zim.updateGroupInviteMode(ZIMGroupInviteMode.ADMIN, "groupID", new ZIMGroupInviteModeUpdatedCallback(){
public void onGroupInviteModeUpdated(String groupID, ZIMGroupInviteMode mode, ZIMError errorInfo){
// Update the callback notification of the verification mode result of inviting others to join the group.
}
});
1
// 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
// Listen for onGroupVerifyInfoUpdated event.
void onGroupVerifyInfoUpdated(zim::ZIM * /*zim*/,
const zim::ZIMGroupVerifyInfo & /*verifyInfo*/,
const zim::ZIMGroupOperatedInfo & /*operatedInfo*/,
const std::string & /*groupID*/) override {
......
}
// Update beInviteMode.
zim_->updateGroupBeInviteMode(
zim::ZIMGroupBeInviteMode::ZIM_GROUP_BE_INVITE_MODE_AUTH, group_id,
[=](const std::string &groupID, zim::ZIMGroupBeInviteMode mode,
const zim::ZIMError &errorInfo) {
// Business code
});
1
// Listen for groupVerifyInfoUpdated event.
zim.on('groupVerifyInfoUpdated', (zim, { groupID, verifyInfo, operatedInfo }) => {
console.log(groupID, verifyInfo.beInviteMode);
});
var groupID = '';
// Update beInviteMode.
var beInviteMode = 1;
zim.updateGroupBeInviteMode(beInviteMode, groupID)
.then(function ({ groupID, mode }) {
// Operation successful.
})
.catch(function (err) {
// Operation failed.
});
1
// Listen for onGroupVerifyInfoUpdated event.
- (void)zim:(ZIM *)zim
groupVerifyInfoUpdated:(ZIMGroupVerifyInfo *)verifyInfo
operatedInfo:(ZIMGroupOperatedInfo *)operatedInfo
groupID:(NSString *)groupID{
}
// Update beInviteMode.
[zim updateGroupBeInviteMode:ZIMGroupBeInviteModeAuth groupID:@"groupID" callback:^(NSString * _Nonnull groupID, ZIMGroupBeInviteMode mode, ZIMError * _Nonnull errorInfo) {
}];
1
Query the list of group joining applications
After logging in to the ZIM SDK, a user calls the queryGroupApplicationListWithConfig method to query the list of group joining applications. The query result contains applications sent to the user.from and to the user.
ZIMGroupApplicationListQueryConfig config = new ZIMGroupApplicationListQueryConfig();
config.count = 10;
// Fill in 0 for the first query.
conifg.nextFlag = 0;
zim.queryGroupApplicationList(config, new ZIMGroupApplicationListQueriedCallback() {
public void onGroupApplicationListQueried(ArrayList<ZIMGroupApplicationInfo> applicationList, int nextFlag, ZIMError errorInfo) {
// Query group application list result callback.
}
})
1
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
zim::ZIMGroupApplicationListQueryConfig config;
config.count = 100;
config.nextFlag = 0;
zim_->queryGroupApplicationList(
config, [=](const std::vector<zim::ZIMGroupApplicationInfo> &applicationList,
unsigned long long nextFlag, const zim::ZIMError &errorInfo) {
// Business code
});
1
// Query the group application list.
var config = {
count: 30, // Single query number.
nextFlag: 0 // Anchor point, fill in 0 for the first query, and use the nextFlag returned by the current query as the anchor point for the next query.
};
zim.queryGroupApplicationList(config)
.then(function ({ nextFlag, applicationList }) {
// Operation successful, use nextFlag as the anchor point for the next query.
})
.catch(function (err) {
// Operation failed.
});
1
ZIMGroupApplicationListQueryConfig *config = [[ZIMGroupApplicationListQueryConfig alloc] init];
config.count = 20;
[zim queryGroupApplicationListWithConfig:config callback:^(NSArray<ZIMGroupApplicationInfo *> * _Nonnull applicationList, unsigned int nextFlag, ZIMError * _Nonnull errorInfo) {
}];
1