IM 即时通讯
Android
动态与公告
IM UIKit 更新日志
NIM SDK 开发版更新日志
NIM SDK 稳定版更新日志
新手接入指南
产品介绍
简介
主要功能
产品优势
功能介绍
账号集成与登录
多端登录与互踢策略
群组功能
聊天室功能
聊天室标签功能
圈组功能
质量数据监控台
海外数据中心
IM平滑迁移方案
接口及业务限制
体验 Demo
下载 SDK 与 Demo 源码
快速开始
跑通 IM Demo 源码
实现单聊消息收发(不含 UI)
跑通圈组 Demo 源码
实现圈组消息收发(不含 UI)
含 UI 集成
什么是 IM UIKit
IM UIKit 功能概览
快速集成 IM UIKit
组件导入
初始化
界面跳转
自定义用户信息
全局配置
会话列表相关
集成会话列表界面
会话列表事件监听
自定义会话列表界面 UI
会话列表 API 概览
会话消息相关
集成会话界面
会话界面事件监听
实现音视频通话
实现地理位置消息功能(含 UI)
实现自定义消息发送(含 UI)
自定义会话界面 UI
会话消息 API 概览
通讯录相关
集成通讯录界面
自定义通讯录界面 UI
通讯录界面事件监听
通讯录 API 概览
UIKit 功能实现方案
消息回复实现方案
UIKit 版本升级说明
系统兼容相关
IM UIKit 常见问题排查
IM UIKit API 概览
不含 UI 集成
使用说明
集成 SDK
初始化
登录相关
登录 IM
多端登录与互踢
登出 IM
消息相关
消息概述
消息收发
自定义消息收发
消息配置选项
NOS 存储场景
广播消息收发
消息已读回执
消息撤回
消息重发与转发
消息更新
消息过滤
语音消息处理
插入本地消息
历史消息
最近会话
服务端会话服务
用户资料
用户关系
在线状态订阅
系统通知
系统通知概述
内置系统通知管理
内置系统通知未读数
自定义系统通知收发
Android 离线推送
实现离线推送
配置消息的推送属性
设置群消息强制推送
设置推送全局免打扰
设置多端推送策略
集成小米推送
集成华为推送
集成荣耀推送
集成 OPPO 推送
集成 vivo 推送
集成魅族推送
集成谷歌推送(FCM)
消息提醒
实现消息提醒
配置消息提醒功能
设置群消息强制提醒
设置消息提醒文案
定制通知栏显示信息
群组功能
群组概述
群组管理
群成员管理
群消息管理
超大群功能
聊天室
圈组功能
圈组概述
登录管理
服务器相关
服务器概述
服务器管理
服务器成员管理
游客功能
服务器未读数管理
频道相关
频道概述
频道管理
频道黑白名单
实时互动频道
频道分组
频道分组黑白名单
频道未读数管理
搜索服务器和频道
身份组相关
身份组概述
身份组应用场景
服务器身份组
频道身份组
用户定制权限
频道分组身份组
自定义权限项
成员权限查询与判定
身份组相关查询
圈组订阅机制
圈组消息相关
图解圈组消息流转
圈组消息收发
消息发送配置项
圈组消息撤回
圈组消息更新
圈组消息删除
消息正在输入
会话消息回复(Thread)
圈组快捷评论
获取频道最后一条消息
查询历史消息
查询@我的消息
圈组消息缓存
圈组消息搜索
圈组系统通知相关
圈组系统通知概述
圈组系统通知收发
圈组系统通知更新
圈组离线推送
圈组内容审核
圈组相关抄送
圈组第三方回调
圈组各端接口命名差异
反垃圾(内容审核)
聊天扩展
接入第三方机器人
其他
最佳实践
IM 登录最佳实践
IM 应用隐私合规
聊天室重要消息投递
API 参考
Android SDK API
Android SDK 状态码/错误码
IM 控制台指南
创建应用
注册 IM 账号
升级服务
开通聊天室功能
配置应用客户端标识
添加推送证书
常见问题
FAQ
错题集
Android 端推送问题排查
第三方推送厂商的限制说明
服务协议

频道分组

更新时间: 2022/12/27 17:25:13

网易云信即时通讯 NIM Android SDK 的QChatChannelCategory结构体定义了频道分组。同时,SDK 的QChatChannelService接口提供管理频道分组的相关方法,助您快速实现对频道的分类管理。

功能介绍

频道管理相关方法,基本都需要满足如下两个前提条件才能调用。各方法的具体调用前提,请参见本文的 API参考

  • 频道分组对用户可见,具体机制见下文的频道分组可见机制
  • 拥有管理频道的权限(QChatRoleResource枚举中的MANAGE_CHANNEL)。

频道分组可见机制

  • 频道分组对服务器成员的可见机制与频道的类似,分如下两种情况:

    • 如果频道分组为公开频道分组,那么只要用户未被加入频道分组黑名单,频道分组就对其可见。
    • 如果频道分组为私密频道分组,那么用户需被加入频道分组白名单,频道分组才对其可见。

    频道分组黑白名单相关说明,请参见频道分组黑白名单

  • 频道分组是否对游客可见,取决于频道分组内是否有频道对游客可见。如果频道分组内有频道对游客可见,则该频道分组对游客也可见。频道是否对游客可见由visitorMode决定,可在创建频道和修改频道时设置,具体见频道管理

    如果频道的visitorMode为跟随模式,且同步模式(syncMode)为“与频道分组同步”,则当该频道所属的频道分组的查看模式(viewMode)变更后,该频道对游客的可见性也将变更。例如,在这种情况下,频道分组的查看模式由公开变为私密,则此时该频道对游客从“可见”变为“不可见”。

与频道的关联逻辑

频道管理相关方法(如createChannel)的入参包含categoryIdsyncMode。在调用createChannel时传入 categoryId 可将频道加入某个频道分组;通过设置syncMode,可实现频道数据与频道分组数据的同步。具体同步的数据包括查看模式(私密或公开)、黑白名单和身份组权限。

参数
类型
说明
categoryId long 频道需加入或所在的频道分组 ID。设置为 0 表示频道没有频道分组。设置为频道分组 ID 表示归属某个频道分组
syncMode QChatChannelSyncMode 频道同步模式。传1同步,传0不同步,不传默认不同步。如果频道查看模式、黑白名单、身份组权限等被修改,自动改为不同步

归属于单个频道分组的频道数量上限为 50。

与服务器的关联逻辑

QChatServer结构体包含categoryNumber参数,该参数表示服务器内频道分组的数量。QChatServer结构体定义了服务器。

服务器内频道分组数量上限为 100。

实现方法

本节以服务器所有者(即创建者)和服务器成员的交互为例,介绍服务器成员创建频道分组的实现流程。

  • 服务器所有者拥有全局权限,可以在创建服务器后直接调用createChannelCategory方法创建频道分组。
  • 用户创建频道分组后, 可对频道分组做更新、删除、修改和查询等操作,相关可调用的方法请参见本文的API 参考

前提条件

实现流程

  1. 服务器所有者调用addMembersToServerRole方法将服务器成员加入身份组。
  2. 服务器所有者调用updateServerRole方法授权该身份组管理频道的权限。
  3. 服务器成员调用createChannelCategory方法创建频道分组。

API 调用时序图

uml diagram

示例代码

//************************1.将服务器成员加入身份组************************/
//服务器Id
long serviceId = 2114708;
//服务器身份组Id
long roleId = 21343;
//需要加入服务器的成员账户
String accid = "test1";
List<String> accidList = new ArrayList<>();
accidList.add(accid);

QChatAddMembersToServerRoleParam addMembersToServerRoleParam = new QChatAddMembersToServerRoleParam(serviceId,roleId,accidList);
NIMClient.getService(QChatRoleService.class).addMembersToServerRole(addMembersToServerRoleParam).setCallback(
        new RequestCallback<QChatAddMembersToServerRoleResult>() {
            @Override
            public void onSuccess(QChatAddMembersToServerRoleResult result) {
                List<String> failedAccids = result.getFailedAccids();
                //如果失败列表中成员accid,表示成功了
                if(!failedAccids.contains(accid)){
                    //成功的UI操作
                }
            }

            @Override
            public void onFailed(int code) {

            }

            @Override
            public void onException(Throwable exception) {

            }
        });

//************************2.授予该身份组管理频道权限************************/
//如果该身份组没有管理频道权限,则授予该身份组管理频道权限
QChatUpdateServerRoleParam updateServerRoleParam = new QChatUpdateServerRoleParam(serviceId,roleId);
//开启管理频道权限
Map<QChatRoleResource, QChatRoleOption> resourceAuths = new HashMap<>();
resourceAuths.put(QChatRoleResource.MANAGE_CHANNEL,QChatRoleOption.ALLOW);
updateServerRoleParam.setResourceAuths(resourceAuths);

NIMClient.getService(QChatRoleService.class).updateServerRole(updateServerRoleParam).setCallback(
        new RequestCallback<QChatUpdateServerRoleResult>() {
            @Override
            public void onSuccess(QChatUpdateServerRoleResult result) {
                //  返回更新后的服务器身份组
                QChatServerRole role = result.getRole();
            }

            @Override
            public void onFailed(int code) {

            }

            @Override
            public void onException(Throwable exception) {

            }
        });

//************************3.创建频道分组************************/
QChatCreateChannelCategoryParam categoryParam = new QChatCreateChannelCategoryParam(serviceId);
categoryParam.setName("频道分组名称");
categoryParam.setCustom("频道分组自定义扩展字段");
//设置频道查看模式
categoryParam.setViewMode(QChatChannelMode.PUBLIC);
NIMClient.getService(QChatChannelService.class).createChannelCategory(categoryParam).setCallback(
        new RequestCallback<QChatCreateChannelCategoryResult>() {
            @Override
            public void onSuccess(QChatCreateChannelCategoryResult result) {
                //返回创建好的频道分组
                QChatChannelCategory category = result.getCategory();
            }

            @Override
            public void onFailed(int code) {

            }

            @Override
            public void onException(Throwable exception) {

            }
        });

相关参考

相关系统通知

频道分组相关事件的系统通知为 SDK 内置系统通知,在QChatSystemNotificationType枚举内定义。具体类型及相关的触发和接收条件见下表。

系统通知类型
触发条件
接收条件
CHANNEL_CATEGORY_CREATE(21) 频道分组成功创建时
  • 服务器创建者和所有者:在线
  • 其他成员:服务器成员数量低于 2,000 人阈值时只需要在线。如大于 2,000,需在线且订阅服务器
CHANNEL_CATEGORY_REMOVE(22) 频道分组被删除时
  • 删除者和服务器所有者:在线
  • 其他成员:服务器成员数量低于 2,000 人阈值时只需要在线。如大于 2,000,需在线且订阅服务器
CHANNEL_CATEGORY_UPDATE(23) 频道分组信息被修改时
  • 修改者和服务器所有者:在线
  • 其他成员:服务器成员数量低于 2,000 人阈值时只需要在线。如大于 2,000,需在线且订阅服务器

2,000 人阈值可联系商务经理调整。

相关推送配置

API参考

API
调用前提
说明
createChannelCategory 用户拥有管理频道的权限 创建频道分组
deleteChannelCategory 频道分组对用户可见,且用户拥有管理频道的权限 删除频道分组
updateChannelCategory 频道分组对用户可见,且用户拥有管理频道的权限 修改频道分组信息
getChannelCategories 查询频道分组
getChannelCategoriesByPage 频道分组对用户可见,且用户拥有管理频道的权限 分页查询服务器下的频道分组列表
getChannelsInCategoryByPage 频道分组对用户可见,且用户拥有管理频道的权限 分页查询频道分组下频道列表
此文档是否对你有帮助?
有帮助
我要吐槽
  • 功能介绍
  • 频道分组可见机制
  • 与频道的关联逻辑
  • 与服务器的关联逻辑
  • 实现方法
  • 前提条件
  • 实现流程
  • API 调用时序图
  • 示例代码
  • 相关参考
  • 相关系统通知
  • 相关推送配置
  • API参考