历史消息
按会话分页拉取云端历史消息,支持向前/向后翻页与本地缓存命中。
契约预留
本平台为 reserved:以下签名来自已冻结绑定,示例为契约样例,不承诺可运行。
平台调用风格
异步风格:Promise<RcResult<T>>(不 reject;错误码在 RcResult.code);uint64/int64 映射为 number,超出安全整数时由实现改用 string。
接口一览
| 操作 | 语义 | 传输 | 返回 |
|---|---|---|---|
getHistoryMessages | 历史消息分页(beforeSeq 向前翻页);limit 默认 20 上限 100。rev23:channelId 过滤超级群频道消息(仅返回该频道消息)。 | REST(客户端) | {messages:Message[], hasMore:bool} |
本页 1 个操作,其中 1 个在本平台绑定中声明了方法签名。
跨端方法名
| 操作 | Android | Web | Electron | macOS | Flutter | Native (C ABI) | iOS |
|---|---|---|---|---|---|---|---|
getHistoryMessages | getHistoryMessages | getHistoryMessages | getHistoryMessages | getHistoryMessages | getHistoryMessages | im_client_history | func |
方法名在 GA 平台之间保持一致(规则 A);Native C ABI 只覆盖部分操作,其余操作以 — 标注。
getHistoryMessages
历史消息分页(beforeSeq 向前翻页);limit 默认 20 上限 100。rev23:channelId 过滤超级群频道消息(仅返回该频道消息)。
getHistoryMessages(conversationType: ConversationType, targetId: string, options?: HistoryOptions): Promise<RcResult<HistoryPage>>参数
| 参数 | 类型 | 说明 |
|---|---|---|
conversationType | ConversationType | 必填;会话类型枚举(ConversationType) |
targetId | string | 必填;目标会话 ID:单聊为对方 userId,群聊为 groupId,聊天室为 chatroomId |
options | {limit?:uint32, beforeSeq?:uint64, channelId?:string} | 可选;选项对象(字段见类型列):{ limit?:uint32, beforeSeq?:uint64, channelId?:string } |
返回
{messages:Message[], hasMore:bool} 历史消息页与是否还有更早数据
示例
TypeScript
// HarmonyOS 绑定为契约预留,以下为声明样例
const res = await client.getHistoryMessages(ConversationType.PRIVATE, 'user2', { });
if (res.code !== 0) { console.error(res.msg); }错误码
| 错误码 | 名称 | 分类 | HTTP | 可重试 | 说明 |
|---|---|---|---|---|---|
1001 | INVALID_PARAMETER | 客户端 / 参数 / 权限 | 400 | 否 | 参数错误 |
1003 | FORBIDDEN | 客户端 / 参数 / 权限 | 403 | 否 | 无权限 |
相关文档
- 功能列表:103 个操作与签名
- 状态码:错误码与重试策略
- API 参考:类与成员
- IMLib 集成指南