消息管理
支持消息撤回(默认 2 分钟窗口,可在控制台调整)与本地消息全文搜索。
平台调用风格
进程模型:main(IMLib 客户端 + 本地 SQLite,单写者)/ preload(contextBridge 白名单)/ renderer(薄代理,不直连网络与数据库)。异步接口返回 Promise<RcResult<T>>。
接口一览
| 操作 | 语义 | 传输 | 返回 |
|---|---|---|---|
recallMessage | 撤回消息(仅发送者、撤回时限内)。成功后本地与对端收到 MESSAGE_RECALLED。 | WS 长连接 | Message |
searchMessages | 在当前用户全部会话中搜索文本消息(倒序)。 | REST(客户端) | {messages:Message[], total:uint32} |
本页 2 个操作,其中 2 个在本平台绑定中声明了方法签名。
跨端方法名
| 操作 | Android | Web | Electron | macOS | Flutter | Native (C ABI) | iOS |
|---|---|---|---|---|---|---|---|
recallMessage | recallMessage | recallMessage | recallMessage | recallMessage | recallMessage | im_client_recall | func |
searchMessages | searchMessages | searchMessages | searchMessages | searchMessages | searchMessages | — | func |
方法名在 GA 平台之间保持一致(规则 A);Native C ABI 只覆盖部分操作,其余操作以 — 标注。
recallMessage
撤回消息(仅发送者、撤回时限内)。成功后本地与对端收到 MESSAGE_RECALLED。
recallMessage(messageId: string | number): Promise<RcResult<Message>>参数
| 参数 | 类型 | 说明 |
|---|---|---|
messageId | string | 必填;消息 ID(服务端生成) |
返回
Message 消息实体(messageId、seq、发送状态)
示例
JavaScript
const res = await client.recallMessage('m_10001');
if (res.code !== 0) throw new Error(res.msg);
const data = res.data;错误码
| 错误码 | 名称 | 分类 | HTTP | 可重试 | 说明 |
|---|---|---|---|---|---|
1001 | INVALID_PARAMETER | 客户端 / 参数 / 权限 | 400 | 否 | 参数错误 |
1003 | FORBIDDEN | 客户端 / 参数 / 权限 | 403 | 否 | 无权限 |
1004 | USER_NOT_FOUND | 客户端 / 参数 / 权限 | 404 | 否 | 用户不存在 |
1022 | RECALL_EXPIRED | 客户端 / 参数 / 权限 | 400 | 否 | 超过撤回时限 |
1023 | MESSAGE_ALREADY_RECALLED | 客户端 / 参数 / 权限 | 400 | 否 | 消息已撤回 |
3001 | SDK_NOT_CONNECTED | SDK 本地 | 0 | 是 | 长连接未就绪 |
searchMessages
在当前用户全部会话中搜索文本消息(倒序)。
searchMessages(options: {keyword: string; limit?: number; conversationType?: ConversationType; targetId?: string; range?: {start?: number; end?: number}}): Promise<RcResult<{messages: Message[]; total: number}>>参数
| 参数 | 类型 | 说明 |
|---|---|---|
options | {keyword:string, limit?:uint32} | 必填;选项对象(字段见类型列):{ keyword:string, limit?:uint32 } |
返回
{messages:Message[], total:uint32} 搜索结果与命中总数
示例
JavaScript
const res = await client.searchMessages({ keyword: '你好' });
if (res.code !== 0) throw new Error(res.msg);
const data = res.data;错误码
| 错误码 | 名称 | 分类 | HTTP | 可重试 | 说明 |
|---|---|---|---|---|---|
1001 | INVALID_PARAMETER | 客户端 / 参数 / 权限 | 400 | 否 | 参数错误 |
1003 | FORBIDDEN | 客户端 / 参数 / 权限 | 403 | 否 | 无权限 |
相关文档
- 功能列表:103 个操作与签名
- 状态码:错误码与重试策略
- API 参考:类与成员
- IMLib 集成指南