Skip to content
体验新版
项目
组织
正在加载...
登录
切换导航
打开侧边栏
OpenHarmony
Docs
提交
fb3b1f1d
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看板
提交
fb3b1f1d
编写于
3月 22, 2022
作者:
Z
zengyawen
浏览文件
操作
浏览文件
下载
电子邮件补丁
差异文件
update docs
Signed-off-by:
N
zengyawen
<
zengyawen1@huawei.com
>
上级
8a6ab0b4
变更
3
展开全部
隐藏空白更改
内联
并排
Showing
3 changed file
with
1197 addition
and
722 deletion
+1197
-722
en/website.md
en/website.md
+515
-31
zh-cn/application-dev/reference/apis/js-apis-request.md
zh-cn/application-dev/reference/apis/js-apis-request.md
+48
-48
zh-cn/application-dev/website.md
zh-cn/application-dev/website.md
+634
-643
未找到文件。
en/website.md
浏览文件 @
fb3b1f1d
此差异已折叠。
点击以展开。
zh-cn/application-dev/reference/apis/js-apis-request.md
浏览文件 @
fb3b1f1d
...
...
@@ -126,7 +126,7 @@ upload(config: UploadConfig, callback: AsyncCallback<UploadTask>): void
### on('progress')
on(type: 'progress', callback:
AsyncCallback
<
uploadedSize: number, totalSize: number
>
=
>
void): void
on(type: 'progress', callback:
(uploadedSize: number, totalSize: number)
=
>
void): void
开启上传任务监听,异步方法,使用callback形式返回结果。
...
...
@@ -142,10 +142,10 @@ on(type: 'progress', callback:AsyncCallback <uploadedSize: number, totalSize:
回调函数的参数:
| 参数名 | 类型 | 必填 | 说明 |
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| uploadedSize | number | 是 | 当前已上传文件大小,单位为KB。 |
| totalSize | number | 是 | 上传文件的总大小,单位为KB。 |
| uploadedSize | number | 是 | 当前已上传文件大小,单位为KB。 |
| totalSize | number | 是 | 上传文件的总大小,单位为KB。 |
-
示例:
...
...
@@ -159,7 +159,7 @@ on(type: 'progress', callback:AsyncCallback <uploadedSize: number, totalSize:
### on('headerReceive')<sup>7+</sup>
on(type: 'headerReceive', callback:
AsyncCallback
<
object
>
=
>
void): void
on(type: 'headerReceive', callback:
(header: object)
=
>
void): void
开启上传任务监听,异步方法,使用callback形式返回结果。
...
...
@@ -171,13 +171,13 @@ on(type: 'headerReceive', callback: AsyncCallback<object> => void): voi
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| type | string | 是 | 订阅的事件类型,取值为'headerReceive'(接收响应头)。 |
| callback |
AsyncCallback
<
object
>
| 是 | HTTP
Response
Header事件的回调函数。 |
| callback |
header:
object
| 是 | HTTP
Response
Header事件的回调函数。 |
回调函数的参数:
| 参数名 | 类型 | 必填 | 说明 |
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| header
s | object | 是 | HTTP
Response
Header。 |
| header
| object | 是 | HTTP
Response
Header。 |
-
示例:
...
...
@@ -191,7 +191,7 @@ on(type: 'headerReceive', callback: AsyncCallback<object> => void): voi
### off('progress')
off(type:
'progress', callback:AsyncCallback
<
uploadedSize: number, totalSize: number
>
=
>
void): void
off(type:
'progress', callback?: (uploadedSize: number, totalSize: number) =
>
void): void
关闭上传任务监听,异步方法,使用callback形式返回结果。
...
...
@@ -207,10 +207,10 @@ off(type: 'progress', callback:AsyncCallback<uploadedSize: number, totalSize:
回调函数的参数:
| 参数名 | 类型 | 必填 | 说明 |
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| uploadedSize | number | 是 | 当前已上传文件的大小,单位为KB。 |
| totalSize | number | 是 | 上传文件的总大小,单位为KB。 |
| uploadedSize | number | 是 | 当前已上传文件的大小,单位为KB。 |
| totalSize | number | 是 | 上传文件的总大小,单位为KB。 |
-
示例:
...
...
@@ -224,7 +224,7 @@ off(type: 'progress', callback:AsyncCallback<uploadedSize: number, totalSize:
### off('headerReceive')<sup>7+</sup>
off(type: 'headerReceive', callback
:AsyncCallback
<
object
>
=
>
void): void
off(type: 'headerReceive', callback
?: (header: object)
=
>
void): void
关闭上传任务监听,异步方法,使用callback形式返回结果。
...
...
@@ -236,13 +236,13 @@ off(type: 'headerReceive', callback:AsyncCallback<object> => void): voi
| 参数名 | 参数类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| type | string | 是 | 取消订阅的事件类型,取值为'headerReceive'(接收响应头)。 |
| callback |
AsyncCallback
<
object
>
| 否 | HTTP
Response
Header事件的回调函数。 |
| callback |
header:
object
| 否 | HTTP
Response
Header事件的回调函数。 |
回调函数的参数:
| 参数名 | 类型 | 必填 | 说明 |
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| header
s | object | 是 | HTTP
Response
Header。 |
| header
| object | 是 | HTTP
Response
Header。 |
-
示例:
...
...
@@ -337,7 +337,7 @@ remove(callback: AsyncCallback<boolean>): void
| -------- | -------- | -------- | -------- |
| filename | string | 否 | multipart提交时,请求头中的文件名。 |
| name | string | 否 | multipart提交时,表单项目的名称,缺省为file。 |
| ur
l
| string | 是 | 文件的本地存储路径。
<br/>
支持“dataability”和“internal”两种协议类型,但“internal”仅支持临时目录,示例:
<br/>
dataability:///com.domainname.dataability.persondata/person/10/file.txt
<br/>
internal://cache/path/to/file.txt |
| ur
i
| string | 是 | 文件的本地存储路径。
<br/>
支持“dataability”和“internal”两种协议类型,但“internal”仅支持临时目录,示例:
<br/>
dataability:///com.domainname.dataability.persondata/person/10/file.txt
<br/>
internal://cache/path/to/file.txt |
| type | string | 否 | 文件的内容类型,默认根据文件名或路径的后缀获取。 |
...
...
@@ -419,7 +419,7 @@ download(config: DownloadConfig, callback: AsyncCallback<DownloadTask>): v
### on('progress')
on(type: 'progress', callback:
AsyncCallback
<
receivedSize: number, totalSize: number
>
=
>
void): void
on(type: 'progress', callback:
(receivedSize: number, totalSize: number)
=
>
void): void
开启下载任务监听,异步方法,使用callback形式返回结果。
...
...
@@ -435,10 +435,10 @@ on(type: 'progress', callback:AsyncCallback<receivedSize: number, totalSize:
回调函数的参数:
| 参数名 | 类型 | 必填 | 说明 |
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| receivedSize | number | 是 | 当前下载的进度,单位为KB。 |
| totalSize | number | 是 | 下载文件的总大小,单位为KB。 |
| receivedSize | number | 是 | 当前下载的进度,单位为KB。 |
| totalSize | number | 是 | 下载文件的总大小,单位为KB。 |
-
示例:
...
...
@@ -459,7 +459,7 @@ on(type: 'progress', callback:AsyncCallback<receivedSize: number, totalSize:
### off('progress')
off(type: 'progress', callback
: AsyncCallback
<
receivedSize: number, totalSize: number
>
=
>
void): void
off(type: 'progress', callback
?: (receivedSize: number, totalSize: number)
=
>
void): void
关闭下载任务监听,异步方法,使用callback形式返回结果。
...
...
@@ -475,10 +475,10 @@ off(type: 'progress', callback: AsyncCallback<receivedSize: number, totalSize
回调函数的参数:
| 参数名 | 类型 | 必填 | 说明 |
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| receivedSize | number | 是 | 当前下载的进度。 |
| totalSize | number | 是 | 下载文件的总大小。 |
| receivedSize | number | 是 | 当前下载的进度。 |
| totalSize | number | 是 | 下载文件的总大小。 |
-
示例:
...
...
@@ -499,7 +499,7 @@ off(type: 'progress', callback: AsyncCallback<receivedSize: number, totalSize
### on('complete')<sup>7+</sup>
on(type: 'complete', callback:
AsyncCallback
<>
=
>
void): void
on(type: 'complete', callback:
()
=
>
void): void
开启下载任务完成监听,异步方法,使用callback形式返回。
...
...
@@ -532,7 +532,7 @@ on(type: 'complete', callback:AsyncCallback<> => void): void
### off('complete')<sup>7+</sup>
off(type: 'complete', callback
:AsyncCallback
<>
=
>
void): void
off(type: 'complete', callback
?:()
=
>
void): void
取消下载任务完成监听,异步方法,使用callback形式返回。
...
...
@@ -565,7 +565,7 @@ off(type: 'complete', callback:AsyncCallback<> => void): void
### on('fail')<sup>7+</sup>
on(type: 'fail', callback:
AsyncCallback
<
err: number
>
=
>
void): void
on(type: 'fail', callback:
(err: number)
=
>
void): void
开启下载任务失败监听,异步方法,使用callback形式返回结果。
...
...
@@ -581,9 +581,9 @@ on(type: 'fail', callback:AsyncCallback<err: number> => void): void
回调函数的参数:
| 参数名 | 类型 | 必填 | 说明 |
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| err | number | 是 | 下载失败的错误码,错误原因见
[
ERROR.*
](
#常量
)
。 |
| err | number | 是 | 下载失败的错误码,错误原因见
[
ERROR.*
](
#常量
)
。 |
-
示例
...
...
@@ -604,7 +604,7 @@ on(type: 'fail', callback:AsyncCallback<err: number> => void): void
### off('fail')<sup>7+</sup>
off(type: 'fail', callback
:AsyncCallback
<
err: number
>
=
>
void): void
off(type: 'fail', callback
?: (err: number)
=
>
void): void
取消下载任务失败监听,异步方法,使用callback形式返回结果。
...
...
@@ -620,9 +620,9 @@ off(type: 'fail', callback:AsyncCallback<err: number> => void): void
回调函数的参数
| 参数名 | 类型 | 必填 | 说明 |
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| err | number | 是 | 下载失败的错误码。错误原因见
[
ERROR_*
](
#常量
)
。 |
| err | number | 是 | 下载失败的错误码。错误原因见
[
ERROR_*
](
#常量
)
。 |
-
示例
...
...
@@ -643,7 +643,7 @@ off(type: 'fail', callback:AsyncCallback<err: number> => void): void
### on('pause')<sup>7+</sup>
on(type: 'pause', callback:
AsyncCallback
<>
=
>
void): void
on(type: 'pause', callback:
()
=
>
void): void
开启下载任务暂停监听,异步方法,使用callback形式返回结果。
...
...
@@ -676,7 +676,7 @@ on(type: 'pause', callback:AsyncCallback<> => void): void
### off('pause')<sup>7+</sup>
off(type: 'pause', callback
:AsyncCallback
<>
=
>
void): void
off(type: 'pause', callback
?:()
=
>
void): void
取消下载任务暂停监听,异步方法,使用callback形式返回结果。
...
...
@@ -709,7 +709,7 @@ off(type: 'pause', callback:AsyncCallback<> => void): void
### on('remove')<sup>7+</sup>
on(type: 'remove', callback:
AsyncCallback
<>
=
>
void): void
on(type: 'remove', callback:
()
=
>
void): void
开启下载任务移除监听,异步方法,使用callback形式返回结果。
...
...
@@ -742,7 +742,7 @@ on(type: 'remove', callback:AsyncCallback<> => void): void
### off('remove')<sup>7+</sup>
off(type: 'remove', callback
:AsyncCallback
<>
=
>
void): void
off(type: 'remove', callback
?:()
=
>
void): void
取消下载任务移除监听,异步方法,使用callback形式返回结果。
...
...
@@ -847,7 +847,7 @@ query(): Promise<DownloadInfo>
-
参数:
| 类型 | 说明 |
| -------- | -------- |
| Promise
<
[DownloadInfo](#downloadinfo)
>
| 查询下载任务信息。 |
| Promise
<
[DownloadInfo](#downloadinfo
7
)
>
| 查询下载任务信息。 |
-
示例
...
...
@@ -873,7 +873,7 @@ query(callback: AsyncCallback<DownloadInfo>): void
-
参数:
| 参数名 | 参数类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| callback | AsyncCallback
<
[DownloadInfo](#downloadinfo)
>
| 是 | 查询下载任务的回调函数。 |
| callback | AsyncCallback
<
[DownloadInfo](#downloadinfo
7
)
>
| 是 | 查询下载任务的回调函数。 |
-
示例:
...
...
@@ -944,7 +944,7 @@ queryMimeType(callback: AsyncCallback<string>): void;
### pause<sup>7+</sup>
pause(): Promise
<
boolean
>
pause(): Promise
<
void
>
暂停下载任务,异步方法,使用promise形式返回结果。
...
...
@@ -955,7 +955,7 @@ pause(): Promise<boolean>
-
返回值:
| 类型 | 说明 |
| -------- | -------- |
| Promise
<
boolean
>
| 暂停下载任务是否成功。 |
| Promise
<
void
>
| 暂停下载任务是否成功。 |
-
示例
...
...
@@ -974,7 +974,7 @@ pause(): Promise<boolean>
### pause<sup>7+</sup>
pause(callback: AsyncCallback
<
boolean
>
): void
pause(callback: AsyncCallback
<
void
>
): void
暂停下载任务,异步方法,使用callback形式返回结果。
...
...
@@ -985,7 +985,7 @@ pause(callback: AsyncCallback<boolean>): void
-
参数
| 参数名 | 参数类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| callback | AsyncCallback
<
boolean
>
| 是 | 暂停下载任务的回调函数。 |
| callback | AsyncCallback
<
void
>
| 是 | 暂停下载任务的回调函数。 |
-
示例
...
...
@@ -1006,7 +1006,7 @@ pause(callback: AsyncCallback<boolean>): void
### resume<sup>7+</sup>
resume(): Promise
<
boolean
>
resume(): Promise
<
void
>
重新启动暂停的下载任务,异步方法,使用promise形式返回结果。
...
...
@@ -1017,7 +1017,7 @@ resume(): Promise<boolean>
-
参数:
| 类型 | 说明 |
| -------- | -------- |
| Promise
<
boolean
>
| 重新启动暂停的下载任务是否成功。 |
| Promise
<
void
>
| 重新启动暂停的下载任务是否成功。 |
-
示例
...
...
@@ -1037,7 +1037,7 @@ resume(): Promise<boolean>
### resume<sup>7+</sup>
resume(callback: AsyncCallback
<
boolean
>
): void
resume(callback: AsyncCallback
<
void
>
): void
重新启动暂停的下载任务,异步方法,使用callback形式返回结果。
...
...
@@ -1048,7 +1048,7 @@ resume(callback: AsyncCallback<boolean>): void
-
参数
| 参数名 | 参数类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| callback | AsyncCallback
<
boolean
>
| 是 | 重新启动暂停的下载任务的回调函数。 |
| callback | AsyncCallback
<
void
>
| 是 | 重新启动暂停的下载任务的回调函数。 |
-
示例
...
...
@@ -1083,7 +1083,7 @@ resume(callback: AsyncCallback<boolean>): void
| title | string | 否 | 设置下载会话标题。 |
## DownloadInfo
## DownloadInfo
<sup>7+</sup>
**系统能力**
: SystemCapability.MiscServices.Download
...
...
zh-cn/application-dev/website.md
浏览文件 @
fb3b1f1d
此差异已折叠。
点击以展开。
编辑
预览
Markdown
is supported
0%
请重试
或
添加新附件
.
添加附件
取消
You are about to add
0
people
to the discussion. Proceed with caution.
先完成此消息的编辑!
取消
想要评论请
注册
或
登录