草稿
按会话保存文本草稿,支持跨页面恢复与清除;草稿仅保存在本地。
平台调用风格
进程模型:main(IMLib 客户端 + 本地 SQLite,单写者)/ preload(contextBridge 白名单)/ renderer(薄代理,不直连网络与数据库)。异步接口返回 Promise<RcResult<T>>。
接口一览
| 操作 | 语义 | 传输 | 返回 |
|---|---|---|---|
saveTextMessageDraft | 保存草稿(空串=清除)。 | REST(客户端) | null |
getTextMessageDraft | 读取草稿;无草稿返回空串。 | REST(客户端) | string |
clearTextMessageDraft | 清除草稿。 | REST(客户端) | null |
本页 3 个操作,其中 3 个在本平台绑定中声明了方法签名。
跨端方法名
| 操作 | Android | Web | Electron | macOS | Flutter | Native (C ABI) | iOS |
|---|---|---|---|---|---|---|---|
saveTextMessageDraft | saveTextMessageDraft | saveTextMessageDraft | saveTextMessageDraft | saveTextMessageDraft | saveTextMessageDraft | — | func |
getTextMessageDraft | getTextMessageDraft | getTextMessageDraft | getTextMessageDraft | getTextMessageDraft | getTextMessageDraft | — | func |
clearTextMessageDraft | clearTextMessageDraft | clearTextMessageDraft | clearTextMessageDraft | clearTextMessageDraft | clearTextMessageDraft | — | func |
方法名在 GA 平台之间保持一致(规则 A);Native C ABI 只覆盖部分操作,其余操作以 — 标注。
saveTextMessageDraft
保存草稿(空串=清除)。
saveTextMessageDraft(conversationType: ConversationType, targetId: string, draft: string): Promise<RcResult<null>>参数
| 参数 | 类型 | 说明 |
|---|---|---|
conversationType | ConversationType | 必填;会话类型枚举(ConversationType) |
targetId | string | 必填;目标会话 ID:单聊为对方 userId,群聊为 groupId,聊天室为 chatroomId |
draft | string | 必填;草稿文本,空串表示清除 |
返回
null 无返回数据;成功与否通过错误码判断
示例
JavaScript
await client.saveTextMessageDraft(ConversationType.PRIVATE, 'user2', '明天见'); /* code === 0 为成功 */错误码
| 错误码 | 名称 | 分类 | HTTP | 可重试 | 说明 |
|---|---|---|---|---|---|
1001 | INVALID_PARAMETER | 客户端 / 参数 / 权限 | 400 | 否 | 参数错误 |
1003 | FORBIDDEN | 客户端 / 参数 / 权限 | 403 | 否 | 无权限 |
getTextMessageDraft
读取草稿;无草稿返回空串。
getTextMessageDraft(conversationType: ConversationType, targetId: string): Promise<RcResult<string>>参数
| 参数 | 类型 | 说明 |
|---|---|---|
conversationType | ConversationType | 必填;会话类型枚举(ConversationType) |
targetId | string | 必填;目标会话 ID:单聊为对方 userId,群聊为 groupId,聊天室为 chatroomId |
返回
string 字符串
示例
JavaScript
const res = await client.getTextMessageDraft(ConversationType.PRIVATE, 'user2');
if (res.code !== 0) throw new Error(res.msg);
const data = res.data;错误码
| 错误码 | 名称 | 分类 | HTTP | 可重试 | 说明 |
|---|---|---|---|---|---|
1001 | INVALID_PARAMETER | 客户端 / 参数 / 权限 | 400 | 否 | 参数错误 |
1003 | FORBIDDEN | 客户端 / 参数 / 权限 | 403 | 否 | 无权限 |
clearTextMessageDraft
清除草稿。
clearTextMessageDraft(conversationType: ConversationType, targetId: string): Promise<RcResult<null>>参数
| 参数 | 类型 | 说明 |
|---|---|---|
conversationType | ConversationType | 必填;会话类型枚举(ConversationType) |
targetId | string | 必填;目标会话 ID:单聊为对方 userId,群聊为 groupId,聊天室为 chatroomId |
返回
null 无返回数据;成功与否通过错误码判断
示例
JavaScript
await client.clearTextMessageDraft(ConversationType.PRIVATE, 'user2'); /* code === 0 为成功 */错误码
| 错误码 | 名称 | 分类 | HTTP | 可重试 | 说明 |
|---|---|---|---|---|---|
1001 | INVALID_PARAMETER | 客户端 / 参数 / 权限 | 400 | 否 | 参数错误 |
1003 | FORBIDDEN | 客户端 / 参数 / 权限 | 403 | 否 | 无权限 |
相关文档
- 功能列表:103 个操作与签名
- 状态码:错误码与重试策略
- API 参考:类与成员
- IMLib 集成指南