简体中文
下载文件资源到本地,客户端直接发起一个 HTTP GET 请求,返回文件的本地临时路径。
下载文件常见场景是apk的下载更新,app升级中心是一个现成的开源项目,实现下载进度在通知栏显示等复杂交互,可直接使用。
名称 | 类型 | 必填 | 默认值 | 描述 | ||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
options | DownloadFileOptions | 是 | - | |||||||||||||||||||||||||||||||||||||||||
|
名称 | 类型 | 必备 | 默认值 | 描述 |
---|---|---|---|---|
tempFilePath | string | 是 | - | 临时文件路径,下载后的文件会存储到一个临时文件 |
statusCode | number | 是 | - | 开发者服务器返回的 HTTP 状态码 |
Android | iOS | web | |
---|---|---|---|
tempFilePath | 3.9 | 4.11 | - |
statusCode | 3.9 | 4.11 | - |
名称 | 类型 | 必备 | 默认值 | 描述 |
---|---|---|---|---|
errCode | 5 | 1000 | 100001 | 100002 | 600003 | 600009 | 602001 | 是 | - | 错误码 - 5 接口超时 - 1000 服务端系统错误 - 100001 json数据解析错误 - 100002 错误信息json解析失败 - 600003 网络中断 - 600009 URL格式不合法 - 602001 request系统错误 |
errSubject | string | 是 | - | 统一错误主题(模块)名称 |
data | any | null | 否 | - | 错误信息中包含的数据 |
cause | Error | null | 否 | - | 源错误信息,可以包含多个错误,详见SourceError |
errMsg | string | 是 | - | - |
Android | iOS | web | |
---|---|---|---|
url | 3.9 | 4.11 | - |
header | 3.9 | 4.11 | - |
filePath | 3.9 | 4.11 | - |
timeout | 3.9 | 4.11 | - |
uni.env.CACHE_PATH/cache/uni-download
。但在HBuilderX 3.99前有过几次变更,3.98的目录是uni.env.CACHE_PATH/cache/uniDownloads
,而3.98之前则不在cache目录下。类型 |
---|
DownloadTask |
中断下载任务。
Android | iOS | web |
---|---|---|
3.9 | 4.11 | 4.0 |
监听下载进度变化。
名称 | 类型 | 必填 | 默认值 | 描述 |
---|---|---|---|---|
callback | (result: OnProgressDownloadResult) => void | 是 | - |
名称 | 类型 | 必备 | 默认值 | 描述 |
---|---|---|---|---|
progress | number | 是 | - | 下载进度百分比 |
totalBytesWritten | number | 是 | - | 已经下载的数据长度,单位 Bytes |
totalBytesExpectedToWrite | number | 是 | - | 预期需要下载的数据总长度,单位 Bytes |
Android | iOS | web | |
---|---|---|---|
progress | 3.9 | 4.11 | - |
totalBytesWritten | 3.9 | 4.11 | - |
totalBytesExpectedToWrite | 3.9 | 4.11 | - |
Android | iOS | web |
---|---|---|
3.9 | 4.11 | 4.0 |
Android | iOS | web |
---|---|---|
3.9 | 4.11 | 4.0 |
Template
Script
<template>
<!-- #ifdef APP -->
<scroll-view style="flex: 1">
<!-- #endif -->
<view>
<page-head :title="title"></page-head>
<view>
<view v-if="imageSrc">
<image class="img" :src="imageSrc" mode="aspectFit" />
</view>
<view v-else style="margin: 10px;">
<text class="uni-hello-text">点击按钮下载服务端示例图片(下载网络文件到本地临时目录)</text>
<button type="primary" @tap="downloadImage">下载</button>
</view>
</view>
</view>
<!-- #ifdef APP -->
</scroll-view>
<!-- #endif -->
</template>
<style>
.img {
margin: 0 auto;
}
</style>
名称 | 类型 | 必备 | 默认值 | 描述 |
---|---|---|---|---|
errMsg | string | 是 | - | 错误信息 |