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

功能描述

用户在登录 App 后,可以展示最近会话列表,方便找到目标会话。
会话列表功能主要分为获取会话列表、监听会话列表更新事件。
核心数据结构 Conversation

获取会话列表

接入侧可通过调用 getConversationList 接口主动获取会话列表。
接口
chat.getConversationList(options);
参数
名称
类型
描述
options
undefined | Array | Object
options 不传表示获取全部会话
options 传入数组参数表示获取指定的多个会话,如果传入空数组,则接口不返回数
options 传入 { type, markType, groupName, hasUnreadCount, hasGroupAtInfo }表示按这些条件过滤会话列表。

返回值
Promise
示例
// 获取全量的会话列表
let promise = chat.getConversationList();
promise.then(function(imResponse) {
// 全量的会话列表,用该列表覆盖原有的会话列表
const conversationList = imResponse.data.conversationList;
// 从云端同步会话列表是否完成
const isSyncCompleted = imResponse.data.isSyncCompleted;
}).catch(function(imError) {
// 获取会话列表失败的相关信息
console.warn('getConversationList error:', imError);
});
// 获取指定的会话列表
let promise = chat.getConversationList([
conversationID1,
conversationID2
]);
promise.then(function(imResponse) {
// 缓存中已存在的指定的会话列表
const conversationList = imResponse.data.conversationList;
}).catch(function(imError) {
// 获取会话列表失败的相关信息
console.warn('getConversationList error:', imError);
});
// 获取所有的群会话
let promise = chat.getConversationList({
type: TencentCloudChat.TYPES.CONV_GROUP
});
promise.then(function(imResponse) {
const conversationList = imResponse.data.conversationList; // 会话列表
});
// 获取所有的“标星”会话
let promise = chat.getConversationList({
markType: TencentCloudChat.TYPES.CONV_MARK_TYPE_STAR
});
promise.then(function(imResponse) {
const conversationList = imResponse.data.conversationList; // 会话列表
});
// 获取所有的无标记的会话(v3.3.0起支持)
let promise = chat.getConversationList({ markType: 0 });
promise.then(function(imResponse) {
const conversationList = imResponse.data.conversationList; // 会话列表
});
// 获取指定会话分组下的所有会话
let promise = chat.getConversationList({ groupName: 'Suppliers' });
promise.then(function(imResponse) {
const conversationList = imResponse.data.conversationList; // 会话列表
});
// 获取不属于任何分组的会话(v3.3.0起支持)
let promise = chat.getConversationList({ groupName: '' });
promise.then(function(imResponse) {
const conversationList = imResponse.data.conversationList; // 会话列表
});
// 获取有未读数的会话(v3.3.0起支持)
let promise = chat.getConversationList({ hasUnreadCount: true });
promise.then(function(imResponse) {
const conversationList = imResponse.data.conversationList; // 会话列表
});
// 获取有群 @ 消息的会话(v3.3.0起支持)
let promise = chat.getConversationList({ hasGroupAtInfo: true });
promise.then(function(imResponse) {
const conversationList = imResponse.data.conversationList; // 会话列表
});

监听会话列表更新事件

接入侧监听 TencentCloudChat.EVENT.CONVERSATION_LIST_UPDATED 事件,获取会话列表更新的通知。
示例
let onConversationListUpdated = function(event) {
console.log(event.data); // 包含 Conversation 实例的数组
};
chat.on(TencentCloudChat.EVENT.CONVERSATION_LIST_UPDATED, onConversationListUpdated);


帮助和支持

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

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

文档反馈