抖音开放平台Logo
控制台

DownloadTask.offProgressUpdate
收藏
我的收藏

基础库 1.0.0 开始支持本方法，这是一个同步方法。

取消监听下载进度变化事件，其中 DownloadTask 是通过 tt.downloadFile() 返回的对象。

前提条件无
业务背景无
使用限制无
注意事项无
支持沙盒
否
相关教程无

语法

DownloadTask.offProgressUpdate(callback)

参数说明

callback

类型默认值必填说明最低支持版本
function是
需要取消监听的回调函数
1.0.0

callback 是一个回调函数，接收 object 类型的参数，属性如下：

属性名类型说明最低支持版本
progressnumber
下载进度
1.0.0
totalBytesWrittennumber
已经下载的数据长度，单位 byte
1.0.0
totalBytesExpectedToWritenumber
预期需要下载的数据总长度，单位 byte
1.0.0

返回值

无

代码示例

开发者工具中预览

const task = tt.downloadFile({
  url: "", // 输入真实的下载地址
});

const callback = (res) => {
  console.log("onProgressUpdate", res);
};

task.onProgressUpdate(callback); // 监听下载进度
task.offProgressUpdate(callback); // 取消监听下载进度