文件上传
上传图片、语音、文件等媒体,返回可发送的消息内容体。
平台调用风格
进程模型:main(IMLib 客户端 + 本地 SQLite,单写者)/ preload(contextBridge 白名单)/ renderer(薄代理,不直连网络与数据库)。异步接口返回 Promise<RcResult<T>>。
接口一览
| 操作 | 语义 | 传输 | 返回 |
|---|---|---|---|
uploadFile | 上传文件(<=20MB),返回可用于图片/文件/语音消息的 url。 | REST(客户端) | {url:string,name:string,size:uint64,mime:string,fullUrl?:string} |
本页 1 个操作,其中 1 个在本平台绑定中声明了方法签名。
跨端方法名
| 操作 | Android | Web | Electron | macOS | Flutter | Native (C ABI) | iOS |
|---|---|---|---|---|---|---|---|
uploadFile | uploadFile | uploadFile | uploadFile | uploadFile | uploadFile | im_client_upload_file | func |
方法名在 GA 平台之间保持一致(规则 A);Native C ABI 只覆盖部分操作,其余操作以 — 标注。
uploadFile
上传文件(<=20MB),返回可用于图片/文件/语音消息的 url。
uploadFile(data: Uint8Array | Blob | {path: string}, name: string, mime?: string, options?: {onProgress?: (percent: number) => void; signal?: AbortSignal}): Promise<RcResult<{url: string; name: string; size: number; mime: string; fullUrl?: string}>>参数
| 参数 | 类型 | 说明 |
|---|---|---|
data | bytes|blob | 必填;文件二进制内容(<=20MB) |
name | string | 必填;名称(群名 / 聊天室名 / 文件名) |
mime | string | 可选;MIME 类型,如 image/png |
返回
{url:string,name:string,size:uint64,mime:string,fullUrl?:string} 上传结果(url 可直接用于媒体消息)
示例
JavaScript
const res = await client.uploadFile(new Uint8Array([1, 2, 3]), 'report.pdf');
if (res.code !== 0) throw new Error(res.msg);
const data = res.data;错误码
| 错误码 | 名称 | 分类 | HTTP | 可重试 | 说明 |
|---|---|---|---|---|---|
1001 | INVALID_PARAMETER | 客户端 / 参数 / 权限 | 400 | 否 | 参数错误 |
1003 | FORBIDDEN | 客户端 / 参数 / 权限 | 403 | 否 | 无权限 |
1007 | MESSAGE_TOO_LARGE | 客户端 / 参数 / 权限 | 400 | 否 | 消息体过大(上限 5KB) |
相关文档
- 功能列表:103 个操作与签名
- 状态码:错误码与重试策略
- API 参考:类与成员
- IMLib 集成指南