文件上传

上传图片、语音、文件等媒体,返回可发送的消息内容体。

平台调用风格

进程模型:main(客户端 + 本地库,单写者)/ preload(contextBridge 具名方法)/ renderer(薄代理)。renderer 不直连网络与数据库。

接口一览​

操作语义传输返回
uploadFile上传文件(<=20MB),返回可用于图片/文件/语音消息的 url。REST(客户端){url:string,name:string,size:uint64,mime:string,fullUrl?:string}

本页 1 个操作,其中 1 个在本平台绑定中声明了方法签名。

跨端方法名​

操作AndroidWebElectronmacOSFlutterNative (C ABI)iOS
uploadFileuploadFileuploadFileuploadFileuploadFileuploadFileim_client_upload_filefunc

方法名在 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}>>
REST(客户端)since 1.0.0
参数
参数类型说明
databytes|blob必填;文件二进制内容(<=20MB)
namestring必填;名称(群名 / 聊天室名 / 文件名)
mimestring可选;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可重试说明
1001INVALID_PARAMETER客户端 / 参数 / 权限400否参数错误
1003FORBIDDEN客户端 / 参数 / 权限403否无权限
1007MESSAGE_TOO_LARGE客户端 / 参数 / 权限400否消息体过大(上限 5KB)

相关文档​