Skip to content

uploadFile

描述

将本地文件上传到网络。

网页应用需要完成鉴权后调用该接口。

支持说明

客户端平台WPS协作版本要求
iOS>=2.3.0
Android>=2.3.0

输入

名称数据类型是否必填描述
paramsobject
∟ filePathstring要上传文件资源的路径,可通过chooseFile等接口获取
∟ formDataobjectHttp 请求中额外的 Form Data
注意:仅uploadType为1时有效
∟ headerobjectHTTP 请求 Header
注意:header 不支持设置 referer,content-type不可变更
∟ methodstring请求方法
可选值:
• POST
• PUT
默认为: POST
∟ namestring文件对应的 key,开发者在服务端可以通过这个 key 获取文件的二进制内容
默认为:file
注意:仅uploadType为1时有效
∟ uploadTypenumber上传方式
可能值:
• 1:表单上传,content-type为multipart/form-data
• 2:二进制流上传
默认值:1
∟ urlstring开发者服务器地址

输出

名称类型描述
headerobject开发者服务器返回的header,base64字符串
responsestring响应体,base64字符串
statusCodenumberHttp状态码
注意:5.24.0以上版本支持

示例代码

ts
const header = {
 //开发者请求url自定义header
 token:"xxxxxxx"
}
const formData = {}
const params = {
 url:'https://www.ksyun.com/',
 filePath:'storage/emulated/0/Download/xxx.txt',
 header:header,
 formData:formData
};
// 调用sdk后会返回一个包含几个方法的uploadTask对象
const uploadTask = window.ksoxz_sdk.uploadFile({params, onSuccess, onError});

错误码

errnomsg含义
1042001No such file or directory找不到文件或目录
1043103Connect timed out网络连接超时
1043100Request error请求开发者接口错误。请根据 extras 字段返回信息获取上传接口的业务报错,extras 包含字段为statusCode: Http 状态码response:响应体,base64 字符串。header:开发者服务器返回的 header,base64 字符串。

错误码

参考:公共错误码