ks.uploadFile

更新时间：2024-09-19 14:44:22

基础库1.26.1开始支持,低版本需做兼容处理

开发者工具1.22.0开始支持

将本地资源上传到服务器，客户端发起一个 HTTPS POST 请求。

使用前请注意阅读相关说明 (opens new window)。

参数

Object object

属性	类型	默认值	必填	说明
url	string		是	开发者服务器地址
filePath	string		是	要上传文件资源的路径 (本地路径)
name	string		是	文件对应的 key，开发者在服务端可以通过这个 key 获取文件的二进制内容
header	Object		否	HTTP 请求 Header，Header 中不能设置 Referer，content-type
formData	Object		否	HTTP 请求中其他额外的 form data
timeout	number		否	超时时间，单位为毫秒
success	function		否	接口调用成功的回调函数
fail	function		否	接口调用失败的回调函数
complete	function		否	接口调用结束的回调函数（调用成功、失败都会执行）

object.success 回调函数

参数

Object res

属性	类型	说明
data	string	开发者服务器返回的数据
statusCode	number	开发者服务器返回的 HTTP 状态码

返回值

UploadTask

一个可以监听上传进度进度变化的事件和取消上传的对象

错误信息

错误信息	错误说明
upload has up to max count:10	同时上传任务数超限
file not exists	文件不存在
host/url not in domain list	host/url 不在白名单内

示例代码

ks.chooseImage({
    sizeType: 'compressed',
    sourceType: 'album',
    success(res) {
        const tempFilePaths = res.tempFilePaths;
        ks.uploadFile({
            url: 'https://example.com/upload', // 仅为示例，非真实的接口地址
            filePath: tempFilePaths[0],
            name: 'file',
            formData: {
                user: 'test',
            },
            success(res) {
                const data = res.data;
                // do something
            },
        });
    },
});