社群管理
功能描述
社群是一个由于共同主题而让大家聚集在一起的超大群组,可以在社群下根据不同兴趣创建多个话题。
社群用来管理群成员。社群下的所有话题不仅可以共享社群成员,还可以独立收发消息而不相互干扰。
社群和话题的管理接口在核心类
TencentImSDKPlugin.v2TIMManager.getGroupManager()
中。话题中的消息相关接口在核心类
TencentImSDKPlugin.v2TIMManager.getMessageManager()
中。社群管理
创建社群
创建支持话题的社群分两步:
1. 创建
V2TIMGroupInfo
(Details) 对象,其中 groupType
设置为 Community
,isSupportTopic
设置为 true
/YES
。2. 调用
createGroup
(Details) 接口创建群组。示例代码如下:
// 创建只会社群的话题groupManager.createGroup(groupType: "Community", groupName: "社群",isSupportTopic: true);
获取加入的社群列表
示例代码如下:
// 获取加入的社群列表const groupList = await groupManager.getJoinedCommunityList();
其他管理接口
其他功能跟普通群组使用方法一样,涉及的接口有:
话题管理
同一社群下可创建多个话题,多个话题共享一套社群成员关系,但不同话题内独立收发消息、互不干扰。
说明:
创建话题
创建话题分两步:
1. 创建
V2TIMTopicInfo
(Details) 对象。2. 调用
createTopicInCommunity
(Details) 接口创建话题。示例代码如下:
// 创建话题groupManager.createTopicInCommunity("groupID", {topicName: "topic",});
删除话题
示例代码如下:
// 删除话题groupManager.deleteTopicFromCommunity("groupID", ["topicID"]);
修改话题信息
修改话题信息分两步:
1. 创建
V2TIMTopicInfo
(Details) 对象,并设置需要修改的字段2. 调用
setTopicInfo
(Details) 接口修改话题信息示例代码如下:
// 修改话题信息groupManager.setTopicInfo({topicName: "topicName",});
获取话题列表
获取话题列表
当 topicIDList 列表为空时,为获取该社群下的所有话题列表
当 topicIDList 填入指定的话题 ID 时,为获取填入的话题列表
示例代码如下:
// 获取话题列表groupManager.getTopicInfoList("groupID", ["topicID"]);
话题分组
社群模式(娱乐协作新利器),支持社群-分组-话题三级结构,将消息相互区隔。
加载社群时,根据社群(群组)的
customInfo
的话题分组列表字段,展示分组。该字段建议用 string[]
形式存储。具体每个分组中有什么话题 Topic,则要遍历 Topic 列表,通过
V2TimTopicInfo
的 customString
获得每个话题所属分组。说明:
获取社群的分组列表
调用
getCommunityCategoryList(String groupID)
方法,示例代码如下:const getCommunityCategoryList = async (groupID) => {const customInfo = await getCommunityCustomInfo(groupID);if (customInfo != null) {const categoryListString = customInfo["categoryList"];if (categoryListString != null && categoryListString !== "") {return JSON.parse(categoryListString);}}};const getCommunityCustomInfo = async (groupID) => {const groupIDList = [groupID];const res = await TencentImSDKPlugin.v2TIMManager.getGroupManager().getGroupsInfo(groupIDList);if (res.code != 0) {const groupInfo = res.data[0];if (groupInfo != null) {const customInfo = groupInfo.groupInfo?.customInfo;return customInfo;}}return null;};
配置社群的分组列表
此处直接修改群组
groupInfo
的 customInfo
即可。此处为一个 Map,key 值您定义的话题分组列表字段名。getCommunityCustomInfo
方法已在上一段实现,示例代码如下:const setCommunityCategoryList = async (groupID,groupType,newCategoryList) => {const customInfo = await getCommunityCustomInfo(groupID);customInfo["categoryList"] = JSON.parse(newCategoryList);TencentImSDKPlugin.v2TIMManager.getGroupManager().setGroupInfo({customInfo: customInfo,groupID: groupID,groupType: groupType,// ...其他资料});};
为话题添加分组
示例代码如下:
const addCategoryForTopic = (groupID, categoryName) => {TencentImSDKPlugin.v2TIMManager.getGroupManager().setTopicInfo({customString: categoryName,});};
获取话题所在分组
监听话题回调
在
V2TIMGroupListener
(Details) 中增加了话题相关的回调方法,onTopicCreated
,onTopicDeleted
,onTopicInfoChanged
,用来监听话题事件。示例代码如下:
const v2TIMGroupListener = {onTopicCreated: (groupID, topicID) => {// 监听话题创建通知},onTopicDeleted: (groupID, topicIDList) => {// 监听话题删除通知},onTopicInfoChanged: (groupID, topicInfo) => {// 监听话题信息更新通知},};V2TIMManager.getInstance().addGroupListener(v2TIMGroupListener);
话题消息
话题消息相关功能跟普通消息使用方法一样,涉及的接口有: