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:24:00

服务器未读数,指圈组服务器下所有频道的总未读数。网易云信 NIM SDK 的QChatServerUnreadInfoChangedEvent接口定义了圈组服务器未读信息变更事件。用户在圈组频道内发送或删除消息后,SDK 触发该事件,事件信息包含未读信息QChatServerUnreadInfo。您可调用QChatServiceObserver接口的observeServerUnreadInfoChanged方法监听该事件。

本文介绍获取服务器未读数并按需清空的实现方法以及相应的示例代码。

游客接收到的消息无已读未读逻辑。不支持对游客展示消息未读数。

前提条件

实现流程

流程概览

以下时序图可能因为网络问题显示异常。如显示异常,一般刷新当前页面即可正常显示。

uml diagram

流程说明

以下仅对上图中标为橙色的流程进行详细说明。

  1. 用户A 调用 observeServerUnreadInfoChanged 方法监听QChatServerUnreadInfoChangedEvent

    示例代码如下:

    //监听服务器未读数
    NIMClient.getService(QChatServiceObserver.class).observeServerUnreadInfoChanged(new Observer<QChatServerUnreadInfoChangedEvent>() {
        @Override
        public void onEvent(QChatServerUnreadInfoChangedEvent event) {
            //获取变更后服务器未读信息列表
            List<QChatServerUnreadInfo> serverUnreadInfos = event.getServerUnreadInfos();
            //遍历变更的服务器未读信息
            for (QChatServerUnreadInfo serverUnreadInfo : serverUnreadInfos) {
                
            }
        }
    },true);
    
  2. 根据服务器下的频道数量,按如下方法订阅服务器下的所有频道的未读数。订阅后 SDK 获取并缓存各频道的初始未读数。

    • 如果目标服务器下的频道数量不超过 200 个,则用户A 可调用subscribeAllChannel方法一次性订阅服务器下所有的频道的未读数(单次调用最多可传入 10 个 服务器 ID)。
    • 如果目标服务器下的频道数量超过 200 个,则用户 A 需多次调用subscribeChannel方法订阅服务器下所有频道的未读数(单次调用最多可订阅 100 个频道)。
    • 通过subscribeAllChannel订阅频道,单次调用可传入的服务器 ID 数量上限为 10 个。即使多次调用,单个服务器下最多仅能订阅 200 个 频道。如果目标服务器下频道数量大于 200,需改用subscribeChannel方法订阅服务器下所有频道(单次调用最多可订阅 100 个频道)。
    • 获取服务器的精确未读数,必须订阅服务器下的所有频道的未读数。

    示例代码如下:

    调用 subscribeAllChannel 的示例
    QChatSubscribeType type = QChatSubscribeType.CHANNEL_MSG;
    List<Long> serverIds = getServerIds();
    QChatSubscribeAllChannelParam param = new QChatSubscribeAllChannelParam(type,serverIds);
    NIMClient.getService(QChatServerService.class).subscribeAllChannel(param).setCallback(
            new RequestCallback<QChatSubscribeAllChannelResult>() {
                @Override
                public void onSuccess(QChatSubscribeAllChannelResult result) {
                    //订阅成功的频道未读信息
                    List<QChatUnreadInfo> unreadInfoList = result.getUnreadInfoList();
                    //订阅失败的频道Id列表
                    List<Long> failedList = result.getFailedList();
                }
    
                @Override
                public void onFailed(int code) {
                    
                }
    
                @Override
                public void onException(Throwable exception) {
    
                }
            });
    
    调用 subscribeChannel 的示例
    //获取server下所有channelId信息
    List<QChatChannelIdInfo> channelIdInfos = getAllChannelIdInfoOfServer(311254);
    QChatSubscribeChannelParam param = new QChatSubscribeChannelParam(QChatSubscribeType.CHANNEL_MSG_UNREAD_COUNT, QChatSubscribeOperateType.SUB,channelIdInfos);
    NIMClient.getService(QChatChannelService.class).subscribeChannel(param).setCallback(new RequestCallback<QChatSubscribeChannelResult>() {
        @Override
        public void onSuccess(QChatSubscribeChannelResult result) {
            //订阅成功
        }
    
        @Override
        public void onFailed(int code) {
            //订阅失败
        }
    
        @Override
        public void onException(Throwable exception) {
            //订阅异常
        }
    });
    
  3. 其他用户发送消息删除消息后,SDK 对服务器下所有已订阅频道的未读数进行累加计算。

    未读数累加规则如下:

    • 接到新消息,某个频道未读数 +1 时:
      • 如果累加未读数达到未读数上限(maxCount),则触发QChatServerUnreadInfoChangedEvent,并给出maxCount
      • 如果累加未读数没有达到maxCount,则触发QChatServerUnreadInfoChangedEvent,并给出累加未读数。
    • 消息被删除,某个频道未读数 - 1 时:
      • 如果累加未读数达到maxCount,则触发QChatServerUnreadInfoChangedEvent,并给出maxCount
      • 如果累加未读数没有达到maxCount,则触发QChatServerUnreadInfoChangedEvent,并给出累加未读数。
  4. SDK 计算完所有已订阅频道的累加未读数(QChatServerUnreadInfo)后,将其返回给用户A。

    服务器累加未读数在达到maxCount后,QChatServerUnreadInfoChangedEvent事件将不会触发。

  5. 如需清空该服务器的未读数,可调用markRead方法清空。

    示例代码如下:

    List<Long> serverIds = getServerIds();
    NIMClient.getService(QChatServerService.class).markRead(new QChatServerMarkReadParam(serverIds)).setCallback(
            new RequestCallback<QChatServerMarkReadResult>() {
                @Override
                public void onSuccess(QChatServerMarkReadResult result) {
                    //清空未读数成功的服务器Id列表
                    List<Long> successServerIds = result.getSuccessServerIds();
                    //清空未读数失败的服务器Id列表
                    List<Long> failedServerIds = result.getFailedServerIds();
                }
    
                @Override
                public void onFailed(int code) {
    
                }
    
                @Override
                public void onException(Throwable exception) {
    
                }
            });
    

API参考

API
说明
subscribeAllChannel 一次性订阅服务器下最多 200 个频道,可按不同的订阅策略对频道相关事件和系统通知进行订阅。单次调用可传入的服务器 ID 数量上限为 10 个。即使多次调用,单个服务器下最多仅能订阅 200 个 频道
subscribeChannel 订阅服务器下的频道,单次调用最多订阅 100 个频道
observeServerUnreadInfoChanged 注册/注销服务器未读通知接收观察者
markRead 清空服务器的未读数,即将服务器下所有频道的消息未读数清空
此文档是否对你有帮助?
有帮助
我要吐槽
  • 前提条件
  • 实现流程
  • 流程概览
  • 流程说明
  • API参考