tencent cloud

即时通信 IM

动态与公告
产品动态
公告
产品简介
产品概述
基本概念
应用场景
功能介绍
账号系统
用户资料与关系链
消息管理
群组相关
公众号系统
音视频通话 Call
使用限制
购买指南
计费概述
价格说明
购买指引
续费指引
停服说明
退费说明
开发指引
Demo 专区
开通服务
体验 Demo
快速跑通
下载中心
SDK & Demo 源码
更新日志
聊天互动(含 UI)
TUIKit 组件介绍
快速开始
全功能接入
单功能接入
AI 集成
构建基础界面
更多特性
定义外观
国际化界面语言
推送服务(Push)
服务概述
名词解释
开通服务
快速跑通
厂商通道
数据统计
排查工具
客户端 API
服务端 API
推送回调
高级功能
更新日志
错误码
常见问题
智能客服
功能概述
快速入门
集成指引
管理员操作手册
客服操作手册
更多实践
直播间搭建
AI 聊天机器人方案
超大娱乐协作社群
Discord 实现指南
游戏内集成 Chat 指南
类 WhatsApp Channel 搭建方案
发送红包
Chat 应对防火墙限制相关
无 UI 集成
快速开始
集成 SDK
初始化
登录登出
消息相关
会话相关
群组相关
社群话题
用户管理
离线推送
云端搜索
本地搜索
公众号
客户端 API
JavaScript
Android
iOS & macOS
Swift
Flutter
Electron
Unity
React Native
C 接口
C++
服务端 API
生成 UserSig
REST API
第三方回调
控制台指南
新版控制台介绍
创建并升级应用
基本配置
功能配置
账号管理
群组管理
公众号管理
回调配置
用量统计
资源包查看指南
实时监控
开发辅助工具
访问管理
高级功能
常见问题
uni-app 常见问题
购买相关问题
SDK 相关问题
账号鉴权相关问题
用户资料与关系链相关问题
消息相关问题
群组相关问题
直播群相关问题
昵称头像相关问题
协议与认证
服务等级协议
安全合规认证
IM 政策
隐私政策
数据隐私和安全协议
平滑迁移方案
平滑迁移完整版
平滑迁移简化版
错误码
联系我们

React Native

PDF
聚焦模式
字号
最后更新时间: 2024-11-20 15:50:48

功能描述

用户的会话列表中一般会有若干个会话,如果某个会话收到了新消息,通常需要在列表的 cell 中以小红点或者数字角标的方式,向用户展示该会话的未读消息数,提醒用户尚未阅读。
用户点击进入该会话后退回到会话列表,未读消息数被清空,小红点消失。部分应用还会统计所有会话的未读消息总数之和,将其展示在会话列表的底部 tab 上。

获取所有会话未读消息总数

说明:
1. 仅适用于好友工作群(Work)、陌生人社交群(Public)、社群(Community)和临时会议群(Meeting),直播群(AVChatRoom)暂不支持。
2. 未读总数会减去设置为免打扰的会话的未读数。
3. 未读总数不计算系统会话的未读数。
4. 因为该接口依赖 SDK 从云端同步会话列表,所以登录成功后立即调用该接口获取到的未读总数可能为 0,接入侧可以结合 TOTAL_UNREAD_MESSAGE_COUNT_UPDATED 事件更新本地的未读总数。
接口
chat.getTotalUnreadMessageCount();
返回值
Number
示例
// 获取单聊和群聊会话的未读总数
let totalUnreadCount = chat.getTotalUnreadMessageCount();

会话未读总数变更通知

示例
let onTotalUnreadMessageCountUpdated = function(event) {
console.log(event.data); // 当前单聊和群聊会话的未读总数
};
chat.on(TencentCloudChat.EVENT.TOTAL_UNREAD_MESSAGE_COUNT_UPDATED, onTotalUnreadMessageCountUpdated);

清空会话未读消息数

接口
chat.setMessageRead(options);
参数 optionsObject类型,包含的属性值如下:
参数
参数
类型
说明
conversationID
String
会话 ID。会话 ID 组成方式:
C2C${userID}(单聊)
GROUP{groupID}(群聊)
GROUP${topicID}(话题)
@TIM#SYSTEM(系统通知会话)
返回值
Promise
示例
// 将某会话下所有未读消息已读上报
let promise = chat.setMessageRead({conversationID: 'C2Cexample'});
promise.then(function(imResponse) {
// 已读上报成功,指定 ID 的会话的 unreadCount 属性值被置为0
}).catch(function(imError) {
// 已读上报失败
console.warn('setMessageRead error:', imError);
});

清空所有会话未读消息数

chat.setAllMessageRead(options);
参数 optionsObject 类型,包含的属性值如下:
参数
参数
类型
说明
scope
String | undefined
设置消息处理的范围。详细类型如下:
TencentCloudChat.TYPES.READ_ALL_C2C_MSG (设置所有 C2C 会话未读消息为已读)
TencentCloudChat.TYPES.READ_ALL_GROUP_MSG (设置所有群会话未读消息为已读)
TencentCloudChat.TYPES.READ_ALL_MSG (默认值,设置所有 C2C 和群会话未读消息为已读)
返回值
Promise
示例
// 将所有会话的未读消息全部设置为已读
let promise = chat.setAllMessageRead(); // 等同于 chat.setAllMessageRead({scope: TIM.TYPES.READ_ALL_MSG})
promise.then(function(imResponse) {
// 已读上报成功,所有会话的 unreadCount 属性值被置为0
}).catch(function(imError) {
// 已读上报失败
console.warn('setAllMessageRead error:', imError);
});
// 将所有 C2C 会话的未读消息全部设置为已读
let promise = chat.setAllMessageRead({scope: TencentCloudChat.TYPES.READ_ALL_C2C_MSG});
promise.then(function(imResponse) {
// 已读上报成功,所有 C2C 会话的 unreadCount 属性值被置为0
}).catch(function(imError) {
// 已读上报失败
console.warn('setAllMessageRead error:', imError);
});
// 将所有群会话的未读消息全部设置为已读
let promise = chat.setAllMessageRead({scope: TencentCloudChat.TYPES.READ_ALL_GROUP_MSG});
promise.then(function(imResponse) {
// 已读上报成功,所有 C2C 会话的 unreadCount 属性值被置为0
}).catch(function(imError) {
// 已读上报失败
console.warn('setAllMessageRead error:', imError);
});

发送不计入会话未读数的消息

正常情况下,无论是发送单聊消息还是群消息,都会计入未读消息数(会话对象 Conversation 的 unreadCount 属性,表示一个会话的未读消息数)。
当您希望发送一些不计入未读计数的消息时,例如提示类或者控制类的消息,可以参考以下示例代码。
示例
chat.sendMessage(message, {
messageControlInfo: {
excludedFromUnreadCount: true, // 消息不更新会话 unreadCount(消息存漫游)
excludedFromLastMessage: true // 消息不更新会话 lastMessage(消息存漫游)
}
});


帮助和支持

本页内容是否解决了您的问题?

填写满意度调查问卷,共创更好文档体验。

文档反馈