目录

创建和管理群组

更新时间:2022-07-13

群组是支持多人沟通的即时通讯系统,本文介绍如何使用环信即时通讯 IM SDK 在实时互动 app 中创建和管理群组,并实现群组相关功能。

如需查看消息相关内容,参见 消息管理

技术原理

环信即时通讯 IM iOS SDK 提供 IEMGroupManager 类和 EMGroup 类用于管理群组,支持你通过调用 API 在项目中实现如下功能:

前提条件

开始前,请确保满足以下条件:

实现方法

本节介绍如何使用环信即时通讯 IM SDK 提供的 API 实现上述功能。

创建群组

在创建群组前,你需要设置群组类型(EMGroupStyle)和进群邀请是否需要对方同意 (IsInviteNeedConfirm)。

1、私有群不可被搜索到,公开群可以通过 ID 搜索到。目前支持四种群组类型(EMGroupStyle),具体设置如下:

2、进群邀请是否需要对方同意 (IsInviteNeedConfirm) 的具体设置如下:

流程如下:

img

用户可以调用 createGroup 方法创建群组,并通过 EMGroupOptions 参数设置群组名称、群组描述、群组成员和建群原因。

用户加入群组后,将可以收到群消息。

示例代码如下:

EMGroupOptions *options = [[EMGroupOptions alloc] init];
options.maxUsersCount = self.maxMemNum;
options.IsInviteNeedConfirm = YES;
options.style = EMGroupStylePrivateMemberCanInvite;
NSArray *members = @{@"memeber1",@"member2"};
[[EMClient sharedClient].groupManager createGroupWithSubject:@"subject"
                         description:@"description"
                         invitees:members
                         message:@"message"
                         setting:options
                         error:nil];

注:如果 options.IsInviteNeedConfirm 设置为 false,即直接加被邀请人进群。在此情况下,被邀请人设置非自动进群是不起作用的。

用户申请入群

根据 创建群组 时的群组类型 (EMGroupStyle) 设置,加入群组的处理逻辑差别如下:

注意

用户只能申请加入公开群组,私有群组不支持用户申请入群。

用户申请加入群组步骤如下:

  1. 调用 getPublicGroupsFromServer 方法从服务器获取公开群列表,查询到想要加入的群组 ID。
  2. 调用 joinPublicGroup 方法传入群组 ID,申请加入对应群组。

示例代码如下:

// 从服务器获取公开群组列表
NSMutableArray *memberList = [[NSMutableArray alloc]init];
NSInteger pageSize = 50;
NSString *cursor = nil;
EMCursorResult *result = [[EMCursorResult alloc]init];
do {
  result = [[EMClient sharedClient].groupManager
                         getPublicGroupsFromServerWithCursor:cursor
                         pageSize:50
                         error:nil];
  [memberList addObjectsFromArray:result.list];
  cursor = result.cursor;
} while (result && result.list < pageSize);

// 申请加入群组
[[EMClient sharedClient].groupManager joinPublicGroup:@"groupID" error:nil];

解散群组

注意

该操作只能群主才能进行。该操作是危险操作,解散群组后,将删除本地数据库及内存中的群相关信息及群会话。

示例代码如下:

//群组解散后,群成员将会收到 `EMGroupManagerDelegate#didLeaveGroup` 回调。
[[EMClient sharedClient].groupManager destroyGroup:@"groupID"];

退出群组

群成员可以调用 leaveGroup 方法退出群组,其他成员将会收到群组事件回调 EMGroupManagerDelegate#didLeaveGroup

退出群组后,该用户将不再收到群消息。群主不能调用该接口退出群组,只能调用 destroyGroup 解散群组。

示例代码如下:

[[[EMClient sharedClient].groupManager leaveGroup:@"groupID" error:nil];

获取群组详情

注意

从 3.7.4 版本开始支持 “是否获取群组成员” 参数。

群成员可以调用 aGroup.adminList 方法从内存获取群组详情。返回结果包括:群组 ID、群组名称、群组描述、群组基本属性、群主、群组管理员列表,默认不包含群成员。

群成员也可以调用 getGroupSpecificationFromServerWithId 方法从服务器获取群组详情。返回结果包括:群组 ID、群组名称、群组描述、群组基本属性、群主、群组管理员列表。另外,若设置 fetchMemberstrue,获取群组详情时同时获取群成员,默认获取最大数量为 200。

// 原型
- (void)getGroupSpecificationFromServerWithId:(NSString *)aGroupId
                                   fetchMembers:(BOOL)fetchMembers
                                   completion:(void (^)(EMGroup *aGroup, EMError *aError))aCompletionBlock;

// 根据群组 ID 从服务器获取群组详情。
[[EMClient sharedClient].groupManager getGroupSpecificationFromServerWithId:self.group.groupId fetchMembers:YES completion:^(EMGroup *aGroup, EMError *aError) {
    if (!aError) {
        // EMGroup 中包含了很多群组属性,比如群组 ID,群组成员,是否屏蔽群组消息(isBlocked 属性)等,具体到 SDK 中 EMGroup.h 头文件查看。
        NSLog(@"获取群组详情成功");
    } else {
        NSLog(@"获取群组详情失败的原因 --- %@", aError.errorDescription);
    }
}];


// 根据群组 ID 从本地获取群组详情。
NSArray *admins = aGroup.adminList;

获取群成员列表

群成员可以调用 getGroupMemberListFromServerWithId 方法从服务器分页获取群成员列表。

NSMutableArray *memberList = [[NSMutableArray alloc]init];
NSInteger pageSize = 50;
NSString *cursor = nil;
EMCursorResult *result = [[EMCursorResult alloc]init];
do {
  result = [[EMClient sharedClient].groupManager
                            getGroupMemberListFromServerWithId:@"groupID"
                            cursor:cursor
                            pageSize:pageSize
                            error:nil];
  [memberList addObjectsFromArray:result.list];
  cursor = result.cursor;
} while (result && result.list < pageSize);
// 第二个参数传入 TRUE,默认取 200 人的群成员列表。
EMGroup *group = [[EMClient sharedClient].groupManager
                                getGroupSpecificationFromServerWithId:@"groupID"
                                fetchMembers:YES
                                error:nil];
NSArray *memeberList = [group.memberList];

获取群组列表

用户可以调用 getJoinedGroupsFromServer 方法从服务器获取自己加入和创建的群组列表。示例代码如下:

NSArray *groupList = [[EMClient sharedClient].groupManager
                                getJoinedGroupsFromServerWithPage:nil
                                pageSize:-1
                                error:nil];
NSArray *groupList = [[EMClient sharedClient].groupManager getJoinedGroups];
NSMutableArray *memberList = [[NSMutableArray alloc]init];
NSInteger pageSize = 50;
NSString *cursor = nil;
EMCursorResult *result = [[EMCursorResult alloc]init];
do {
  result = [[EMClient sharedClient].groupManager
                         getPublicGroupsFromServerWithCursor:cursor
                         pageSize:50
                         error:nil];
  [memberList addObjectsFromArray:result.list];
  cursor = result.cursor;
} while (result && result.list < pageSize);

屏蔽和解除屏蔽群消息

屏蔽群消息

群成员可以调用 blockGroup 方法屏蔽群消息。屏蔽群消息后,该成员不再从指定群组接收群消息,群主和群管理员不能进行此操作。示例代码如下:

[[EMClient sharedClient].groupManager blockGroup:@"groupID"error:nil];

解除屏蔽群

群成员可以调用 unblockGroup 方法解除屏蔽群消息。示例代码如下:

[[EMClient sharedClient].groupManager unblockGroup:@"groupID" error:nil];

检查是否已经屏蔽群消息

群成员可以通过 EMGroup#isBlocked 检查用户是否屏蔽了该群的群消息。使用此方法检查时,为了保证结果的准确性,需要先从服务器获取群详情,即调用 EMGroup#getGroupSpecificationFromServerWithId

监听群组事件

IEMGroupManager 中提供群组事件的监听接口。开发者可以通过设置此监听,获取群组中的事件,并做出相应处理。如果不再使用该监听,需要移除,防止出现内存泄漏。

示例代码如下:

// 添加代理。
- (void)viewDidLoad
  {
    [super viewDidLoad];
    [[EMClient sharedClient].groupManager addDelegate:self delegateQueue:nil];
  }
// 移除代理。
- (void)dealloc
  {
    [[EMClient sharedClient].groupManager removeDelegate:self];
  }

群组事件如下:

// 用户收到进群邀请
- (void)groupInvitationDidReceive:(NSString *)aGroupId inviter:(NSString *)aInviter message:(NSString *)aMessage
  {

}

// 群主或群管理员收到进群申请
- (void)joinGroupRequestDidReceive:(EMGroup *)aGroup user:(NSString *)aUsername reason:(NSString *)aReason
  {

}

// 群主或群管理员同意用户的进群申请
- (void)joinGroupRequestDidApprove:(EMGroup *)aGroup
  {

}

// 群主或群管理员拒绝用户的进群申请
- (void)joinGroupRequestDidDecline:(NSString *)aGroupId reason:(NSString *)aReason
  {

}

// 用户同意进群邀请
- (void)groupInvitationDidAccept:(EMGroup *)aGroup invitee:(NSString *)aInvitee
  {

}

// 用户拒绝进群邀请
- (void)groupInvitationDidDecline:(EMGroup *)aGroup invitee:(NSString *)aInvitee reason:(NSString *)aReason
  {

}

// 有用户自动同意加入群组
- (void)didJoinGroup:(EMGroup *)aGroup inviter:(NSString *)aInviter message:(NSString *)aMessage
  {

}

// 有成员被加入群组禁言列表
- (void)groupMuteListDidUpdate:(EMGroup *)aGroup addedMutedMembers:(NSArray *)aMutedMembers muteExpire:(NSInteger)aMuteExpire
  {

}

// 有成员被移出禁言列表
- (void)groupMuteListDidUpdate:(EMGroup *)aGroup removedMutedMembers:(NSArray *)aMutedMembers
  {

}

// 有成员被加入群组白名单
- (void)groupWhiteListDidUpdate:(EMGroup *)aGroup addedWhiteListMembers:(NSArray *)aMembers
  {

}

// 有成员被移出群组白名单
- (void)groupWhiteListDidUpdate:(EMGroup *)aGroup removedWhiteListMembers:(NSArray *)aMembers
  {

}

// 全员禁言状态变化
- (void)groupAllMemberMuteChanged:(EMGroup *)aGroup isAllMemberMuted:(BOOL)aMuted
  {

}

// 群组新增管理员
- (void)groupAdminListDidUpdate:(EMGroup *)aGroup addedAdmin:(NSString *)aAdmin
  {

}

// 有群组管理员被移除权限
- (void)groupAdminListDidUpdate:(EMGroup *)aGroup removedAdmin:(NSString *)aAdmin
  {

}

// 群主转移权限
- (void)groupOwnerDidUpdate:(EMGroup *)aGroup newOwner:(NSString *)aNewOwner oldOwner:(NSString *)aOldOwner
  {

}

// 有新成员加入群组
- (void)userDidJoinGroup:(EMGroup *)aGroup user:(NSString *)aUsername
  {

}

// 有成员主动退出群
- (void)userDidLeaveGroup:(EMGroup *)aGroup user:(NSString *)aUsername
  {

}

// 群组公告更新
- (void)groupAnnouncementDidUpdate:(EMGroup *)aGroup announcement:(NSString *)aAnnouncement
  {

}

// 有成员新上传群组共享文件
- (void)groupFileListDidUpdate:(EMGroup *)aGroup addedSharedFile:(EMGroupSharedFile *)aSharedFile
  {

}

// 群组共享文件被删除
- (void)groupFileListDidUpdate:(EMGroup *)aGroup removedSharedFile:(NSString *)aFileId
  {

}

// 群组详情变更
- (void)groupSpecificationDidUpdate:(NSString *)aGroupId
{

}