服务端会话服务
更新时间: 2024/03/14 19:21:15
服务端会话列表服务(CloudSession) ,即服务端的最近联系人列表,它记录了与用户最近有过会话的联系人信息,包括联系人账号、最近一条消息的时间、扩展字段、消息内容等信息。
服务端会话列表服务的 API 都挂载在 CloudSession 模块中,具体接口请参见 interface CloudSessionServiceInterface。
服务端会话列表服务与本地最近会话不同,其提供了新的会话列表获取服务,需要从云端拉取,不支持同步到本地最近会话列表。
-
服务器支持存储用户全量的会话历史列表以及保存最近一条消息;
-
客户端获取会话列表,支持按照需要指定获取的会话数,不与本地会话合并;
-
不支持未读数;
获取服务端会话列表
通过 queryCloudSessionList
方法获取服务端会话列表,不依赖本地数据。
- API 原型
queryCloudSessionList(options: NIMEQueryCloudSessionListOptions): Promise<NIMEQueryCloudSessionListResult>
- NIMEQueryCloudSessionListOptions 参数说明
参数 | 类型 | 说明 |
---|---|---|
maxTimestamp | Number | 查询时间戳,与 minTimestamp 组成一个时间段,默认 0,表示不限制 |
minTimestamp | Number | 查询时间戳,与 maxTimestamp 组成一个时间段,默认 0,表示不限制 |
limit | Number | 单页查询的会话数量,默认 100,最大 100 |
includedLastMsg | Boolean | 是否需要返回 last msg,默认 true |
- NIMEQueryCloudSessionListResult 参数说明
参数 | 类型 | 说明 |
---|---|---|
sessionList | NIMECloudSession[] | 查询到的会话列表 |
hasMore | Boolean | 是否下一页还有数据 |
获取服务端指定会话
通过 queryCloudSession
方法获取指定的服务端会话的详细信息。
- API 原型
queryCloudSession(options: NIMEQueryCloudSessionOptions): Promise<NIMECloudSession>
- NIMEQueryCloudSessionOptions 参数说明
参数 | 类型 | 说明 |
---|---|---|
sessionId | String | 会话 ID,分为 P2P/Team/SuperTeam,分别对应用户 ID(accid), 群 ID(tid),超大群 ID(tid) |
修改服务端会话扩展信息
通过 updateCloudSession
方法修改服务端会话的扩展信息,扩展信息仅自己可见。
- API 原型
updateCloudSession(options: NIMEUpdateCloudSessionOptions): Promise<void>
- NIMEUpdateCloudSessionOptions 参数说明
参数 | 类型 | 说明 |
---|---|---|
sessionId | String | 会话 ID,分为 P2P/Team/SuperTeam,分别对应用户 ID(accid), 群 ID(tid),超大群 ID(tid) |
ext | String | 会话的扩展字段,仅自己可见 |
删除服务端会话
通过 deleteCloudSessionList
方法删除服务端会话。
- API 原型
deleteCloudSessionList(options: NIMEDeleteCloudSessionListOptions): Promise<void>
- NIMEDeleteCloudSessionListOptions 参数说明
参数 | 类型 | 说明 |
---|---|---|
sessionIdList | Array of string | 需要删除的会话 ID 列表,每一项分为 P2P/Team/SuperTeam,分别对应 用户 ID(accid),群 ID(tid),超大群 ID(tid) |
此文档是否对你有帮助?