提交 fb3b1f1d 编写于 作者: Z zengyawen

update docs

Signed-off-by: Nzengyawen <zengyawen1@huawei.com>
上级 8a6ab0b4
此差异已折叠。
......@@ -126,7 +126,7 @@ upload(config: UploadConfig, callback: AsyncCallback&lt;UploadTask&gt;): void
### on('progress')
on(type: 'progress', callback:AsyncCallback &lt;uploadedSize: number, totalSize: number&gt; =&gt; void): void
on(type: 'progress', callback:(uploadedSize: number, totalSize: number) =&gt; void): void
开启上传任务监听,异步方法,使用callback形式返回结果。
......@@ -159,7 +159,7 @@ on(type: 'progress', callback:AsyncCallback &lt;uploadedSize: number, totalSize:
### on('headerReceive')<sup>7+</sup>
on(type: 'headerReceive', callback: AsyncCallback&lt;object&gt; =&gt; void): void
on(type: 'headerReceive', callback: (header: object) =&gt; void): void
开启上传任务监听,异步方法,使用callback形式返回结果。
......@@ -171,13 +171,13 @@ on(type: 'headerReceive', callback: AsyncCallback&lt;object&gt; =&gt; void): voi
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| type | string | 是 | 订阅的事件类型,取值为'headerReceive'(接收响应头)。 |
| callback | AsyncCallback&lt;object&gt; | 是 | HTTP&nbsp;Response&nbsp;Header事件的回调函数。 |
| callback | header:&nbsp;object | 是 | HTTP&nbsp;Response&nbsp;Header事件的回调函数。 |
回调函数的参数:
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| headers | object | 是 | HTTP&nbsp;Response&nbsp;Header。 |
| header | object | 是 | HTTP&nbsp;Response&nbsp;Header。 |
- 示例:
......@@ -191,7 +191,7 @@ on(type: 'headerReceive', callback: AsyncCallback&lt;object&gt; =&gt; void): voi
### off('progress')
off(type: 'progress', callback:AsyncCallback&lt;uploadedSize: number, totalSize: number&gt;=&gt; void): void
off(type: 'progress', callback?: (uploadedSize: number, totalSize: number) =&gt; void): void
关闭上传任务监听,异步方法,使用callback形式返回结果。
......@@ -224,7 +224,7 @@ off(type: 'progress', callback:AsyncCallback&lt;uploadedSize: number, totalSize:
### off('headerReceive')<sup>7+</sup>
off(type: 'headerReceive', callback:AsyncCallback&lt;object&gt; =&gt; void): void
off(type: 'headerReceive', callback?: (header: object) =&gt; void): void
关闭上传任务监听,异步方法,使用callback形式返回结果。
......@@ -236,13 +236,13 @@ off(type: 'headerReceive', callback:AsyncCallback&lt;object&gt; =&gt; void): voi
| 参数名 | 参数类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| type | string | 是 | 取消订阅的事件类型,取值为'headerReceive'(接收响应头)。 |
| callback | AsyncCallback&lt;object&gt; | 否 | HTTP&nbsp;Response&nbsp;Header事件的回调函数。 |
| callback | header:&nbsp;object | 否 | HTTP&nbsp;Response&nbsp;Header事件的回调函数。 |
回调函数的参数:
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| headers | object | 是 | HTTP&nbsp;Response&nbsp;Header。 |
| header | object | 是 | HTTP&nbsp;Response&nbsp;Header。 |
- 示例:
......@@ -337,7 +337,7 @@ remove(callback: AsyncCallback&lt;boolean&gt;): void
| -------- | -------- | -------- | -------- |
| filename | string | 否 | multipart提交时,请求头中的文件名。 |
| name | string | 否 | multipart提交时,表单项目的名称,缺省为file。 |
| url | string | 是 | 文件的本地存储路径。<br/>支持“dataability”和“internal”两种协议类型,但“internal”仅支持临时目录,示例:<br/>dataability:///com.domainname.dataability.persondata/person/10/file.txt<br/>internal://cache/path/to/file.txt |
| uri | 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&lt;DownloadTask&gt;): v
### on('progress')
on(type: 'progress', callback:AsyncCallback&lt;receivedSize: number, totalSize: number&gt; =&gt; void): void
on(type: 'progress', callback:(receivedSize: number, totalSize: number) =&gt; void): void
开启下载任务监听,异步方法,使用callback形式返回结果。
......@@ -459,7 +459,7 @@ on(type: 'progress', callback:AsyncCallback&lt;receivedSize: number, totalSize:
### off('progress')
off(type: 'progress', callback: AsyncCallback&lt;receivedSize: number, totalSize: number&gt; =&gt; void): void
off(type: 'progress', callback?: (receivedSize: number, totalSize: number) =&gt; void): void
关闭下载任务监听,异步方法,使用callback形式返回结果。
......@@ -499,7 +499,7 @@ off(type: 'progress', callback: AsyncCallback&lt;receivedSize: number, totalSize
### on('complete')<sup>7+</sup>
on(type: 'complete', callback:AsyncCallback&lt;&gt; =&gt; void): void
on(type: 'complete', callback:() =&gt; void): void
开启下载任务完成监听,异步方法,使用callback形式返回。
......@@ -532,7 +532,7 @@ on(type: 'complete', callback:AsyncCallback&lt;&gt; =&gt; void): void
### off('complete')<sup>7+</sup>
off(type: 'complete', callback:AsyncCallback&lt;&gt; =&gt; void): void
off(type: 'complete', callback?:() =&gt; void): void
取消下载任务完成监听,异步方法,使用callback形式返回。
......@@ -565,7 +565,7 @@ off(type: 'complete', callback:AsyncCallback&lt;&gt; =&gt; void): void
### on('fail')<sup>7+</sup>
on(type: 'fail', callback:AsyncCallback&lt;err: number&gt; =&gt; void): void
on(type: 'fail', callback: (err: number) =&gt; void): void
开启下载任务失败监听,异步方法,使用callback形式返回结果。
......@@ -604,7 +604,7 @@ on(type: 'fail', callback:AsyncCallback&lt;err: number&gt; =&gt; void): void
### off('fail')<sup>7+</sup>
off(type: 'fail', callback:AsyncCallback&lt;err: number&gt; =&gt; void): void
off(type: 'fail', callback?: (err: number) =&gt; void): void
取消下载任务失败监听,异步方法,使用callback形式返回结果。
......@@ -643,7 +643,7 @@ off(type: 'fail', callback:AsyncCallback&lt;err: number&gt; =&gt; void): void
### on('pause')<sup>7+</sup>
on(type: 'pause', callback:AsyncCallback&lt;&gt; =&gt; void): void
on(type: 'pause', callback:() =&gt; void): void
开启下载任务暂停监听,异步方法,使用callback形式返回结果。
......@@ -676,7 +676,7 @@ on(type: 'pause', callback:AsyncCallback&lt;&gt; =&gt; void): void
### off('pause')<sup>7+</sup>
off(type: 'pause', callback:AsyncCallback&lt;&gt; =&gt; void): void
off(type: 'pause', callback?:() =&gt; void): void
取消下载任务暂停监听,异步方法,使用callback形式返回结果。
......@@ -709,7 +709,7 @@ off(type: 'pause', callback:AsyncCallback&lt;&gt; =&gt; void): void
### on('remove')<sup>7+</sup>
on(type: 'remove', callback:AsyncCallback&lt;&gt; =&gt; void): void
on(type: 'remove', callback:() =&gt; void): void
开启下载任务移除监听,异步方法,使用callback形式返回结果。
......@@ -742,7 +742,7 @@ on(type: 'remove', callback:AsyncCallback&lt;&gt; =&gt; void): void
### off('remove')<sup>7+</sup>
off(type: 'remove', callback:AsyncCallback&lt;&gt; =&gt; void): void
off(type: 'remove', callback?:() =&gt; void): void
取消下载任务移除监听,异步方法,使用callback形式返回结果。
......@@ -847,7 +847,7 @@ query(): Promise&lt;DownloadInfo&gt;
- 参数:
| 类型 | 说明 |
| -------- | -------- |
| Promise&lt;[DownloadInfo](#downloadinfo)&gt; | 查询下载任务信息。 |
| Promise&lt;[DownloadInfo](#downloadinfo7)&gt; | 查询下载任务信息。 |
- 示例
......@@ -873,7 +873,7 @@ query(callback: AsyncCallback&lt;DownloadInfo&gt;): void
- 参数:
| 参数名 | 参数类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| callback | AsyncCallback&lt;[DownloadInfo](#downloadinfo)&gt; | 是 | 查询下载任务的回调函数。 |
| callback | AsyncCallback&lt;[DownloadInfo](#downloadinfo7)&gt; | 是 | 查询下载任务的回调函数。 |
- 示例:
......@@ -944,7 +944,7 @@ queryMimeType(callback: AsyncCallback&lt;string&gt;): void;
### pause<sup>7+</sup>
pause(): Promise&lt;boolean&gt;
pause(): Promise&lt;void&gt;
暂停下载任务,异步方法,使用promise形式返回结果。
......@@ -955,7 +955,7 @@ pause(): Promise&lt;boolean&gt;
- 返回值:
| 类型 | 说明 |
| -------- | -------- |
| Promise&lt;boolean&gt; | 暂停下载任务是否成功。 |
| Promise&lt;void&gt; | 暂停下载任务是否成功。 |
- 示例
......@@ -974,7 +974,7 @@ pause(): Promise&lt;boolean&gt;
### pause<sup>7+</sup>
pause(callback: AsyncCallback&lt;boolean&gt;): void
pause(callback: AsyncCallback&lt;void&gt;): void
暂停下载任务,异步方法,使用callback形式返回结果。
......@@ -985,7 +985,7 @@ pause(callback: AsyncCallback&lt;boolean&gt;): void
- 参数
| 参数名 | 参数类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| callback | AsyncCallback&lt;boolean&gt; | 是 | 暂停下载任务的回调函数。 |
| callback | AsyncCallback&lt;void&gt; | 是 | 暂停下载任务的回调函数。 |
- 示例
......@@ -1006,7 +1006,7 @@ pause(callback: AsyncCallback&lt;boolean&gt;): void
### resume<sup>7+</sup>
resume(): Promise&lt;boolean&gt;
resume(): Promise&lt;void&gt;
重新启动暂停的下载任务,异步方法,使用promise形式返回结果。
......@@ -1017,7 +1017,7 @@ resume(): Promise&lt;boolean&gt;
- 参数:
| 类型 | 说明 |
| -------- | -------- |
| Promise&lt;boolean&gt; | 重新启动暂停的下载任务是否成功。 |
| Promise&lt;void&gt; | 重新启动暂停的下载任务是否成功。 |
- 示例
......@@ -1037,7 +1037,7 @@ resume(): Promise&lt;boolean&gt;
### resume<sup>7+</sup>
resume(callback: AsyncCallback&lt;boolean&gt;): void
resume(callback: AsyncCallback&lt;void&gt;): void
重新启动暂停的下载任务,异步方法,使用callback形式返回结果。
......@@ -1048,7 +1048,7 @@ resume(callback: AsyncCallback&lt;boolean&gt;): void
- 参数
| 参数名 | 参数类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| callback | AsyncCallback&lt;boolean&gt; | 是 | 重新启动暂停的下载任务的回调函数。 |
| callback | AsyncCallback&lt;void&gt; | 是 | 重新启动暂停的下载任务的回调函数。 |
- 示例
......@@ -1083,7 +1083,7 @@ resume(callback: AsyncCallback&lt;boolean&gt;): void
| title | string | 否 | 设置下载会话标题。 |
## DownloadInfo
## DownloadInfo<sup>7+</sup>
**系统能力**: SystemCapability.MiscServices.Download
......
# 应用开发
- [应用开发导读](application-dev-guide.md)
- 快速开始
- [应用开发快速入门](quick-start/Readme-CN.md)
- 应用开发快速入门
- DevEco Studio(OpenHarmony)使用指南
- [概述](quick-start/deveco-studio-overview.md)
- [版本变更说明](quick-start/deveco-studio-release-notes.md)
......@@ -13,11 +11,11 @@
- [配置OpenHarmony应用签名信息](quick-start/configuring-openharmony-app-signature.md)
- [安装运行OpenHarmony应用](quick-start/installing-openharmony-app.md)
- 快速入门
- [前言](start-overview.md)
- [使用eTS语言开发](start-with-ets.md)
- [使用JS语言开发(传统代码方式)](start-with-js.md)
- [使用JS语言开发(低代码方式)](start-with-js-low-code.md)
- [应用开发包结构说明](quick-start/quick-start/package-structure.md)
- [前言](quick-start/start-overview.md)
- [使用eTS语言开发](quick-start/start-with-ets.md)
- [使用JS语言开发(传统代码方式)](quick-start/start-with-js.md)
- [使用JS语言开发(低代码方式)](quick-start/start-with-js-low-code.md)
- [应用开发包结构说明](quick-start/package-structure.md)
- [资源文件的分类](quick-start/basic-resource-file-categories.md)
- 开发
- [Ability开发](ability/Readme-CN.md)
......@@ -37,9 +35,7 @@
- 其他
- [WantAgent使用指导](ability/wantagent.md)
- [Ability助手使用指导](ability/ability-assistant-guidelines.md)
- [UI开发](ui/Readme-CN.md)
- [方舟开发框架(ArkUI)概述](ui/arkui-overview.md)
- 基于JS扩展的类Web开发范式
- [概述](ui/ui-js-overview.md)
......@@ -174,53 +170,50 @@
- [构建食物列表List布局](ui/ui-ts-building-category-list-layout.md)
- [构建食物分类Grid布局](ui/ui-ts-building-category-grid-layout.md)
- [页面跳转与数据传递](ui/ui-ts-page-redirection-data-transmission.md)
- 基础功能开发
- [窗口管理](windowmanager/Readme-CN.md)
* 窗口
* [窗口开发概述](windowmanager/window-overview.md)
* [窗口开发指导](windowmanager/window-guidelines.md)
* 显示设备
* [屏幕属性开发概述](windowmanager/display-overview.md)
* [屏幕属性开发指导](windowmanager/display-guidelines.md)
* 屏幕截图
* [屏幕截图开发概述](windowmanager/screenshot-overview.md)
* [屏幕截图开发指导](windowmanager/screenshot-guidelines.md)
- [WebGL](webgl/Readme-CN.md)
- 窗口管理
- 窗口
- [窗口开发概述](windowmanager/window-overview.md)
- [窗口开发指导](windowmanager/window-guidelines.md)
- 显示设备
- [屏幕属性开发概述](windowmanager/display-overview.md)
- [屏幕属性开发指导](windowmanager/display-guidelines.md)
- 屏幕截图
- [屏幕截图开发概述](windowmanager/screenshot-overview.md)
- [屏幕截图开发指导](windowmanager/screenshot-guidelines.md)
- WebGL
- [概述](webgl/webgl-overview.md)
- [WebGL开发指导](webgl/webgl-guidelines.md)
- [媒体](media/Readme-CN.md)
- 媒体
- 音频
- [音频开发概述](media/audio-overview.md)
- [音频播放开发指导](media/audio-playback.md)
- [音频管理开发指导](media/audio-management.md)
- [音频录制开发指导](media/audio-recorder.md)
- [音频渲染开发指导](media/audio-renderer.md)
- [音频采集开发指导](media/audio-capturer.md)
- 视频
- [视频播放开发指导](media/video-playback.md)
- [视频录制开发指导](media/video-recorder.md)
- 图片
- [图片开发指导](media/image.md)
- [安全](security/Readme-CN.md)
- 安全
- 用户认证
- [用户认证开发概述](security/userauth-overview.md)
- [用户认证开发指导](security/userauth-guidelines.md)
- 密钥管理
- [HUKS开发概述](security/huks-overview.md)
- [HUKS开发指导](security/huks-guidelines.md)
- Hap包签名工具
- [Hap包签名工具开发指导](security/hapsigntool-guidelines.md)
- 访问控制
- [访问控制开发概述](security/accesstoken-overview.md)
- [访问控制开发指导](security/accesstoken-guidelines.md)
- [网络与连接](connectivity/Readme-CN.md)
- 网络与连接
- IPC与RPC通信
- [IPC与RPC通信概述](connectivity/ipc-rpc-overview.md)
- [IPC与RPC通信开发指导](connectivity/ipc-rpc-development-guideline.md)
- [远端状态订阅开发实例](connectivity/subscribe-remote-state.md)
- [数据管理](database/Readme-CN.md)
- 数据管理
- 分布式数据服务
- [分布式数据服务概述](database/database-mdds-overview.md)
- [分布式数据服务开发指导](database/database-mdds-guidelines.md)
......@@ -233,14 +226,14 @@
- 分布式数据对象
- [分布式数据对象概述](database/database-distributedobject-overview.md)
- [分布式数据对象开发指导](database/database-distributedobject-guidelines.md)
- [后台代理提醒](background-agent-scheduled-reminder/Readme-CN.md)
- 后台代理提醒
- [概述](background-agent-scheduled-reminder/background-agent-scheduled-reminder-overview.md)
- [开发指导](background-agent-scheduled-reminder/background-agent-scheduled-reminder-guide.md)
- [后台任务管理](background-task-management/Readme-CN.md)
- 后台任务管理
- 后台任务
- [后台任务概述](background-task-management/background-task-overview.md)
- [后台任务开发指导](background-task-management/background-task-dev-guide.md)
- [设备管理](device/Readme-CN.md)
- 设备管理
- USB服务
- [USB服务开发概述](device/usb-overview.md)
- [USB服务开发指导](device/usb-guidelines.md)
......@@ -254,10 +247,10 @@
- 振动
- [振动开发概述](device/vibrator-guidelines.md)
- [振动开发指导](device/vibrator-guidelines.md)
- [设备使用信息统计](device-usage-statistics/Readme-CN.md)
- 设备使用信息统计
- [设备使用信息统计概述](device-usage-statistics/device-usage-statistics-overview.md)
- [设备使用信息统计开发指导](device-usage-statistics/device-usage-statistics-dev-guide.md)
- [DFX](dfx/Readme-CN.md)
- DFX
- 应用事件打点
- [应用事件打点概述](dfx/hiappevent-overview.md)
- [应用事件打点开发指导](dfx/hiappevent-guidelines.md)
......@@ -267,12 +260,12 @@
- 分布式跟踪
- [分布式跟踪概述](dfx/hitracechain-overview.md)
- [分布式跟踪开发指导](dfx/hitracechain-guidelines.md)
- [国际化](international/Readme-CN.md)
- [国际化开发概述](international/international-overview.md)
- [Intl开发指导](international/intl-guidelines.md)
- [I18n开发指导](international/i18n-guidelines.md)
- 国际化
- [国际化开发概述](internationalization/international-overview.md)
- [Intl开发指导](internationalization/intl-guidelines.md)
- [I18n开发指导](internationalization/i18n-guidelines.md)
- 工具
- [DevEco Studio(OpenHarmony)使用指南](quick-start/deveco-studio-user-guide-for-openharmony.md)
- DevEco Studio(OpenHarmony)使用指南
- [概述](quick-start/deveco-studio-overview.md)
- [版本变更说明](quick-start/deveco-studio-release-notes.md)
- [配置OpenHarmony SDK](quick-start/configuring-openharmony-sdk.md)
......@@ -281,10 +274,9 @@
- [安装运行OpenHarmony应用](quick-start/installing-openharmony-app.md)
- 示例教程
- [示例代码](https://gitee.com/openharmony/app_samples/blob/master/README_zh.md)
- [Codelabs](https://gitee.com/openharmony/codelabs/blob/master/README.md)
- API参考
- [组件参考(基于JS扩展的类Web开发范式)](reference/arkui-js/Readme-CN.md)
- 组件参考(基于JS扩展的类Web开发范式)
- 组件
- 通用
- [通用属性](reference/arkui-js/js-components-common-attributes.md)
......@@ -294,7 +286,6 @@
- [动画样式](reference/arkui-js/js-components-common-animation.md)
- [渐变样式](reference/arkui-js/js-components-common-gradient.md)
- [转场样式](reference/arkui-js/js-components-common-transition.md)
- [媒体查询](reference/arkui-js/js-components-common-mediaquery.md)
- [自定义字体样式](reference/arkui-js/js-components-common-customizing-font.md)
- [原子布局](reference/arkui-js/js-components-common-atomic-layout.md)
- 容器组件
......@@ -386,7 +377,7 @@
- [生命周期定义](reference/arkui-js/js-components-custom-lifecycle.md)
- 附录
- [类型说明](reference/arkui-js/js-appendix-types.md)
- [组件参考(基于TS扩展的声明式开发范式)](reference/arkui-ts/Readme-CN.md)
- 组件参考(基于TS扩展的声明式开发范式)
- 组件
- 通用
- 通用事件
......@@ -527,7 +518,7 @@
- [菜单](reference/arkui-ts/ts-methods-menu.md)
- 附录
- [文档中涉及到的内置枚举值](reference/arkui-ts/ts-appendix-enums.md)
- [接口参考](reference/apis/Readme-CN.md)
- 接口参考
- Ability框架
- [FeatureAbility模块](reference/apis/js-apis-featureAbility.md)
- [ParticleAbility模块](reference/apis/js-apis-particleAbility.md)
......@@ -603,11 +594,11 @@
- [USB管理](reference/apis/js-apis-usb.md)
- [位置服务](reference/apis/js-apis-geolocation.md)
- 基本功能
- [应用上下文](reference/apis/js-apis-basic-features-app-context.md)
- [应用上下文](reference/apis/js-apis-system-app.md)
- [日志打印](reference/apis/js-apis-basic-features-logs.md)
- [页面路由](reference/apis/js-apis-basic-features-routes.md)
- [弹窗](reference/apis/js-apis-basic-features-pop-up.md)
- [应用配置](reference/apis/js-apis-basic-features-configuration.md)
- [页面路由](reference/apis/js-apis-system-router.md)
- [弹窗](reference/apis/js-apis-system-prompt.md)
- [应用配置](reference/apis/js-apis-system-configuration.md)
- [定时器](reference/apis/js-apis-basic-features-timer.md)
- [设置系统时间](reference/apis/js-apis-system-time.md)
- [动画](reference/apis/js-apis-basic-features-animator.md)
......@@ -615,7 +606,7 @@
- [WebGL2](reference/apis/js-apis-webgl2.md)
- [屏幕截图](reference/apis/js-apis-screenshot.md)
- [输入法框架](reference/apis/js-apis-inputmethod.md)
- [输入法服务](reference/apis/reference/apis/js-apis-inputmethodengine.md)
- [输入法服务](reference/apis/js-apis-inputmethodengine.md)
- [辅助功能](reference/apis/js-apis-accessibility.md)
- DFX
- [应用打点](reference/apis/js-apis-hiappevent.md)
......
Markdown is supported
0% .
You are about to add 0 people to the discussion. Proceed with caution.
先完成此消息的编辑!
想要评论请 注册