浏览 SDKs · uni-app / uni-app x
平台
SDKsuni-app / uni-app x

取消文件上传

使用上传任务的取消 ID 终止尚未完成的文件上传。

复制

调用 uploadFile() 时传入 cancelID 后,可以使用同一个值调用 cancelUpload(),终止仍在进行的上传任务。

import { cancelUpload } from '@/uni_modules/unix-openim-sdk'

await cancelUpload({ cancelID })

cancelID 是唯一必填字段,应在开始上传前生成,并与业务侧的上传任务一起保存。不要用文件名或列表下标代替取消 ID;并发上传时,每个任务必须使用不同的值。

Promise 成功表示 SDK 已完成取消请求。任务已经结束、取消 ID 不存在或服务端已经接收完整文件时,实际结果可能取决于当前上传阶段;界面应以原上传 Promise 的最终结果为准,并避免在用户取消后继续写入头像、附件等业务数据。

取消上传不会删除已经由业务保存的远端资源,也不会撤销已经发送的消息。完整上传参数和进度监听见上传文件