获取会话(Electron)
本文档仅适用于 Electron 解决方案,仅限于配合 Electron 模块 (@rongcloud/electron 与 @rongcloud/electron-renderer)使用。
本文档描述了如何从客户端本地获取会话。
获取本地全部会话
提示
从 SDK 5.4.0 开始支持该接口 。注意:获取本地会话必须在调用 RongIMLib.connect()
并且成功建立连接之后执行。
调用 electronExtension.getAllConversationList 获取本地全部会话。
RongIMLib.electronExtension.getAllConversationList().then(res => {
if (res.code === 0) {
console.log(res.code, res.data)
} else {
console.log(res.code, res.msg)
}
})
参数 | 类型 | 必填 | 说明 |
---|---|---|---|
channelId | String | 否 | 频道Id, 默认获取所有频道的会话列表 |
分页获取本地会话
提示
从 SDK 5.4.0 开始支持该接口。注意:获取本地会话必须在调用 RongIMLib.connect()
并且成功建立连接之后执行。
调用 electronExtension.getConversationList 分页获取本地会话列表。
const startTime = 0
const count = 10
RongIMLib.electronExtension.getConversationList(startTime, count).then(res => {
if (res.code === 0) {
console.log(res.code, res.data)
} else {
console.log(res.code, res.msg)
}
})
参数 | 类型 | 必填 | 说明 |
---|---|---|---|
startTime | Number | 是 | 时间戳,需要精确到毫秒,0表示当前时间 |
count | Number | 是 | 数量 |
channelId | string | 否 | 频道Id,默认获取所有频道的会话列表 |
topPriority | Boolean | 否 | 获取会话列表是否按置顶状态排序,默认 false |
批量获取会话信息
注意
从 SDK 5.9.9 开始支持该接口。注意:获取本地会话必须在调用
RongIMLib.connect()
并且成功建立连接之后执行。
// 最多支持获取 100
const conversations = [{ targetId:"user1", conversationType:1 }];
RongIMLib.electronExtension.getConversations(conversations).then(res => {
if (res.code === 0) {
console.log(res.code, res.data)
} else {
console.log(res.code, res.msg)
}
})
参数 | 类型 | 必填 | 说明 |
---|---|---|---|
conversations | IConversationOption[] | 是 | 会话 IConversationOption 的数组,一次最多获取 100 个会话。IConversationOption 必须提供会话类型(ConversationType)和会话 ID(targetId ) |