管理频道分组

大约 4 分钟

管理频道分组

环信超级社区(Circle)支持将多个频道归入一个频道分组,方便频道管理。例如,可将歌剧频道、民歌频道和流行歌曲频道划分为声乐频道分组。

社区创建时会创建默认的频道分组,包含默认频道。

超级社区中的频道基于即时通讯 IM 的群组或聊天室(频道 ID 为群组 ID 或聊天室 ID)创建,删除群组或聊天室时需注意以下几点:

1. 在环信控制台或者通过客户端删除群组或聊天室、群组或聊天室加人、踢人等操作时请谨慎操作,需确保操作的群组或者聊天室不是超级社区使用的。2. 如果将超级社区使用的频道对应的群组或者聊天室删除,会出现数据不一致情况,导致用户加入不了社区、频道、在频道内发不了消息等情况发生。3. 在清理群组或者聊天室数据时,需先确认要删除的群组 ID 或聊天室 ID 与超级社区的频道 ID 是否一致。你可以调用获取频道详情 API 确认要删除的群组或聊天室是否为超级社区的频道。如果是,请不要进行删除。4. 如果需要清理超级社区数据,调用删除社区删除频道等 API。

技术原理

环信即时通讯 IM Web SDK 支持你通过调用 API 实现如下功能:

  • 创建和管理频道分组;
  • 监听频道分组事件。

前提条件

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

  • 完成 SDK 4.1.4-beta 版本的初始化,详见 快速开始
  • 了解环信即时通讯 IM 的使用限制,详见 使用限制

实现方法

创建频道分组

仅社区所有者可以调用 createCategory 方法创建频道分组。创建频道分组时需设置频道分组所属的社区 ID 和频道分组名称。频道分组创建后,社区所有成员(除创建者外)会收到 onCategoryEvent 回调,事件为 create

每个社区下最多可创建 50 个频道分组,超过需要联系商务。

示例代码如下:

let options = {
  serverId: 'serverId',
  name: 'categoryName',
}
WebIM.conn.createCategory(options).then(res => {
  console.log(res)
})

修改频道分组名称

仅社区所有者和管理员可调用 updateCategory 方法修改频道分组名称。频道分组名称修改后,社区所有成员(除操作者外)会收到 onCategoryEvent 回调,事件为 update

示例代码如下:

let options = {
  serverId: 'serverId',
  categoryId: 'categoryId',
  name: 'categoryName',
}
WebIM.conn.updateCategory(options).then(res => {
  console.log(res)
})

删除频道分组

仅社区所有者可调用 deleteCategory 方法删除频道分组。社区所有成员(除操作者外)会收到 onCategoryEvent 回调,事件为 destroy。频道分组删除后,分组下的频道会移至当前社区的默认分组下。

示例代码如下:

WebIM.conn.deleteCategory({serverId: 'serverId', categoryId: 'categoryId',}).then(res => {
  console.log(res)
})

分页获取社区下的频道分组列表

社区中的所有成员可以调用 getCategorylist 方法获取社区下的频道分组列表。

示例代码如下:

WebIM.conn.getCategorylist({serverId: 'serverId',pageSize:'20',cursor:''}).then(res => {
  console.log(res)
})

更换指定频道的频道分组

仅社区所有者和管理员可以调用 transferChannel 方法将指定频道从一个频道分组转移至另一个频道分组。频道分组更换后,社区所有成员(除操作者外)会收到 onCategoryEvent 回调,事件为 transferChannel

提示

调用该方法时,若 newCategoryId 参数传入 null、空字符串(``)或者不传,表示将频道归入社区默认的频道分组。

示例代码如下:

WebIM.conn.transferChannel({serverId: 'serverId',channelId: 'channelId',newCategoryId:'newCategoryId'}).then(res => {
  console.log(res)
})

监听频道分组事件

Circle 提供 addEventHandler 方法用于注册监听事件。开发者可以通过设置此监听,获取频道分组中的事件。

WebIM.conn.addEventHandler('CIRCLE',{
  onServerEvent:(msg) => {
		switch (msg.operation){
        case "create":
          //创建频道分组。社区所有成员(除创建者外)会收到该事件。
          break;
        case "update":
          //修改了频道分组名称。社区所有成员(除创建者外)会收到该事件。
          break;
        case "destroy":
          //删除了频道分组。社区所有成员(除创建者外)会收到该事件。
          break;
        case "transferChannel":
          //频道更换了分组。社区所有成员(除创建者外)会收到该事件。
          break;
        default:
          break;
    }
  },
});