---
name: "DownloadTask.offProgressUpdate"
mode: "kit"
versionRequirements:
  - { name: "BaseKit", version: "2.0.1" }
platform:
  - "iOS"
  - "Android"
title: "DownloadTask.onProgressUpdate - 监听下载进度变化事件"
---

## DownloadTask.offProgressUpdate

> [VERSION] BaseKit >= 2.0.1

> [PLATFORM] iOS, Android

### 描述

取消监听下载进度变化事件

### 参数

`(listener: Function)`

| 参数 | 类型 | 必填 | 默认值 | 描述 |
| --- | --- | --- | --- | --- |
| `listener` | `(params: Object) => void` | 是 | - | 事件监听回调函数 |

##### DownloadTask.offProgressUpdate.listener(params) 的属性

| 属性 | 类型 | 必填 | 默认值 | 最低版本 | 描述 |
| --- | --- | --- | --- | --- | --- |
| `progress` | `number` | 是 | - | `2.0.1` | 下载进度百分比 |
| `totalBytesSent` | `number` | 是 | - | `2.0.1` | 已经下载的数据长度，单位 Bytes |
| `totalBytesExpectedToSend` | `number` | 是 | - | `2.0.1` | 预期需要下载的数据总长度，单位 Bytes |
| `requestId` | `string` | 是 | - | `2.0.1` | 网络请求id |


### 示例代码

#### Demo

```tsx
import { downloadFile } from '@ray-js/ray'

// 取消进度监听：先用 ty.downloadFile 拿到下载任务句柄，再在句柄上注册并取消进度监听。
const downloadTask = await downloadFile({
  url: "https://airtake-public-data-1254153901.cos.ap-shanghai.myqcloud.com/ttttestfile/test_video.mp4",
});

const handler = e => {
  console.log(e);
};
downloadTask.onProgressUpdate(handler);
downloadTask.offProgressUpdate(handler);
```