功能描述
群组管理功能指的是创建群组、加入群组、获取已加入的群组、退出群组和解散群组等,相关方法在核心类
TencentImSDKPlugin.v2TIMManager.getGroupManager()
中。群事件监听
下文描述的群组管理功能中,有些会触发群事件通知回调,例如有人进群、有人退群等,这些事件都是由 IM 服务器自动触发的。
注意
只有预先设置好群事件监听器,才能正常接收到下文中的各种群事件通知。
示例代码如下:
TencentImSDKPlugin.v2TIMManager.setGroupListener(listener: V2TimGroupListener());
创建群组
示例代码如下:
// 创建public群,并指定相关群属性groupManager.createGroup(groupType: "Public",groupName: "groupName",notification: "",introduction: "",faceUrl: "",isAllMuted: false,isSupportTopic: false,addOpt: GroupAddOptTypeEnum.V2TIM_GROUP_ADD_AUTH,memberList: [],);
加入群组
不同类型的群组,加群的方法不同:
类型 | 加群方法 |
好友工作群(Work) | 必须由其他群成员邀请 |
陌生人社交群(Public) | 用户申请,群主或管理员审批 |
临时会议群(Meeting) | 用户可随意加入 |
社群(Community) | 用户可随意加入 |
直播群(AVChatRoom) | 用户可随意加入 |
下面将根据加群流程从简单到复杂进行逐一介绍。
注意
自由加群
临时会议群(Meeting)、直播群(AVChatRoom)和社群(Community)主要用于满足成员随意进出的交互场景,例如在线会议,秀场直播等。因此这几种类型群的入群流程最为简单:
1. 加群者调用
joinGroup
(点击查看详情) 加入群组。2. 加群者加群成功后,全体群成员(包括加群者本人)都会收到
onMemberEnter
(点击查看详情) 回调。示例代码如下:
// 加入群组TencentImSDKPlugin.v2TIMManager.joinGroup(groupID: "groupID",message: "hello",groupType: "Public");// 监听加入群组事件TencentImSDKPlugin.v2TIMManager.addGroupListener(listener: V2TimGroupListener(onMemberEnter: ((groupID, memberList) {// 获取加入群的人员信息})));
邀请加群
好友工作群(Work)类似微信群和企业微信群,适用于工作交流,在交互设计上限制用户主动加入,只能由现有的群成员邀请才能加群。
加群步骤为:
1. 现有的群成员调用
inviteUserToGroup
(点击查看详情) 邀请另一个用户入群。2. 全体群成员(包括邀请者自己)会收到
onMemberInvited
(点击查看详情) 回调。您可以在这个回调中做一些 UI 上的提示。示例代码如下:
// 邀请 userA 用户进入群组 groupA 中groupManager.inviteUserToGroup(groupID: "groupID",userList:[]);// 监听群组邀请事件TencentImSDKPlugin.v2TIMManager.addGroupListener(listener: V2TimGroupListener(onMemberInvited: ((groupID, opUser, memberList) {// 获取邀请者、被邀请成员信息})));
邀请且审批加群
陌生人社交群(Public)类似 QQ 中的各种兴趣群和部落群,任何人都可以申请入群,但需要经过群主或管理员审批才能真正入群。
邀请且审批加群的流程如下:
流程说明:
1. 申请者调用
joinGroup
(点击查看详情) 申请加群。2. 群主或管理员收到加群申请通知
onReceiveJoinApplication
(点击查看详情) ,在其中调用 getGroupApplicationList
(点击查看详情)获取加群申请列表。3. 群主或管理员遍历加群申请列表,逐一调用
acceptGroupApplication
(点击查看详情) 同意加群,或调用 refuseGroupApplication
(点击查看详情) 拒绝加群请求。4. 请求加群被同意或者拒绝后,申请者会收到
onApplicationProcessed
(点击查看详情) 回调。其中 isAgreeJoin
为 true
表示同意加群,反之被拒绝。5. 同意加群后,全员(包括请求者)收到
onMemberEnter
(点击查看详情) 回调,通知群组成员有人进群。示例代码如下:
// ******群主端******//// 1、群主端修改加群选项为需要审核groupManager.setGroupInfo(info: V2TimGroupInfo.fromJson({"groupAddOpt":GroupAddOptTypeEnum.V2TIM_GROUP_ADD_AUTH}));// 2、群主端监听加群请求并处理TencentImSDKPlugin.v2TIMManager.addGroupListener(listener: V2TimGroupListener(onReceiveJoinApplication: (groupID, member, opReason) async {// 获取所有申请V2TimValueCallback<V2TimGroupApplicationResult> appls = await groupManager.getGroupApplicationList();appls.data.groupApplicationList.forEach((application) {// 同意groupManager.acceptGroupApplication(groupID: application.groupID, fromUser: application.fromUser, toUser: application.toUser,type: GroupApplicationTypeEnum.values[application.type]);// 拒绝groupManager.refuseGroupApplication(groupID: application.groupID, fromUser: application.fromUser, toUser: application.toUser, addTime: application.addTime, type: GroupApplicationTypeEnum.values[application.type]);});},));// ******用户端******//// 1、用户端申请加群TencentImSDKPlugin.v2TIMManager.joinGroup(groupID: "groupID",message: "hello",groupType: "Public");// 2、用户端监听加群审批结果TencentImSDKPlugin.v2TIMManager.addGroupListener(listener: V2TimGroupListener(onApplicationProcessed: ((groupID, opUser, isAgreeJoin, opReason) {// 加群申请被处理}),onMemberEnter:(groupID,memberlist){// 用户进群}));
群主或管理员也可以通过
setGroupInfo
(点击查看详情) 接口调整加群选项(V2TIMGroupAddOpt
),可以设置为更严格的 “禁止任何人加群”,也可以设置为更宽松的 “放开审批流程”。V2TIMGroupAddOpt
的可选项有:加群选项 | 含义 |
GroupAddOptTypeEnum.V2TIM_GROUP_ADD_FORBID | 禁止任何人加群 |
GroupAddOptTypeEnum.V2TIM_GROUP_ADD_AUTH | 需要群主或管理员审批才能加入(默认值) |
GroupAddOptTypeEnum.V2TIM_GROUP_ADD_ANY | 取消审批流程,任何用户都可以加入 |
获取已加入的群组
您可以调用
getJoinedGroupList
(点击查看详情) 获取已加入的好友工作群(Work)、陌生人社交群(Public)、临时会议群(Meeting)、社群(Community,不支持话题功能)列表。但直播群(AVChatRoom)和 社群(Community,支持话题的社群)不包含在此列表中。代码示例如下:
// 获取已经加入的群组V2TimValueCallback<List<V2TimGroupInfo>> groupRes =await groupManager.getJoinedGroupList();
退出群组
注意
示例代码如下:
// 退出群组TencentImSDKPlugin.v2TIMManager.quitGroup(groupID: "groupID");TencentImSDKPlugin.v2TIMManager.addGroupListener(listener: V2TimGroupListener(onMemberLeave: (groupID, member) {// 离开群成员信息},));
解散群组
示例代码如下:
// 解散群组TencentImSDKPlugin.v2TIMManager.dismissGroup(groupID: "groupID");// 事件监听TencentImSDKPlugin.v2TIMManager.addGroupListener(listener: V2TimGroupListener(onGroupDismissed: (groupID, opUser) {// 群被解散},onGroupRecycled: (groupID, opUser){// 群被回收}));