IM 即时通讯(增强版)
Web
动态与公告
IM UIKit 更新日志
NIM SDK 更新日志
新手接入指南
产品介绍
简介
产品优势
主要功能
功能介绍
账号集成与登录
基础消息功能
群组功能
聊天室功能
圈组功能
多端登录与互踢策略
海外数据中心
IM 平滑迁移方案
接口及业务限制
体验 Demo
下载 SDK 与 Demo 源码
快速开始
跑通 IM Demo 源码
实现单聊消息收发(不含 UI)
实现聊天室登录(不含 UI)
实现圈组消息收发(不含 UI)
含 UI 集成
什么是 IM UIKit
IM UIKit 功能列表
快速集成 IM UIKit
非React框架快速集成
非React框架集成 IM UIKit
非 React 框架自定义示渲染
组件导入
初始化
全局上下文
登录相关
会话列表相关
集成会话列表界面
自定义会话列表界面 UI
会话消息相关
集成会话界面
实现自定义消息收发
自定义会话界面 UI
用户资料相关
集成用户资料组件
通讯录相关
集成通讯录界面
自定义通讯录界面 UI
搜素组件相关
集成搜索组件
自定义搜索组件 UI
主题样式设置
语言设置
初始化(兼容 NIM SDK)
常见问题
如何解决样式冲突
不含 UI 集成
集成 SDK
IM 登录与初始化相关
初始化并登录 IM
注销登录与销毁实例
多端登录与互踢
消息收发
历史消息
消息扩展
最近会话
服务端会话服务
用户资料托管
好友关系托管
在线状态订阅
系统通知
群组功能
群组概述
群组管理
群成员管理
群消息管理
超大群功能
超大群概述
超大群管理
超大群成员管理
超大群消息管理
反垃圾
聊天室功能
聊天室概述
聊天室初始化与登录相关
初始化并登录聊天室
注销登录与销毁实例
聊天室标签功能
聊天室消息管理
聊天室成员管理
聊天室信息管理
聊天室队列服务
圈组功能
圈组概述
初始化与登录
通用接口校验说明
服务器相关
服务器概述
服务器管理
服务器成员管理
游客功能
服务器未读数管理
频道相关
频道概述
频道管理
频道黑白名单
频道分组
频道分组黑白名单
频道未读数管理
实时互动频道
搜索服务器与频道
身份组相关
身份组概述
身份组应用场景
服务器身份组
频道身份组
频道用户定制权限
频道分组身份组
自定义权限项
成员权限查询与判定
身份组相关查询
圈组订阅机制
圈组消息相关
圈组消息收发
圈组消息撤回
圈组消息更新
圈组消息删除
消息正在输入
获取频道最后一条消息
会话消息回复(Thread)
圈组快捷评论
圈组消息搜索
查询历史消息
查询@我的消息
圈组系统通知相关
圈组系统通知概述
圈组系统通知收发
圈组系统通知更新
圈组内容审核
圈组第三方回调
圈组相关抄送
圈组各端接口命名差异
融合存储方案
最佳实践
聊天室重要消息投递
API 参考
NIM SDK API 参考
状态码
IM 控制台指南
创建应用
注册 IM 账号
升级服务
服务协议

最近会话

更新时间: 2023/04/12 10:24:56

最近会话(Session) ,即最近联系人列表,它记录了与用户最近有过会话的联系人信息,包括联系人帐号、联系人类型、最近一条消息的时间、消息状态、消息内容、未读条数等信息。

最近会话的 API 都挂载在 session 模块中,使用 nim.session 进行访问,具体接口请参见 interface SessionServiceInterface

生成规则

SDK 会根据漫游消息和离线消息来生成初始会话列表, 在收到消息和发送消息之后,SDK 会更新会话列表。在没有数据库支持时,SDK 内存中会维护一份会话列表。

会话对象

会话对象(type Session)的重要参数如下:

类型 参数名 说明
string id 会话 id,例如 p2p-cs1、team-113879441
string scene 会话场景 p2p、team、superTeam
string to 聊天对象
number unread 未读数
object lastMsg 上一条消息
number ack 自己已读过的最近一条消息的时间
number msgReceiptTime 聊天对象所读过的最近一条消息的时间
  • 己方发送了某条消息 msgFromSelf, 想判定对方是否已读,msgFromSelf.time > session.msgReceiptTime 证明对方未读。
  • 对方发送的的消息 msgFromOtherSide, 想判定己方是否已读,msgFromOtherSide.time > session.ack 证明己方未读。

获取本地会话

获取最近会话列表,一般用于首页显示会话列表。

示例代码如下:

const session = await nim.session.getSession({
  id: 'p2p-cs1'
})

const sessions = await nim.session.getSessions({
  "limit": 10,
  "desc": true
})

const sessions = await nim.session.getAllSessions(
)

删除会话

删除最近会话列表,可以删除指定的会话,也可以删除全部会话。

  • 通过 deleteSession 方法删除指定的会话,同时可选发送协议,让服务器清除此会话的漫游消息。在下一次登录时,如果没有新的消息下发,则不会再次生成会话。
  • 通过 deleteAllSessionsFromLocal 方法删除所有本地缓存的会话,如果会话内存在消息,则在下一次登录时继续生成会话。

若开发者使用了置顶会话功能,那么推荐您在删除会话时进行判定(是否存在云端置顶会话),根据自身需求决定是否取消置顶会话,具体请参见示例代码。

示例代码如下:

// 假设已经得到一个 `p2p-cs1` 的 session,并且其中存在着若干条消息
// first time init
const nim = new NIMSDK(options)
await nim.connect()
await nim.session.deleteAllSessionsFromLocal()
var session = nim.session.getSession({ id: 'p2p-cs1' })
console.log(session) // undefined
await nim.destroy()
nim = null

// second time init
const nim1 = new NIMSDK(options)
await nim1.connect()
var session = nim1.session.getSession({ id: 'p2p-cs1' })
console.log(session) // { sessionId: 'p2p-cs1', ... }
// 若存在云端置顶会话,则去移除会话的置顶。
if (session.stickTopInfo && session.stickTopInfo.isStickOnTop) {
  await nim1.session.deleteStickTopSession({
    "id": "p2p-cjhz1"
  })
}
await nim1.session.deleteSession({
  // sessionId
  "id": "p2p-cs1",
  // true: delete roaming msg in session。
  "isSyncToServer": true
})
var session = nim1.session.getSession({ id: 'p2p-cs1' })
console.log(session) // undefined
await nim1.destroy()
nim1 = null

// third time init
const nim2 = new NIMSDK(options)
await nim2.connect()
var session = nim1.session.getSession({ id: 'p2p-cs1' })
console.log(session) // undefined

重置会话未读数

重置当前会话,SDK 会自动管理消息的未读数。

示例代码如下:

await nim.session.resetSessionUnreadCount({
  "id": "p2p-cs2",
})

var session = nim1.session.getSession({ id: 'p2p-cs2' })
console.log(session.unread) // 0

// or you can reset all session unread count
// await nim.session.resetAllSessionsUnreadCount()

置顶会话

会话置顶功能需要单独开通,您可通过云信官网提供的联系方式咨询商务经理开通。

SDK 支持置顶/取消置顶/更新置顶最近会话。将会话设置为云端置顶后,IM 服务器将会在云端记录中置顶会话,包括会话id,置顶的扩展字段等信息。

示例代码如下:

let session = await nim.session.addStickTopSession({
  "id": "p2p-cjhz1",
  "ext": "extensions"
})

console.log(session)
{
//     "id": "p2p-cjhz1",
//     "scene": "p2p",
//     "to": "cjhz1",
//     "lastMsg": { ... },
//     "updateTime": 1658739496811,
//     "unread": 0,
//     "unreadMsgs": [],
//     "ack": 1656587535333,
//     "stickTopInfo": {
//         "id": "p2p-cjhz1",
//         "ext": "extensions",
//         "createTime": 1659063314105,
//         "updateTime": 1659063314105,
//         "isStickOnTop": true
//     }
// }

session = await nim.session.updateStickTopSession({
  "id": "p2p-cjhz1",
  "ext": "extensions_1"
})

session = await nim.session.deleteStickTopSession({
  "id": "p2p-cjhz1"
})

对比 IM1

IM Web Elite 与 IM1 对比,废弃了 setCurrentSession 功能。

IM1 版本的 setCurrentSession 的效果是:会将此会话未读数置为 0,并且实例能收到 updateSession 事件代表会话被更新,之后此会话在收到消息时不再更新未读数。

为了更灵活的处理已读未读和未读计数逻辑,推荐您结合 resetSessionUnreadCountsendMsgReceipt 使用。

  1. UI 上进入会话时,首先调用 resetSessionUnreadCount + sendMsgReceipt 清除一遍会话数量和标记消息已读。
  2. 记录当前激活的会话id。每当收到 updateSession 事件,判断后调用 resetSessionUnreadCount 清除此会话未读数。
此文档是否对你有帮助?
有帮助
我要吐槽
  • 生成规则
  • 会话对象
  • 获取本地会话
  • 删除会话
  • 重置会话未读数
  • 置顶会话
  • 对比 IM1