Skip to content
体验新版
项目
组织
正在加载...
登录
切换导航
打开侧边栏
OpenHarmony
Docs
提交
624ebd36
D
Docs
项目概览
OpenHarmony
/
Docs
1 年多 前同步成功
通知
159
Star
292
Fork
28
代码
文件
提交
分支
Tags
贡献者
分支图
Diff
Issue
0
列表
看板
标记
里程碑
合并请求
0
Wiki
0
Wiki
分析
仓库
DevOps
项目成员
Pages
D
Docs
项目概览
项目概览
详情
发布
仓库
仓库
文件
提交
分支
标签
贡献者
分支图
比较
Issue
0
Issue
0
列表
看板
标记
里程碑
合并请求
0
合并请求
0
Pages
分析
分析
仓库分析
DevOps
Wiki
0
Wiki
成员
成员
收起侧边栏
关闭侧边栏
动态
分支图
创建新Issue
提交
Issue看板
提交
624ebd36
编写于
12月 06, 2022
作者:
A
anyueling
浏览文件
操作
浏览文件
下载
电子邮件补丁
差异文件
API参考内容优化改进
Signed-off-by:
N
anyueling
<
anyueling@huawei.com
>
上级
e2b63e42
变更
1
隐藏空白更改
内联
并排
Showing
1 changed file
with
273 addition
and
279 deletion
+273
-279
zh-cn/application-dev/reference/apis/js-apis-request.md
zh-cn/application-dev/reference/apis/js-apis-request.md
+273
-279
未找到文件。
zh-cn/application-dev/reference/apis/js-apis-request.md
浏览文件 @
624ebd36
...
...
@@ -68,16 +68,12 @@ var config = {
| SESSION_SUCCESSFUL
<sup>
7+
</sup>
| number | 是 | 否 | 下载会话已完成。 |
## request.upload
## request.upload
File<sup>9+</sup>
upload
(
config: UploadConfig): Promise
<
UploadTask
>
upload
File(context: BaseContext,
config: UploadConfig): Promise
<
UploadTask
>
上传,异步方法,使用promise形式返回结果。
此接口仅可在FA模型下使用
> **说明:** 从API Version 9开始废弃,建议使用[request.uploadFile<sup>9+</sup>](#requestuploadfile9)替代。
**需要权限**
:ohos.permission.INTERNET
**系统能力**
: SystemCapability.MiscServices.Upload
...
...
@@ -86,16 +82,25 @@ upload(config: UploadConfig): Promise<UploadTask>
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| context | BaseContext | 是 | 基于应用程序的上下文。 |
| config |
[
UploadConfig
](
#uploadconfig
)
| 是 | 上传的配置信息。 |
**返回值:**
| 类型 | 说明 |
| -------- | -------- |
| Promise
<
[UploadTask](#uploadtask)
>
| 返回上传任务。 |
**错误码:**
以下错误码的详细介绍请参见
[
上传下载错误码
](
../errorcodes/errorcode-request.md
)
。
| 错误码ID | 错误信息 |
| -------- | -------- |
| 13400002 | Bad file path. |
**示例:**
```
js
let
uploadTask
;
let
uploadConfig
=
{
...
...
@@ -105,24 +110,20 @@ upload(config: UploadConfig): Promise<UploadTask>
files
:
[{
filename
:
"
test
"
,
name
:
"
test
"
,
uri
:
"
internal://cache/test.jpg
"
,
type
:
"
jpg
"
}],
data
:
[{
name
:
"
name123
"
,
value
:
"
123
"
}],
};
request
.
upload
(
uploadConfig
).
then
((
data
)
=>
{
request
.
upload
File
(
globalThis
.
abilityContext
,
uploadConfig
).
then
((
data
)
=>
{
uploadTask
=
data
;
}).
catch
((
err
)
=>
{
console
.
error
(
'
Failed to request the upload. Cause:
'
+
JSON
.
stringify
(
err
));
})
})
;
```
## request.upload
## request.upload
File<sup>9+</sup>
upload
(
config: UploadConfig, callback: AsyncCallback
<
UploadTask
>
): void
upload
File(context: BaseContext,
config: UploadConfig, callback: AsyncCallback
<
UploadTask
>
): void
上传,异步方法,使用callback形式返回结果。
此接口仅可在FA模型下使用
> **说明:** 从API Version 9开始废弃,建议使用[request.uploadFile<sup>9+</sup>](#requestuploadfile9-1)替代。
**需要权限**
:ohos.permission.INTERNET
**系统能力**
: SystemCapability.MiscServices.Upload
...
...
@@ -131,11 +132,19 @@ upload(config: UploadConfig, callback: AsyncCallback<UploadTask>): void
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| context | BaseContext | 是 | 基于应用程序的上下文。 |
| config |
[
UploadConfig
](
#uploadconfig
)
| 是 | 上传的配置信息。 |
| callback | AsyncCallback
<
[UploadTask](#uploadtask)
>
| 是 | 回调函数,异步返回UploadTask对象。 |
**错误码:**
以下错误码的详细介绍请参见
[
上传下载错误码
](
../errorcodes/errorcode-request.md
)
。
| 错误码ID | 错误信息 |
| -------- | -------- |
| 13400002 | Bad file path. |
**示例:**
```
js
let
uploadTask
;
let
uploadConfig
=
{
...
...
@@ -145,7 +154,7 @@ upload(config: UploadConfig, callback: AsyncCallback<UploadTask>): void
files
:
[{
filename
:
"
test
"
,
name
:
"
test
"
,
uri
:
"
internal://cache/test.jpg
"
,
type
:
"
jpg
"
}],
data
:
[{
name
:
"
name123
"
,
value
:
"
123
"
}],
};
request
.
upload
(
uploadConfig
,
(
err
,
data
)
=>
{
request
.
upload
File
(
globalThis
.
abilityContext
,
uploadConfig
,
(
err
,
data
)
=>
{
if
(
err
)
{
console
.
error
(
'
Failed to request the upload. Cause:
'
+
JSON
.
stringify
(
err
));
return
;
...
...
@@ -153,13 +162,16 @@ upload(config: UploadConfig, callback: AsyncCallback<UploadTask>): void
uploadTask
=
data
;
});
```
## request.upload<sup>9+</sup>
upload(context: BaseContext, config: UploadConfig): Promise
<
UploadTask
>
## request.upload<sup>(deprecated)</sup>
upload(config: UploadConfig): Promise
<
UploadTask
>
上传,异步方法,使用promise形式返回结果。
> **说明:** 从API Version 9开始废弃,建议使用[request.uploadFile<sup>9+</sup>](#requestuploadfile9)替代。
**模型约束**
:此接口仅可在FA模型下使用
> **说明:** 从API Version 9开始不再维护,建议使用[request.uploadFile<sup>9+</sup>](#requestuploadfile9)替代。
**需要权限**
:ohos.permission.INTERNET
...
...
@@ -169,9 +181,7 @@ upload(context: BaseContext, config: UploadConfig): Promise<UploadTask>
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| context | BaseContext | 是 | 基于应用程序的上下文。 |
| config |
[
UploadConfig
](
#uploadconfig
)
| 是 | 上传的配置信息。 |
**返回值:**
...
...
@@ -180,7 +190,7 @@ upload(context: BaseContext, config: UploadConfig): Promise<UploadTask>
| Promise
<
[UploadTask](#uploadtask)
>
| 返回上传任务。 |
**示例:**
```
js
let
uploadTask
;
let
uploadConfig
=
{
...
...
@@ -190,21 +200,23 @@ upload(context: BaseContext, config: UploadConfig): Promise<UploadTask>
files
:
[{
filename
:
"
test
"
,
name
:
"
test
"
,
uri
:
"
internal://cache/test.jpg
"
,
type
:
"
jpg
"
}],
data
:
[{
name
:
"
name123
"
,
value
:
"
123
"
}],
};
request
.
upload
(
globalThis
.
abilityContext
,
uploadConfig
).
then
((
data
)
=>
{
request
.
upload
(
uploadConfig
).
then
((
data
)
=>
{
uploadTask
=
data
;
}).
catch
((
err
)
=>
{
console
.
error
(
'
Failed to request the upload. Cause:
'
+
JSON
.
stringify
(
err
));
})
;
})
```
## request.upload<sup>
9+
</sup>
## request.upload<sup>
(deprecated)
</sup>
upload(con
text: BaseContext, con
fig: UploadConfig, callback: AsyncCallback
<
UploadTask
>
): void
upload(config: UploadConfig, callback: AsyncCallback
<
UploadTask
>
): void
上传,异步方法,使用callback形式返回结果。
> **说明:** 从API Version 9开始废弃,建议使用[request.uploadFile<sup>9+</sup>](#requestuploadfile9-1)替代。
**模型约束**
:此接口仅可在FA模型下使用
> **说明:** 从API Version 9开始不再维护,建议使用[request.uploadFile<sup>9+</sup>](#requestuploadfile9-1)替代。
**需要权限**
:ohos.permission.INTERNET
...
...
@@ -214,12 +226,11 @@ upload(context: BaseContext, config: UploadConfig, callback: AsyncCallback<Up
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| context | BaseContext | 是 | 基于应用程序的上下文。 |
| config |
[
UploadConfig
](
#uploadconfig
)
| 是 | 上传的配置信息。 |
| callback | AsyncCallback
<
[UploadTask](#uploadtask)
>
| 是 | 回调函数,异步返回UploadTask对象。 |
**示例:**
```
js
let
uploadTask
;
let
uploadConfig
=
{
...
...
@@ -229,7 +240,7 @@ upload(context: BaseContext, config: UploadConfig, callback: AsyncCallback<Up
files
:
[{
filename
:
"
test
"
,
name
:
"
test
"
,
uri
:
"
internal://cache/test.jpg
"
,
type
:
"
jpg
"
}],
data
:
[{
name
:
"
name123
"
,
value
:
"
123
"
}],
};
request
.
upload
(
globalThis
.
abilityContext
,
uploadConfig
,
(
err
,
data
)
=>
{
request
.
upload
(
uploadConfig
,
(
err
,
data
)
=>
{
if
(
err
)
{
console
.
error
(
'
Failed to request the upload. Cause:
'
+
JSON
.
stringify
(
err
));
return
;
...
...
@@ -238,37 +249,31 @@ upload(context: BaseContext, config: UploadConfig, callback: AsyncCallback<Up
});
```
## request.upload<sup>(deprecated)</sup>
## request.uploadFile<sup>9+</sup>
uploadFile(context: BaseContext, config: UploadConfig): Promise
<
UploadTask
>
upload(context: BaseContext, config: UploadConfig): Promise
<
UploadTask
>
上传,异步方法,使用promise形式返回结果。
> **说明:** 从API Version 9开始支持,从API Version 9开始不再维护,建议使用[request.uploadFile<sup>9+</sup>](#requestuploadfile9)替代。
**需要权限**
:ohos.permission.INTERNET
**系统能力**
: SystemCapability.MiscServices.Upload
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| context | BaseContext | 是 | 基于应用程序的上下文。 |
| config |
[
UploadConfig
](
#uploadconfig
)
| 是 | 上传的配置信息。 |
| context | BaseContext | 是 | 基于应用程序的上下文。 |
| config |
[
UploadConfig
](
#uploadconfig
)
| 是 | 上传的配置信息。 |
**返回值:**
| 类型 | 说明 |
| 类型 | 说明 |
| -------- | -------- |
| Promise
<
[UploadTask](#uploadtask)
>
| 返回上传任务。 |
**错误码:**
以下错误码的详细介绍请参见
[
上传下载错误码
](
../errorcodes/errorcode-request.md
)
。
| 错误码ID | 错误信息 |
| -------- | -------- |
| 13400002 | Bad file path. |
| Promise
<
[UploadTask](#uploadtask)
>
| 返回上传任务。 |
**示例:**
...
...
@@ -281,7 +286,7 @@ uploadFile(context: BaseContext, config: UploadConfig): Promise<UploadTask>
files
:
[{
filename
:
"
test
"
,
name
:
"
test
"
,
uri
:
"
internal://cache/test.jpg
"
,
type
:
"
jpg
"
}],
data
:
[{
name
:
"
name123
"
,
value
:
"
123
"
}],
};
request
.
upload
File
(
globalThis
.
abilityContext
,
uploadConfig
).
then
((
data
)
=>
{
request
.
upload
(
globalThis
.
abilityContext
,
uploadConfig
).
then
((
data
)
=>
{
uploadTask
=
data
;
}).
catch
((
err
)
=>
{
console
.
error
(
'
Failed to request the upload. Cause:
'
+
JSON
.
stringify
(
err
));
...
...
@@ -289,30 +294,25 @@ uploadFile(context: BaseContext, config: UploadConfig): Promise<UploadTask>
```
## request.upload
File<sup>9+
</sup>
## request.upload
<sup>(deprecated)
</sup>
upload
File
(context: BaseContext, config: UploadConfig, callback: AsyncCallback
<
UploadTask
>
): void
upload(context: BaseContext, config: UploadConfig, callback: AsyncCallback
<
UploadTask
>
): void
上传,异步方法,使用callback形式返回结果。
> **说明:** 从API Version 9开始支持,从API Version 9开始不再维护,建议使用[request.uploadFile<sup>9+</sup>](#requestuploadfile9-1)替代。
**需要权限**
:ohos.permission.INTERNET
**系统能力**
: SystemCapability.MiscServices.Upload
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| context | BaseContext | 是 | 基于应用程序的上下文。 |
| config |
[
UploadConfig
](
#uploadconfig
)
| 是 | 上传的配置信息。 |
| callback | AsyncCallback
<
[UploadTask](#uploadtask)
>
| 是 | 回调函数,异步返回UploadTask对象。 |
**错误码:**
以下错误码的详细介绍请参见
[
上传下载错误码
](
../errorcodes/errorcode-request.md
)
。
| 错误码ID | 错误信息 |
| -------- | -------- |
| 13400002 | Bad file path. |
| context | BaseContext | 是 | 基于应用程序的上下文。 |
| config |
[
UploadConfig
](
#uploadconfig
)
| 是 | 上传的配置信息。 |
| callback | AsyncCallback
<
[UploadTask](#uploadtask)
>
| 是 | 回调函数,异步返回UploadTask对象。 |
**示例:**
...
...
@@ -325,7 +325,7 @@ uploadFile(context: BaseContext, config: UploadConfig, callback: AsyncCallback&l
files
:
[{
filename
:
"
test
"
,
name
:
"
test
"
,
uri
:
"
internal://cache/test.jpg
"
,
type
:
"
jpg
"
}],
data
:
[{
name
:
"
name123
"
,
value
:
"
123
"
}],
};
request
.
upload
File
(
globalThis
.
abilityContext
,
uploadConfig
,
(
err
,
data
)
=>
{
request
.
upload
(
globalThis
.
abilityContext
,
uploadConfig
,
(
err
,
data
)
=>
{
if
(
err
)
{
console
.
error
(
'
Failed to request the upload. Cause:
'
+
JSON
.
stringify
(
err
));
return
;
...
...
@@ -334,7 +334,6 @@ uploadFile(context: BaseContext, config: UploadConfig, callback: AsyncCallback&l
});
```
## UploadTask
上传任务,使用下列方法前,需要先获取UploadTask对象。
...
...
@@ -365,7 +364,7 @@ on(type: 'progress', callback:(uploadedSize: number, totalSize: number) => vo
| totalSize | number | 是 | 上传文件的总大小,单位为KB。 |
**示例:**
```
js
let
uploadTask
;
uploadTask
.
on
(
'
progress
'
,
function
callback
(
uploadedSize
,
totalSize
)
{
...
...
@@ -399,7 +398,7 @@ on(type: 'headerReceive', callback: (header: object) => void): void
| header | object | 是 | HTTP
Response
Header。 |
**示例:**
```
js
let
uploadTask
;
uploadTask
.
on
(
'
headerReceive
'
,
function
callback
(
headers
){
...
...
@@ -433,7 +432,7 @@ on(type: 'headerReceive', callback: (header: object) => void): void
| taskstates | Array
<
[TaskState](#taskstate9)
>
| 是 | 上传任务返回结果 |
**示例:**
```
js
let
uploadTask
;
uploadTask
.
on
(
'
complete
'
,
function
callback
(
taskStates
)
{
...
...
@@ -477,7 +476,7 @@ off(type: 'progress', callback?: (uploadedSize: number, totalSize: number) =&g
| totalSize | number | 是 | 上传文件的总大小,单位为KB。 |
**示例:**
```
js
let
uploadTask
;
uploadTask
.
off
(
'
progress
'
,
function
callback
(
uploadedSize
,
totalSize
)
{
...
...
@@ -511,7 +510,7 @@ off(type: 'headerReceive', callback?: (header: object) => void): void
| header | object | 是 | HTTP
Response
Header。 |
**示例:**
```
js
let
uploadTask
;
uploadTask
.
off
(
'
headerReceive
'
,
function
callback
(
headers
)
{
...
...
@@ -544,7 +543,7 @@ off(type: 'headerReceive', callback?: (header: object) => void): void
| taskstates | Array
<
[TaskState](#taskstate9)
>
| 是 | 上传任务返回结果 |
**示例:**
```
js
let
uploadTask
;
uploadTask
.
off
(
'
complete
'
,
function
callback
(
taskStates
)
{
...
...
@@ -562,15 +561,11 @@ off(type: 'headerReceive', callback?: (header: object) => void): void
);
```
### remove
remove(): Promise
<
boolean
>
### delete<sup>9+</sup>
delete(): Promise
<
boolean
>
移除上传的任务,异步方法,使用promise形式返回结果。
> **说明:** 从API Version 9开始废弃,建议使用[delete<sup>9+</sup>](#delete9)替代。
**需要权限**
:ohos.permission.INTERNET
**系统能力**
: SystemCapability.MiscServices.Upload
...
...
@@ -582,10 +577,10 @@ remove(): Promise<boolean>
| Promise
<
boolean
>
| 移除任务是否成功。true:成功,false:不成功。 |
**示例:**
```
js
let
uploadTask
;
uploadTask
.
remov
e
().
then
((
result
)
=>
{
uploadTask
.
delet
e
().
then
((
result
)
=>
{
if
(
result
)
{
console
.
info
(
'
Upload task removed successfully.
'
);
}
else
{
...
...
@@ -597,14 +592,12 @@ remove(): Promise<boolean>
```
###
remove
###
delete<sup>9+</sup>
remov
e(callback: AsyncCallback
<
boolean
>
): void
delet
e(callback: AsyncCallback
<
boolean
>
): void
移除上传的任务,异步方法,使用callback形式返回结果。
> **说明:** 从API Version 9开始废弃,建议使用[delete<sup>9+</sup>](#delete9-1)替代。
**需要权限**
:ohos.permission.INTERNET
**系统能力**
: SystemCapability.MiscServices.Upload
...
...
@@ -616,10 +609,10 @@ remove(callback: AsyncCallback<boolean>): void
| callback | AsyncCallback
<
boolean
>
| 是 | 移除任务的回调函数。 |
**示例:**
```
js
let
uploadTask
;
uploadTask
.
remov
e
((
err
,
result
)
=>
{
uploadTask
.
delet
e
((
err
,
result
)
=>
{
if
(
err
)
{
console
.
error
(
'
Failed to remove the upload task. Cause:
'
+
JSON
.
stringify
(
err
));
return
;
...
...
@@ -633,27 +626,29 @@ remove(callback: AsyncCallback<boolean>): void
```
###
delete<sup>9+
</sup>
###
remove<sup>(deprecated)
</sup>
delet
e(): Promise
<
boolean
>
remov
e(): Promise
<
boolean
>
移除上传的任务,异步方法,使用promise形式返回结果。
> **说明:** 从API Version 9开始不再维护,建议使用[delete<sup>9+</sup>](#delete9)替代。
**需要权限**
:ohos.permission.INTERNET
**系统能力**
: SystemCapability.MiscServices.Upload
**返回值:**
| 类型 | 说明 |
| 类型 | 说明 |
| -------- | -------- |
| Promise
<
boolean
>
| 移除任务是否成功。true:成功,false:不成功。 |
| Promise
<
boolean
>
| 移除任务是否成功。true:成功,false:不成功。 |
**示例:**
```
js
let
uploadTask
;
uploadTask
.
delet
e
().
then
((
result
)
=>
{
uploadTask
.
remov
e
().
then
((
result
)
=>
{
if
(
result
)
{
console
.
info
(
'
Upload task removed successfully.
'
);
}
else
{
...
...
@@ -665,27 +660,29 @@ delete(): Promise<boolean>
```
###
delete<sup>9+
</sup>
###
remove<sup>(deprecated)
</sup>
delet
e(callback: AsyncCallback
<
boolean
>
): void
remov
e(callback: AsyncCallback
<
boolean
>
): void
移除上传的任务,异步方法,使用callback形式返回结果。
> **说明:** 从API Version 9开始不再维护,建议使用[delete<sup>9+</sup>](#delete9-1)替代。
**需要权限**
:ohos.permission.INTERNET
**系统能力**
: SystemCapability.MiscServices.Upload
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| callback | AsyncCallback
<
boolean
>
| 是 | 移除任务的回调函数。 |
| callback | AsyncCallback
<
boolean
>
| 是 | 移除任务的回调函数。 |
**示例:**
```
js
let
uploadTask
;
uploadTask
.
delet
e
((
err
,
result
)
=>
{
uploadTask
.
remov
e
((
err
,
result
)
=>
{
if
(
err
)
{
console
.
error
(
'
Failed to remove the upload task. Cause:
'
+
JSON
.
stringify
(
err
));
return
;
...
...
@@ -698,7 +695,6 @@ delete(callback: AsyncCallback<boolean>): void
});
```
## UploadConfig
**需要权限**
:ohos.permission.INTERNET
...
...
@@ -750,17 +746,12 @@ delete(callback: AsyncCallback<boolean>): void
| name | string | 是 | 表示表单元素的名称。 |
| value | string | 是 | 表示表单元素的值。 |
## request.downloadFile<sup>9+</sup>
## request.download
download(config: DownloadConfig): Promise
<
DownloadTask
>
downloadFile(context: BaseContext, config: DownloadConfig): Promise
<
DownloadTask
>
下载,异步方法,使用promise形式返回结果。
> **说明:** 从API Version 9开始废弃,建议使用[request.downloadFile<sup>9+</sup>](#requestdownloadfile9)替代。
此接口仅可在FA模型下使用
**需要权限**
:ohos.permission.INTERNET
**系统能力**
: SystemCapability.MiscServices.Download
...
...
@@ -769,6 +760,7 @@ download(config: DownloadConfig): Promise<DownloadTask>
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| context | BaseContext | 是 | 基于应用程序的上下文。 |
| config |
[
DownloadConfig
](
#downloadconfig
)
| 是 | 下载的配置信息。 |
**返回值:**
...
...
@@ -777,11 +769,20 @@ download(config: DownloadConfig): Promise<DownloadTask>
| -------- | -------- |
| Promise
<
[DownloadTask](#downloadtask)
>
| 返回下载任务。 |
**错误码:**
以下错误码的详细介绍请参见
[
上传下载错误码
](
../errorcodes/errorcode-request.md
)
。
| 错误码ID | 错误信息 |
| -------- | -------- |
| 13400001 | File operation error. |
| 13400002 | Bad file path. |
| 13400003 | Task manager service error. |
**示例:**
```
js
let
downloadTask
;
request
.
download
(
{
url
:
'
https://xxxx/xxxx.hap
'
}).
then
((
data
)
=>
{
request
.
download
File
(
globalThis
.
abilityContext
,
{
url
:
'
https://xxxx/xxxx.hap
'
}).
then
((
data
)
=>
{
downloadTask
=
data
;
}).
catch
((
err
)
=>
{
console
.
error
(
'
Failed to request the download. Cause:
'
+
JSON
.
stringify
(
err
));
...
...
@@ -789,16 +790,12 @@ download(config: DownloadConfig): Promise<DownloadTask>
```
## request.download
## request.download
File<sup>9+</sup>
download
(config: DownloadConfig, callback: AsyncCallback
<
DownloadTask
>
): void
download
File(context: BaseContext, config: DownloadConfig, callback: AsyncCallback
<
DownloadTask
>
): void;
下载,异步方法,使用callback形式返回结果。
> **说明:** 从API Version 9开始废弃,建议使用[request.downloadFile<sup>9+</sup>](#requestdownloadfile9-1)替代。
此接口仅可在FA模型下使用
**需要权限**
:ohos.permission.INTERNET
**系统能力**
: SystemCapability.MiscServices.Download
...
...
@@ -807,14 +804,24 @@ download(config: DownloadConfig, callback: AsyncCallback<DownloadTask>): v
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| context | BaseContext | 是 | 基于应用程序的上下文。 |
| config |
[
DownloadConfig
](
#downloadconfig
)
| 是 | 下载的配置信息。 |
| callback | AsyncCallback
<
[DownloadTask](#downloadtask)
>
| 是 | 下载接口的回调函数。 |
**错误码:**
以下错误码的详细介绍请参见
[
上传下载错误码
](
../errorcodes/errorcode-request.md
)
。
| 错误码ID | 错误信息 |
| -------- | -------- |
| 13400001 | File operation error. |
| 13400002 | Bad file path. |
| 13400003 | Task manager service error. |
**示例:**
```
js
let
downloadTask
;
request
.
download
(
{
url
:
'
https://xxxx/xxxxx.hap
'
,
request
.
download
File
(
globalThis
.
abilityContext
,
{
url
:
'
https://xxxx/xxxxx.hap
'
,
filePath
:
'
xxx/xxxxx.hap
'
},
(
err
,
data
)
=>
{
if
(
err
)
{
console
.
error
(
'
Failed to request the download. Cause:
'
+
JSON
.
stringify
(
err
));
...
...
@@ -824,13 +831,15 @@ download(config: DownloadConfig, callback: AsyncCallback<DownloadTask>): v
});
```
## request.download<sup>
9+
</sup>
## request.download<sup>
(deprecated)
</sup>
download(con
text: BaseContext, con
fig: DownloadConfig): Promise
<
DownloadTask
>
download(config: DownloadConfig): Promise
<
DownloadTask
>
下载,异步方法,使用promise形式返回结果。
> **说明:** 从API Version 9开始废弃,建议使用[request.downloadFile<sup>9+</sup>](#requestdownloadfile9)替代。
> **说明:** 从API Version 9开始不再维护,建议使用[request.downloadFile<sup>9+</sup>](#requestdownloadfile9)替代。
**模型约束**
:此接口仅可在FA模型下使用
**需要权限**
:ohos.permission.INTERNET
...
...
@@ -840,7 +849,6 @@ download(context: BaseContext, config: DownloadConfig): Promise<DownloadTask&
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| context | BaseContext | 是 | 基于应用程序的上下文。 |
| config |
[
DownloadConfig
](
#downloadconfig
)
| 是 | 下载的配置信息。 |
**返回值:**
...
...
@@ -850,10 +858,10 @@ download(context: BaseContext, config: DownloadConfig): Promise<DownloadTask&
| Promise
<
[DownloadTask](#downloadtask)
>
| 返回下载任务。 |
**示例:**
```
js
let
downloadTask
;
request
.
download
(
globalThis
.
abilityContext
,
{
url
:
'
https://xxxx/xxxx.hap
'
}).
then
((
data
)
=>
{
request
.
download
({
url
:
'
https://xxxx/xxxx.hap
'
}).
then
((
data
)
=>
{
downloadTask
=
data
;
}).
catch
((
err
)
=>
{
console
.
error
(
'
Failed to request the download. Cause:
'
+
JSON
.
stringify
(
err
));
...
...
@@ -861,13 +869,15 @@ download(context: BaseContext, config: DownloadConfig): Promise<DownloadTask&
```
## request.download<sup>
9+
</sup>
## request.download<sup>
(deprecated)
</sup>
download(con
text: BaseContext, config: DownloadConfig, callback: AsyncCallback
<
DownloadTask
>
): void;
download(con
fig: DownloadConfig, callback: AsyncCallback
<
DownloadTask
>
): void
下载,异步方法,使用callback形式返回结果。
> **说明:** 从API Version 9开始废弃,建议使用[request.downloadFile<sup>9+</sup>](#requestdownloadfile9-1)替代。
> **说明:** 从API Version 9开始不再维护,建议使用[request.downloadFile<sup>9+</sup>](#requestdownloadfile9-1)替代。
**模型约束**
:此接口仅可在FA模型下使用
**需要权限**
:ohos.permission.INTERNET
...
...
@@ -877,15 +887,14 @@ download(context: BaseContext, config: DownloadConfig, callback: AsyncCallback&l
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| context | BaseContext | 是 | 基于应用程序的上下文。 |
| config |
[
DownloadConfig
](
#downloadconfig
)
| 是 | 下载的配置信息。 |
| callback | AsyncCallback
<
[DownloadTask](#downloadtask)
>
| 是 | 下载接口的回调函数。 |
**示例:**
```
js
let
downloadTask
;
request
.
download
(
globalThis
.
abilityContext
,
{
url
:
'
https://xxxx/xxxxx.hap
'
,
request
.
download
({
url
:
'
https://xxxx/xxxxx.hap
'
,
filePath
:
'
xxx/xxxxx.hap
'
},
(
err
,
data
)
=>
{
if
(
err
)
{
console
.
error
(
'
Failed to request the download. Cause:
'
+
JSON
.
stringify
(
err
));
...
...
@@ -895,44 +904,36 @@ download(context: BaseContext, config: DownloadConfig, callback: AsyncCallback&l
});
```
## request.download<sup>(deprecated)</sup>
## request.downloadFile<sup>9+</sup>
downloadFile(context: BaseContext, config: DownloadConfig): Promise
<
DownloadTask
>
download(context: BaseContext, config: DownloadConfig): Promise
<
DownloadTask
>
下载,异步方法,使用promise形式返回结果。
> **说明:** 从API Version 9开始支持,从API Version 9开始不再维护,建议使用[request.downloadFile<sup>9+</sup>](#requestdownloadfile9)替代。
**需要权限**
:ohos.permission.INTERNET
**系统能力**
: SystemCapability.MiscServices.Download
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| context | BaseContext | 是 | 基于应用程序的上下文。 |
| config |
[
DownloadConfig
](
#downloadconfig
)
| 是 | 下载的配置信息。 |
| context | BaseContext | 是 | 基于应用程序的上下文。 |
| config |
[
DownloadConfig
](
#downloadconfig
)
| 是 | 下载的配置信息。 |
**返回值:**
| 类型 | 说明 |
| 类型 | 说明 |
| -------- | -------- |
| Promise
<
[DownloadTask](#downloadtask)
>
| 返回下载任务。 |
**错误码:**
以下错误码的详细介绍请参见
[
上传下载错误码
](
../errorcodes/errorcode-request.md
)
。
| 错误码ID | 错误信息 |
| -------- | -------- |
| 13400001 | File operation error. |
| 13400002 | Bad file path. |
| 13400003 | Task manager service error. |
| Promise
<
[DownloadTask](#downloadtask)
>
| 返回下载任务。 |
**示例:**
```
js
let
downloadTask
;
request
.
download
File
(
globalThis
.
abilityContext
,
{
url
:
'
https://xxxx/xxxx.hap
'
}).
then
((
data
)
=>
{
request
.
download
(
globalThis
.
abilityContext
,
{
url
:
'
https://xxxx/xxxx.hap
'
}).
then
((
data
)
=>
{
downloadTask
=
data
;
}).
catch
((
err
)
=>
{
console
.
error
(
'
Failed to request the download. Cause:
'
+
JSON
.
stringify
(
err
));
...
...
@@ -940,38 +941,31 @@ downloadFile(context: BaseContext, config: DownloadConfig): Promise<DownloadT
```
## request.download
File<sup>9+
</sup>
## request.download
<sup>(deprecated)
</sup>
download
File
(context: BaseContext, config: DownloadConfig, callback: AsyncCallback
<
DownloadTask
>
): void;
download(context: BaseContext, config: DownloadConfig, callback: AsyncCallback
<
DownloadTask
>
): void;
下载,异步方法,使用callback形式返回结果。
> **说明:** 从API Version 9开始支持,从API Version 9开始不再维护,建议使用[request.downloadFile<sup>9+</sup>](#requestdownloadfile9-1)替代。
**需要权限**
:ohos.permission.INTERNET
**系统能力**
: SystemCapability.MiscServices.Download
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| context | BaseContext | 是 | 基于应用程序的上下文。 |
| config |
[
DownloadConfig
](
#downloadconfig
)
| 是 | 下载的配置信息。 |
| callback | AsyncCallback
<
[DownloadTask](#downloadtask)
>
| 是 | 下载接口的回调函数。 |
**错误码:**
以下错误码的详细介绍请参见
[
上传下载错误码
](
../errorcodes/errorcode-request.md
)
。
| 错误码ID | 错误信息 |
| -------- | -------- |
| 13400001 | File operation error. |
| 13400002 | Bad file path. |
| 13400003 | Task manager service error. |
| context | BaseContext | 是 | 基于应用程序的上下文。 |
| config |
[
DownloadConfig
](
#downloadconfig
)
| 是 | 下载的配置信息。 |
| callback | AsyncCallback
<
[DownloadTask](#downloadtask)
>
| 是 | 下载接口的回调函数。 |
**示例:**
```
js
let
downloadTask
;
request
.
download
File
(
globalThis
.
abilityContext
,
{
url
:
'
https://xxxx/xxxxx.hap
'
,
request
.
download
(
globalThis
.
abilityContext
,
{
url
:
'
https://xxxx/xxxxx.hap
'
,
filePath
:
'
xxx/xxxxx.hap
'
},
(
err
,
data
)
=>
{
if
(
err
)
{
console
.
error
(
'
Failed to request the download. Cause:
'
+
JSON
.
stringify
(
err
));
...
...
@@ -1012,7 +1006,7 @@ on(type: 'progress', callback:(receivedSize: number, totalSize: number) => vo
| totalSize | number | 是 | 下载文件的总大小,单位为KB。 |
**示例:**
```
js
let
downloadTask
;
downloadTask
.
on
(
'
progress
'
,
function
download_callback
(
receivedSize
,
totalSize
)
{
...
...
@@ -1047,7 +1041,7 @@ off(type: 'progress', callback?: (receivedSize: number, totalSize: number) =>
| totalSize | number | 是 | 下载文件的总大小。 |
**示例:**
```
js
downloadTask
.
off
(
'
progress
'
,
function
download_callback
(
receivedSize
,
totalSize
)
{
console
.
info
(
"
download receivedSize:
"
+
receivedSize
+
"
totalSize:
"
+
totalSize
);
...
...
@@ -1074,7 +1068,7 @@ on(type: 'complete'|'pause'|'remove', callback:() => void): void
| callback | function | 是 | 回调函数。 |
**示例:**
```
js
let
downloadTask
;
downloadTask
.
on
(
'
complete
'
,
function
callback
()
{
...
...
@@ -1102,7 +1096,7 @@ off(type: 'complete'|'pause'|'remove', callback?:() => void): void
| callback | function | 否 | 回调函数。 |
**示例:**
```
js
let
downloadTask
;
downloadTask
.
off
(
'
complete
'
,
function
callback
()
{
...
...
@@ -1136,7 +1130,7 @@ on(type: 'fail', callback: (err: number) => void): void
| err | number | 是 | 下载失败的错误码,错误原因见
[
ERROR.*
](
#常量
)
。 |
**示例:**
```
js
let
downloadTask
;
downloadTask
.
on
(
'
fail
'
,
function
callBack
(
err
)
{
...
...
@@ -1170,7 +1164,7 @@ off(type: 'fail', callback?: (err: number) => void): void
| err | number | 是 | 下载失败的错误码。错误原因见
[
ERROR_*
](
#常量
)
。 |
**示例:**
```
js
let
downloadTask
;
downloadTask
.
off
(
'
fail
'
,
function
callBack
(
err
)
{
...
...
@@ -1179,15 +1173,12 @@ off(type: 'fail', callback?: (err: number) => void): void
);
```
### delete
<sup>
9+
</sup>
### remove
remove(): Promise
<
boolean
>
delete(): Promise
<
boolean
>
移除下载的任务,异步方法,使用promise形式返回结果。
> **说明:** 从API Version 9开始废弃,建议使用[delete<sup>9+</sup>](#delete9-2)替代。
**需要权限**
:ohos.permission.INTERNET
**系统能力**
: SystemCapability.MiscServices.Download
...
...
@@ -1199,10 +1190,10 @@ remove(): Promise<boolean>
| Promise
<
boolean
>
| 移除任务是否成功。 |
**示例:**
```
js
let
downloadTask
;
downloadTask
.
remov
e
().
then
((
result
)
=>
{
downloadTask
.
delet
e
().
then
((
result
)
=>
{
if
(
result
)
{
console
.
info
(
'
Download task removed.
'
);
}
else
{
...
...
@@ -1214,14 +1205,12 @@ remove(): Promise<boolean>
```
###
remove
###
delete<sup>9+</sup>
remov
e(callback: AsyncCallback
<
boolean
>
): void
delet
e(callback: AsyncCallback
<
boolean
>
): void
移除下载的任务,异步方法,使用callback形式返回结果。
> **说明:** 从API Version 9开始废弃,建议使用[delete<sup>9+</sup>](#delete9-3)替代。
**需要权限**
:ohos.permission.INTERNET
**系统能力**
: SystemCapability.MiscServices.Download
...
...
@@ -1233,10 +1222,10 @@ remove(callback: AsyncCallback<boolean>): void
| callback | AsyncCallback
<
boolean
>
| 是 | 移除任务是否成功。 |
**示例:**
```
js
let
downloadTask
;
downloadTask
.
remov
e
((
err
,
result
)
=>
{
downloadTask
.
delet
e
((
err
,
result
)
=>
{
if
(
err
)
{
console
.
error
(
'
Failed to remove the download task.
'
);
return
;
...
...
@@ -1250,14 +1239,12 @@ remove(callback: AsyncCallback<boolean>): void
```
###
query<sup>7
+</sup>
###
getTaskInfo<sup>9
+</sup>
query
(): Promise
<
DownloadInfo
>
getTaskInfo
(): Promise
<
DownloadInfo
>
查询下载任务,异步方法,使用promise形式返回DownloadInfo里的信息。
> **说明:** 从API Version 9开始废弃,建议使用[getTaskInfo<sup>9+</sup>](#gettaskinfo9)替代。
**需要权限**
:ohos.permission.INTERNET
**系统能力**
: SystemCapability.MiscServices.Download
...
...
@@ -1269,10 +1256,10 @@ query(): Promise<DownloadInfo>
| Promise
<
[DownloadInfo](#downloadinfo7)
>
| 查询下载任务信息。 |
**示例:**
```
js
let
downloadTask
;
downloadTask
.
query
().
then
((
downloadInfo
)
=>
{
downloadTask
.
getTaskInfo
().
then
((
downloadInfo
)
=>
{
console
.
info
(
'
Download task queried. Data:
'
+
JSON
.
stringify
(
downloadInfo
))
})
.
catch
((
err
)
=>
{
console
.
error
(
'
Failed to query the download task. Cause:
'
+
err
)
...
...
@@ -1280,14 +1267,12 @@ query(): Promise<DownloadInfo>
```
###
query<sup>7
+</sup>
###
getTaskInfo<sup>9
+</sup>
query
(callback: AsyncCallback
<
DownloadInfo
>
): void
getTaskInfo
(callback: AsyncCallback
<
DownloadInfo
>
): void
查询下载的任务,异步方法,使用callback形式返回结果。
> **说明:** 从API Version 9开始废弃,建议使用[getTaskInfo<sup>9+</sup>](#gettaskinfo9-1)替代。
**需要权限**
:ohos.permission.INTERNET
**系统能力**
: SystemCapability.MiscServices.Download
...
...
@@ -1299,10 +1284,10 @@ query(callback: AsyncCallback<DownloadInfo>): void
| callback | AsyncCallback
<
[DownloadInfo](#downloadinfo7)
>
| 是 | 查询下载任务的回调函数。 |
**示例:**
```
js
let
downloadTask
;
downloadTask
.
query
((
err
,
downloadInfo
)
=>
{
downloadTask
.
getTaskInfo
((
err
,
downloadInfo
)
=>
{
if
(
err
)
{
console
.
error
(
'
Failed to query the download mimeType. Cause:
'
+
JSON
.
stringify
(
err
));
}
else
{
...
...
@@ -1312,14 +1297,12 @@ query(callback: AsyncCallback<DownloadInfo>): void
```
###
queryMimeType<sup>7
+</sup>
###
getTaskMimeType<sup>9
+</sup>
query
MimeType(): Promise
<
string
>
getTask
MimeType(): Promise
<
string
>
查询下载的任务的 MimeType,异步方法,使用promise形式返回结果。
> **说明:** 从API Version 9开始废弃,建议使用[getTaskMimeType<sup>9+</sup>](#gettaskmimetype9)替代。
**需要权限**
:ohos.permission.INTERNET
**系统能力**
: SystemCapability.MiscServices.Download
...
...
@@ -1331,10 +1314,10 @@ queryMimeType(): Promise<string>
| Promise
<
string
>
| 查询下载任务的MimeType。 |
**示例:**
```
js
let
downloadTask
;
downloadTask
.
query
MimeType
().
then
((
data
)
=>
{
downloadTask
.
getTask
MimeType
().
then
((
data
)
=>
{
console
.
info
(
'
Download task queried. Data:
'
+
JSON
.
stringify
(
data
));
}).
catch
((
err
)
=>
{
console
.
error
(
'
Failed to query the download MimeType. Cause:
'
+
JSON
.
stringify
(
err
))
...
...
@@ -1342,14 +1325,12 @@ queryMimeType(): Promise<string>
```
###
queryMimeType<sup>7
+</sup>
###
getTaskMimeType<sup>9
+</sup>
query
MimeType(callback: AsyncCallback
<
string
>
): void;
getTask
MimeType(callback: AsyncCallback
<
string
>
): void;
查询下载的任务的 MimeType,异步方法,使用callback形式返回结果。
> **说明:** 从API Version 9开始废弃,建议使用[getTaskMimeType<sup>9+</sup>](#gettaskmimetype9-1)替代。
**需要权限**
:ohos.permission.INTERNET
**系统能力**
: SystemCapability.MiscServices.Download
...
...
@@ -1361,10 +1342,10 @@ queryMimeType(callback: AsyncCallback<string>): void;
| callback | AsyncCallback
<
string
>
| 是 | 查询下载任务的MimeType的回调函数。 |
**示例:**
```
js
let
downloadTask
;
downloadTask
.
query
MimeType
((
err
,
data
)
=>
{
downloadTask
.
getTask
MimeType
((
err
,
data
)
=>
{
if
(
err
)
{
console
.
error
(
'
Failed to query the download mimeType. Cause:
'
+
JSON
.
stringify
(
err
));
}
else
{
...
...
@@ -1374,14 +1355,12 @@ queryMimeType(callback: AsyncCallback<string>): void;
```
###
pause<sup>7
+</sup>
###
suspend<sup>9
+</sup>
pause(): Promise
<
void
>
suspend(): Promise
<
boolean
>
暂停下载任务,异步方法,使用promise形式返回结果。
> **说明:** 从API Version 9开始废弃,建议使用[suspend<sup>9+</sup>](#suspend9)替代。
**需要权限**
:ohos.permission.INTERNET
**系统能力**
: SystemCapability.MiscServices.Download
...
...
@@ -1390,13 +1369,13 @@ pause(): Promise<void>
| 类型 | 说明 |
| -------- | -------- |
| Promise
<
void
>
| 暂停下载任务是否成功。 |
| Promise
<
boolean
>
| 暂停下载任务是否成功。 |
**示例:**
```
js
let
downloadTask
;
downloadTask
.
pause
().
then
((
result
)
=>
{
downloadTask
.
suspend
().
then
((
result
)
=>
{
if
(
result
)
{
console
.
info
(
'
Download task paused.
'
);
}
else
{
...
...
@@ -1408,11 +1387,9 @@ pause(): Promise<void>
```
### pause<sup>7+</sup>
pause(callback: AsyncCallback
<
void
>
): void
### suspend<sup>9+</sup>
> **说明:** 从API Version 9开始废弃,建议使用[suspend<sup>9+</sup>](#suspend9-1)替代。
suspend(callback: AsyncCallback
<
boolean
>
): void
暂停下载任务,异步方法,使用callback形式返回结果。
...
...
@@ -1424,13 +1401,13 @@ pause(callback: AsyncCallback<void>): void
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| callback | AsyncCallback
<
void
>
| 是 | 暂停下载任务的回调函数。 |
| callback | AsyncCallback
<
boolean
>
| 是 | 暂停下载任务的回调函数。 |
**示例:**
```
js
let
downloadTask
;
downloadTask
.
pause
((
err
,
result
)
=>
{
downloadTask
.
suspend
((
err
,
result
)
=>
{
if
(
err
)
{
console
.
error
(
'
Failed to pause the download task. Cause:
'
+
JSON
.
stringify
(
err
));
return
;
...
...
@@ -1444,14 +1421,12 @@ pause(callback: AsyncCallback<void>): void
```
### res
ume<sup>7
+</sup>
### res
tore<sup>9
+</sup>
res
ume(): Promise
<
void
>
res
tore(): Promise
<
boolean
>
重新启动暂停的下载任务,异步方法,使用promise形式返回结果。
> **说明:** 从API Version 9开始废弃,建议使用[restore<sup>9+</sup>](#restore9)替代。
**需要权限**
:ohos.permission.INTERNET
**系统能力**
: SystemCapability.MiscServices.Download
...
...
@@ -1460,13 +1435,13 @@ resume(): Promise<void>
| 类型 | 说明 |
| -------- | -------- |
| Promise
<
void
>
| 重新启动暂停的下载任务是否成功。 |
| Promise
<
boolean
>
| 重新启动暂停的下载任务是否成功。 |
**示例:**
```
js
let
downloadTask
;
downloadTask
.
res
um
e
().
then
((
result
)
=>
{
downloadTask
.
res
tor
e
().
then
((
result
)
=>
{
if
(
result
)
{
console
.
info
(
'
Download task resumed.
'
)
}
else
{
...
...
@@ -1479,11 +1454,9 @@ resume(): Promise<void>
```
### resume<sup>7+</sup>
resume(callback: AsyncCallback
<
void
>
): void
### restore<sup>9+</sup>
> **说明:** 从API Version 9开始废弃,建议使用[restore<sup>9+</sup>](#restore9-1)替代。
restore(callback: AsyncCallback
<
boolean
>
): void
重新启动暂停的下载任务,异步方法,使用callback形式返回结果。
...
...
@@ -1495,13 +1468,13 @@ resume(callback: AsyncCallback<void>): void
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| callback | AsyncCallback
<
void
>
| 是 | 重新启动暂停的下载任务的回调函数。 |
| callback | AsyncCallback
<
boolean
>
| 是 | 重新启动暂停的下载任务的回调函数。 |
**示例:**
```
js
let
downloadTask
;
downloadTask
.
res
um
e
((
err
,
result
)
=>
{
downloadTask
.
res
tor
e
((
err
,
result
)
=>
{
if
(
err
)
{
console
.
error
(
'
Failed to resume the download task. Cause:
'
+
err
);
return
;
...
...
@@ -1515,27 +1488,30 @@ resume(callback: AsyncCallback<void>): void
```
### delete<sup>9+</sup>
delete(): Promise
<
boolean
>
### remove<sup>(deprecated)</sup>
remove(): Promise
<
boolean
>
移除下载的任务,异步方法,使用promise形式返回结果。
> **说明:** 从API Version 9开始不再维护,建议使用[delete<sup>9+</sup>](#delete9-2)替代。
**需要权限**
:ohos.permission.INTERNET
**系统能力**
: SystemCapability.MiscServices.Download
**返回值:**
| 类型 | 说明 |
| 类型 | 说明 |
| -------- | -------- |
| Promise
<
boolean
>
| 移除任务是否成功。 |
| Promise
<
boolean
>
| 移除任务是否成功。 |
**示例:**
```
js
let
downloadTask
;
downloadTask
.
delet
e
().
then
((
result
)
=>
{
downloadTask
.
remov
e
().
then
((
result
)
=>
{
if
(
result
)
{
console
.
info
(
'
Download task removed.
'
);
}
else
{
...
...
@@ -1547,27 +1523,29 @@ delete(): Promise<boolean>
```
###
delete<sup>9+
</sup>
###
remove<sup>(deprecated)
</sup>
delet
e(callback: AsyncCallback
<
boolean
>
): void
remov
e(callback: AsyncCallback
<
boolean
>
): void
移除下载的任务,异步方法,使用callback形式返回结果。
> **说明:** 从API Version 9开始不再维护,建议使用[delete<sup>9+</sup>](#delete9-3)替代。
**需要权限**
:ohos.permission.INTERNET
**系统能力**
: SystemCapability.MiscServices.Download
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| callback | AsyncCallback
<
boolean
>
| 是 | 移除任务是否成功。 |
| callback | AsyncCallback
<
boolean
>
| 是 | 移除任务是否成功。 |
**示例:**
```
js
let
downloadTask
;
downloadTask
.
delet
e
((
err
,
result
)
=>
{
downloadTask
.
remov
e
((
err
,
result
)
=>
{
if
(
err
)
{
console
.
error
(
'
Failed to remove the download task.
'
);
return
;
...
...
@@ -1581,27 +1559,29 @@ delete(callback: AsyncCallback<boolean>): void
```
###
getTaskInfo<sup>9+
</sup>
###
query<sup>(deprecated)
</sup>
getTaskInfo
(): Promise
<
DownloadInfo
>
query
(): Promise
<
DownloadInfo
>
查询下载任务,异步方法,使用promise形式返回DownloadInfo里的信息。
> **说明:** 从API Version 7开始支持,从API Version 9开始不再维护,建议使用[getTaskInfo<sup>9+</sup>](#gettaskinfo9)替代。
**需要权限**
:ohos.permission.INTERNET
**系统能力**
: SystemCapability.MiscServices.Download
**返回值:**
| 类型 | 说明 |
| -------- | -------- |
| Promise
<
[DownloadInfo](#downloadinfo7)
>
| 查询下载任务信息。 |
| 类型 | 说明 |
| -------- | -------- |
| Promise
<
[DownloadInfo](#downloadinfo7)
>
| 查询下载任务信息。 |
**示例:**
```
js
let
downloadTask
;
downloadTask
.
getTaskInfo
().
then
((
downloadInfo
)
=>
{
downloadTask
.
query
().
then
((
downloadInfo
)
=>
{
console
.
info
(
'
Download task queried. Data:
'
+
JSON
.
stringify
(
downloadInfo
))
})
.
catch
((
err
)
=>
{
console
.
error
(
'
Failed to query the download task. Cause:
'
+
err
)
...
...
@@ -1609,27 +1589,29 @@ getTaskInfo(): Promise<DownloadInfo>
```
###
getTaskInfo<sup>9+
</sup>
###
query<sup>(deprecated)
</sup>
getTaskInfo
(callback: AsyncCallback
<
DownloadInfo
>
): void
query
(callback: AsyncCallback
<
DownloadInfo
>
): void
查询下载的任务,异步方法,使用callback形式返回结果。
> **说明:** 从API Version 7开始支持,从API Version 9开始不再维护,建议使用[getTaskInfo<sup>9+</sup>](#gettaskinfo9-1)替代。
**需要权限**
:ohos.permission.INTERNET
**系统能力**
: SystemCapability.MiscServices.Download
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| callback | AsyncCallback
<
[DownloadInfo](#downloadinfo7)
>
| 是 | 查询下载任务的回调函数。 |
| callback | AsyncCallback
<
[DownloadInfo](#downloadinfo7)
>
| 是 | 查询下载任务的回调函数。 |
**示例:**
```
js
let
downloadTask
;
downloadTask
.
getTaskInfo
((
err
,
downloadInfo
)
=>
{
downloadTask
.
query
((
err
,
downloadInfo
)
=>
{
if
(
err
)
{
console
.
error
(
'
Failed to query the download mimeType. Cause:
'
+
JSON
.
stringify
(
err
));
}
else
{
...
...
@@ -1639,27 +1621,29 @@ getTaskInfo(callback: AsyncCallback<DownloadInfo>): void
```
###
getTaskMimeType<sup>9+
</sup>
###
queryMimeType<sup>(deprecated)
</sup>
getTask
MimeType(): Promise
<
string
>
query
MimeType(): Promise
<
string
>
查询下载的任务的 MimeType,异步方法,使用promise形式返回结果。
> **说明:** 从API Version 7开始支持,从API Version 9开始不再维护,建议使用[getTaskMimeType<sup>9+</sup>](#gettaskmimetype9)替代。
**需要权限**
:ohos.permission.INTERNET
**系统能力**
: SystemCapability.MiscServices.Download
**返回值:**
| 类型 | 说明 |
| 类型 | 说明 |
| -------- | -------- |
| Promise
<
string
>
| 查询下载任务的MimeType。 |
| Promise
<
string
>
| 查询下载任务的MimeType。 |
**示例:**
```
js
let
downloadTask
;
downloadTask
.
getTask
MimeType
().
then
((
data
)
=>
{
downloadTask
.
query
MimeType
().
then
((
data
)
=>
{
console
.
info
(
'
Download task queried. Data:
'
+
JSON
.
stringify
(
data
));
}).
catch
((
err
)
=>
{
console
.
error
(
'
Failed to query the download MimeType. Cause:
'
+
JSON
.
stringify
(
err
))
...
...
@@ -1667,27 +1651,29 @@ getTaskMimeType(): Promise<string>
```
###
getTaskMimeType<sup>9+
</sup>
###
queryMimeType<sup>(deprecated)
</sup>
getTask
MimeType(callback: AsyncCallback
<
string
>
): void;
query
MimeType(callback: AsyncCallback
<
string
>
): void;
查询下载的任务的 MimeType,异步方法,使用callback形式返回结果。
> **说明:** 从API Version 7开始支持,从API Version 9开始不再维护,建议使用[getTaskMimeType<sup>9+</sup>](#gettaskmimetype9-1)替代。
**需要权限**
:ohos.permission.INTERNET
**系统能力**
: SystemCapability.MiscServices.Download
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| callback | AsyncCallback
<
string
>
| 是 | 查询下载任务的MimeType的回调函数。 |
| callback | AsyncCallback
<
string
>
| 是 | 查询下载任务的MimeType的回调函数。 |
**示例:**
```
js
let
downloadTask
;
downloadTask
.
getTask
MimeType
((
err
,
data
)
=>
{
downloadTask
.
query
MimeType
((
err
,
data
)
=>
{
if
(
err
)
{
console
.
error
(
'
Failed to query the download mimeType. Cause:
'
+
JSON
.
stringify
(
err
));
}
else
{
...
...
@@ -1697,27 +1683,29 @@ getTaskMimeType(callback: AsyncCallback<string>): void;
```
###
suspend<sup>9+
</sup>
###
pause<sup>(deprecated)
</sup>
suspend(): Promise
<
boolean
>
pause(): Promise
<
void
>
暂停下载任务,异步方法,使用promise形式返回结果。
> **说明:** 从API Version 7开始支持,从API Version 9开始不再维护,建议使用[suspend<sup>9+</sup>](#suspend9)替代。
**需要权限**
:ohos.permission.INTERNET
**系统能力**
: SystemCapability.MiscServices.Download
**返回值:**
| 类型 | 说明 |
| 类型 | 说明 |
| -------- | -------- |
| Promise
<
boolean
>
| 暂停下载任务是否成功。 |
| Promise
<
void
>
| 暂停下载任务是否成功。 |
**示例:**
```
js
let
downloadTask
;
downloadTask
.
suspend
().
then
((
result
)
=>
{
downloadTask
.
pause
().
then
((
result
)
=>
{
if
(
result
)
{
console
.
info
(
'
Download task paused.
'
);
}
else
{
...
...
@@ -1729,9 +1717,11 @@ suspend(): Promise<boolean>
```
###
suspend<sup>9+
</sup>
###
pause<sup>(deprecated)
</sup>
suspend(callback: AsyncCallback
<
boolean
>
): void
pause(callback: AsyncCallback
<
void
>
): void
> **说明:** 从API Version 7开始支持,从API Version 9开始不再维护,建议使用[suspend<sup>9+</sup>](#suspend9-1)替代。
暂停下载任务,异步方法,使用callback形式返回结果。
...
...
@@ -1741,15 +1731,15 @@ suspend(callback: AsyncCallback<boolean>): void
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| callback | AsyncCallback
<
boolean
>
| 是 | 暂停下载任务的回调函数。 |
| callback | AsyncCallback
<
void
>
| 是 | 暂停下载任务的回调函数。 |
**示例:**
```
js
let
downloadTask
;
downloadTask
.
suspend
((
err
,
result
)
=>
{
downloadTask
.
pause
((
err
,
result
)
=>
{
if
(
err
)
{
console
.
error
(
'
Failed to pause the download task. Cause:
'
+
JSON
.
stringify
(
err
));
return
;
...
...
@@ -1763,27 +1753,29 @@ suspend(callback: AsyncCallback<boolean>): void
```
### res
tore<sup>9+
</sup>
### res
ume<sup>(deprecated)
</sup>
res
tore(): Promise
<
boolean
>
res
ume(): Promise
<
void
>
重新启动暂停的下载任务,异步方法,使用promise形式返回结果。
> **说明:** 从API Version 7开始支持,从API Version 9开始不再维护,建议使用[restore<sup>9+</sup>](#restore9)替代。
**需要权限**
:ohos.permission.INTERNET
**系统能力**
: SystemCapability.MiscServices.Download
**返回值:**
| 类型 | 说明 |
| 类型 | 说明 |
| -------- | -------- |
| Promise
<
boolean
>
| 重新启动暂停的下载任务是否成功。 |
| Promise
<
void
>
| 重新启动暂停的下载任务是否成功。 |
**示例:**
```
js
let
downloadTask
;
downloadTask
.
res
tor
e
().
then
((
result
)
=>
{
downloadTask
.
res
um
e
().
then
((
result
)
=>
{
if
(
result
)
{
console
.
info
(
'
Download task resumed.
'
)
}
else
{
...
...
@@ -1796,9 +1788,11 @@ restore(): Promise<boolean>
```
### res
tore<sup>9+
</sup>
### res
ume<sup>(deprecated)
</sup>
restore(callback: AsyncCallback
<
boolean
>
): void
resume(callback: AsyncCallback
<
void
>
): void
> **说明:** 从API Version 7开始支持,从API Version 9开始不再维护,建议使用[restore<sup>9+</sup>](#restore9-1)替代。
重新启动暂停的下载任务,异步方法,使用callback形式返回结果。
...
...
@@ -1808,15 +1802,15 @@ restore(callback: AsyncCallback<boolean>): void
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| callback | AsyncCallback
<
boolean
>
| 是 | 重新启动暂停的下载任务的回调函数。 |
| callback | AsyncCallback
<
void
>
| 是 | 重新启动暂停的下载任务的回调函数。 |
**示例:**
```
js
let
downloadTask
;
downloadTask
.
res
tor
e
((
err
,
result
)
=>
{
downloadTask
.
res
um
e
((
err
,
result
)
=>
{
if
(
err
)
{
console
.
error
(
'
Failed to resume the download task. Cause:
'
+
err
);
return
;
...
...
编辑
预览
Markdown
is supported
0%
请重试
或
添加新附件
.
添加附件
取消
You are about to add
0
people
to the discussion. Proceed with caution.
先完成此消息的编辑!
取消
想要评论请
注册
或
登录