Skip to content
体验新版
项目
组织
正在加载...
登录
切换导航
打开侧边栏
OpenHarmony
Docs
提交
8abb3d00
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看板
体验新版 GitCode,发现更多精彩内容 >>
提交
8abb3d00
编写于
11月 25, 2022
作者:
W
wangdongqi
浏览文件
操作
浏览文件
下载
电子邮件补丁
差异文件
Signed-off-by: wangdongqi <wangdongqi2@huawei.com>
Changes to be committed:
上级
f2a9008b
变更
2
隐藏空白更改
内联
并排
Showing
2 changed file
with
45 addition
and
43 deletion
+45
-43
zh-cn/application-dev/reference/apis/js-apis-request.md
zh-cn/application-dev/reference/apis/js-apis-request.md
+42
-40
zh-cn/application-dev/reference/apis/js-apis-screen-lock.md
zh-cn/application-dev/reference/apis/js-apis-screen-lock.md
+3
-3
未找到文件。
zh-cn/application-dev/reference/apis/js-apis-request.md
浏览文件 @
8abb3d00
...
...
@@ -129,7 +129,7 @@ upload(config: UploadConfig, callback: AsyncCallback<UploadTask>): void
**参数:**
| 参数名 |
参数
类型 | 必填 | 说明 |
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| config |
[
UploadConfig
](
#uploadconfig
)
| 是 | 上传的配置信息。 |
| callback | AsyncCallback
<
[UploadTask](#uploadtask)
>
| 否 | 回调函数,异步返回UploadTask对象。 |
...
...
@@ -212,7 +212,7 @@ upload(context: BaseContext, config: UploadConfig, callback: AsyncCallback<Up
**参数:**
| 参数名 |
参数
类型 | 必填 | 说明 |
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| context | BaseContext | 是 | 基于应用程序的上下文。 |
| config |
[
UploadConfig
](
#uploadconfig
)
| 是 | 上传的配置信息。 |
...
...
@@ -266,7 +266,7 @@ uploadFile(context: BaseContext, config: UploadConfig): Promise<UploadTask>
**错误码:**
以下错误码的详细介绍请参见
[
上传下载错误码
](
../errorcodes/errorcode-request.md
)
。
| 错误码ID | 错误
码
信息 |
| 错误码ID | 错误信息 |
| -------- | -------- |
| 13400002 | Bad file path. |
...
...
@@ -301,7 +301,7 @@ uploadFile(context: BaseContext, config: UploadConfig, callback: AsyncCallback&l
**参数:**
| 参数名 |
参数
类型 | 必填 | 说明 |
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| context | BaseContext | 是 | 基于应用程序的上下文。 |
| config |
[
UploadConfig
](
#uploadconfig
)
| 是 | 上传的配置信息。 |
...
...
@@ -310,7 +310,7 @@ uploadFile(context: BaseContext, config: UploadConfig, callback: AsyncCallback&l
**错误码:**
以下错误码的详细介绍请参见
[
上传下载错误码
](
../errorcodes/errorcode-request.md
)
。
| 错误码ID | 错误
码
信息 |
| 错误码ID | 错误信息 |
| -------- | -------- |
| 13400002 | Bad file path. |
...
...
@@ -424,7 +424,7 @@ on(type: 'headerReceive', callback: (header: object) => void): void
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| type | string | 是 | 订阅的事件类型,取值为'complete',表示上传任务完成;取值为'fail',表示上传任务失败。|
| callback |
function
| 是 | 上传任务完成或失败的回调函数。 |
| callback |
Callback
<
Array
<
TaskState
>>
| 是 | 上传任务完成或失败的回调函数。 |
回调函数的参数
...
...
@@ -464,7 +464,7 @@ off(type: 'progress', callback?: (uploadedSize: number, totalSize: number) =&g
**参数:**
| 参数名 |
参数
类型 | 必填 | 说明 |
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| type | string | 是 | 取消订阅的事件类型,取值为'progress'(上传的进度信息)。 |
| callback | function | 否 | 上传任务的回调函数。 |
...
...
@@ -499,7 +499,7 @@ off(type: 'headerReceive', callback?: (header: object) => void): void
**参数:**
| 参数名 |
参数
类型 | 必填 | 说明 |
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| type | string | 是 | 取消订阅的事件类型,取值为'headerReceive'(接收响应头)。 |
| callback | function | 否 | HTTP
Response
Header事件的回调函数。 |
...
...
@@ -535,7 +535,7 @@ off(type: 'headerReceive', callback?: (header: object) => void): void
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| type | string | 是 | 订阅的事件类型,取值为'complete',表示上传任务完成;取值为'fail',表示上传任务失败。|
| callback |
function
| 否 | 上传任务完成或失败的回调函数。 |
| callback |
Callback
<
Array
<
TaskState
>>
| 否 | 上传任务完成或失败的回调函数。 |
回调函数的参数
...
...
@@ -611,7 +611,7 @@ remove(callback: AsyncCallback<boolean>): void
**参数:**
| 参数名 |
参数
类型 | 必填 | 说明 |
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| callback | AsyncCallback
<
boolean
>
| 是 | 移除任务的回调函数。 |
...
...
@@ -677,7 +677,7 @@ delete(callback: AsyncCallback<boolean>): void
**参数:**
| 参数名 |
参数
类型 | 必填 | 说明 |
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| callback | AsyncCallback
<
boolean
>
| 是 | 移除任务的回调函数。 |
...
...
@@ -805,7 +805,7 @@ download(config: DownloadConfig, callback: AsyncCallback<DownloadTask>): v
**参数:**
| 参数名 |
参数
类型 | 必填 | 说明 |
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| config |
[
DownloadConfig
](
#downloadconfig
)
| 是 | 下载的配置信息。 |
| callback | AsyncCallback
<
[DownloadTask](#downloadtask)
>
| 否 | 下载接口的回调函数。 |
...
...
@@ -875,7 +875,7 @@ download(context: BaseContext, config: DownloadConfig, callback: AsyncCallback&l
**参数:**
| 参数名 |
参数
类型 | 必填 | 说明 |
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| context | BaseContext | 是 | 基于应用程序的上下文。 |
| config |
[
DownloadConfig
](
#downloadconfig
)
| 是 | 下载的配置信息。 |
...
...
@@ -922,7 +922,7 @@ downloadFile(context: BaseContext, config: DownloadConfig): Promise<DownloadT
**错误码:**
以下错误码的详细介绍请参见
[
上传下载错误码
](
../errorcodes/errorcode-request.md
)
。
| 错误码ID | 错误
码
信息 |
| 错误码ID | 错误信息 |
| -------- | -------- |
| 13400001 | File operation error. |
| 13400002 | Bad file path. |
...
...
@@ -952,7 +952,7 @@ downloadFile(context: BaseContext, config: DownloadConfig, callback: AsyncCallba
**参数:**
| 参数名 |
参数
类型 | 必填 | 说明 |
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| context | BaseContext | 是 | 基于应用程序的上下文。 |
| config |
[
DownloadConfig
](
#downloadconfig
)
| 是 | 下载的配置信息。 |
...
...
@@ -961,7 +961,7 @@ downloadFile(context: BaseContext, config: DownloadConfig, callback: AsyncCallba
**错误码:**
以下错误码的详细介绍请参见
[
上传下载错误码
](
../errorcodes/errorcode-request.md
)
。
| 错误码ID | 错误
码
信息 |
| 错误码ID | 错误信息 |
| -------- | -------- |
| 13400001 | File operation error. |
| 13400002 | Bad file path. |
...
...
@@ -1034,7 +1034,7 @@ off(type: 'progress', callback?: (receivedSize: number, totalSize: number) =>
**参数:**
| 参数名 |
参数
类型 | 必填 | 说明 |
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| type | string | 是 | 取消订阅的事件类型,取值为'progress'(下载的进度信息)。 |
| callback | function | 否 | 下载任务的回调函数。 |
...
...
@@ -1228,7 +1228,7 @@ remove(callback: AsyncCallback<boolean>): void
**参数:**
| 参数名 |
参数
类型 | 必填 | 说明 |
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| callback | AsyncCallback
<
boolean
>
| 是 | 移除任务是否成功。 |
...
...
@@ -1262,8 +1262,9 @@ query(): Promise<DownloadInfo>
**系统能力**
: SystemCapability.MiscServices.Download
**参数:**
| 类型 | 说明 |
**返回值:**
| 类型 | 说明 |
| -------- | -------- |
| Promise
<
[DownloadInfo](#downloadinfo7)
>
| 查询下载任务信息。 |
...
...
@@ -1293,7 +1294,7 @@ query(callback: AsyncCallback<DownloadInfo>): void
**参数:**
| 参数名 |
参数
类型 | 必填 | 说明 |
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| callback | AsyncCallback
<
[DownloadInfo](#downloadinfo7)
>
| 是 | 查询下载任务的回调函数。 |
...
...
@@ -1355,7 +1356,7 @@ queryMimeType(callback: AsyncCallback<string>): void;
**参数:**
| 参数名 |
参数
类型 | 必填 | 说明 |
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| callback | AsyncCallback
<
string
>
| 是 | 查询下载任务的MimeType的回调函数。 |
...
...
@@ -1421,7 +1422,7 @@ pause(callback: AsyncCallback<void>): void
**参数:**
| 参数名 |
参数
类型 | 必填 | 说明 |
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| callback | AsyncCallback
<
void
>
| 是 | 暂停下载任务的回调函数。 |
...
...
@@ -1455,7 +1456,7 @@ resume(): Promise<void>
**系统能力**
: SystemCapability.MiscServices.Download
**
参数
:**
**
返回值
:**
| 类型 | 说明 |
| -------- | -------- |
...
...
@@ -1492,7 +1493,7 @@ resume(callback: AsyncCallback<void>): void
**参数:**
| 参数名 |
参数
类型 | 必填 | 说明 |
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| callback | AsyncCallback
<
void
>
| 是 | 重新启动暂停的下载任务的回调函数。 |
...
...
@@ -1558,7 +1559,7 @@ delete(callback: AsyncCallback<boolean>): void
**参数:**
| 参数名 |
参数
类型 | 必填 | 说明 |
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| callback | AsyncCallback
<
boolean
>
| 是 | 移除任务是否成功。 |
...
...
@@ -1590,7 +1591,8 @@ getTaskInfo(): Promise<DownloadInfo>
**系统能力**
: SystemCapability.MiscServices.Download
**参数:**
**返回值:**
| 类型 | 说明 |
| -------- | -------- |
| Promise
<
[DownloadInfo](#downloadinfo7)
>
| 查询下载任务信息。 |
...
...
@@ -1619,7 +1621,7 @@ query(callback: AsyncCallback<DownloadInfo>): void
**参数:**
| 参数名 |
参数
类型 | 必填 | 说明 |
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| callback | AsyncCallback
<
[DownloadInfo](#downloadinfo7)
>
| 是 | 查询下载任务的回调函数。 |
...
...
@@ -1677,7 +1679,7 @@ getTaskMimeType(callback: AsyncCallback<string>): void;
**参数:**
| 参数名 |
参数
类型 | 必填 | 说明 |
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| callback | AsyncCallback
<
string
>
| 是 | 查询下载任务的MimeType的回调函数。 |
...
...
@@ -1697,7 +1699,7 @@ getTaskMimeType(callback: AsyncCallback<string>): void;
### suspend<sup>9+</sup>
suspend(): Promise
<
void
>
suspend(): Promise
<
boolean
>
暂停下载任务,异步方法,使用promise形式返回结果。
...
...
@@ -1709,7 +1711,7 @@ suspend(): Promise<void>
| 类型 | 说明 |
| -------- | -------- |
| Promise
<
void
>
| 暂停下载任务是否成功。 |
| Promise
<
boolean
>
| 暂停下载任务是否成功。 |
**示例:**
...
...
@@ -1729,7 +1731,7 @@ suspend(): Promise<void>
### suspend<sup>9+</sup>
suspend(callback: AsyncCallback
<
void
>
): void
suspend(callback: AsyncCallback
<
boolean
>
): void
暂停下载任务,异步方法,使用callback形式返回结果。
...
...
@@ -1739,9 +1741,9 @@ suspend(callback: AsyncCallback<void>): void
**参数:**
| 参数名 |
参数
类型 | 必填 | 说明 |
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| callback | AsyncCallback
<
void
>
| 是 | 暂停下载任务的回调函数。 |
| callback | AsyncCallback
<
boolean
>
| 是 | 暂停下载任务的回调函数。 |
**示例:**
...
...
@@ -1763,7 +1765,7 @@ suspend(callback: AsyncCallback<void>): void
### restore<sup>9+</sup>
restore(): Promise
<
void
>
restore(): Promise
<
boolean
>
重新启动暂停的下载任务,异步方法,使用promise形式返回结果。
...
...
@@ -1771,11 +1773,11 @@ restore(): Promise<void>
**系统能力**
: SystemCapability.MiscServices.Download
**
参数
:**
**
返回值
:**
| 类型 | 说明 |
| -------- | -------- |
| Promise
<
void
>
| 重新启动暂停的下载任务是否成功。 |
| Promise
<
boolean
>
| 重新启动暂停的下载任务是否成功。 |
**示例:**
...
...
@@ -1796,7 +1798,7 @@ restore(): Promise<void>
### restore<sup>9+</sup>
restore(callback: AsyncCallback
<
void
>
): void
restore(callback: AsyncCallback
<
boolean
>
): void
重新启动暂停的下载任务,异步方法,使用callback形式返回结果。
...
...
@@ -1806,9 +1808,9 @@ restore(callback: AsyncCallback<void>): void
**参数:**
| 参数名 |
参数
类型 | 必填 | 说明 |
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| callback | AsyncCallback
<
void
>
| 是 | 重新启动暂停的下载任务的回调函数。 |
| callback | AsyncCallback
<
boolean
>
| 是 | 重新启动暂停的下载任务的回调函数。 |
**示例:**
...
...
zh-cn/application-dev/reference/apis/js-apis-screen-lock.md
浏览文件 @
8abb3d00
...
...
@@ -238,7 +238,7 @@ unlock(callback: AsyncCallback<boolean>): void
| 参数名 | 类型 | 必填 | 说明 |
| -------- | --------------------- | ---- | ------------------------- |
| callback | AsyncCallback
<
void
>
| 是 | 回调函数。返回true表示屏幕解锁成功,返回false表示屏幕解锁失败。 |
| callback | AsyncCallback
<
boolean
>
| 是 | 回调函数。返回true表示屏幕解锁成功,返回false表示屏幕解锁失败。 |
**示例:**
...
...
@@ -261,10 +261,10 @@ unlock(): Promise<boolean>
**系统能力:**
SystemCapability.MiscServices.ScreenLock
**返回值:**
boolean
| 类型 | 说明 |
| ------------------- | ------------------------------------------------------------ |
| Promise
<
void
>
| Promise对象。返回true表示屏幕解锁成功,返回false表示屏幕解锁失败。 |
| Promise
<
boolean
>
| Promise对象。返回true表示屏幕解锁成功,返回false表示屏幕解锁失败。 |
**示例:**
...
...
编辑
预览
Markdown
is supported
0%
请重试
或
添加新附件
.
添加附件
取消
You are about to add
0
people
to the discussion. Proceed with caution.
先完成此消息的编辑!
取消
想要评论请
注册
或
登录