一、效果展示
你可以使用本功能实现如下所示的社群效果：
二、创建社群
示例
// 创建支持话题的社群let promise = chat.createGroup({ type: TencentCloudChat.TYPES.GRP_COMMUNITY, name: 'WebSDK', isSupportTopic: true,});promise.then(function(imResponse) { // 创建成功 console.log(imResponse.data.group); // 创建的群的资料}).catch(function(imError) { console.warn('createGroup error:', imError); // 创建群组失败的相关信息});
三、获取支持话题的社群列表
注意：该接口仅适用于获取支持话题的社群，需 购买旗舰版或企业版套餐包 并在 控制台 > 功能配置 > 群组配置 > 群功能配置 > 社群 打开开关后方可使用。
接口
chat.getJoinedCommunityList();
参数
无
返回值
Promise
示例
// 获取支持话题的社群列表let promise = chat.getJoinedCommunityList();promise.then(function(imResponse) { // 获取成功 console.log(imResponse.data.groupList); // 支持话题的社群列表}).catch(function(imError) { // 获取失败 console.warn('getJoinedCommunityList error:', imError); // 失败的相关信息});
四、创建话题
注意：1. 该接口仅适用于支持话题的社群，需 购买旗舰版或企业版套餐包 在 控制台 > 功能配置> 群组配置> 群功能配置 > 社群 页面，完成开通社群后，再打开开通话题开关，方可使用。
注意：2. 该接口使用前必须先调用 createGroup 创建支持话题的社群。
接口
chat.createTopicInCommunity(options);
参数
参数 options 为 Object 类型，包含的属性值如下：
| 名称 | 类型 | 描述 |
| groupID | String | 话题所属社群 ID |
| topicName | String | 话题名称 |
| topicID | String | 自定义话题 ID 时，格式必须是社群 ID 拼接上自定义话题 ID。例如：@TGS#_xxx@TOPIC#_xxx |
| avatar | String | 话题头像 |
| notification | String | 话题公告 |
| introduction | String | 话题简介 |
| customData | String | 话题自定义信息 |
返回值
Promise
示例
// 创建话题let promise = chat.createTopicInCommunity({ groupID: 'group1', topicName: 'test', avatar: 'xxx' notification: 'xxx', introduction: 'xxx', customData: 'xxxx',});promise.then(function(imResponse) { // 创建成功 console.log(imResponse.data.topicID); // 话题 ID}).catch(function(imError) { // 创建失败 console.warn('createTopicInCommunity error:', imError); // 创建话题失败的相关信息});
五、删除话题
注意：该接口仅适用于支持话题的社群。
接口
chat.deleteTopicFromCommunity(options);
参数
参数 options 为 Object 类型，包含的属性值如下：
| 名称 | 类型 | 描述 |
| groupID | String | 话题所属社群 ID |
| topicIDList | Array | undefined | 话题 ID 列表，不传 topicIDList 表示删除全部话题 |
返回值
Promise
示例
// 删除某个社群下指定话题let promise = chat.deleteTopicFromCommunity({ groupID: 'group1', topicIDList: ['topicID'],});promise.then(function(imResponse) { // 删除成功 const { successTopicList, failureTopicList } = imResponse.data; // 删除成功的话题列表 successTopicList.forEach((item) => { const { topicID } = item; }); // 删除失败的话题列表 failureTopicList.forEach((item) => { const { topicID, code, message } = item; })}).catch(function(imError) { // 删除失败 console.warn('deleteTopicFromCommunity error:', imError); // 删除话题失败的相关信息});
// 删除某个社群下所有话题let promise = chat.deleteTopicFromCommunity({ groupID: 'group1',});promise.then(function(imResponse) { // 删除成功 const { successTopicList, failureTopicList } = imResponse.data; // 删除成功的话题列表 successTopicList.forEach((item) => { const { topicID } = item; }); // 删除失败的话题列表 failureTopicList.forEach((item) => { const { topicID, code, message } = item; })}).catch(function(imError) { // 删除失败 console.warn('deleteTopicFromCommunity error:', imError); // 删除话题失败的相关信息});
六、修改话题信息
注意：1. 该接口仅适用于支持话题的社群。
注意：2. 话题内其他成员可以收到 TencentCloudChat.EVENT.TOPIC_UPDATED 事件。
接口
chat.updateTopicProfile(options);
参数
参数 options 为 Object 类型，包含的属性值如下：
| 名称 | 类型 | 描述 |
| groupID | String | 话题所属社群 ID |
| topicID | String | 必填，话题 ID |
| topicName | String | undefined | 话题名称 |
| avatar | String | undefined | 话题头像 |
| notification | String | undefined | 话题公告 |
| introduction | String | undefined | 话题简介 |
| customData | String | undefined | 话题自定义信息 |
| muteAllMembers | Boolean | undefined | 设置全体禁言，true – 全体禁言 false – 取消全体禁言 |
返回值
Promise
示例
// 更新话题资料let promise = chat.updateTopicProfile({ groupID: 'group1', topicID: 'topic1', topicName: 'test', avatar: 'xxx' notification: 'xxx', introduction: 'xxx', customData: 'xxxx', muteAllMembers: true});promise.then(function(imResponse) { // 设置话题资料成功 console.log(imResponse.data.topic); // 返回修改后的话题资料}).catch(function(imError) { // 设置话题资料失败 console.warn('updateTopicProfile error:', imError); // 设置话题资料失败的相关信息});
七、获取话题列表
注意：该接口仅适用于支持话题的社群。
接口
chat.getTopicList(options);
参数
参数 options 为 Object 类型，包含的属性值如下：
| 名称 | 类型 | 描述 |
| groupID | String | 话题所属社群 ID |
| topicIDList | Array | undefined | 话题 ID 列表，不传 topicIDList 表示获取全部话题 |
返回值
Promise
示例
// 获取某个社群下指定的话题let promise = chat.getTopicList({ groupID: 'group1', topicIDList: ['topicID'],});promise.then(function(imResponse) { // 获取成功 const { successTopicList, failureTopicList } = imResponse.data; // 获取成功的话题列表 successTopicList.forEach((item) => { const { topicID } = item; }); // 获取失败的话题列表 failureTopicList.forEach((item) => { const { topicID, code, message } = item; })}).catch(function(imError) { // 获取失败 console.warn('getTopicList error:', imError); // 获取话题列表失败的相关信息});
// 获取某个社群下全部的话题let promise = chat.getTopicList({ groupID: 'group1',});promise.then(function(imResponse) { // 获取成功 const { successTopicList, failureTopicList } = imResponse.data; // 获取成功的话题列表 successTopicList.forEach((item) => { const { topicID } = item; }); // 获取失败的话题列表 failureTopicList.forEach((item) => { const { topicID, code, message } = item; })}).catch(function(imError) { // 获取失败 console.warn('getTopicList error:', imError); // 获取话题列表失败的相关信息});
八、实现话题分组
社群-分组-话题三级结构中的分组实现原理为：
社群资料的 groupCustomField 中定义一个字段保存该社群的话题分组列表；每个话题所属的分组，存储于话题资料的 customData 字段中。
·加载社群时，根据社群（群组）资料中的 groupCustomField 的话题分组列表字段，展示分组列表。
·加载社群下的 Topic 列表时，通过话题资料中的 customData 获取分组名分配到所属分组中。
注意：说明：
注意：社群（群组）中 groupCustomField 的话题分组列表字段名，key 值，可由你自行定义。以下示例代码中，将其命名为 topic_category 。
九、配置社群的分组列表
此处直接修改群组资料的 groupCustomField 即可。key 值是你定义的话题分组列表字段名，value 是话题分组列表。
示例代码如下：
// 话题分组列表const categoryList = ['分组1', '分组2'];// 更新社群的话题分组列表let promise = chat.updateGroupProfile({ groupID: 'group1', // 需要先在控制台配置群自定义字段 topic_category groupCustomField: [{ key: 'topic_category', value: JSON.stringify(categoryList) }]});promise.then(function(imResponse) { console.log(imResponse.data.group) // 修改成功后的群组详细资料}).catch(function(imError) { console.warn('updateGroupProfile error:', imError); // 修改群组资料失败的相关信息});
十、获取社群的分组列表
示例代码如下：
let promise = chat.getGroupProfile({ groupID: 'group1', groupCustomFieldFilter: ['topic_category'],});promise.then(function(imResponse) { console.log(imResponse.data.group); const categoryList = []; // 话题分组列表 const { groupCustomField } = imResponse.data.group; groupCustomField.forEach((item) => { if (item.key === 'topic_category') { // 解析出分组列表 categoryList = JSON.parse(item.value); } });}).catch(function(imError) { console.warn('getGroupProfile error:', imError); // 获取群详细资料失败的相关信息});
十一、为话题添加分组
话题所属的分组可以使用话题的 customData 字段来保存。
示例代码如下：
// 给话题定义分组const customData = { category: '分组1' };// 更新话题分组let promise = chat.updateTopicProfile({ groupID: 'group1', // 社群ID topicID: 'topic1', // 话题ID customData: JSON.stringify(customData),});promise.then(function(imResponse) { // 更新话题分组成功 console.log(imResponse.data.topic); // 返回修改后的话题资料}).catch(function(imError) { // 更新话题分组失败 console.warn('updateTopicProfile error:', imError); // 更新话题分组失败的相关信息});
十二、获取话题所在分组
直接从 获取话题列表 中，取出 customData 解析 json 即可。
十三、监听话题回调
let onTopicCreated = function(event) { const groupID = event.data.groupID // 话题所属社群 ID const topicID = event.data.topicID // 话题 ID console.log(event.data);};chat.on(TencentCloudChat.EVENT.TOPIC_CREATED, onTopicCreated);
let onTopicDeleted = function(event) { const groupID = event.data.groupID // 话题所属社群 ID const topicIDList = event.data.topicIDList // 删除的话题 ID 列表 console.log(event.data);};chat.on(TencentCloudChat.EVENT.TOPIC_DELETED, onTopicDeleted);
let onTopicUpdated = function(event) { const groupID = event.data.groupID // 话题所属社群 ID const topic = event.data.topic // 话题资料 console.log(event.data);};chat.on(TencentCloudChat.EVENT.TOPIC_UPDATED, onTopicUpdated);