Skip to content
体验新版
项目
组织
正在加载...
登录
切换导航
打开侧边栏
OpenHarmony
Docs
提交
80252784
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看板
提交
80252784
编写于
7月 06, 2022
作者:
T
tianyu
浏览文件
操作
浏览文件
下载
电子邮件补丁
差异文件
explain
Signed-off-by:
N
tianyu
<
tianyu55@h-partners.com
>
上级
409b01e3
变更
76
显示空白变更内容
内联
并排
Showing
76 changed file
with
856 addition
and
755 deletion
+856
-755
zh-cn/application-dev/reference/apis/js-apis-animator.md
zh-cn/application-dev/reference/apis/js-apis-animator.md
+14
-12
zh-cn/application-dev/reference/apis/js-apis-bytrace.md
zh-cn/application-dev/reference/apis/js-apis-bytrace.md
+2
-0
zh-cn/application-dev/reference/apis/js-apis-connectedTag.md
zh-cn/application-dev/reference/apis/js-apis-connectedTag.md
+2
-0
zh-cn/application-dev/reference/apis/js-apis-contact.md
zh-cn/application-dev/reference/apis/js-apis-contact.md
+2
-0
zh-cn/application-dev/reference/apis/js-apis-continuation-continuationExtraParams.md
...ence/apis/js-apis-continuation-continuationExtraParams.md
+3
-1
zh-cn/application-dev/reference/apis/js-apis-convertxml.md
zh-cn/application-dev/reference/apis/js-apis-convertxml.md
+2
-0
zh-cn/application-dev/reference/apis/js-apis-fileio.md
zh-cn/application-dev/reference/apis/js-apis-fileio.md
+394
-394
zh-cn/application-dev/reference/apis/js-apis-i18n.md
zh-cn/application-dev/reference/apis/js-apis-i18n.md
+3
-0
zh-cn/application-dev/reference/apis/js-apis-image.md
zh-cn/application-dev/reference/apis/js-apis-image.md
+2
-0
zh-cn/application-dev/reference/apis/js-apis-inputmethod.md
zh-cn/application-dev/reference/apis/js-apis-inputmethod.md
+19
-17
zh-cn/application-dev/reference/apis/js-apis-intl.md
zh-cn/application-dev/reference/apis/js-apis-intl.md
+3
-0
zh-cn/application-dev/reference/apis/js-apis-logs.md
zh-cn/application-dev/reference/apis/js-apis-logs.md
+2
-0
zh-cn/application-dev/reference/apis/js-apis-mediaquery.md
zh-cn/application-dev/reference/apis/js-apis-mediaquery.md
+2
-0
zh-cn/application-dev/reference/apis/js-apis-prompt.md
zh-cn/application-dev/reference/apis/js-apis-prompt.md
+2
-0
zh-cn/application-dev/reference/apis/js-apis-router.md
zh-cn/application-dev/reference/apis/js-apis-router.md
+2
-0
zh-cn/application-dev/reference/apis/js-apis-system-mediaquery.md
...plication-dev/reference/apis/js-apis-system-mediaquery.md
+2
-0
zh-cn/application-dev/reference/apis/js-apis-system-prompt.md
...n/application-dev/reference/apis/js-apis-system-prompt.md
+2
-0
zh-cn/application-dev/reference/apis/js-apis-system-router.md
...n/application-dev/reference/apis/js-apis-system-router.md
+2
-0
zh-cn/application-dev/reference/arkui-ts/ts-basic-components-button.md
...tion-dev/reference/arkui-ts/ts-basic-components-button.md
+9
-10
zh-cn/application-dev/reference/arkui-ts/ts-basic-components-loadingprogress.md
...reference/arkui-ts/ts-basic-components-loadingprogress.md
+2
-2
zh-cn/application-dev/reference/arkui-ts/ts-basic-components-qrcode.md
...tion-dev/reference/arkui-ts/ts-basic-components-qrcode.md
+6
-7
zh-cn/application-dev/reference/arkui-ts/ts-basic-components-rating.md
...tion-dev/reference/arkui-ts/ts-basic-components-rating.md
+11
-12
zh-cn/application-dev/reference/arkui-ts/ts-basic-components-span.md
...cation-dev/reference/arkui-ts/ts-basic-components-span.md
+4
-5
zh-cn/application-dev/reference/arkui-ts/ts-basic-components-stepper.md
...ion-dev/reference/arkui-ts/ts-basic-components-stepper.md
+8
-9
zh-cn/application-dev/reference/arkui-ts/ts-basic-components-stepperitem.md
...dev/reference/arkui-ts/ts-basic-components-stepperitem.md
+7
-8
zh-cn/application-dev/reference/arkui-ts/ts-basic-components-text.md
...cation-dev/reference/arkui-ts/ts-basic-components-text.md
+17
-18
zh-cn/application-dev/reference/arkui-ts/ts-basic-components-textarea.md
...on-dev/reference/arkui-ts/ts-basic-components-textarea.md
+2
-3
zh-cn/application-dev/reference/arkui-ts/ts-basic-components-textinput.md
...n-dev/reference/arkui-ts/ts-basic-components-textinput.md
+2
-3
zh-cn/application-dev/reference/arkui-ts/ts-basic-components-textpicker.md
...-dev/reference/arkui-ts/ts-basic-components-textpicker.md
+9
-10
zh-cn/application-dev/reference/arkui-ts/ts-basic-components-texttimer.md
...n-dev/reference/arkui-ts/ts-basic-components-texttimer.md
+10
-11
zh-cn/application-dev/reference/arkui-ts/ts-basic-components-timepicker.md
...-dev/reference/arkui-ts/ts-basic-components-timepicker.md
+11
-12
zh-cn/application-dev/reference/arkui-ts/ts-basic-components-toggle.md
...tion-dev/reference/arkui-ts/ts-basic-components-toggle.md
+3
-1
zh-cn/application-dev/reference/arkui-ts/ts-basic-gestures-longpressgesture.md
.../reference/arkui-ts/ts-basic-gestures-longpressgesture.md
+13
-11
zh-cn/application-dev/reference/arkui-ts/ts-basic-gestures-pangesture.md
...on-dev/reference/arkui-ts/ts-basic-gestures-pangesture.md
+24
-22
zh-cn/application-dev/reference/arkui-ts/ts-basic-gestures-pinchgesture.md
...-dev/reference/arkui-ts/ts-basic-gestures-pinchgesture.md
+15
-13
zh-cn/application-dev/reference/arkui-ts/ts-basic-gestures-rotationgesture.md
...v/reference/arkui-ts/ts-basic-gestures-rotationgesture.md
+12
-10
zh-cn/application-dev/reference/arkui-ts/ts-basic-gestures-swipegesture.md
...-dev/reference/arkui-ts/ts-basic-gestures-swipegesture.md
+11
-9
zh-cn/application-dev/reference/arkui-ts/ts-basic-gestures-tapgesture.md
...on-dev/reference/arkui-ts/ts-basic-gestures-tapgesture.md
+8
-6
zh-cn/application-dev/reference/arkui-ts/ts-combined-gestures.md
...pplication-dev/reference/arkui-ts/ts-combined-gestures.md
+8
-6
zh-cn/application-dev/reference/arkui-ts/ts-components-canvas-lottie.md
...ion-dev/reference/arkui-ts/ts-components-canvas-lottie.md
+2
-0
zh-cn/application-dev/reference/arkui-ts/ts-container-alphabet-indexer.md
...n-dev/reference/arkui-ts/ts-container-alphabet-indexer.md
+19
-22
zh-cn/application-dev/reference/arkui-ts/ts-container-badge.md
.../application-dev/reference/arkui-ts/ts-container-badge.md
+6
-7
zh-cn/application-dev/reference/arkui-ts/ts-container-flex.md
...n/application-dev/reference/arkui-ts/ts-container-flex.md
+2
-3
zh-cn/application-dev/reference/arkui-ts/ts-container-refresh.md
...pplication-dev/reference/arkui-ts/ts-container-refresh.md
+2
-2
zh-cn/application-dev/reference/arkui-ts/ts-drawing-components-circle.md
...on-dev/reference/arkui-ts/ts-drawing-components-circle.md
+8
-9
zh-cn/application-dev/reference/arkui-ts/ts-explicit-animation.md
...plication-dev/reference/arkui-ts/ts-explicit-animation.md
+11
-9
zh-cn/application-dev/reference/arkui-ts/ts-gesture-settings.md
...application-dev/reference/arkui-ts/ts-gesture-settings.md
+2
-0
zh-cn/application-dev/reference/arkui-ts/ts-interpolation-calculation.md
...on-dev/reference/arkui-ts/ts-interpolation-calculation.md
+37
-35
zh-cn/application-dev/reference/arkui-ts/ts-matrix-transformation.md
...cation-dev/reference/arkui-ts/ts-matrix-transformation.md
+2
-0
zh-cn/application-dev/reference/arkui-ts/ts-media-components-video.md
...ation-dev/reference/arkui-ts/ts-media-components-video.md
+2
-2
zh-cn/application-dev/reference/arkui-ts/ts-methods-menu.md
zh-cn/application-dev/reference/arkui-ts/ts-methods-menu.md
+2
-0
zh-cn/application-dev/reference/arkui-ts/ts-universal-attributes-click.md
...n-dev/reference/arkui-ts/ts-universal-attributes-click.md
+2
-0
zh-cn/application-dev/reference/arkui-ts/ts-universal-attributes-component-id.md
...eference/arkui-ts/ts-universal-attributes-component-id.md
+12
-12
zh-cn/application-dev/reference/arkui-ts/ts-universal-attributes-enable.md
...-dev/reference/arkui-ts/ts-universal-attributes-enable.md
+4
-2
zh-cn/application-dev/reference/arkui-ts/ts-universal-attributes-focus.md
...n-dev/reference/arkui-ts/ts-universal-attributes-focus.md
+4
-2
zh-cn/application-dev/reference/arkui-ts/ts-universal-attributes-gradient-color.md
...erence/arkui-ts/ts-universal-attributes-gradient-color.md
+12
-10
zh-cn/application-dev/reference/arkui-ts/ts-universal-attributes-hover-effect.md
...eference/arkui-ts/ts-universal-attributes-hover-effect.md
+2
-0
zh-cn/application-dev/reference/arkui-ts/ts-universal-attributes-image-effect.md
...eference/arkui-ts/ts-universal-attributes-image-effect.md
+2
-0
zh-cn/application-dev/reference/arkui-ts/ts-universal-attributes-layout-constraints.md
...ce/arkui-ts/ts-universal-attributes-layout-constraints.md
+5
-3
zh-cn/application-dev/reference/arkui-ts/ts-universal-attributes-location.md
...ev/reference/arkui-ts/ts-universal-attributes-location.md
+6
-4
zh-cn/application-dev/reference/arkui-ts/ts-universal-attributes-menu.md
...on-dev/reference/arkui-ts/ts-universal-attributes-menu.md
+2
-0
zh-cn/application-dev/reference/arkui-ts/ts-universal-attributes-overlay.md
...dev/reference/arkui-ts/ts-universal-attributes-overlay.md
+2
-0
zh-cn/application-dev/reference/arkui-ts/ts-universal-attributes-popup.md
...n-dev/reference/arkui-ts/ts-universal-attributes-popup.md
+8
-6
zh-cn/application-dev/reference/arkui-ts/ts-universal-attributes-sharp-clipping.md
...erence/arkui-ts/ts-universal-attributes-sharp-clipping.md
+5
-3
zh-cn/application-dev/reference/arkui-ts/ts-universal-attributes-size.md
...on-dev/reference/arkui-ts/ts-universal-attributes-size.md
+2
-0
zh-cn/application-dev/reference/arkui-ts/ts-universal-attributes-transformation.md
...erence/arkui-ts/ts-universal-attributes-transformation.md
+2
-0
zh-cn/application-dev/reference/arkui-ts/ts-universal-attributes-visibility.md
.../reference/arkui-ts/ts-universal-attributes-visibility.md
+6
-4
zh-cn/application-dev/reference/arkui-ts/ts-universal-attributes-z-order.md
...dev/reference/arkui-ts/ts-universal-attributes-z-order.md
+4
-2
zh-cn/application-dev/reference/arkui-ts/ts-universal-component-area-change-event.md
...ence/arkui-ts/ts-universal-component-area-change-event.md
+5
-3
zh-cn/application-dev/reference/arkui-ts/ts-universal-events-click.md
...ation-dev/reference/arkui-ts/ts-universal-events-click.md
+9
-0
zh-cn/application-dev/reference/arkui-ts/ts-universal-events-drag-drop.md
...n-dev/reference/arkui-ts/ts-universal-events-drag-drop.md
+2
-0
zh-cn/application-dev/reference/arkui-ts/ts-universal-events-key.md
...ication-dev/reference/arkui-ts/ts-universal-events-key.md
+2
-0
zh-cn/application-dev/reference/arkui-ts/ts-universal-events-show-hide.md
...n-dev/reference/arkui-ts/ts-universal-events-show-hide.md
+2
-0
zh-cn/application-dev/reference/arkui-ts/ts-universal-events-touch.md
...ation-dev/reference/arkui-ts/ts-universal-events-touch.md
+2
-0
zh-cn/application-dev/reference/arkui-ts/ts-universal-focus-event.md
...cation-dev/reference/arkui-ts/ts-universal-focus-event.md
+5
-3
zh-cn/application-dev/reference/arkui-ts/ts-universal-mouse-key.md
...lication-dev/reference/arkui-ts/ts-universal-mouse-key.md
+2
-0
未找到文件。
zh-cn/application-dev/reference/apis/js-apis-animator.md
浏览文件 @
80252784
# 动画
# 动画
本模块提供组件动画效果,包括定义动画、启动动画和以相反的顺序播放动画等。
> **说明:**
> **说明:**
>
>
> 本模块首批接口从API version 6开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。
> 本模块首批接口从API version 6开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。
...
@@ -21,14 +23,14 @@ createAnimator(options: AnimatorOptions): AnimatorResult
...
@@ -21,14 +23,14 @@ createAnimator(options: AnimatorOptions): AnimatorResult
**系统能力:**
SystemCapability.ArkUI.ArkUI.Full
**系统能力:**
SystemCapability.ArkUI.ArkUI.Full
**参数:**
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| -------- | -------- | -------- | -------- |
| options |
[
AnimatorOptions
](
#animatoroptions
)
| 是 | 定义动画选项。|
| options |
[
AnimatorOptions
](
#animatoroptions
)
| 是 | 定义动画选项。|
**返回值:**
**返回值:**
| 类型 | 说明 |
| 类型 | 说明 |
| -------- | -------- |
| -------- | -------- |
|
[
AnimatorResult
](
#animatorresult
)
| Animator结果接口。 |
|
[
AnimatorResult
](
#animatorresult
)
| Animator结果接口。 |
**示例:**
**示例:**
...
@@ -92,9 +94,9 @@ update(options: AnimatorOptions): void
...
@@ -92,9 +94,9 @@ update(options: AnimatorOptions): void
**系统能力:**
SystemCapability.ArkUI.ArkUI.Full
**系统能力:**
SystemCapability.ArkUI.ArkUI.Full
**参数:**
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| -------- | -------- | -------- | -------- |
| options |
[
AnimatorOptions
](
#animatoroptions
)
| 是 | 定义动画选项。|
| options |
[
AnimatorOptions
](
#animatoroptions
)
| 是 | 定义动画选项。|
**示例:**
**示例:**
```
```
...
@@ -175,9 +177,9 @@ onframe: (progress: number) => void
...
@@ -175,9 +177,9 @@ onframe: (progress: number) => void
**系统能力:**
SystemCapability.ArkUI.ArkUI.Full
**系统能力:**
SystemCapability.ArkUI.ArkUI.Full
**参数:**
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| -------- | -------- | -------- | -------- |
| progress | number | 是 | 动画的当前进度。|
| progress | number | 是 | 动画的当前进度。|
**示例:**
**示例:**
```
```
...
...
zh-cn/application-dev/reference/apis/js-apis-bytrace.md
浏览文件 @
80252784
# 性能打点
# 性能打点
本模块提供了追踪进程轨迹。
> **说明:**
> **说明:**
> - 从API Version 8开始,该接口不再维护,推荐使用新接口[`@ohos.hiTraceMeter`](js-apis-hitracemeter.md)。
> - 从API Version 8开始,该接口不再维护,推荐使用新接口[`@ohos.hiTraceMeter`](js-apis-hitracemeter.md)。
> - 本模块首批接口从API version 7开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。
> - 本模块首批接口从API version 7开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。
...
...
zh-cn/application-dev/reference/apis/js-apis-connectedTag.md
浏览文件 @
80252784
# 有源标签
# 有源标签
本模块提供有源标签的使用,包括初始化有源标签芯片、读取有源标签内容、写入内容到有源标签等。
> ![icon-note.gif](public_sys-resources/icon-note.gif) **说明:**
> ![icon-note.gif](public_sys-resources/icon-note.gif) **说明:**
> 本模块首批接口从API version 8开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。
> 本模块首批接口从API version 8开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。
...
...
zh-cn/application-dev/reference/apis/js-apis-contact.md
浏览文件 @
80252784
# 联系人
# 联系人
本模块提供联系人管理能力,包括添加联系人、删除联系人、更新联系人等
>**说明:**
>**说明:**
>
>
>本模块首批接口从API version 7开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。
>本模块首批接口从API version 7开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。
...
...
zh-cn/application-dev/reference/apis/js-apis-continuation-continuationExtraParams.md
浏览文件 @
80252784
# ContinuationExtraParams
# ContinuationExtraParams
本模块提供流转管理入口中互联面板所需的过滤参数。
> ![icon-note.gif](public_sys-resources/icon-note.gif) **说明:**
> ![icon-note.gif](public_sys-resources/icon-note.gif) **说明:**
> 本模块首批接口从API version 8开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。
> 本模块首批接口从API version 8开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。
...
...
zh-cn/application-dev/reference/apis/js-apis-convertxml.md
浏览文件 @
80252784
# xml转换JavaScript
# xml转换JavaScript
本模块提供转换xml文本为JavaScript对象的选项。
> **说明:**
> **说明:**
> 本模块首批接口从API version 8开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。
> 本模块首批接口从API version 8开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。
...
...
zh-cn/application-dev/reference/apis/js-apis-fileio.md
浏览文件 @
80252784
文件管理
#
文件管理
> ![icon-note.gif](public_sys-resources/icon-note.gif) **说明:**
> ![icon-note.gif](public_sys-resources/icon-note.gif) **说明:**
> 本模块首批接口从API version 6开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。
> 本模块首批接口从API version 6开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。
...
@@ -41,9 +41,9 @@ stat(path: string): Promise<Stat>
...
@@ -41,9 +41,9 @@ stat(path: string): Promise<Stat>
**返回值:**
**返回值:**
| 类型 | 说明 |
| 类型 | 说明 |
| ---------------------------- | ---------- |
| ---------------------------- | ---------- |
| Promise
<
[Stat](#stat)
>
| Promise对象。返回文件的具体信息。 |
| Promise
<
[Stat](#stat)
>
| Promise对象。返回文件的具体信息。 |
**示例:**
**示例:**
```
js
```
js
...
@@ -92,9 +92,9 @@ statSync(path:string): Stat
...
@@ -92,9 +92,9 @@ statSync(path:string): Stat
**返回值:**
**返回值:**
| 类型 | 说明 |
| 类型 | 说明 |
| ------------- | ---------- |
| ------------- | ---------- |
|
[
Stat
](
#stat
)
| 表示文件的具体信息。 |
|
[
Stat
](
#stat
)
| 表示文件的具体信息。 |
**示例:**
**示例:**
```
js
```
js
...
@@ -117,9 +117,9 @@ opendir(path: string): Promise<Dir>
...
@@ -117,9 +117,9 @@ opendir(path: string): Promise<Dir>
| path | string | 是 | 待打开文件目录的应用沙箱路径。 |
| path | string | 是 | 待打开文件目录的应用沙箱路径。 |
**返回值:**
**返回值:**
| 类型 | 说明 |
| 类型 | 说明 |
| -------------------------- | -------- |
| -------------------------- | -------- |
| Promise
<
[Dir](#dir)
>
| Promise对象。返回Dir对象。 |
| Promise
<
[Dir](#dir)
>
| Promise对象。返回Dir对象。 |
**示例:**
**示例:**
```
js
```
js
...
@@ -171,9 +171,9 @@ opendirSync(path: string): Dir
...
@@ -171,9 +171,9 @@ opendirSync(path: string): Dir
| path | string | 是 | 待打开文件目录的应用沙箱路径。 |
| path | string | 是 | 待打开文件目录的应用沙箱路径。 |
**返回值:**
**返回值:**
| 类型 | 说明 |
| 类型 | 说明 |
| ----------- | -------- |
| ----------- | -------- |
|
[
Dir
](
#dir
)
| 返回Dir对象。 |
|
[
Dir
](
#dir
)
| 返回Dir对象。 |
**示例:**
**示例:**
```
js
```
js
...
@@ -199,9 +199,9 @@ access(path: string, mode?: number): Promise<void>
...
@@ -199,9 +199,9 @@ access(path: string, mode?: number): Promise<void>
| mode | number | 否 | 访问文件时的选项,可给定如下选项,以按位或的方式使用多个选项,默认给定0。
<br/>
确认当前进程是否具有对应权限:
<br/>
-
0:确认文件是否存在。
<br/>
-
1:确认当前进程是否具有可执行权限。
<br/>
-
2:确认当前进程是否具有写权限。
<br/>
-
4:确认当前进程是否具有读权限。 |
| mode | number | 否 | 访问文件时的选项,可给定如下选项,以按位或的方式使用多个选项,默认给定0。
<br/>
确认当前进程是否具有对应权限:
<br/>
-
0:确认文件是否存在。
<br/>
-
1:确认当前进程是否具有可执行权限。
<br/>
-
2:确认当前进程是否具有写权限。
<br/>
-
4:确认当前进程是否具有读权限。 |
**返回值:**
**返回值:**
| 类型 | 说明 |
| 类型 | 说明 |
| ------------------- | ---------------------------- |
| ------------------- | ---------------------------- |
| Promise
<
void
>
| Promise对象。无返回值。 |
| Promise
<
void
>
| Promise对象。无返回值。 |
**示例:**
**示例:**
```
js
```
js
...
@@ -269,14 +269,14 @@ close(fd: number):Promise<void>
...
@@ -269,14 +269,14 @@ close(fd: number):Promise<void>
**系统能力**
:SystemCapability.FileManagement.File.FileIO
**系统能力**
:SystemCapability.FileManagement.File.FileIO
**参数:**
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| 参数名 | 类型 | 必填 | 说明 |
| ---- | ------ | ---- | ------------ |
| ---- | ------ | ---- | ------------ |
| fd | number | 是 | 待关闭文件的文件描述符。 |
| fd | number | 是 | 待关闭文件的文件描述符。 |
**返回值:**
**返回值:**
| 类型 | 说明 |
| 类型 | 说明 |
| ------------------- | ---------------------------- |
| ------------------- | ---------------------------- |
| Promise
<
void
>
| Promise对象。无返回值。 |
| Promise
<
void
>
| Promise对象。无返回值。 |
**示例:**
**示例:**
```
js
```
js
...
@@ -298,10 +298,10 @@ close(fd: number, callback:AsyncCallback<void>): void
...
@@ -298,10 +298,10 @@ close(fd: number, callback:AsyncCallback<void>): void
**系统能力**
:SystemCapability.FileManagement.File.FileIO
**系统能力**
:SystemCapability.FileManagement.File.FileIO
**参数:**
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ------------------------- | ---- | ------------ |
| -------- | ------------------------- | ---- | ------------ |
| fd | number | 是 | 待关闭文件的文件描述符。 |
| fd | number | 是 | 待关闭文件的文件描述符。 |
| callback | AsyncCallback
<
void
>
| 是 | 异步关闭文件之后的回调。 |
| callback | AsyncCallback
<
void
>
| 是 | 异步关闭文件之后的回调。 |
**示例:**
**示例:**
```
js
```
js
...
@@ -321,9 +321,9 @@ closeSync(fd: number): void
...
@@ -321,9 +321,9 @@ closeSync(fd: number): void
**系统能力**
:SystemCapability.FileManagement.File.FileIO
**系统能力**
:SystemCapability.FileManagement.File.FileIO
**参数:**
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| 参数名 | 类型 | 必填 | 说明 |
| ---- | ------ | ---- | ------------ |
| ---- | ------ | ---- | ------------ |
| fd | number | 是 | 待关闭文件的文件描述符。 |
| fd | number | 是 | 待关闭文件的文件描述符。 |
**示例:**
**示例:**
```
js
```
js
...
@@ -340,9 +340,9 @@ close(): Promise<void>
...
@@ -340,9 +340,9 @@ close(): Promise<void>
**系统能力**
:SystemCapability.FileManagement.File.FileIO
**系统能力**
:SystemCapability.FileManagement.File.FileIO
**返回值:**
**返回值:**
| 类型 | 说明 |
| 类型 | 说明 |
| ------------------- | ---------------------------- |
| ------------------- | ---------------------------- |
| Promise
<
void
>
| Promise对象。无返回值。 |
| Promise
<
void
>
| Promise对象。无返回值。 |
**示例:**
**示例:**
```
js
```
js
...
@@ -363,9 +363,9 @@ close(callback: AsyncCallback<void>): void
...
@@ -363,9 +363,9 @@ close(callback: AsyncCallback<void>): void
**系统能力**
:SystemCapability.FileManagement.File.FileIO
**系统能力**
:SystemCapability.FileManagement.File.FileIO
**参数:**
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ------------------------- | ---- | ------------- |
| -------- | ------------------------- | ---- | ------------- |
| callback | AsyncCallback
<
void
>
| 是 | 异步关闭文件流之后的回调。 |
| callback | AsyncCallback
<
void
>
| 是 | 异步关闭文件流之后的回调。 |
**示例:**
**示例:**
```
js
```
js
...
@@ -384,16 +384,16 @@ copyFile(src:string | number, dest:string | number, mode?:number):Promise<voi
...
@@ -384,16 +384,16 @@ copyFile(src:string | number, dest:string | number, mode?:number):Promise<voi
**系统能力**
:SystemCapability.FileManagement.File.FileIO
**系统能力**
:SystemCapability.FileManagement.File.FileIO
**参数:**
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| 参数名 | 类型 | 必填 | 说明 |
| ---- | -------------------------- | ---- | ---------------------------------------- |
| ---- | -------------------------- | ---- | ---------------------------------------- |
| src | string
\|
number | 是 | 待复制文件的路径或待复制文件的描述符。 |
| src | string
\|
number | 是 | 待复制文件的路径或待复制文件的描述符。 |
| dest | string
\|
number | 是 | 目标文件路径或目标文件描述符。 |
| dest | string
\|
number | 是 | 目标文件路径或目标文件描述符。 |
| mode | number | 否 | mode提供覆盖文件的选项,当前仅支持0,且默认为0。
<br/>
0:完全覆盖目标文件,未覆盖部分将被裁切掉。 |
| mode | number | 否 | mode提供覆盖文件的选项,当前仅支持0,且默认为0。
<br/>
0:完全覆盖目标文件,未覆盖部分将被裁切掉。 |
**返回值:**
**返回值:**
| 类型 | 说明 |
| 类型 | 说明 |
| ------------------- | ---------------------------- |
| ------------------- | ---------------------------- |
| Promise
<
void
>
| Promise对象。无返回值。 |
| Promise
<
void
>
| Promise对象。无返回值。 |
**示例:**
**示例:**
```
js
```
js
...
@@ -414,12 +414,12 @@ copyFile(src: string | number, dest: string | number, mode: number, callback: As
...
@@ -414,12 +414,12 @@ copyFile(src: string | number, dest: string | number, mode: number, callback: As
**系统能力**
:SystemCapability.FileManagement.File.FileIO
**系统能力**
:SystemCapability.FileManagement.File.FileIO
**参数:**
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------------------------- | ---- | ---------------------------------------- |
| -------- | -------------------------- | ---- | ---------------------------------------- |
| src | string
\|
number | 是 | 待复制文件的路径或待复制文件的描述符。 |
| src | string
\|
number | 是 | 待复制文件的路径或待复制文件的描述符。 |
| dest | string
\|
number | 是 | 目标文件路径或目标文件描述符。 |
| dest | string
\|
number | 是 | 目标文件路径或目标文件描述符。 |
| mode | number | 否 | mode提供覆盖文件的选项,当前仅支持0,且默认为0。
<br/>
0:完全覆盖目标文件,未覆盖部分将被裁切掉。 |
| mode | number | 否 | mode提供覆盖文件的选项,当前仅支持0,且默认为0。
<br/>
0:完全覆盖目标文件,未覆盖部分将被裁切掉。 |
| callback | AsyncCallback
<
void
>
| 是 | 异步复制文件之后的回调。 |
| callback | AsyncCallback
<
void
>
| 是 | 异步复制文件之后的回调。 |
**示例:**
**示例:**
```
js
```
js
...
@@ -438,11 +438,11 @@ copyFileSync(src: string | number, dest: string | number, mode?: number): void
...
@@ -438,11 +438,11 @@ copyFileSync(src: string | number, dest: string | number, mode?: number): void
**系统能力**
:SystemCapability.FileManagement.File.FileIO
**系统能力**
:SystemCapability.FileManagement.File.FileIO
**参数:**
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| 参数名 | 类型 | 必填 | 说明 |
| ---- | -------------------------- | ---- | ---------------------------------------- |
| ---- | -------------------------- | ---- | ---------------------------------------- |
| src | string
\|
number | 是 | 待复制文件的路径或待复制文件的描述符。 |
| src | string
\|
number | 是 | 待复制文件的路径或待复制文件的描述符。 |
| dest | string
\|
number | 是 | 目标文件路径或目标文件描述符。 |
| dest | string
\|
number | 是 | 目标文件路径或目标文件描述符。 |
| mode | number | 否 | mode提供覆盖文件的选项,当前仅支持0,且默认为0。
<br/>
0:完全覆盖目标文件,未覆盖部分将被裁切掉。 |
| mode | number | 否 | mode提供覆盖文件的选项,当前仅支持0,且默认为0。
<br/>
0:完全覆盖目标文件,未覆盖部分将被裁切掉。 |
**示例:**
**示例:**
```
js
```
js
...
@@ -465,9 +465,9 @@ mkdir(path:string, mode?: number): Promise<void>
...
@@ -465,9 +465,9 @@ mkdir(path:string, mode?: number): Promise<void>
| mode | number | 否 | 创建目录的权限,可给定如下权限,以按位或的方式追加权限,默认给定0o775。
<br/>
-
0o775:所有者具有读、写及可执行权限,其余用户具有读及可执行权限。
<br/>
-
0o700:所有者具有读、写及可执行权限。
<br/>
-
0o400:所有者具有读权限。
<br/>
-
0o200:所有者具有写权限。
<br/>
-
0o100:所有者具有可执行权限。
<br/>
-
0o070:所有用户组具有读、写及可执行权限。
<br/>
-
0o040:所有用户组具有读权限。
<br/>
-
0o020:所有用户组具有写权限。
<br/>
-
0o010:所有用户组具有可执行权限。
<br/>
-
0o007:其余用户具有读、写及可执行权限。
<br/>
-
0o004:其余用户具有读权限。
<br/>
-
0o002:其余用户具有写权限。
<br/>
-
0o001:其余用户具有可执行权限。 |
| mode | number | 否 | 创建目录的权限,可给定如下权限,以按位或的方式追加权限,默认给定0o775。
<br/>
-
0o775:所有者具有读、写及可执行权限,其余用户具有读及可执行权限。
<br/>
-
0o700:所有者具有读、写及可执行权限。
<br/>
-
0o400:所有者具有读权限。
<br/>
-
0o200:所有者具有写权限。
<br/>
-
0o100:所有者具有可执行权限。
<br/>
-
0o070:所有用户组具有读、写及可执行权限。
<br/>
-
0o040:所有用户组具有读权限。
<br/>
-
0o020:所有用户组具有写权限。
<br/>
-
0o010:所有用户组具有可执行权限。
<br/>
-
0o007:其余用户具有读、写及可执行权限。
<br/>
-
0o004:其余用户具有读权限。
<br/>
-
0o002:其余用户具有写权限。
<br/>
-
0o001:其余用户具有可执行权限。 |
**返回值:**
**返回值:**
| 类型 | 说明 |
| 类型 | 说明 |
| ------------------- | ---------------------------- |
| ------------------- | ---------------------------- |
| Promise
<
void
>
| Promise对象。无返回值。 |
| Promise
<
void
>
| Promise对象。无返回值。 |
**示例:**
**示例:**
```
js
```
js
...
@@ -538,9 +538,9 @@ open(path: string, flags?: number, mode?: number): Promise<number>
...
@@ -538,9 +538,9 @@ open(path: string, flags?: number, mode?: number): Promise<number>
| mode | number | 否 | 若创建文件,则指定文件的权限,可给定如下权限,以按位或的方式追加权限,默认给定0o666。
<br/>
-
0o666:所有者具有读、写权限,所有用户组具有读、写权限,其余用户具有读、写权限。
<br/>
-
0o700:所有者具有读、写及可执行权限。
<br/>
-
0o400:所有者具有读权限。
<br/>
-
0o200:所有者具有写权限。
<br/>
-
0o100:所有者具有可执行权限。
<br/>
-
0o070:所有用户组具有读、写及可执行权限。
<br/>
-
0o040:所有用户组具有读权限。
<br/>
-
0o020:所有用户组具有写权限。
<br/>
-
0o010:所有用户组具有可执行权限。
<br/>
-
0o007:其余用户具有读、写及可执行权限。
<br/>
-
0o004:其余用户具有读权限。
<br/>
-
0o002:其余用户具有写权限。
<br/>
-
0o001:其余用户具有可执行权限。 |
| mode | number | 否 | 若创建文件,则指定文件的权限,可给定如下权限,以按位或的方式追加权限,默认给定0o666。
<br/>
-
0o666:所有者具有读、写权限,所有用户组具有读、写权限,其余用户具有读、写权限。
<br/>
-
0o700:所有者具有读、写及可执行权限。
<br/>
-
0o400:所有者具有读权限。
<br/>
-
0o200:所有者具有写权限。
<br/>
-
0o100:所有者具有可执行权限。
<br/>
-
0o070:所有用户组具有读、写及可执行权限。
<br/>
-
0o040:所有用户组具有读权限。
<br/>
-
0o020:所有用户组具有写权限。
<br/>
-
0o010:所有用户组具有可执行权限。
<br/>
-
0o007:其余用户具有读、写及可执行权限。
<br/>
-
0o004:其余用户具有读权限。
<br/>
-
0o002:其余用户具有写权限。
<br/>
-
0o001:其余用户具有可执行权限。 |
**返回值:**
**返回值:**
| 类型 | 说明 |
| 类型 | 说明 |
| --------------------- | ----------- |
| --------------------- | ----------- |
| Promise
<
number
>
| Promise对象。返回打开文件的文件描述符。 |
| Promise
<
number
>
| Promise对象。返回打开文件的文件描述符。 |
**示例:**
**示例:**
```
js
```
js
...
@@ -592,9 +592,9 @@ openSync(path:string, flags?:number, mode?:number): number
...
@@ -592,9 +592,9 @@ openSync(path:string, flags?:number, mode?:number): number
| mode | number | 否 | 若创建文件,则指定文件的权限,可给定如下权限,以按位或的方式追加权限,默认给定0o666。
<br/>
-
0o666:所有者具有读、写权限,所有用户组具有读、写权限,其余用户具有读、写权限。
<br/>
-
0o640:所有者具有读、写权限,所有用户组具有读权限。
<br/>
-
0o700:所有者具有读、写及可执行权限。
<br/>
-
0o400:所有者具有读权限。
<br/>
-
0o200:所有者具有写权限。
<br/>
-
0o100:所有者具有可执行权限。
<br/>
-
0o070:所有用户组具有读、写及可执行权限。
<br/>
-
0o040:所有用户组具有读权限。
<br/>
-
0o020:所有用户组具有写权限。
<br/>
-
0o010:所有用户组具有可执行权限。
<br/>
-
0o007:其余用户具有读、写及可执行权限。
<br/>
-
0o004:其余用户具有读权限。
<br/>
-
0o002:其余用户具有写权限。
<br/>
-
0o001:其余用户具有可执行权限。
<br/>
创建出的文件权限受umask影响,umask随进程启动确定,其修改当前不开放。 |
| mode | number | 否 | 若创建文件,则指定文件的权限,可给定如下权限,以按位或的方式追加权限,默认给定0o666。
<br/>
-
0o666:所有者具有读、写权限,所有用户组具有读、写权限,其余用户具有读、写权限。
<br/>
-
0o640:所有者具有读、写权限,所有用户组具有读权限。
<br/>
-
0o700:所有者具有读、写及可执行权限。
<br/>
-
0o400:所有者具有读权限。
<br/>
-
0o200:所有者具有写权限。
<br/>
-
0o100:所有者具有可执行权限。
<br/>
-
0o070:所有用户组具有读、写及可执行权限。
<br/>
-
0o040:所有用户组具有读权限。
<br/>
-
0o020:所有用户组具有写权限。
<br/>
-
0o010:所有用户组具有可执行权限。
<br/>
-
0o007:其余用户具有读、写及可执行权限。
<br/>
-
0o004:其余用户具有读权限。
<br/>
-
0o002:其余用户具有写权限。
<br/>
-
0o001:其余用户具有可执行权限。
<br/>
创建出的文件权限受umask影响,umask随进程启动确定,其修改当前不开放。 |
**返回值:**
**返回值:**
| 类型 | 说明 |
| 类型 | 说明 |
| ------ | ----------- |
| ------ | ----------- |
| number | 打开文件的文件描述符。 |
| number | 打开文件的文件描述符。 |
**示例:**
**示例:**
```
js
```
js
...
@@ -631,9 +631,9 @@ read(fd: number, buffer: ArrayBuffer, options?: {
...
@@ -631,9 +631,9 @@ read(fd: number, buffer: ArrayBuffer, options?: {
**返回值:**
**返回值:**
| 类型 | 说明 |
| 类型 | 说明 |
| ---------------------------------- | ------ |
| ---------------------------------- | ------ |
| Promise
<
[ReadOut](#readout)
>
| Promise对象。返回读取的结果。 |
| Promise
<
[ReadOut](#readout)
>
| Promise对象。返回读取的结果。 |
**示例:**
**示例:**
```
js
```
js
...
@@ -661,12 +661,12 @@ read(fd: number, buffer: ArrayBuffer, options: {
...
@@ -661,12 +661,12 @@ read(fd: number, buffer: ArrayBuffer, options: {
**系统能力**
:SystemCapability.FileManagement.File.FileIO
**系统能力**
:SystemCapability.FileManagement.File.FileIO
**参数:**
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ---------------------------------------- | ---- | ---------------------------------------- |
| -------- | ---------------------------------------- | ---- | ---------------------------------------- |
| fd | number | 是 | 待读取文件的文件描述符。 |
| fd | number | 是 | 待读取文件的文件描述符。 |
| buffer | ArrayBuffer | 是 | 用于保存读取到的文件数据的缓冲区。 |
| buffer | ArrayBuffer | 是 | 用于保存读取到的文件数据的缓冲区。 |
| options | Object | 否 | 支持如下选项:
<br/>
-
offset,number类型,表示将数据读取到缓冲区的位置,即相对于缓冲区首地址的偏移。可选,默认为0。
<br/>
-
length,number类型,表示期望读取数据的长度。可选,默认缓冲区长度减去偏移长度。
<br/>
-
position,number类型,表示期望读取文件的位置。可选,默认从当前位置开始读。
<br/>
约束:offset+length<=buffer.size。 |
| options | Object | 否 | 支持如下选项:
<br/>
-
offset,number类型,表示将数据读取到缓冲区的位置,即相对于缓冲区首地址的偏移。可选,默认为0。
<br/>
-
length,number类型,表示期望读取数据的长度。可选,默认缓冲区长度减去偏移长度。
<br/>
-
position,number类型,表示期望读取文件的位置。可选,默认从当前位置开始读。
<br/>
约束:offset+length<=buffer.size。 |
| callback | AsyncCallback
<
[ReadOut](#readout)
>
| 是 | 异步读取数据之后的回调。 |
| callback | AsyncCallback
<
[ReadOut](#readout)
>
| 是 | 异步读取数据之后的回调。 |
**示例:**
**示例:**
```
js
```
js
...
@@ -694,16 +694,16 @@ readSync(fd: number, buffer: ArrayBuffer, options?: {
...
@@ -694,16 +694,16 @@ readSync(fd: number, buffer: ArrayBuffer, options?: {
**系统能力**
:SystemCapability.FileManagement.File.FileIO
**系统能力**
:SystemCapability.FileManagement.File.FileIO
**参数:**
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| 参数名 | 类型 | 必填 | 说明 |
| ------- | ----------- | ---- | ---------------------------------------- |
| ------- | ----------- | ---- | ---------------------------------------- |
| fd | number | 是 | 待读取文件的文件描述符。 |
| fd | number | 是 | 待读取文件的文件描述符。 |
| buffer | ArrayBuffer | 是 | 用于保存读取到的文件数据的缓冲区。 |
| buffer | ArrayBuffer | 是 | 用于保存读取到的文件数据的缓冲区。 |
| options | Object | 否 | 支持如下选项:
<br/>
-
offset,number类型,表示将数据读取到缓冲区的位置,即相对于缓冲区首地址的偏移。可选,默认为0。
<br/>
-
length,number类型,表示期望读取数据的长度。可选,默认缓冲区长度减去偏移长度。
<br/>
-
position,number类型,表示期望读取文件的位置。可选,默认从当前位置开始读。
<br/>
约束:offset+length<=buffer.size。 |
| options | Object | 否 | 支持如下选项:
<br/>
-
offset,number类型,表示将数据读取到缓冲区的位置,即相对于缓冲区首地址的偏移。可选,默认为0。
<br/>
-
length,number类型,表示期望读取数据的长度。可选,默认缓冲区长度减去偏移长度。
<br/>
-
position,number类型,表示期望读取文件的位置。可选,默认从当前位置开始读。
<br/>
约束:offset+length<=buffer.size。 |
**返回值:**
**返回值:**
| 类型 | 说明 |
| 类型 | 说明 |
| ------ | -------- |
| ------ | -------- |
| number | 实际读取的长度。 |
| number | 实际读取的长度。 |
**示例:**
**示例:**
```
js
```
js
...
@@ -727,9 +727,9 @@ rmdir(path: string): Promise<void>
...
@@ -727,9 +727,9 @@ rmdir(path: string): Promise<void>
| path | string | 是 | 待删除目录的应用沙箱路径。 |
| path | string | 是 | 待删除目录的应用沙箱路径。 |
**返回值:**
**返回值:**
| 类型 | 说明 |
| 类型 | 说明 |
| ------------------- | ---------------------------- |
| ------------------- | ---------------------------- |
| Promise
<
void
>
| Promise对象。无返回值。 |
| Promise
<
void
>
| Promise对象。无返回值。 |
**示例:**
**示例:**
```
js
```
js
...
@@ -797,9 +797,9 @@ unlink(path:string): Promise<void>
...
@@ -797,9 +797,9 @@ unlink(path:string): Promise<void>
| path | string | 是 | 待删除文件的应用沙箱路径。 |
| path | string | 是 | 待删除文件的应用沙箱路径。 |
**返回值:**
**返回值:**
| 类型 | 说明 |
| 类型 | 说明 |
| ------------------- | ---------------------------- |
| ------------------- | ---------------------------- |
| Promise
<
void
>
| Promise对象。无返回值。 |
| Promise
<
void
>
| Promise对象。无返回值。 |
**示例:**
**示例:**
```
js
```
js
...
@@ -866,16 +866,16 @@ write(fd: number, buffer: ArrayBuffer | string, options?: {
...
@@ -866,16 +866,16 @@ write(fd: number, buffer: ArrayBuffer | string, options?: {
**系统能力**
:SystemCapability.FileManagement.File.FileIO
**系统能力**
:SystemCapability.FileManagement.File.FileIO
**参数:**
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| 参数名 | 类型 | 必填 | 说明 |
| ------- | ------------------------------- | ---- | ---------------------------------------- |
| ------- | ------------------------------- | ---- | ---------------------------------------- |
| fd | number | 是 | 待写入文件的文件描述符。 |
| fd | number | 是 | 待写入文件的文件描述符。 |
| buffer | ArrayBuffer
\|
string | 是 | 待写入文件的数据,可来自缓冲区或字符串。 |
| buffer | ArrayBuffer
\|
string | 是 | 待写入文件的数据,可来自缓冲区或字符串。 |
| options | Object | 否 | 支持如下选项:
<br/>
-
offset,number类型,表示期望写入数据的位置相对于数据首地址的偏移。可选,默认为0。
<br/>
-
length,number类型,表示期望写入数据的长度。可选,默认缓冲区长度减去偏移长度。
<br/>
-
position,number类型,表示期望写入文件的位置。可选,默认从当前位置开始写。
<br/>
-
encoding,string类型,当数据是string类型时有效,表示数据的编码方式,默认
'utf-8'。仅支持
'utf-8'。
<br/>
约束:offset+length<=buffer.size。 |
| options | Object | 否 | 支持如下选项:
<br/>
-
offset,number类型,表示期望写入数据的位置相对于数据首地址的偏移。可选,默认为0。
<br/>
-
length,number类型,表示期望写入数据的长度。可选,默认缓冲区长度减去偏移长度。
<br/>
-
position,number类型,表示期望写入文件的位置。可选,默认从当前位置开始写。
<br/>
-
encoding,string类型,当数据是string类型时有效,表示数据的编码方式,默认
'utf-8'。仅支持
'utf-8'。
<br/>
约束:offset+length<=buffer.size。 |
**返回值:**
**返回值:**
| 类型 | 说明 |
| 类型 | 说明 |
| --------------------- | -------- |
| --------------------- | -------- |
| Promise
<
number
>
| Promise对象。返回实际写入的长度。 |
| Promise
<
number
>
| Promise对象。返回实际写入的长度。 |
**示例:**
**示例:**
```
js
```
js
...
@@ -902,12 +902,12 @@ write(fd: number, buffer: ArrayBuffer | string, options: {
...
@@ -902,12 +902,12 @@ write(fd: number, buffer: ArrayBuffer | string, options: {
**系统能力**
:SystemCapability.FileManagement.File.FileIO
**系统能力**
:SystemCapability.FileManagement.File.FileIO
**参数:**
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ------------------------------- | ---- | ---------------------------------------- |
| -------- | ------------------------------- | ---- | ---------------------------------------- |
| fd | number | 是 | 待写入文件的文件描述符。 |
| fd | number | 是 | 待写入文件的文件描述符。 |
| buffer | ArrayBuffer
\|
string | 是 | 待写入文件的数据,可来自缓冲区或字符串。 |
| buffer | ArrayBuffer
\|
string | 是 | 待写入文件的数据,可来自缓冲区或字符串。 |
| options | Object | 否 | 支持如下选项:
<br/>
-
offset,number类型,表示期望写入数据的位置相对于数据首地址的偏移。可选,默认为0。
<br/>
-
length,number类型,表示期望写入数据的长度。可选,默认缓冲区长度减去偏移长度。
<br/>
-
position,number类型,表示期望写入文件的位置。可选,默认从当前位置开始写。
<br/>
-
encoding,string类型,当数据是string类型时有效,表示数据的编码方式,默认
'utf-8'。仅支持
'utf-8'。
<br/>
约束:offset+length<=buffer.size。 |
| options | Object | 否 | 支持如下选项:
<br/>
-
offset,number类型,表示期望写入数据的位置相对于数据首地址的偏移。可选,默认为0。
<br/>
-
length,number类型,表示期望写入数据的长度。可选,默认缓冲区长度减去偏移长度。
<br/>
-
position,number类型,表示期望写入文件的位置。可选,默认从当前位置开始写。
<br/>
-
encoding,string类型,当数据是string类型时有效,表示数据的编码方式,默认
'utf-8'。仅支持
'utf-8'。
<br/>
约束:offset+length<=buffer.size。 |
| callback | AsyncCallback
<
number
>
| 是 | 异步将数据写入完成后执行的回调函数。 |
| callback | AsyncCallback
<
number
>
| 是 | 异步将数据写入完成后执行的回调函数。 |
**示例:**
**示例:**
```
js
```
js
...
@@ -934,16 +934,16 @@ writeSync(fd: number, buffer: ArrayBuffer | string, options?: {
...
@@ -934,16 +934,16 @@ writeSync(fd: number, buffer: ArrayBuffer | string, options?: {
**系统能力**
:SystemCapability.FileManagement.File.FileIO
**系统能力**
:SystemCapability.FileManagement.File.FileIO
**参数:**
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| 参数名 | 类型 | 必填 | 说明 |
| ------- | ------------------------------- | ---- | ---------------------------------------- |
| ------- | ------------------------------- | ---- | ---------------------------------------- |
| fd | number | 是 | 待写入文件的文件描述符。 |
| fd | number | 是 | 待写入文件的文件描述符。 |
| buffer | ArrayBuffer
\|
string | 是 | 待写入文件的数据,可来自缓冲区或字符串。 |
| buffer | ArrayBuffer
\|
string | 是 | 待写入文件的数据,可来自缓冲区或字符串。 |
| options | Object | 否 | 支持如下选项:
<br/>
-
offset,number类型,表示期望写入数据的位置相对于数据首地址的偏移。可选,默认为0。
<br/>
-
length,number类型,表示期望写入数据的长度。可选,默认缓冲区长度减去偏移长度。
<br/>
-
position,number类型,表示期望写入文件的位置。可选,默认从当前位置开始写。
<br/>
-
encoding,string类型,当数据是string类型时有效,表示数据的编码方式,默认
'utf-8'。仅支持
'utf-8'。
<br/>
约束:offset+length<=buffer.size。 |
| options | Object | 否 | 支持如下选项:
<br/>
-
offset,number类型,表示期望写入数据的位置相对于数据首地址的偏移。可选,默认为0。
<br/>
-
length,number类型,表示期望写入数据的长度。可选,默认缓冲区长度减去偏移长度。
<br/>
-
position,number类型,表示期望写入文件的位置。可选,默认从当前位置开始写。
<br/>
-
encoding,string类型,当数据是string类型时有效,表示数据的编码方式,默认
'utf-8'。仅支持
'utf-8'。
<br/>
约束:offset+length<=buffer.size。 |
**返回值:**
**返回值:**
| 类型 | 说明 |
| 类型 | 说明 |
| ------ | -------- |
| ------ | -------- |
| number | 实际写入的长度。 |
| number | 实际写入的长度。 |
**示例:**
**示例:**
```
js
```
js
...
@@ -967,9 +967,9 @@ hash(path: string, algorithm: string): Promise<string>
...
@@ -967,9 +967,9 @@ hash(path: string, algorithm: string): Promise<string>
| algorithm | string | 是 | 哈希计算采用的算法。可选
"md5"、"sha1"
或
"sha256"。建议采用安全强度更高的
"sha256"。 |
| algorithm | string | 是 | 哈希计算采用的算法。可选
"md5"、"sha1"
或
"sha256"。建议采用安全强度更高的
"sha256"。 |
**返回值:**
**返回值:**
| 类型 | 说明 |
| 类型 | 说明 |
| --------------------- | -------------------------- |
| --------------------- | -------------------------- |
| Promise
<
string
>
| Promise对象。返回文件的哈希值。表示为十六进制数字串,所有字母均大写。 |
| Promise
<
string
>
| Promise对象。返回文件的哈希值。表示为十六进制数字串,所有字母均大写。 |
**示例:**
**示例:**
```
js
```
js
...
@@ -1021,9 +1021,9 @@ chmod(path: string, mode: number):Promise<void>
...
@@ -1021,9 +1021,9 @@ chmod(path: string, mode: number):Promise<void>
| mode | number | 是 | 改变文件权限,可给定如下权限,以按位或的方式追加权限。
<br/>
-
0o700:所有者具有读、写及可执行权限。
<br/>
-
0o400:所有者具有读权限。
<br/>
-
0o200:所有者具有写权限。
<br/>
-
0o100:所有者具有可执行权限。
<br/>
-
0o070:所有用户组具有读、写及可执行权限。
<br/>
-
0o040:所有用户组具有读权限。
<br/>
-
0o020:所有用户组具有写权限。
<br/>
-
0o010:所有用户组具有可执行权限。
<br/>
-
0o007:其余用户具有读、写及可执行权限。
<br/>
-
0o004:其余用户具有读权限。
<br/>
-
0o002:其余用户具有写权限。
<br/>
-
0o001:其余用户具有可执行权限。 |
| mode | number | 是 | 改变文件权限,可给定如下权限,以按位或的方式追加权限。
<br/>
-
0o700:所有者具有读、写及可执行权限。
<br/>
-
0o400:所有者具有读权限。
<br/>
-
0o200:所有者具有写权限。
<br/>
-
0o100:所有者具有可执行权限。
<br/>
-
0o070:所有用户组具有读、写及可执行权限。
<br/>
-
0o040:所有用户组具有读权限。
<br/>
-
0o020:所有用户组具有写权限。
<br/>
-
0o010:所有用户组具有可执行权限。
<br/>
-
0o007:其余用户具有读、写及可执行权限。
<br/>
-
0o004:其余用户具有读权限。
<br/>
-
0o002:其余用户具有写权限。
<br/>
-
0o001:其余用户具有可执行权限。 |
**返回值:**
**返回值:**
| 类型 | 说明 |
| 类型 | 说明 |
| ------------------- | ---------------------------- |
| ------------------- | ---------------------------- |
| Promise
<
void
>
| Promise对象。无返回值。 |
| Promise
<
void
>
| Promise对象。无返回值。 |
**示例:**
**示例:**
```
js
```
js
...
@@ -1087,14 +1087,14 @@ fstat(fd: number): Promise<Stat>
...
@@ -1087,14 +1087,14 @@ fstat(fd: number): Promise<Stat>
**系统能力**
:SystemCapability.FileManagement.File.FileIO
**系统能力**
:SystemCapability.FileManagement.File.FileIO
**参数:**
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| 参数名 | 类型 | 必填 | 说明 |
| ---- | ------ | ---- | ------------ |
| ---- | ------ | ---- | ------------ |
| fd | number | 是 | 待获取文件状态的文件描述符。 |
| fd | number | 是 | 待获取文件状态的文件描述符。 |
**返回值:**
**返回值:**
| 类型 | 说明 |
| 类型 | 说明 |
| ---------------------------- | ---------- |
| ---------------------------- | ---------- |
| Promise
<
[Stat](#stat)
>
| Promise对象。返回表示文件状态的具体信息。 |
| Promise
<
[Stat](#stat)
>
| Promise对象。返回表示文件状态的具体信息。 |
**示例:**
**示例:**
```
js
```
js
...
@@ -1115,10 +1115,10 @@ fstat(fd: number, callback: AsyncCallback<Stat>): void
...
@@ -1115,10 +1115,10 @@ fstat(fd: number, callback: AsyncCallback<Stat>): void
**系统能力**
:SystemCapability.FileManagement.File.FileIO
**系统能力**
:SystemCapability.FileManagement.File.FileIO
**参数:**
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ---------------------------------- | ---- | ---------------- |
| -------- | ---------------------------------- | ---- | ---------------- |
| fd | number | 是 | 待获取文件状态的文件描述符。 |
| fd | number | 是 | 待获取文件状态的文件描述符。 |
| callback | AsyncCallback
<
[Stat](#stat)
>
| 是 | 异步获取文件状态信息之后的回调。 |
| callback | AsyncCallback
<
[Stat](#stat)
>
| 是 | 异步获取文件状态信息之后的回调。 |
**示例:**
**示例:**
```
js
```
js
...
@@ -1138,14 +1138,14 @@ fstatSync(fd: number): Stat
...
@@ -1138,14 +1138,14 @@ fstatSync(fd: number): Stat
**系统能力**
:SystemCapability.FileManagement.File.FileIO
**系统能力**
:SystemCapability.FileManagement.File.FileIO
**参数:**
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| 参数名 | 类型 | 必填 | 说明 |
| ---- | ------ | ---- | ------------ |
| ---- | ------ | ---- | ------------ |
| fd | number | 是 | 待获取文件状态的文件描述符。 |
| fd | number | 是 | 待获取文件状态的文件描述符。 |
**返回值:**
**返回值:**
| 类型 | 说明 |
| 类型 | 说明 |
| ------------- | ---------- |
| ------------- | ---------- |
|
[
Stat
](
#stat
)
| 表示文件状态的具体信息。 |
|
[
Stat
](
#stat
)
| 表示文件状态的具体信息。 |
**示例:**
**示例:**
```
js
```
js
...
@@ -1163,15 +1163,15 @@ ftruncate(fd: number, len?: number): Promise<void>
...
@@ -1163,15 +1163,15 @@ ftruncate(fd: number, len?: number): Promise<void>
**系统能力**
:SystemCapability.FileManagement.File.FileIO
**系统能力**
:SystemCapability.FileManagement.File.FileIO
**参数:**
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| 参数名 | 类型 | 必填 | 说明 |
| ---- | ------ | ---- | ---------------- |
| ---- | ------ | ---- | ---------------- |
| fd | number | 是 | 待截断文件的文件描述符。 |
| fd | number | 是 | 待截断文件的文件描述符。 |
| len | number | 否 | 文件截断后的长度,以字节为单位。 |
| len | number | 否 | 文件截断后的长度,以字节为单位。 |
**返回值:**
**返回值:**
| 类型 | 说明 |
| 类型 | 说明 |
| ------------------- | ---------------------------- |
| ------------------- | ---------------------------- |
| Promise
<
void
>
| Promise对象。无返回值。|
| Promise
<
void
>
| Promise对象。无返回值。|
**示例:**
**示例:**
```
js
```
js
...
@@ -1193,11 +1193,11 @@ ftruncate(fd: number, len: number, callback:AsyncCallback<void>): void
...
@@ -1193,11 +1193,11 @@ ftruncate(fd: number, len: number, callback:AsyncCallback<void>): void
**系统能力**
:SystemCapability.FileManagement.File.FileIO
**系统能力**
:SystemCapability.FileManagement.File.FileIO
**参数:**
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ------------------------- | ---- | ---------------- |
| -------- | ------------------------- | ---- | ---------------- |
| fd | number | 是 | 待截断文件的文件描述符。 |
| fd | number | 是 | 待截断文件的文件描述符。 |
| len | number | 是 | 文件截断后的长度,以字节为单位。 |
| len | number | 是 | 文件截断后的长度,以字节为单位。 |
| callback | AsyncCallback
<
void
>
| 是 | 回调函数,本调用无返回值。 |
| callback | AsyncCallback
<
void
>
| 是 | 回调函数,本调用无返回值。 |
**示例:**
**示例:**
```
js
```
js
...
@@ -1216,10 +1216,10 @@ ftruncateSync(fd: number, len?: number): void
...
@@ -1216,10 +1216,10 @@ ftruncateSync(fd: number, len?: number): void
**系统能力**
:SystemCapability.FileManagement.File.FileIO
**系统能力**
:SystemCapability.FileManagement.File.FileIO
**参数:**
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| 参数名 | 类型 | 必填 | 说明 |
| ---- | ------ | ---- | ---------------- |
| ---- | ------ | ---- | ---------------- |
| fd | number | 是 | 待截断文件的文件描述符。 |
| fd | number | 是 | 待截断文件的文件描述符。 |
| len | number | 否 | 文件截断后的长度,以字节为单位。 |
| len | number | 否 | 文件截断后的长度,以字节为单位。 |
**示例:**
**示例:**
```
js
```
js
...
@@ -1242,9 +1242,9 @@ truncate(path: string, len?: number): Promise<void>
...
@@ -1242,9 +1242,9 @@ truncate(path: string, len?: number): Promise<void>
| len | number | 否 | 文件截断后的长度,以字节为单位。 |
| len | number | 否 | 文件截断后的长度,以字节为单位。 |
**返回值:**
**返回值:**
| 类型 | 说明 |
| 类型 | 说明 |
| ------------------- | ---------------------------- |
| ------------------- | ---------------------------- |
| Promise
<
void
>
| Promise对象。无返回值。 |
| Promise
<
void
>
| Promise对象。无返回值。 |
**示例:**
**示例:**
```
js
```
js
...
@@ -1318,9 +1318,9 @@ readText(filePath: string, options?: {
...
@@ -1318,9 +1318,9 @@ readText(filePath: string, options?: {
| options | Object | 否 | 支持如下选项:
<br/>
-
position,number类型,表示期望读取文件的位置。可选,默认从当前位置开始读取。
<br/>
-
length,number类型,表示期望读取数据的长度。可选,默认缓冲区长度减去偏移长度。
<br/>
-
encoding,string类型,当数据是
string
类型时有效,表示数据的编码方式,默认
'utf-8',仅支持
'utf-8'。 |
| options | Object | 否 | 支持如下选项:
<br/>
-
position,number类型,表示期望读取文件的位置。可选,默认从当前位置开始读取。
<br/>
-
length,number类型,表示期望读取数据的长度。可选,默认缓冲区长度减去偏移长度。
<br/>
-
encoding,string类型,当数据是
string
类型时有效,表示数据的编码方式,默认
'utf-8',仅支持
'utf-8'。 |
**返回值:**
**返回值:**
| 类型 | 说明 |
| 类型 | 说明 |
| --------------------- | ---------- |
| --------------------- | ---------- |
| Promise
<
string
>
| Promise对象。返回读取文件的内容。 |
| Promise
<
string
>
| Promise对象。返回读取文件的内容。 |
**示例:**
**示例:**
```
js
```
js
...
@@ -1378,9 +1378,9 @@ readTextSync(filePath: string, options?: {
...
@@ -1378,9 +1378,9 @@ readTextSync(filePath: string, options?: {
| options | Object | 否 | 支持如下选项:
<br/>
-
position,number类型,表示期望读取文件的位置。可选,默认从当前位置开始读取。
<br/>
-
length,number类型,表示期望读取数据的长度。可选,默认缓冲区长度减去偏移长度。
<br/>
-
encoding,string类型,当数据是
string
类型时有效,表示数据的编码方式,默认
'utf-8',仅支持
'utf-8'。 |
| options | Object | 否 | 支持如下选项:
<br/>
-
position,number类型,表示期望读取文件的位置。可选,默认从当前位置开始读取。
<br/>
-
length,number类型,表示期望读取数据的长度。可选,默认缓冲区长度减去偏移长度。
<br/>
-
encoding,string类型,当数据是
string
类型时有效,表示数据的编码方式,默认
'utf-8',仅支持
'utf-8'。 |
**返回值:**
**返回值:**
| 类型 | 说明 |
| 类型 | 说明 |
| ------ | -------------------- |
| ------ | -------------------- |
| string | 返回读取文件的内容。 |
| string | 返回读取文件的内容。 |
**示例:**
**示例:**
```
js
```
js
...
@@ -1402,9 +1402,9 @@ lstat(path: string): Promise<Stat>
...
@@ -1402,9 +1402,9 @@ lstat(path: string): Promise<Stat>
| path | string | 是 | 目标文件的应用沙箱路径。 |
| path | string | 是 | 目标文件的应用沙箱路径。 |
**返回值:**
**返回值:**
| 类型 | 说明 |
| 类型 | 说明 |
| ---------------------------- | ---------- |
| ---------------------------- | ---------- |
| Promise
<
[Stat](#stat)
>
| promise对象,返回文件对象,表示文件的具体信息,详情见stat。 |
| Promise
<
[Stat](#stat)
>
| promise对象,返回文件对象,表示文件的具体信息,详情见stat。 |
**示例:**
**示例:**
```
js
```
js
...
@@ -1452,9 +1452,9 @@ lstatSync(path:string): Stat
...
@@ -1452,9 +1452,9 @@ lstatSync(path:string): Stat
| path | string | 是 | 目标文件的应用沙箱路径。 |
| path | string | 是 | 目标文件的应用沙箱路径。 |
**返回值:**
**返回值:**
| 类型 | 说明 |
| 类型 | 说明 |
| ------------- | ---------- |
| ------------- | ---------- |
|
[
Stat
](
#stat
)
| 表示文件的具体信息。 |
|
[
Stat
](
#stat
)
| 表示文件的具体信息。 |
**示例:**
**示例:**
```
js
```
js
...
@@ -1475,15 +1475,15 @@ read(buffer: ArrayBuffer, options?: {
...
@@ -1475,15 +1475,15 @@ read(buffer: ArrayBuffer, options?: {
**系统能力**
:SystemCapability.FileManagement.File.FileIO
**系统能力**
:SystemCapability.FileManagement.File.FileIO
**参数:**
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| 参数名 | 类型 | 必填 | 说明 |
| ------- | ----------- | ---- | ------------------------------------------------------------ |
| ------- | ----------- | ---- | ------------------------------------------------------------ |
| buffer | ArrayBuffer | 是 | 用于保存读取到的文件数据的缓冲区。 |
| buffer | ArrayBuffer | 是 | 用于保存读取到的文件数据的缓冲区。 |
| options | Object | 否 | 支持如下选项:
<br/>
-
offset,number类型,表示将数据读取到缓冲区的位置,即相对于缓冲区首地址的偏移。可选,默认为0。
<br/>
-
length,number类型,表示期望读取数据的长度。可选,默认缓冲区长度减去偏移长度。
<br/>
约束:offset+length<=buffer.size。 |
| options | Object | 否 | 支持如下选项:
<br/>
-
offset,number类型,表示将数据读取到缓冲区的位置,即相对于缓冲区首地址的偏移。可选,默认为0。
<br/>
-
length,number类型,表示期望读取数据的长度。可选,默认缓冲区长度减去偏移长度。
<br/>
约束:offset+length<=buffer.size。 |
**返回值:**
**返回值:**
| 类型 | 说明 |
| 类型 | 说明 |
| ---------------------------------- | ------ |
| ---------------------------------- | ------ |
| Promise
<
[ReadOut](#readout)
>
| Promise对象。返回读取的结果。 |
| Promise
<
[ReadOut](#readout)
>
| Promise对象。返回读取的结果。 |
**示例:**
**示例:**
```
js
```
js
...
@@ -1509,11 +1509,11 @@ read(buffer: ArrayBuffer, options: {
...
@@ -1509,11 +1509,11 @@ read(buffer: ArrayBuffer, options: {
**系统能力**
:SystemCapability.FileManagement.File.FileIO
**系统能力**
:SystemCapability.FileManagement.File.FileIO
**参数:**
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ---------------------------------------- | ---- | ---------------------------------------- |
| -------- | ---------------------------------------- | ---- | ---------------------------------------- |
| buffer | ArrayBuffer | 是 | 用于保存读取到的文件数据的缓冲区。 |
| buffer | ArrayBuffer | 是 | 用于保存读取到的文件数据的缓冲区。 |
| options | Object | 否 | 支持如下选项:
<br/>
-
offset,number类型,表示将数据读取到缓冲区的位置,即相对于缓冲区首地址的偏移。可选,默认为0。
<br/>
-
length,number类型,表示期望读取数据的长度。可选,默认缓冲区长度减去偏移长度。
<br/>
约束:offset+length<=buffer.size。 |
| options | Object | 否 | 支持如下选项:
<br/>
-
offset,number类型,表示将数据读取到缓冲区的位置,即相对于缓冲区首地址的偏移。可选,默认为0。
<br/>
-
length,number类型,表示期望读取数据的长度。可选,默认缓冲区长度减去偏移长度。
<br/>
约束:offset+length<=buffer.size。 |
| callback | AsyncCallback
<
[ReadOut](#readout)
>
| 是 | 异步从文件读取数据之后的回调。 |
| callback | AsyncCallback
<
[ReadOut](#readout)
>
| 是 | 异步从文件读取数据之后的回调。 |
**示例:**
**示例:**
```
js
```
js
...
@@ -1542,9 +1542,9 @@ rename(oldPath: string, newPath: string): Promise<void>
...
@@ -1542,9 +1542,9 @@ rename(oldPath: string, newPath: string): Promise<void>
| newPath | String | 是 | 目标文件的新应用沙箱路径。 |
| newPath | String | 是 | 目标文件的新应用沙箱路径。 |
**返回值:**
**返回值:**
| 类型 | 说明 |
| 类型 | 说明 |
| ------------------- | ---------------------------- |
| ------------------- | ---------------------------- |
| Promise
<
void
>
| Promise对象。无返回值。 |
| Promise
<
void
>
| Promise对象。无返回值。 |
**示例:**
**示例:**
```
js
```
js
...
@@ -1607,14 +1607,14 @@ fsync(fd: number): Promise<void>
...
@@ -1607,14 +1607,14 @@ fsync(fd: number): Promise<void>
**系统能力**
:SystemCapability.FileManagement.File.FileIO
**系统能力**
:SystemCapability.FileManagement.File.FileIO
**参数:**
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| 参数名 | 类型 | 必填 | 说明 |
| ---- | ------ | ---- | ------------ |
| ---- | ------ | ---- | ------------ |
| fd | number | 是 | 待同步文件的文件描述符。 |
| fd | number | 是 | 待同步文件的文件描述符。 |
**返回值:**
**返回值:**
| 类型 | 说明 |
| 类型 | 说明 |
| ------------------- | ---------------------------- |
| ------------------- | ---------------------------- |
| Promise
<
void
>
| Promise对象。无返回值。 |
| Promise
<
void
>
| Promise对象。无返回值。 |
**示例:**
**示例:**
```
js
```
js
...
@@ -1635,10 +1635,10 @@ fsync(fd: number, callback: AsyncCallback<void>): void
...
@@ -1635,10 +1635,10 @@ fsync(fd: number, callback: AsyncCallback<void>): void
**系统能力**
:SystemCapability.FileManagement.File.FileIO
**系统能力**
:SystemCapability.FileManagement.File.FileIO
**参数:**
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ------------------------- | ---- | --------------- |
| -------- | ------------------------- | ---- | --------------- |
| fd | number | 是 | 待同步文件的文件描述符。 |
| fd | number | 是 | 待同步文件的文件描述符。 |
| Callback | AsyncCallback
<
void
>
| 是 | 异步将文件数据同步之后的回调。 |
| Callback | AsyncCallback
<
void
>
| 是 | 异步将文件数据同步之后的回调。 |
**示例:**
**示例:**
```
js
```
js
...
@@ -1657,9 +1657,9 @@ fsyncSync(fd: number): void
...
@@ -1657,9 +1657,9 @@ fsyncSync(fd: number): void
**系统能力**
:SystemCapability.FileManagement.File.FileIO
**系统能力**
:SystemCapability.FileManagement.File.FileIO
**参数:**
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| 参数名 | 类型 | 必填 | 说明 |
| ---- | ------ | ---- | ------------ |
| ---- | ------ | ---- | ------------ |
| fd | number | 是 | 待同步文件的文件描述符。 |
| fd | number | 是 | 待同步文件的文件描述符。 |
**示例:**
**示例:**
```
js
```
js
...
@@ -1676,14 +1676,14 @@ fdatasync(fd: number): Promise<void>
...
@@ -1676,14 +1676,14 @@ fdatasync(fd: number): Promise<void>
**系统能力**
:SystemCapability.FileManagement.File.FileIO
**系统能力**
:SystemCapability.FileManagement.File.FileIO
**参数:**
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| 参数名 | 类型 | 必填 | 说明 |
| ---- | ------ | ---- | ------------ |
| ---- | ------ | ---- | ------------ |
| fd | number | 是 | 待同步文件的文件描述符。 |
| fd | number | 是 | 待同步文件的文件描述符。 |
**返回值:**
**返回值:**
| 类型 | 说明 |
| 类型 | 说明 |
| ------------------- | ---------------------------- |
| ------------------- | ---------------------------- |
| Promise
<
void
>
| Promise对象。无返回值。 |
| Promise
<
void
>
| Promise对象。无返回值。 |
**示例:**
**示例:**
```
js
```
js
...
@@ -1704,10 +1704,10 @@ fdatasync(fd: number, callback:AsyncCallback<void>): void
...
@@ -1704,10 +1704,10 @@ fdatasync(fd: number, callback:AsyncCallback<void>): void
**系统能力**
:SystemCapability.FileManagement.File.FileIO
**系统能力**
:SystemCapability.FileManagement.File.FileIO
**参数:**
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ------------------------------- | ---- | ----------------- |
| -------- | ------------------------------- | ---- | ----------------- |
| fd | number | 是 | 待同步文件的文件描述符。 |
| fd | number | 是 | 待同步文件的文件描述符。 |
| callback | AsyncCallback
<
void
>
| 是 | 异步将文件内容数据同步之后的回调。 |
| callback | AsyncCallback
<
void
>
| 是 | 异步将文件内容数据同步之后的回调。 |
**示例:**
**示例:**
```
js
```
js
...
@@ -1726,9 +1726,9 @@ fdatasyncSync(fd: number): void
...
@@ -1726,9 +1726,9 @@ fdatasyncSync(fd: number): void
**系统能力**
:SystemCapability.FileManagement.File.FileIO
**系统能力**
:SystemCapability.FileManagement.File.FileIO
**参数:**
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| 参数名 | 类型 | 必填 | 说明 |
| ---- | ------ | ---- | ------------ |
| ---- | ------ | ---- | ------------ |
| fd | number | 是 | 待同步文件的文件描述符。 |
| fd | number | 是 | 待同步文件的文件描述符。 |
**示例:**
**示例:**
```
js
```
js
...
@@ -1751,9 +1751,9 @@ symlink(target: string, srcPath: string): Promise<void>
...
@@ -1751,9 +1751,9 @@ symlink(target: string, srcPath: string): Promise<void>
| srcPath | string | 是 | 符号链接文件的应用沙箱路径。 |
| srcPath | string | 是 | 符号链接文件的应用沙箱路径。 |
**返回值:**
**返回值:**
| 类型 | 说明 |
| 类型 | 说明 |
| ------------------- | ---------------------------- |
| ------------------- | ---------------------------- |
| Promise
<
void
>
| Promise对象。无返回值。 |
| Promise
<
void
>
| Promise对象。无返回值。 |
**示例:**
**示例:**
```
js
```
js
...
@@ -1824,9 +1824,9 @@ chown(path: string, uid: number, gid: number): Promise<void>
...
@@ -1824,9 +1824,9 @@ chown(path: string, uid: number, gid: number): Promise<void>
| gid | number | 是 | 新的GID(GroupID)。 |
| gid | number | 是 | 新的GID(GroupID)。 |
**返回值:**
**返回值:**
| 类型 | 说明 |
| 类型 | 说明 |
| ------------------- | ---------------------------- |
| ------------------- | ---------------------------- |
| Promise
<
void
>
| Promise对象。无返回值。 |
| Promise
<
void
>
| Promise对象。无返回值。 |
**示例:**
**示例:**
```
js
```
js
...
@@ -1895,14 +1895,14 @@ mkdtemp(prefix: string): Promise<string>
...
@@ -1895,14 +1895,14 @@ mkdtemp(prefix: string): Promise<string>
**系统能力**
:SystemCapability.FileManagement.File.FileIO
**系统能力**
:SystemCapability.FileManagement.File.FileIO
**参数:**
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| 参数名 | 类型 | 必填 | 说明 |
| ------ | ------ | ---- | --------------------------- |
| ------ | ------ | ---- | --------------------------- |
| prefix | string | 是 | 用随机产生的字符串替换以“XXXXXX”结尾目录路径。 |
| prefix | string | 是 | 用随机产生的字符串替换以“XXXXXX”结尾目录路径。 |
**返回值:**
**返回值:**
| 类型 | 说明 |
| 类型 | 说明 |
| --------------------- | ---------- |
| --------------------- | ---------- |
| Promise
<
string
>
| Promise对象。返回生成的唯一目录路径。 |
| Promise
<
string
>
| Promise对象。返回生成的唯一目录路径。 |
**示例:**
**示例:**
```
js
```
js
...
@@ -1923,10 +1923,10 @@ mkdtemp(prefix: string, callback: AsyncCallback<string>): void
...
@@ -1923,10 +1923,10 @@ mkdtemp(prefix: string, callback: AsyncCallback<string>): void
**系统能力**
:SystemCapability.FileManagement.File.FileIO
**系统能力**
:SystemCapability.FileManagement.File.FileIO
**参数:**
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| 参数名 | 类型 | 必填 | 说明 |
| -------- | --------------------------- | ---- | --------------------------- |
| -------- | --------------------------- | ---- | --------------------------- |
| prefix | string | 是 | 用随机产生的字符串替换以“XXXXXX”结尾目录路径。 |
| prefix | string | 是 | 用随机产生的字符串替换以“XXXXXX”结尾目录路径。 |
| callback | AsyncCallback
<
string
>
| 是 | 异步创建临时目录之后的回调。 |
| callback | AsyncCallback
<
string
>
| 是 | 异步创建临时目录之后的回调。 |
**示例:**
**示例:**
```
js
```
js
...
@@ -1945,14 +1945,14 @@ mkdtempSync(prefix: string): string
...
@@ -1945,14 +1945,14 @@ mkdtempSync(prefix: string): string
**系统能力**
:SystemCapability.FileManagement.File.FileIO
**系统能力**
:SystemCapability.FileManagement.File.FileIO
**参数:**
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| 参数名 | 类型 | 必填 | 说明 |
| ------ | ------ | ---- | --------------------------- |
| ------ | ------ | ---- | --------------------------- |
| prefix | string | 是 | 用随机产生的字符串替换以“XXXXXX”结尾目录路径。 |
| prefix | string | 是 | 用随机产生的字符串替换以“XXXXXX”结尾目录路径。 |
**返回值:**
**返回值:**
| 类型 | 说明 |
| 类型 | 说明 |
| ------ | ---------- |
| ------ | ---------- |
| string | 产生的唯一目录路径。 |
| string | 产生的唯一目录路径。 |
**示例:**
**示例:**
```
js
```
js
...
@@ -1969,15 +1969,15 @@ fchmod(fd: number, mode: number): Promise<void>
...
@@ -1969,15 +1969,15 @@ fchmod(fd: number, mode: number): Promise<void>
**系统能力**
:SystemCapability.FileManagement.File.FileIO
**系统能力**
:SystemCapability.FileManagement.File.FileIO
**参数:**
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| 参数名 | 类型 | 必填 | 说明 |
| ---- | ------ | ---- | ---------------------------------------- |
| ---- | ------ | ---- | ---------------------------------------- |
| fd | number | 是 | 待改变文件的文件描述符。 |
| fd | number | 是 | 待改变文件的文件描述符。 |
| mode | number | 是 | 若创建文件,则指定文件的权限,可给定如下权限,以按位或的方式追加权限。
<br/>
-
0o700:所有者具有读、写及可执行权限。
<br/>
-
0o400:所有者具有读权限。
<br/>
-
0o200:所有者具有写权限。
<br/>
-
0o100:所有者具有可执行权限。
<br/>
-
0o070:所有用户组具有读、写及可执行权限。
<br/>
-
0o040:所有用户组具有读权限。
<br/>
-
0o020:所有用户组具有写权限。
<br/>
-
0o010:所有用户组具有可执行权限。
<br/>
-
0o007:其余用户具有读、写及可执行权限。
<br/>
-
0o004:其余用户具有读权限。
<br/>
-
0o002:其余用户具有写权限。
<br/>
-
0o001:其余用户具有可执行权限。 |
| mode | number | 是 | 若创建文件,则指定文件的权限,可给定如下权限,以按位或的方式追加权限。
<br/>
-
0o700:所有者具有读、写及可执行权限。
<br/>
-
0o400:所有者具有读权限。
<br/>
-
0o200:所有者具有写权限。
<br/>
-
0o100:所有者具有可执行权限。
<br/>
-
0o070:所有用户组具有读、写及可执行权限。
<br/>
-
0o040:所有用户组具有读权限。
<br/>
-
0o020:所有用户组具有写权限。
<br/>
-
0o010:所有用户组具有可执行权限。
<br/>
-
0o007:其余用户具有读、写及可执行权限。
<br/>
-
0o004:其余用户具有读权限。
<br/>
-
0o002:其余用户具有写权限。
<br/>
-
0o001:其余用户具有可执行权限。 |
**返回值:**
**返回值:**
| 类型 | 说明 |
| 类型 | 说明 |
| ------------------- | ---------------------------- |
| ------------------- | ---------------------------- |
| Promise
<
void
>
| Promise对象。无返回值。 |
| Promise
<
void
>
| Promise对象。无返回值。 |
**示例:**
**示例:**
```
js
```
js
...
@@ -1998,11 +1998,11 @@ fchmod(fd: number, mode: number, callback: AsyncCallback<void>): void
...
@@ -1998,11 +1998,11 @@ fchmod(fd: number, mode: number, callback: AsyncCallback<void>): void
**系统能力**
:SystemCapability.FileManagement.File.FileIO
**系统能力**
:SystemCapability.FileManagement.File.FileIO
**参数:**
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ------------------------------- | ---- | ---------------------------------------- |
| -------- | ------------------------------- | ---- | ---------------------------------------- |
| fd | number | 是 | 待改变文件的文件描述符。 |
| fd | number | 是 | 待改变文件的文件描述符。 |
| mode | number | 是 | 若创建文件,则指定文件的权限,可给定如下权限,以按位或的方式追加权限。
<br/>
-
0o700:所有者具有读、写及可执行权限。
<br/>
-
0o400:所有者具有读权限。
<br/>
-
0o200:所有者具有写权限。
<br/>
-
0o100:所有者具有可执行权限。
<br/>
-
0o070:所有用户组具有读、写及可执行权限。
<br/>
-
0o040:所有用户组具有读权限。
<br/>
-
0o020:所有用户组具有写权限。
<br/>
-
0o010:所有用户组具有可执行权限。
<br/>
-
0o007:其余用户具有读、写及可执行权限。
<br/>
-
0o004:其余用户具有读权限。
<br/>
-
0o002:其余用户具有写权限。
<br/>
-
0o001:其余用户具有可执行权限。 |
| mode | number | 是 | 若创建文件,则指定文件的权限,可给定如下权限,以按位或的方式追加权限。
<br/>
-
0o700:所有者具有读、写及可执行权限。
<br/>
-
0o400:所有者具有读权限。
<br/>
-
0o200:所有者具有写权限。
<br/>
-
0o100:所有者具有可执行权限。
<br/>
-
0o070:所有用户组具有读、写及可执行权限。
<br/>
-
0o040:所有用户组具有读权限。
<br/>
-
0o020:所有用户组具有写权限。
<br/>
-
0o010:所有用户组具有可执行权限。
<br/>
-
0o007:其余用户具有读、写及可执行权限。
<br/>
-
0o004:其余用户具有读权限。
<br/>
-
0o002:其余用户具有写权限。
<br/>
-
0o001:其余用户具有可执行权限。 |
| callback | AsyncCallback
<
void
>
| 是 | 异步改变文件权限之后的回调。 |
| callback | AsyncCallback
<
void
>
| 是 | 异步改变文件权限之后的回调。 |
**示例:**
**示例:**
```
js
```
js
...
@@ -2021,10 +2021,10 @@ fchmodSync(fd: number, mode: number): void
...
@@ -2021,10 +2021,10 @@ fchmodSync(fd: number, mode: number): void
**系统能力**
:SystemCapability.FileManagement.File.FileIO
**系统能力**
:SystemCapability.FileManagement.File.FileIO
**参数:**
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| 参数名 | 类型 | 必填 | 说明 |
| ---- | ------ | ---- | ---------------------------------------- |
| ---- | ------ | ---- | ---------------------------------------- |
| fd | number | 是 | 待改变文件的文件描述符。 |
| fd | number | 是 | 待改变文件的文件描述符。 |
| mode | number | 是 | 若创建文件,则指定文件的权限,可给定如下权限,以按位或的方式追加权限。
<br/>
-
0o700:所有者具有读、写及可执行权限。
<br/>
-
0o400:所有者具有读权限。
<br/>
-
0o200:所有者具有写权限。
<br/>
-
0o100:所有者具有可执行权限。
<br/>
-
0o070:所有用户组具有读、写及可执行权限。
<br/>
-
0o040:所有用户组具有读权限。
<br/>
-
0o020:所有用户组具有写权限。
<br/>
-
0o010:所有用户组具有可执行权限。
<br/>
-
0o007:其余用户具有读、写及可执行权限。
<br/>
-
0o004:其余用户具有读权限。
<br/>
-
0o002:其余用户具有写权限。
<br/>
-
0o001:其余用户具有可执行权限。 |
| mode | number | 是 | 若创建文件,则指定文件的权限,可给定如下权限,以按位或的方式追加权限。
<br/>
-
0o700:所有者具有读、写及可执行权限。
<br/>
-
0o400:所有者具有读权限。
<br/>
-
0o200:所有者具有写权限。
<br/>
-
0o100:所有者具有可执行权限。
<br/>
-
0o070:所有用户组具有读、写及可执行权限。
<br/>
-
0o040:所有用户组具有读权限。
<br/>
-
0o020:所有用户组具有写权限。
<br/>
-
0o010:所有用户组具有可执行权限。
<br/>
-
0o007:其余用户具有读、写及可执行权限。
<br/>
-
0o004:其余用户具有读权限。
<br/>
-
0o002:其余用户具有写权限。
<br/>
-
0o001:其余用户具有可执行权限。 |
**示例:**
**示例:**
```
js
```
js
...
@@ -2047,9 +2047,9 @@ createStream(path: string, mode: string): Promise<Stream>
...
@@ -2047,9 +2047,9 @@ createStream(path: string, mode: string): Promise<Stream>
| mode | string | 是 | -
r:打开只读文件,该文件必须存在。
<br/>
-
r+:打开可读写的文件,该文件必须存在。
<br/>
-
w:打开只写文件,若文件存在则文件长度清0,即该文件内容会消失。若文件不存在则建立该文件。
<br/>
-
w+:打开可读写文件,若文件存在则文件长度清0,即该文件内容会消失。若文件不存在则建立该文件。
<br/>
-
a:以附加的方式打开只写文件。若文件不存在,则会建立该文件,如果文件存在,写入的数据会被加到文件尾,即文件原先的内容会被保留。
<br/>
-
a+:以附加方式打开可读写的文件。若文件不存在,则会建立该文件,如果文件存在,写入的数据会被加到文件尾后,即文件原先的内容会被保留。 |
| mode | string | 是 | -
r:打开只读文件,该文件必须存在。
<br/>
-
r+:打开可读写的文件,该文件必须存在。
<br/>
-
w:打开只写文件,若文件存在则文件长度清0,即该文件内容会消失。若文件不存在则建立该文件。
<br/>
-
w+:打开可读写文件,若文件存在则文件长度清0,即该文件内容会消失。若文件不存在则建立该文件。
<br/>
-
a:以附加的方式打开只写文件。若文件不存在,则会建立该文件,如果文件存在,写入的数据会被加到文件尾,即文件原先的内容会被保留。
<br/>
-
a+:以附加方式打开可读写的文件。若文件不存在,则会建立该文件,如果文件存在,写入的数据会被加到文件尾后,即文件原先的内容会被保留。 |
**返回值:**
**返回值:**
| 类型 | 说明 |
| 类型 | 说明 |
| --------------------------------- | --------- |
| --------------------------------- | --------- |
| Promise
<
[Stream](#stream7)
>
| Promise对象。返回文件流的结果。 |
| Promise
<
[Stream](#stream7)
>
| Promise对象。返回文件流的结果。 |
**示例:**
**示例:**
```
js
```
js
...
@@ -2099,9 +2099,9 @@ createStreamSync(path: string, mode: string): Stream
...
@@ -2099,9 +2099,9 @@ createStreamSync(path: string, mode: string): Stream
| mode | string | 是 | -
r:打开只读文件,该文件必须存在。
<br/>
-
r+:打开可读写的文件,该文件必须存在。
<br/>
-
w:打开只写文件,若文件存在则文件长度清0,即该文件内容会消失。若文件不存在则建立该文件。
<br/>
-
w+:打开可读写文件,若文件存在则文件长度清0,即该文件内容会消失。若文件不存在则建立该文件。
<br/>
-
a:以附加的方式打开只写文件。若文件不存在,则会建立该文件,如果文件存在,写入的数据会被加到文件尾,即文件原先的内容会被保留。
<br/>
-
a+:以附加方式打开可读写的文件。若文件不存在,则会建立该文件,如果文件存在,写入的数据会被加到文件尾后,即文件原先的内容会被保留。 |
| mode | string | 是 | -
r:打开只读文件,该文件必须存在。
<br/>
-
r+:打开可读写的文件,该文件必须存在。
<br/>
-
w:打开只写文件,若文件存在则文件长度清0,即该文件内容会消失。若文件不存在则建立该文件。
<br/>
-
w+:打开可读写文件,若文件存在则文件长度清0,即该文件内容会消失。若文件不存在则建立该文件。
<br/>
-
a:以附加的方式打开只写文件。若文件不存在,则会建立该文件,如果文件存在,写入的数据会被加到文件尾,即文件原先的内容会被保留。
<br/>
-
a+:以附加方式打开可读写的文件。若文件不存在,则会建立该文件,如果文件存在,写入的数据会被加到文件尾后,即文件原先的内容会被保留。 |
**返回值:**
**返回值:**
| 类型 | 说明 |
| 类型 | 说明 |
| ------------------ | --------- |
| ------------------ | --------- |
|
[
Stream
](
#stream7
)
| 返回文件流的结果。 |
|
[
Stream
](
#stream7
)
| 返回文件流的结果。 |
**示例:**
**示例:**
```
js
```
js
...
@@ -2118,15 +2118,15 @@ fdopenStream(fd: number, mode: string): Promise<Stream>
...
@@ -2118,15 +2118,15 @@ fdopenStream(fd: number, mode: string): Promise<Stream>
**系统能力**
:SystemCapability.FileManagement.File.FileIO
**系统能力**
:SystemCapability.FileManagement.File.FileIO
**参数:**
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| 参数名 | 类型 | 必填 | 说明 |
| ---- | ------ | ---- | ---------------------------------------- |
| ---- | ------ | ---- | ---------------------------------------- |
| fd | number | 是 | 待打开文件的文件描述符。 |
| fd | number | 是 | 待打开文件的文件描述符。 |
| mode | string | 是 | -
r:打开只读文件,该文件必须存在。
<br/>
-
r+:打开可读写的文件,该文件必须存在。
<br/>
-
w:打开只写文件,若文件存在则文件长度清0,即该文件内容会消失。若文件不存在则建立该文件。
<br/>
-
w+:打开可读写文件,若文件存在则文件长度清0,即该文件内容会消失。若文件不存在则建立该文件。
<br/>
-
a:以附加的方式打开只写文件。若文件不存在,则会建立该文件,如果文件存在,写入的数据会被加到文件尾,即文件原先的内容会被保留。
<br/>
-
a+:以附加方式打开可读写的文件。若文件不存在,则会建立该文件,如果文件存在,写入的数据会被加到文件尾后,即文件原先的内容会被保留。 |
| mode | string | 是 | -
r:打开只读文件,该文件必须存在。
<br/>
-
r+:打开可读写的文件,该文件必须存在。
<br/>
-
w:打开只写文件,若文件存在则文件长度清0,即该文件内容会消失。若文件不存在则建立该文件。
<br/>
-
w+:打开可读写文件,若文件存在则文件长度清0,即该文件内容会消失。若文件不存在则建立该文件。
<br/>
-
a:以附加的方式打开只写文件。若文件不存在,则会建立该文件,如果文件存在,写入的数据会被加到文件尾,即文件原先的内容会被保留。
<br/>
-
a+:以附加方式打开可读写的文件。若文件不存在,则会建立该文件,如果文件存在,写入的数据会被加到文件尾后,即文件原先的内容会被保留。 |
**返回值:**
**返回值:**
| 类型 | 说明 |
| 类型 | 说明 |
| --------------------------------- | --------- |
| --------------------------------- | --------- |
| Promise
<
[Stream](#stream7)
>
| Promise对象。返回文件流的结果。 |
| Promise
<
[Stream](#stream7)
>
| Promise对象。返回文件流的结果。 |
**示例:**
**示例:**
```
js
```
js
...
@@ -2148,11 +2148,11 @@ fdopenStream(fd: number, mode: string, callback: AsyncCallback<Stream>): v
...
@@ -2148,11 +2148,11 @@ fdopenStream(fd: number, mode: string, callback: AsyncCallback<Stream>): v
**系统能力**
:SystemCapability.FileManagement.File.FileIO
**系统能力**
:SystemCapability.FileManagement.File.FileIO
**参数:**
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ---------------------------------------- | ---- | ---------------------------------------- |
| -------- | ---------------------------------------- | ---- | ---------------------------------------- |
| fd | number | 是 | 待打开文件的文件描述符。 |
| fd | number | 是 | 待打开文件的文件描述符。 |
| mode | string | 是 | -
r:打开只读文件,该文件必须存在。
<br/>
-
r+:打开可读写的文件,该文件必须存在。
<br/>
-
w:打开只写文件,若文件存在则文件长度清0,即该文件内容会消失。若文件不存在则建立该文件。
<br/>
-
w+:打开可读写文件,若文件存在则文件长度清0,即该文件内容会消失。若文件不存在则建立该文件。
<br/>
-
a:以附加的方式打开只写文件。若文件不存在,则会建立该文件,如果文件存在,写入的数据会被加到文件尾,即文件原先的内容会被保留。
<br/>
-
a+:以附加方式打开可读写的文件。若文件不存在,则会建立该文件,如果文件存在,写入的数据会被加到文件尾后,即文件原先的内容会被保留。 |
| mode | string | 是 | -
r:打开只读文件,该文件必须存在。
<br/>
-
r+:打开可读写的文件,该文件必须存在。
<br/>
-
w:打开只写文件,若文件存在则文件长度清0,即该文件内容会消失。若文件不存在则建立该文件。
<br/>
-
w+:打开可读写文件,若文件存在则文件长度清0,即该文件内容会消失。若文件不存在则建立该文件。
<br/>
-
a:以附加的方式打开只写文件。若文件不存在,则会建立该文件,如果文件存在,写入的数据会被加到文件尾,即文件原先的内容会被保留。
<br/>
-
a+:以附加方式打开可读写的文件。若文件不存在,则会建立该文件,如果文件存在,写入的数据会被加到文件尾后,即文件原先的内容会被保留。 |
| callback | AsyncCallback
<
[Stream](#stream7)
>
| 是 | 异步打开文件流之后的回调。 |
| callback | AsyncCallback
<
[Stream](#stream7)
>
| 是 | 异步打开文件流之后的回调。 |
**示例:**
**示例:**
```
js
```
js
...
@@ -2172,15 +2172,15 @@ fdopenStreamSync(fd: number, mode: string): Stream
...
@@ -2172,15 +2172,15 @@ fdopenStreamSync(fd: number, mode: string): Stream
**系统能力**
:SystemCapability.FileManagement.File.FileIO
**系统能力**
:SystemCapability.FileManagement.File.FileIO
**参数:**
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| 参数名 | 类型 | 必填 | 说明 |
| ---- | ------ | ---- | ---------------------------------------- |
| ---- | ------ | ---- | ---------------------------------------- |
| fd | number | 是 | 待打开文件的文件描述符。 |
| fd | number | 是 | 待打开文件的文件描述符。 |
| mode | string | 是 | -
r:打开只读文件,该文件必须存在。
<br/>
-
r+:打开可读写的文件,该文件必须存在。
<br/>
-
w:打开只写文件,若文件存在则文件长度清0,即该文件内容会消失。若文件不存在则建立该文件。
<br/>
-
w+:打开可读写文件,若文件存在则文件长度清0,即该文件内容会消失。若文件不存在则建立该文件。
<br/>
-
a:以附加的方式打开只写文件。若文件不存在,则会建立该文件,如果文件存在,写入的数据会被加到文件尾,即文件原先的内容会被保留。
<br/>
-
a+:以附加方式打开可读写的文件。若文件不存在,则会建立该文件,如果文件存在,写入的数据会被加到文件尾后,即文件原先的内容会被保留。 |
| mode | string | 是 | -
r:打开只读文件,该文件必须存在。
<br/>
-
r+:打开可读写的文件,该文件必须存在。
<br/>
-
w:打开只写文件,若文件存在则文件长度清0,即该文件内容会消失。若文件不存在则建立该文件。
<br/>
-
w+:打开可读写文件,若文件存在则文件长度清0,即该文件内容会消失。若文件不存在则建立该文件。
<br/>
-
a:以附加的方式打开只写文件。若文件不存在,则会建立该文件,如果文件存在,写入的数据会被加到文件尾,即文件原先的内容会被保留。
<br/>
-
a+:以附加方式打开可读写的文件。若文件不存在,则会建立该文件,如果文件存在,写入的数据会被加到文件尾后,即文件原先的内容会被保留。 |
**返回值:**
**返回值:**
| 类型 | 说明 |
| 类型 | 说明 |
| ------------------ | --------- |
| ------------------ | --------- |
|
[
Stream
](
#stream7
)
| 返回文件流的结果。 |
|
[
Stream
](
#stream7
)
| 返回文件流的结果。 |
**示例:**
**示例:**
```
js
```
js
...
@@ -2198,16 +2198,16 @@ fchown(fd: number, uid: number, gid: number): Promise<void>
...
@@ -2198,16 +2198,16 @@ fchown(fd: number, uid: number, gid: number): Promise<void>
**系统能力**
:SystemCapability.FileManagement.File.FileIO
**系统能力**
:SystemCapability.FileManagement.File.FileIO
**参数:**
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| 参数名 | 类型 | 必填 | 说明 |
| ---- | ------ | ---- | ------------ |
| ---- | ------ | ---- | ------------ |
| fd | number | 是 | 待改变文件的文件描述符。 |
| fd | number | 是 | 待改变文件的文件描述符。 |
| uid | number | 是 | 文件所有者的UID。 |
| uid | number | 是 | 文件所有者的UID。 |
| gid | number | 是 | 文件所有组的GID。 |
| gid | number | 是 | 文件所有组的GID。 |
**返回值:**
**返回值:**
| 类型 | 说明 |
| 类型 | 说明 |
| ------------------- | ---------------------------- |
| ------------------- | ---------------------------- |
| Promise
<
void
>
| Promise对象。无返回值。 |
| Promise
<
void
>
| Promise对象。无返回值。 |
**示例:**
**示例:**
```
js
```
js
...
@@ -2229,12 +2229,12 @@ fchown(fd: number, uid: number, gid: number, callback: AsyncCallback<void>
...
@@ -2229,12 +2229,12 @@ fchown(fd: number, uid: number, gid: number, callback: AsyncCallback<void>
**系统能力**
:SystemCapability.FileManagement.File.FileIO
**系统能力**
:SystemCapability.FileManagement.File.FileIO
**参数:**
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ------------------------- | ---- | --------------- |
| -------- | ------------------------- | ---- | --------------- |
| fd | number | 是 | 待改变文件的文件描述符。 |
| fd | number | 是 | 待改变文件的文件描述符。 |
| uid | number | 是 | 文件所有者的UID。 |
| uid | number | 是 | 文件所有者的UID。 |
| gid | number | 是 | 文件所有组的GID。 |
| gid | number | 是 | 文件所有组的GID。 |
| callback | AsyncCallback
<
void
>
| 是 | 异步改变文件所有者之后的回调。 |
| callback | AsyncCallback
<
void
>
| 是 | 异步改变文件所有者之后的回调。 |
**示例:**
**示例:**
```
js
```
js
...
@@ -2254,11 +2254,11 @@ fchownSync(fd: number, uid: number, gid: number): void
...
@@ -2254,11 +2254,11 @@ fchownSync(fd: number, uid: number, gid: number): void
**系统能力**
:SystemCapability.FileManagement.File.FileIO
**系统能力**
:SystemCapability.FileManagement.File.FileIO
**参数:**
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| 参数名 | 类型 | 必填 | 说明 |
| ---- | ------ | ---- | ------------ |
| ---- | ------ | ---- | ------------ |
| fd | number | 是 | 待改变文件的文件描述符。 |
| fd | number | 是 | 待改变文件的文件描述符。 |
| uid | number | 是 | 文件所有者的UID。 |
| uid | number | 是 | 文件所有者的UID。 |
| gid | number | 是 | 文件所有组的GID。 |
| gid | number | 是 | 文件所有组的GID。 |
**示例:**
**示例:**
```
js
```
js
...
@@ -2283,9 +2283,9 @@ lchown(path: string, uid: number, gid: number): Promise<void>
...
@@ -2283,9 +2283,9 @@ lchown(path: string, uid: number, gid: number): Promise<void>
| gid | number | 是 | 新的GID。 |
| gid | number | 是 | 新的GID。 |
**返回值:**
**返回值:**
| 类型 | 说明 |
| 类型 | 说明 |
| ------------------- | ---------------------------- |
| ------------------- | ---------------------------- |
| Promise
<
void
>
| Promise对象。无返回值。 |
| Promise
<
void
>
| Promise对象。无返回值。 |
**示例:**
**示例:**
```
js
```
js
...
@@ -2361,9 +2361,9 @@ createWatcher(filename: string, events: number, callback: AsyncCallback<numbe
...
@@ -2361,9 +2361,9 @@ createWatcher(filename: string, events: number, callback: AsyncCallback<numbe
| callback | AsyncCallback
<
number
>
| 是 | 每发生变化一次,调用一次此函数。 |
| callback | AsyncCallback
<
number
>
| 是 | 每发生变化一次,调用一次此函数。 |
**返回值:**
**返回值:**
| 类型 | 说明 |
| 类型 | 说明 |
| -------------------- | ---------- |
| -------------------- | ---------- |
|
[
Watcher
](
#watcher7
)
| Promise对象。返回文件变化监听的实例。 |
|
[
Watcher
](
#watcher7
)
| Promise对象。返回文件变化监听的实例。 |
**示例:**
**示例:**
```
js
```
js
...
@@ -2421,9 +2421,9 @@ isBlockDevice(): boolean
...
@@ -2421,9 +2421,9 @@ isBlockDevice(): boolean
**系统能力**
:SystemCapability.FileManagement.File.FileIO
**系统能力**
:SystemCapability.FileManagement.File.FileIO
**返回值:**
**返回值:**
| 类型 | 说明 |
| 类型 | 说明 |
| ------- | ---------------- |
| ------- | ---------------- |
| boolean | 表示文件是否是块特殊设备。 |
| boolean | 表示文件是否是块特殊设备。 |
**示例:**
**示例:**
```
js
```
js
...
@@ -2440,9 +2440,9 @@ isCharacterDevice(): boolean
...
@@ -2440,9 +2440,9 @@ isCharacterDevice(): boolean
**系统能力**
:SystemCapability.FileManagement.File.FileIO
**系统能力**
:SystemCapability.FileManagement.File.FileIO
**返回值:**
**返回值:**
| 类型 | 说明 |
| 类型 | 说明 |
| ------- | ----------------- |
| ------- | ----------------- |
| boolean | 表示文件是否是字符特殊设备。 |
| boolean | 表示文件是否是字符特殊设备。 |
**示例:**
**示例:**
```
js
```
js
...
@@ -2459,9 +2459,9 @@ isDirectory(): boolean
...
@@ -2459,9 +2459,9 @@ isDirectory(): boolean
**系统能力**
:SystemCapability.FileManagement.File.FileIO
**系统能力**
:SystemCapability.FileManagement.File.FileIO
**返回值:**
**返回值:**
| 类型 | 说明 |
| 类型 | 说明 |
| ------- | ------------- |
| ------- | ------------- |
| boolean | 表示文件是否是目录。 |
| boolean | 表示文件是否是目录。 |
**示例:**
**示例:**
```
js
```
js
...
@@ -2478,9 +2478,9 @@ isFIFO(): boolean
...
@@ -2478,9 +2478,9 @@ isFIFO(): boolean
**系统能力**
:SystemCapability.FileManagement.File.FileIO
**系统能力**
:SystemCapability.FileManagement.File.FileIO
**返回值:**
**返回值:**
| 类型 | 说明 |
| 类型 | 说明 |
| ------- | --------------------- |
| ------- | --------------------- |
| boolean | 表示文件是否是
FIFO。 |
| boolean | 表示文件是否是
FIFO。 |
**示例:**
**示例:**
```
js
```
js
...
@@ -2497,9 +2497,9 @@ isFile(): boolean
...
@@ -2497,9 +2497,9 @@ isFile(): boolean
**系统能力**
:SystemCapability.FileManagement.File.FileIO
**系统能力**
:SystemCapability.FileManagement.File.FileIO
**返回值:**
**返回值:**
| 类型 | 说明 |
| 类型 | 说明 |
| ------- | --------------- |
| ------- | --------------- |
| boolean | 表示文件是否是普通文件。 |
| boolean | 表示文件是否是普通文件。 |
**示例:**
**示例:**
```
js
```
js
...
@@ -2516,9 +2516,9 @@ isSocket(): boolean
...
@@ -2516,9 +2516,9 @@ isSocket(): boolean
**系统能力**
:SystemCapability.FileManagement.File.FileIO
**系统能力**
:SystemCapability.FileManagement.File.FileIO
**返回值:**
**返回值:**
| 类型 | 说明 |
| 类型 | 说明 |
| ------- | -------------- |
| ------- | -------------- |
| boolean | 表示文件是否是套接字。 |
| boolean | 表示文件是否是套接字。 |
**示例:**
**示例:**
```
js
```
js
...
@@ -2535,9 +2535,9 @@ isSymbolicLink(): boolean
...
@@ -2535,9 +2535,9 @@ isSymbolicLink(): boolean
**系统能力**
:SystemCapability.FileManagement.File.FileIO
**系统能力**
:SystemCapability.FileManagement.File.FileIO
**返回值:**
**返回值:**
| 类型 | 说明 |
| 类型 | 说明 |
| ------- | --------------- |
| ------- | --------------- |
| boolean | 表示文件是否是符号链接。 |
| boolean | 表示文件是否是符号链接。 |
**示例:**
**示例:**
```
js
```
js
...
@@ -2579,9 +2579,9 @@ stop(callback: AsyncCallback<void>): void
...
@@ -2579,9 +2579,9 @@ stop(callback: AsyncCallback<void>): void
**系统能力**
:SystemCapability.FileManagement.File.FileIO
**系统能力**
:SystemCapability.FileManagement.File.FileIO
**参数:**
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ------------------------- | ---- | ---------------------- |
| -------- | ------------------------- | ---- | ---------------------- |
| callback | AsyncCallback
<
void
>
| 是 | 以异步方法关闭watcher监听之后的回调。 |
| callback | AsyncCallback
<
void
>
| 是 | 以异步方法关闭watcher监听之后的回调。 |
**示例:**
**示例:**
```
js
```
js
...
@@ -2609,9 +2609,9 @@ close(): Promise<void>
...
@@ -2609,9 +2609,9 @@ close(): Promise<void>
**系统能力**
:SystemCapability.FileManagement.File.FileIO
**系统能力**
:SystemCapability.FileManagement.File.FileIO
**返回值:**
**返回值:**
| 类型 | 说明 |
| 类型 | 说明 |
| ------------------- | ------------- |
| ------------------- | ------------- |
| Promise
<
void
>
| Promise对象。返回表示异步关闭文件流的结果。 |
| Promise
<
void
>
| Promise对象。返回表示异步关闭文件流的结果。 |
**示例:**
**示例:**
```
js
```
js
...
@@ -2633,9 +2633,9 @@ close(callback: AsyncCallback<void>): void
...
@@ -2633,9 +2633,9 @@ close(callback: AsyncCallback<void>): void
**系统能力**
:SystemCapability.FileManagement.File.FileIO
**系统能力**
:SystemCapability.FileManagement.File.FileIO
**参数:**
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ------------------------- | ---- | ------------- |
| -------- | ------------------------- | ---- | ------------- |
| callback | AsyncCallback
<
void
>
| 是 | 异步关闭文件流之后的回调。 |
| callback | AsyncCallback
<
void
>
| 是 | 异步关闭文件流之后的回调。 |
**示例:**
**示例:**
```
js
```
js
...
@@ -2670,9 +2670,9 @@ flush(): Promise<void>
...
@@ -2670,9 +2670,9 @@ flush(): Promise<void>
**系统能力**
:SystemCapability.FileManagement.File.FileIO
**系统能力**
:SystemCapability.FileManagement.File.FileIO
**返回值:**
**返回值:**
| 类型 | 说明 |
| 类型 | 说明 |
| ------------------- | ------------- |
| ------------------- | ------------- |
| Promise
<
void
>
| Promise对象。返回表示异步刷新文件流的结果。 |
| Promise
<
void
>
| Promise对象。返回表示异步刷新文件流的结果。 |
**示例:**
**示例:**
```
js
```
js
...
@@ -2694,9 +2694,9 @@ flush(callback: AsyncCallback<void>): void
...
@@ -2694,9 +2694,9 @@ flush(callback: AsyncCallback<void>): void
**系统能力**
:SystemCapability.FileManagement.File.FileIO
**系统能力**
:SystemCapability.FileManagement.File.FileIO
**参数:**
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ------------------------- | ---- | -------------- |
| -------- | ------------------------- | ---- | -------------- |
| callback | AsyncCallback
<
void
>
| 是 | 异步刷新文件流后的回调函数。 |
| callback | AsyncCallback
<
void
>
| 是 | 异步刷新文件流后的回调函数。 |
**示例:**
**示例:**
```
js
```
js
...
@@ -2736,15 +2736,15 @@ write(buffer: ArrayBuffer | string, options?: {
...
@@ -2736,15 +2736,15 @@ write(buffer: ArrayBuffer | string, options?: {
**系统能力**
:SystemCapability.FileManagement.File.FileIO
**系统能力**
:SystemCapability.FileManagement.File.FileIO
**参数:**
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| 参数名 | 类型 | 必填 | 说明 |
| ------- | ------------------------------- | ---- | ---------------------------------------- |
| ------- | ------------------------------- | ---- | ---------------------------------------- |
| buffer | ArrayBuffer
\|
string | 是 | 待写入文件的数据,可来自缓冲区或字符串。 |
| buffer | ArrayBuffer
\|
string | 是 | 待写入文件的数据,可来自缓冲区或字符串。 |
| options | Object | 否 | 支持如下选项:
<br/>
-
offset,number类型,表示期望写入数据的位置相对于数据首地址的偏移。可选,默认为0。
<br/>
-
length,number类型,表示期望写入数据的长度。可选,默认缓冲区长度减去偏移长度。
<br/>
-
position,number类型,表示期望写入文件的位置。可选,默认从当前位置开始写。
<br/>
-
encoding,string类型,当数据是string类型时有效,表示数据的编码方式,默认
'utf-8'。仅支持
'utf-8'。
<br/>
约束:offset+length<=buffer.size。 |
| options | Object | 否 | 支持如下选项:
<br/>
-
offset,number类型,表示期望写入数据的位置相对于数据首地址的偏移。可选,默认为0。
<br/>
-
length,number类型,表示期望写入数据的长度。可选,默认缓冲区长度减去偏移长度。
<br/>
-
position,number类型,表示期望写入文件的位置。可选,默认从当前位置开始写。
<br/>
-
encoding,string类型,当数据是string类型时有效,表示数据的编码方式,默认
'utf-8'。仅支持
'utf-8'。
<br/>
约束:offset+length<=buffer.size。 |
**返回值:**
**返回值:**
| 类型 | 说明 |
| 类型 | 说明 |
| --------------------- | -------- |
| --------------------- | -------- |
| Promise
<
number
>
| Promise对象。返回实际写入的长度。 |
| Promise
<
number
>
| Promise对象。返回实际写入的长度。 |
**示例:**
**示例:**
```
js
```
js
...
@@ -2771,11 +2771,11 @@ write(buffer: ArrayBuffer | string, options: {
...
@@ -2771,11 +2771,11 @@ write(buffer: ArrayBuffer | string, options: {
**系统能力**
:SystemCapability.FileManagement.File.FileIO
**系统能力**
:SystemCapability.FileManagement.File.FileIO
**参数:**
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ------------------------------- | ---- | ------------------------------------------------------------ |
| -------- | ------------------------------- | ---- | ------------------------------------------------------------ |
| buffer | ArrayBuffer
\|
string | 是 | 待写入文件的数据,可来自缓冲区或字符串。 |
| buffer | ArrayBuffer
\|
string | 是 | 待写入文件的数据,可来自缓冲区或字符串。 |
| options | Object | 否 | 支持如下选项:
<br/>
-
offset,number类型,表示期望写入数据的位置相对于数据首地址的偏移。可选,默认为0。
<br/>
-
length,number类型,表示期望写入数据的长度。可选,默认缓冲区长度减去偏移长度。
<br/>
-
position,number类型,表示期望写入文件的位置。可选,默认从当前位置开始写。
<br/>
-
encoding,string类型,当数据是string类型时有效,表示数据的编码方式,默认
'utf-8'。仅支持
'utf-8'。
<br/>
约束:offset+length<=buffer.size。 |
| options | Object | 否 | 支持如下选项:
<br/>
-
offset,number类型,表示期望写入数据的位置相对于数据首地址的偏移。可选,默认为0。
<br/>
-
length,number类型,表示期望写入数据的长度。可选,默认缓冲区长度减去偏移长度。
<br/>
-
position,number类型,表示期望写入文件的位置。可选,默认从当前位置开始写。
<br/>
-
encoding,string类型,当数据是string类型时有效,表示数据的编码方式,默认
'utf-8'。仅支持
'utf-8'。
<br/>
约束:offset+length<=buffer.size。 |
| callback | AsyncCallback
<
number
>
| 是 | 异步写入完成后执行的回调函数。 |
| callback | AsyncCallback
<
number
>
| 是 | 异步写入完成后执行的回调函数。 |
**示例:**
**示例:**
```
js
```
js
...
@@ -2803,15 +2803,15 @@ writeSync(buffer: ArrayBuffer | string, options?: {
...
@@ -2803,15 +2803,15 @@ writeSync(buffer: ArrayBuffer | string, options?: {
**系统能力**
:SystemCapability.FileManagement.File.FileIO
**系统能力**
:SystemCapability.FileManagement.File.FileIO
**参数:**
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| 参数名 | 类型 | 必填 | 说明 |
| ------- | ------------------------------- | ---- | ---------------------------------------- |
| ------- | ------------------------------- | ---- | ---------------------------------------- |
| buffer | ArrayBuffer
\|
string | 是 | 待写入文件的数据,可来自缓冲区或字符串。 |
| buffer | ArrayBuffer
\|
string | 是 | 待写入文件的数据,可来自缓冲区或字符串。 |
| options | Object | 否 | 支持如下选项:
<br/>
-
offset,number类型,表示期望写入数据的位置相对于数据首地址的偏移。可选,默认为0。
<br/>
-
length,number类型,表示期望写入数据的长度。可选,默认缓冲区长度减去偏移长度。
<br/>
-
position,number类型,表示期望写入文件的位置。可选,默认从当前位置开始写。
<br/>
-
encoding,string类型,当数据是string类型时有效,表示数据的编码方式,默认
'utf-8'。仅支持
'utf-8'。
<br/>
约束:offset+length<=buffer.size。 |
| options | Object | 否 | 支持如下选项:
<br/>
-
offset,number类型,表示期望写入数据的位置相对于数据首地址的偏移。可选,默认为0。
<br/>
-
length,number类型,表示期望写入数据的长度。可选,默认缓冲区长度减去偏移长度。
<br/>
-
position,number类型,表示期望写入文件的位置。可选,默认从当前位置开始写。
<br/>
-
encoding,string类型,当数据是string类型时有效,表示数据的编码方式,默认
'utf-8'。仅支持
'utf-8'。
<br/>
约束:offset+length<=buffer.size。 |
**返回值:**
**返回值:**
| 类型 | 说明 |
| 类型 | 说明 |
| ------ | -------- |
| ------ | -------- |
| number | 实际写入的长度。 |
| number | 实际写入的长度。 |
**示例:**
**示例:**
```
js
```
js
...
@@ -2833,15 +2833,15 @@ read(buffer: ArrayBuffer, options?: {
...
@@ -2833,15 +2833,15 @@ read(buffer: ArrayBuffer, options?: {
**系统能力**
:SystemCapability.FileManagement.File.FileIO
**系统能力**
:SystemCapability.FileManagement.File.FileIO
**参数:**
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| 参数名 | 类型 | 必填 | 说明 |
| ------- | ----------- | ---- | ---------------------------------------- |
| ------- | ----------- | ---- | ---------------------------------------- |
| buffer | ArrayBuffer | 是 | 用于读取文件的缓冲区。 |
| buffer | ArrayBuffer | 是 | 用于读取文件的缓冲区。 |
| options | Object | 否 | 支持如下选项:
<br/>
-
offset,number类型,表示将数据读取到缓冲区的位置,即相对于缓冲区首地址的偏移。可选,默认为0。
<br/>
-
length,number类型,表示期望读取数据的长度。可选,默认缓冲区长度减去偏移长度。
<br/>
-
position,number类型,表示期望读取文件的位置。可选,默认从当前位置开始读。
<br/>
约束:offset+length<=buffer.size。 |
| options | Object | 否 | 支持如下选项:
<br/>
-
offset,number类型,表示将数据读取到缓冲区的位置,即相对于缓冲区首地址的偏移。可选,默认为0。
<br/>
-
length,number类型,表示期望读取数据的长度。可选,默认缓冲区长度减去偏移长度。
<br/>
-
position,number类型,表示期望读取文件的位置。可选,默认从当前位置开始读。
<br/>
约束:offset+length<=buffer.size。 |
**返回值:**
**返回值:**
| 类型 | 说明 |
| 类型 | 说明 |
| ---------------------------------- | ------ |
| ---------------------------------- | ------ |
| Promise
<
[ReadOut](#readout)
>
| Promise对象。返回读取的结果。 |
| Promise
<
[ReadOut](#readout)
>
| Promise对象。返回读取的结果。 |
**示例:**
**示例:**
```
js
```
js
...
@@ -2868,11 +2868,11 @@ read(buffer: ArrayBuffer, options: {
...
@@ -2868,11 +2868,11 @@ read(buffer: ArrayBuffer, options: {
**系统能力**
:SystemCapability.FileManagement.File.FileIO
**系统能力**
:SystemCapability.FileManagement.File.FileIO
**参数:**
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ---------------------------------------- | ---- | ---------------------------------------- |
| -------- | ---------------------------------------- | ---- | ---------------------------------------- |
| buffer | ArrayBuffer | 是 | 用于读取文件的缓冲区。 |
| buffer | ArrayBuffer | 是 | 用于读取文件的缓冲区。 |
| options | Object | 否 | 支持如下选项:
<br/>
-
offset,number类型,表示将数据读取到缓冲区的位置,即相对于缓冲区首地址的偏移。可选,默认为0。
<br/>
-
length,number类型,表示期望读取数据的长度。可选,默认缓冲区长度减去偏移长度。
<br/>
-
position,number类型,表示期望读取文件的位置。可选,默认从当前位置开始读。
<br/>
约束:offset+length<=buffer.size。 |
| options | Object | 否 | 支持如下选项:
<br/>
-
offset,number类型,表示将数据读取到缓冲区的位置,即相对于缓冲区首地址的偏移。可选,默认为0。
<br/>
-
length,number类型,表示期望读取数据的长度。可选,默认缓冲区长度减去偏移长度。
<br/>
-
position,number类型,表示期望读取文件的位置。可选,默认从当前位置开始读。
<br/>
约束:offset+length<=buffer.size。 |
| callback | AsyncCallback
<
[ReadOut](#readout)
>
| 是 | 异步从流文件读取数据之后的回调。 |
| callback | AsyncCallback
<
[ReadOut](#readout)
>
| 是 | 异步从流文件读取数据之后的回调。 |
**示例:**
**示例:**
```
js
```
js
...
@@ -2900,16 +2900,16 @@ readSync(buffer: ArrayBuffer, options?: {
...
@@ -2900,16 +2900,16 @@ readSync(buffer: ArrayBuffer, options?: {
**参数:**
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| 参数名 | 类型 | 必填 | 说明 |
| ------- | ----------- | ---- | ---------------------------------------- |
| ------- | ----------- | ---- | ---------------------------------------- |
| buffer | ArrayBuffer | 是 | 用于读取文件的缓冲区。 |
| buffer | ArrayBuffer | 是 | 用于读取文件的缓冲区。 |
| options | Object | 否 | 支持如下选项:
<br/>
-
offset,number类型,表示将数据读取到缓冲区的位置,即相对于缓冲区首地址的偏移。可选,默认为0。
<br/>
-
length,number类型,表示期望读取数据的长度。可选,默认缓冲区长度减去偏移长度。
<br/>
-
position,number类型,表示期望读取文件的位置。可选,默认从当前位置开始读。
<br/>
约束:offset+length<=buffer.size。 |
| options | Object | 否 | 支持如下选项:
<br/>
-
offset,number类型,表示将数据读取到缓冲区的位置,即相对于缓冲区首地址的偏移。可选,默认为0。
<br/>
-
length,number类型,表示期望读取数据的长度。可选,默认缓冲区长度减去偏移长度。
<br/>
-
position,number类型,表示期望读取文件的位置。可选,默认从当前位置开始读。
<br/>
约束:offset+length<=buffer.size。 |
**返回值:**
**返回值:**
| 类型 | 说明 |
| 类型 | 说明 |
| ------ | -------- |
| ------ | -------- |
| number | 实际读取的长度。 |
| number | 实际读取的长度。 |
**示例:**
**示例:**
```
js
```
js
...
@@ -2932,9 +2932,9 @@ read(): Promise<Dirent>
...
@@ -2932,9 +2932,9 @@ read(): Promise<Dirent>
**系统能力**
:SystemCapability.FileManagement.File.FileIO
**系统能力**
:SystemCapability.FileManagement.File.FileIO
**返回值:**
**返回值:**
| 类型 | 说明 |
| 类型 | 说明 |
| -------------------------------- | ------------- |
| -------------------------------- | ------------- |
| Promise
<
[Dirent](#dirent)
>
| Promise对象。返回表示异步读取目录项的结果。 |
| Promise
<
[Dirent](#dirent)
>
| Promise对象。返回表示异步读取目录项的结果。 |
**示例:**
**示例:**
```
js
```
js
...
@@ -2956,9 +2956,9 @@ read(callback: AsyncCallback<Dirent>): void
...
@@ -2956,9 +2956,9 @@ read(callback: AsyncCallback<Dirent>): void
**系统能力**
:SystemCapability.FileManagement.File.FileIO
**系统能力**
:SystemCapability.FileManagement.File.FileIO
**参数:**
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------------------------------------- | ---- | ---------------- |
| -------- | -------------------------------------- | ---- | ---------------- |
| callback | AsyncCallback
<
[Dirent](#dirent)
>
| 是 | 异步读取下一个目录项之后的回调。 |
| callback | AsyncCallback
<
[Dirent](#dirent)
>
| 是 | 异步读取下一个目录项之后的回调。 |
**示例:**
**示例:**
```
js
```
js
...
@@ -2981,9 +2981,9 @@ readSync(): Dirent
...
@@ -2981,9 +2981,9 @@ readSync(): Dirent
**系统能力**
:SystemCapability.FileManagement.File.FileIO
**系统能力**
:SystemCapability.FileManagement.File.FileIO
**返回值:**
**返回值:**
| 类型 | 说明 |
| 类型 | 说明 |
| ----------------- | -------- |
| ----------------- | -------- |
|
[
Dirent
](
#dirent
)
| 表示一个目录项。 |
|
[
Dirent
](
#dirent
)
| 表示一个目录项。 |
**示例:**
**示例:**
```
js
```
js
...
@@ -3063,9 +3063,9 @@ isBlockDevice(): boolean
...
@@ -3063,9 +3063,9 @@ isBlockDevice(): boolean
**系统能力**
:SystemCapability.FileManagement.File.FileIO
**系统能力**
:SystemCapability.FileManagement.File.FileIO
**返回值:**
**返回值:**
| 类型 | 说明 |
| 类型 | 说明 |
| ------- | ---------------- |
| ------- | ---------------- |
| boolean | 表示当前目录项是否是块特殊设备。 |
| boolean | 表示当前目录项是否是块特殊设备。 |
**示例:**
**示例:**
```
js
```
js
...
@@ -3083,9 +3083,9 @@ isCharacterDevice(): boolean
...
@@ -3083,9 +3083,9 @@ isCharacterDevice(): boolean
**系统能力**
:SystemCapability.FileManagement.File.FileIO
**系统能力**
:SystemCapability.FileManagement.File.FileIO
**返回值:**
**返回值:**
| 类型 | 说明 |
| 类型 | 说明 |
| ------- | ----------------- |
| ------- | ----------------- |
| boolean | 表示当前目录项是否是字符特殊设备。 |
| boolean | 表示当前目录项是否是字符特殊设备。 |
**示例:**
**示例:**
```
js
```
js
...
@@ -3103,9 +3103,9 @@ isDirectory(): boolean
...
@@ -3103,9 +3103,9 @@ isDirectory(): boolean
**系统能力**
:SystemCapability.FileManagement.File.FileIO
**系统能力**
:SystemCapability.FileManagement.File.FileIO
**返回值:**
**返回值:**
| 类型 | 说明 |
| 类型 | 说明 |
| ------- | ------------- |
| ------- | ------------- |
| boolean | 表示当前目录项是否是目录。 |
| boolean | 表示当前目录项是否是目录。 |
**示例:**
**示例:**
```
js
```
js
...
@@ -3123,9 +3123,9 @@ isFIFO(): boolean
...
@@ -3123,9 +3123,9 @@ isFIFO(): boolean
**系统能力**
:SystemCapability.FileManagement.File.FileIO
**系统能力**
:SystemCapability.FileManagement.File.FileIO
**返回值:**
**返回值:**
| 类型 | 说明 |
| 类型 | 说明 |
| ------- | --------------- |
| ------- | --------------- |
| boolean | 表示当前目录项是否是FIFO。 |
| boolean | 表示当前目录项是否是FIFO。 |
**示例:**
**示例:**
```
js
```
js
...
@@ -3143,9 +3143,9 @@ isFile(): boolean
...
@@ -3143,9 +3143,9 @@ isFile(): boolean
**系统能力**
:SystemCapability.FileManagement.File.FileIO
**系统能力**
:SystemCapability.FileManagement.File.FileIO
**返回值:**
**返回值:**
| 类型 | 说明 |
| 类型 | 说明 |
| ------- | --------------- |
| ------- | --------------- |
| boolean | 表示当前目录项是否是普通文件。 |
| boolean | 表示当前目录项是否是普通文件。 |
**示例:**
**示例:**
```
js
```
js
...
@@ -3163,9 +3163,9 @@ isSocket(): boolean
...
@@ -3163,9 +3163,9 @@ isSocket(): boolean
**系统能力**
:SystemCapability.FileManagement.File.FileIO
**系统能力**
:SystemCapability.FileManagement.File.FileIO
**返回值:**
**返回值:**
| 类型 | 说明 |
| 类型 | 说明 |
| ------- | -------------- |
| ------- | -------------- |
| boolean | 表示当前目录项是否是套接字。 |
| boolean | 表示当前目录项是否是套接字。 |
**示例:**
**示例:**
```
js
```
js
...
@@ -3183,9 +3183,9 @@ isSymbolicLink(): boolean
...
@@ -3183,9 +3183,9 @@ isSymbolicLink(): boolean
**系统能力**
:SystemCapability.FileManagement.File.FileIO
**系统能力**
:SystemCapability.FileManagement.File.FileIO
**返回值:**
**返回值:**
| 类型 | 说明 |
| 类型 | 说明 |
| ------- | --------------- |
| ------- | --------------- |
| boolean | 表示当前目录项是否是符号链接。 |
| boolean | 表示当前目录项是否是符号链接。 |
**示例:**
**示例:**
```
js
```
js
...
...
zh-cn/application-dev/reference/apis/js-apis-i18n.md
浏览文件 @
80252784
# 国际化-I18n
# 国际化-I18n
本模块提供系统相关的或者增强的国际化能力,包括区域管理、电话号码处理、日历等,相关接口为ECMA 402标准中未定义的补充接口。
[
Intl模块
](
js-apis-intl.md
)
提供了ECMA 402标准定义的基础国际化接口,与本模块共同使用可提供完整地国际化支持能力。
> ![icon-note.gif](public_sys-resources/icon-note.gif) **说明:**
> ![icon-note.gif](public_sys-resources/icon-note.gif) **说明:**
> - 本模块首批接口从API version 7开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。
> - 本模块首批接口从API version 7开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。
>
>
...
...
zh-cn/application-dev/reference/apis/js-apis-image.md
浏览文件 @
80252784
# 图片处理
# 图片处理
本模块提供图片处理效果,包括通过属性创建PixelMap、读取图像像素数据、读取区域内的图片数据等。
> **说明:**
> **说明:**
> 本模块首批接口从API version 6开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。
> 本模块首批接口从API version 6开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。
...
...
zh-cn/application-dev/reference/apis/js-apis-inputmethod.md
浏览文件 @
80252784
# 输入法框架
# 输入法框架
本模块提供对输入法框架的管理,包括隐藏输入法、查询已安装的输入法列表和显示输入法选择对话框。
> ![icon-note.gif](public_sys-resources/icon-note.gif) **说明:**
> ![icon-note.gif](public_sys-resources/icon-note.gif) **说明:**
> 本模块首批接口从API version 6开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。
> 本模块首批接口从API version 6开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。
...
@@ -62,9 +64,9 @@ getInputMethodSetting(): InputMethodSetting
...
@@ -62,9 +64,9 @@ getInputMethodSetting(): InputMethodSetting
**返回值:**
**返回值:**
| 类型 | 说明 |
| 类型 | 说明 |
| ----------------------------------------- | ---------------------------- |
| ----------------------------------------- | ---------------------------- |
|
[
InputMethodSetting
](
#InputMethodSetting
)
| 回调返回当前客户端设置实例。 |
|
[
InputMethodSetting
](
#InputMethodSetting
)
| 回调返回当前客户端设置实例。 |
**示例:**
**示例:**
...
@@ -87,9 +89,9 @@ stopInput(callback: AsyncCallback<boolean>): void
...
@@ -87,9 +89,9 @@ stopInput(callback: AsyncCallback<boolean>): void
**参数:**
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| -------- | -------- | -------- | -------- |
| callback | AsyncCallback
<
boolean
>
| 是 | 返回输入法隐藏是否成功。 |
| callback | AsyncCallback
<
boolean
>
| 是 | 返回输入法隐藏是否成功。 |
**示例:**
**示例:**
...
@@ -109,9 +111,9 @@ stopInput(): Promise<boolean>
...
@@ -109,9 +111,9 @@ stopInput(): Promise<boolean>
**返回值:**
**返回值:**
| 类型 | 说明 |
| 类型 | 说明 |
| -------- | -------- |
| -------- | -------- |
| Promise
<
boolean
>
| 返回输入法隐藏是否成功。 |
| Promise
<
boolean
>
| 返回输入法隐藏是否成功。 |
**示例:**
**示例:**
...
@@ -134,9 +136,9 @@ listInputMethod(callback: AsyncCallback<Array<InputMethodProperty>>)
...
@@ -134,9 +136,9 @@ listInputMethod(callback: AsyncCallback<Array<InputMethodProperty>>)
**系统能力**
: SystemCapability.Miscservices.InputMethodFramework
**系统能力**
: SystemCapability.Miscservices.InputMethodFramework
**参数:**
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------------------------------------------------- | ---- | ---------------------- |
| -------- | -------------------------------------------------- | ---- | ---------------------- |
| callback | Array
<
[
InputMethodProperty
](
#InputMethodProperty
)
>
| 是 | 返回已安装输入法列表。 |
| callback | Array
<
[
InputMethodProperty
](
#InputMethodProperty
)
>
| 是 | 返回已安装输入法列表。 |
**示例:**
**示例:**
...
@@ -158,9 +160,9 @@ listInputMethod(): Array<InputMethodProperty>
...
@@ -158,9 +160,9 @@ listInputMethod(): Array<InputMethodProperty>
**系统能力**
: SystemCapability.Miscservices.InputMethodFramework
**系统能力**
: SystemCapability.Miscservices.InputMethodFramework
**返回值:**
**返回值:**
| 类型 | 说明 |
| 类型 | 说明 |
| ----------------------------------------------------------- | ---------------------- |
| ----------------------------------------------------------- | ---------------------- |
| Promise
<Array
<[
InputMethodProperty
](
#InputMethodProperty
)
>
> | 返回已安装输入法列表。 |
| Promise
<Array
<[
InputMethodProperty
](
#InputMethodProperty
)
>
> | 返回已安装输入法列表。 |
**示例:**
**示例:**
...
...
zh-cn/application-dev/reference/apis/js-apis-intl.md
浏览文件 @
80252784
# 国际化-Intl
# 国际化-Intl
本模块提供提供基础的应用国际化能力,包括时间日期格式化、数字格式化、排序等,相关接口在ECMA 402标准中定义。
[
I18N模块
](
js-apis-i18n.md
)
提供其他非ECMA 402定义的国际化接口,与本模块共同使用可提供完整地国际化支持能力。
> ![icon-note.gif](public_sys-resources/icon-note.gif) **说明:**
> ![icon-note.gif](public_sys-resources/icon-note.gif) **说明:**
> - 本模块首批接口从API version 6开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。
> - 本模块首批接口从API version 6开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。
>
>
...
...
zh-cn/application-dev/reference/apis/js-apis-logs.md
浏览文件 @
80252784
# 日志打印
# 日志打印
本模块提供日志打印能力,包括打印debug级别的日志信息、打印info级别的日志信息、打印warn级别的日志信息和打印error级别的日志信息。
> ![icon-note.gif](public_sys-resources/icon-note.gif) **说明:**
> ![icon-note.gif](public_sys-resources/icon-note.gif) **说明:**
> 从API Version 7 开始,该接口不再维护,推荐使用新接口[`@ohos.hilog`](js-apis-hilog.md)。
> 从API Version 7 开始,该接口不再维护,推荐使用新接口[`@ohos.hilog`](js-apis-hilog.md)。
...
...
zh-cn/application-dev/reference/apis/js-apis-mediaquery.md
浏览文件 @
80252784
# 媒体查询
# 媒体查询
提供根据不同媒体类型定义不同的样式。
> **说明:**
> **说明:**
> 从API Version 7开始支持。后续版本如有新增内容,则采用上角标单独标记该内容的起始版本。
> 从API Version 7开始支持。后续版本如有新增内容,则采用上角标单独标记该内容的起始版本。
...
...
zh-cn/application-dev/reference/apis/js-apis-prompt.md
浏览文件 @
80252784
# 弹窗
# 弹窗
创建并显示文本提示框、对话框和操作菜单。
> ![icon-note.gif](public_sys-resources/icon-note.gif) **说明**
> ![icon-note.gif](public_sys-resources/icon-note.gif) **说明**
> 本模块首批接口从API version 8开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。
> 本模块首批接口从API version 8开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。
...
...
zh-cn/application-dev/reference/apis/js-apis-router.md
浏览文件 @
80252784
# 页面路由
# 页面路由
本模块提供通过不同的url访问不同的页面,包括跳转到应用内的指定页面、用应用内的某个页面替换当前页面、返回上一页面或指定的页面等。
> ![icon-note.gif](public_sys-resources/icon-note.gif) **说明**
> ![icon-note.gif](public_sys-resources/icon-note.gif) **说明**
>
>
> - 本模块首批接口从API version 8开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。
> - 本模块首批接口从API version 8开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。
...
...
zh-cn/application-dev/reference/apis/js-apis-system-mediaquery.md
浏览文件 @
80252784
# 媒体查询
# 媒体查询
提供根据不同媒体类型定义不同的样式。
> ![icon-note.gif](public_sys-resources/icon-note.gif) **说明:**
> ![icon-note.gif](public_sys-resources/icon-note.gif) **说明:**
>
>
...
...
zh-cn/application-dev/reference/apis/js-apis-system-prompt.md
浏览文件 @
80252784
# 弹窗
# 弹窗
创建并显示文本提示框、对话框和操作菜单。
> ![icon-note.gif](public_sys-resources/icon-note.gif) **说明:**
> ![icon-note.gif](public_sys-resources/icon-note.gif) **说明:**
>
>
> - 从API Version 8 开始,该接口不再维护,推荐使用新接口[`@ohos.prompt`](js-apis-prompt.md)。
> - 从API Version 8 开始,该接口不再维护,推荐使用新接口[`@ohos.prompt`](js-apis-prompt.md)。
...
...
zh-cn/application-dev/reference/apis/js-apis-system-router.md
浏览文件 @
80252784
# 页面路由
# 页面路由
通过不同的uri访问不同的页面。
> **说明:**
> **说明:**
>
>
> - 从API Version 8 开始,该接口不再维护,推荐使用新接口[`@ohos.router`](js-apis-router.md)。
> - 从API Version 8 开始,该接口不再维护,推荐使用新接口[`@ohos.router`](js-apis-router.md)。
...
...
zh-cn/application-dev/reference/arkui-ts/ts-basic-components-button.md
浏览文件 @
80252784
# Button
# Button
按钮组件,可快速创建不同样式的按钮。
> **说明:**
> **说明:**
> 该组件从API Version 7开始支持。后续版本如有新增内容,则采用上角标单独标记该内容的起始版本。
> 该组件从API Version 7开始支持。后续版本如有新增内容,则采用上角标单独标记该内容的起始版本。
提供按钮组件。
## 权限列表
## 权限列表
无
无
...
...
zh-cn/application-dev/reference/arkui-ts/ts-basic-components-loadingprogress.md
浏览文件 @
80252784
# LoadingProgress
# LoadingProgress
用于显示加载动效的组件。
> **说明:**
> **说明:**
> 该组件从API Version 8开始支持。后续版本如有新增内容,则采用上角标单独标记该内容的起始版本。
> 该组件从API Version 8开始支持。后续版本如有新增内容,则采用上角标单独标记该内容的起始版本。
用于显示加载进展。
## 权限列表
## 权限列表
...
...
zh-cn/application-dev/reference/arkui-ts/ts-basic-components-qrcode.md
浏览文件 @
80252784
# QRCode
# QRCode
用于显示单个二维码的组件。
> **说明:**
> **说明:**
> 该组件从API Version 7开始支持。后续版本如有新增内容,则采用上角标单独标记该内容的起始版本。
> 该组件从API Version 7开始支持。后续版本如有新增内容,则采用上角标单独标记该内容的起始版本。
显示二维码信息。
## 权限列表
## 权限列表
无
无
...
...
zh-cn/application-dev/reference/arkui-ts/ts-basic-components-rating.md
浏览文件 @
80252784
# Rating
# Rating
提供在给定范围内选择评分的组件。
> **说明:**
> **说明:**
> 该组件从API Version 7开始支持。后续版本如有新增内容,则采用上角标单独标记该内容的起始版本。
> 该组件从API Version 7开始支持。后续版本如有新增内容,则采用上角标单独标记该内容的起始版本。
评分条组件。
## 权限列表
## 权限列表
无
无
...
...
zh-cn/application-dev/reference/arkui-ts/ts-basic-components-span.md
浏览文件 @
80252784
# Span
# Span
作为Text组件的子组件,用于显示行内文本的组件。
> **说明:**
> **说明:**
> 该组件从API Version 7开始支持。后续版本如有新增内容,则采用上角标单独标记该内容的起始版本。
> 该组件从API Version 7开始支持。后续版本如有新增内容,则采用上角标单独标记该内容的起始版本。
文本段落,只能作为Text子组件,呈现一段文本信息。
## 权限列表
## 权限列表
无
无
...
...
zh-cn/application-dev/reference/arkui-ts/ts-basic-components-stepper.md
浏览文件 @
80252784
# Stepper
# Stepper
应用步骤方式切换页面的组件。
> **说明:**
> **说明:**
> 该组件从API Version 8开始支持。后续版本如有新增内容,则采用上角标单独标记该内容的起始版本。
> 该组件从API Version 8开始支持。后续版本如有新增内容,则采用上角标单独标记该内容的起始版本。
步骤导航器。
## 权限列表
## 权限列表
无
无
...
@@ -36,7 +35,7 @@ Stepper(value?: { index?: number })
...
@@ -36,7 +35,7 @@ Stepper(value?: { index?: number })
## 事件
## 事件
| 名称 | 描述 |
| 名称 | 描述 |
| -------- | -------- |
| -------- | -------- |
| onFinish(callback:
()
=
>
void) | 步骤导航器最后一个StepperItem的nextLabel被点击时触发该回调
。 |
| onFinish(callback:
()
=
>
void) | 步骤导航器最后一个StepperItem的nextLabel被点击时触发该回调
。 |
| onSkip(callback:
()
=
>
void) | 当前显示的StepperItem状态为ItemState.Skip时,nextLabel被点击时触发该回调。 |
| onSkip(callback:
()
=
>
void) | 当前显示的StepperItem状态为ItemState.Skip时,nextLabel被点击时触发该回调。 |
...
...
zh-cn/application-dev/reference/arkui-ts/ts-basic-components-stepperitem.md
浏览文件 @
80252784
# StepperItem
# StepperItem
用作
[
Stepper
](
ts-basic-components-stepper.md
)
组件的页面子组件。
> **说明:**
> **说明:**
> 该组件从API Version 8开始支持。后续版本如有新增内容,则采用上角标单独标记该内容的起始版本。
> 该组件从API Version 8开始支持。后续版本如有新增内容,则采用上角标单独标记该内容的起始版本。
步骤导航器元素。
## 权限列表
## 权限列表
无
无
...
...
zh-cn/application-dev/reference/arkui-ts/ts-basic-components-text.md
浏览文件 @
80252784
# Text
# Text
显示一段文本的组件。
> **说明:**
> **说明:**
> 该组件从API Version 7开始支持。后续版本如有新增内容,则采用上角标单独标记该内容的起始版本。
> 该组件从API Version 7开始支持。后续版本如有新增内容,则采用上角标单独标记该内容的起始版本。
文本,用于呈现一段信息。
## 权限列表
## 权限列表
无
无
...
...
zh-cn/application-dev/reference/arkui-ts/ts-basic-components-textarea.md
浏览文件 @
80252784
# TextArea
# TextArea
可以输入多行文本并支持响应部分输入事件的组件。
> **说明:**
> **说明:**
> 该组件从API Version 7开始支持。后续版本如有新增内容,则采用上角标单独标记该内容的起始版本。
> 该组件从API Version 7开始支持。后续版本如有新增内容,则采用上角标单独标记该内容的起始版本。
提供多行文本输入组件。
## 权限列表
## 权限列表
无
无
...
...
zh-cn/application-dev/reference/arkui-ts/ts-basic-components-textinput.md
浏览文件 @
80252784
# TextInput
# TextInput
可以输入单行文本并支持响应输入事件的组件。
> **说明:**
> **说明:**
> 该组件从API Version 7开始支持。后续版本如有新增内容,则采用上角标单独标记该内容的起始版本。
> 该组件从API Version 7开始支持。后续版本如有新增内容,则采用上角标单独标记该内容的起始版本。
提供单行文本输入组件。
## 权限列表
## 权限列表
无
无
...
...
zh-cn/application-dev/reference/arkui-ts/ts-basic-components-textpicker.md
浏览文件 @
80252784
# TextPicker
# TextPicker
滚动选择文本的组件。
> **说明:**
> **说明:**
> 该组件从API Version 8开始支持。后续版本如有新增内容,则采用上角标单独标记该内容的起始版本。
> 该组件从API Version 8开始支持。后续版本如有新增内容,则采用上角标单独标记该内容的起始版本。
文本类滑动选择器组件。
## 权限列表
## 权限列表
无
无
...
...
zh-cn/application-dev/reference/arkui-ts/ts-basic-components-texttimer.md
浏览文件 @
80252784
# TextTimer
# TextTimer
通过文本显示计时信息并控制其计时器状态的组件。
> **说明:**
> **说明:**
> 该组件从API Version 8开始支持。后续版本如有新增内容,则采用上角标单独标记该内容的起始版本。
> 该组件从API Version 8开始支持。后续版本如有新增内容,则采用上角标单独标记该内容的起始版本。
文本计时器组件,支持自定义时间格式。
## 权限列表
## 权限列表
无
无
...
...
zh-cn/application-dev/reference/arkui-ts/ts-basic-components-timepicker.md
浏览文件 @
80252784
# TimePicker
# TimePicker
滚动选择时间的组件。
> **说明:**
> **说明:**
> 该组件从API Version 8开始支持。后续版本如有新增内容,则采用上角标单独标记该内容的起始版本。
> 该组件从API Version 8开始支持。后续版本如有新增内容,则采用上角标单独标记该内容的起始版本。
选择时间的滑动选择器组件。
## 权限列表
## 权限列表
无
无
...
@@ -43,10 +42,10 @@ TimePicker(options?: TimePickerOptions)
...
@@ -43,10 +42,10 @@ TimePicker(options?: TimePickerOptions)
| onChange(callback:
(value:
TimePickerResult )
=
>
void) | 选择时间时触发该事件。 |
| onChange(callback:
(value:
TimePickerResult )
=
>
void) | 选择时间时触发该事件。 |
### TimePickerResult对象说明
### TimePickerResult对象说明
| 名称 | 参数类型 | 描述 |
| 名称 | 参数类型 | 描述 |
| -------- | -------- | -------- |
| -------- | -------- | -------- |
| hour | number | 选中时间的时。 |
| hour | number | 选中时间的时。 |
| minute | number | 选中时间的分。 |
| minute | number | 选中时间的分。 |
## 示例
## 示例
...
...
zh-cn/application-dev/reference/arkui-ts/ts-basic-components-toggle.md
浏览文件 @
80252784
# Toggle
# Toggle
组件提供勾选框样式、状态按钮样式及开关样式。
> **说明:**
> **说明:**
> 该组件从API Version 8开始支持。后续版本如有新增内容,则采用上角标单独标记该内容的起始版本。
> 该组件从API Version 8开始支持。后续版本如有新增内容,则采用上角标单独标记该内容的起始版本。
...
@@ -28,7 +30,7 @@ Toggle(options: { type: ToggleType, isOn?: boolean })
...
@@ -28,7 +30,7 @@ Toggle(options: { type: ToggleType, isOn?: boolean })
-
ToggleType枚举说明
-
ToggleType枚举说明
| 名称 | 描述 |
| 名称 | 描述 |
| -------- | -------- |
| -------- | -------- |
| Checkbox | 提供
单
选框样式,子组件设置文本不生效,如需文本设置,可将Text和当前组件放入布局组件中。
<br>
>
**说明:**
<br/>
>
[通用属性padding](ts-universal-attributes-size.md)的默认值为:
<br>
{
<br>
top: 14 vp,
<br>
right: 6 vp,
<br>
bottom: 14 vp,
<br>
left: 6 vp
<br>
} |
| Checkbox | 提供
勾
选框样式,子组件设置文本不生效,如需文本设置,可将Text和当前组件放入布局组件中。
<br>
>
**说明:**
<br/>
>
[通用属性padding](ts-universal-attributes-size.md)的默认值为:
<br>
{
<br>
top: 14 vp,
<br>
right: 6 vp,
<br>
bottom: 14 vp,
<br>
left: 6 vp
<br>
} |
| Button | 提供状态按钮样式,如果有文本设置,则相应的文本内容会显示在按钮内部。 |
| Button | 提供状态按钮样式,如果有文本设置,则相应的文本内容会显示在按钮内部。 |
| Switch | 提供开关样式,子组件设置文本不生效,如需文本设置,可将Text和当前组件放入布局组件中。
<br>
>
**说明:**
<br/>
>
[通用属性padding](ts-universal-attributes-size.md)默认值为:
<br>
{
<br/>
top: 12 vp,
<br/>
right: 12 vp,
<br/>
bottom: 12 vp,
<br/>
left: 12 vp
<br/>
} |
| Switch | 提供开关样式,子组件设置文本不生效,如需文本设置,可将Text和当前组件放入布局组件中。
<br>
>
**说明:**
<br/>
>
[通用属性padding](ts-universal-attributes-size.md)默认值为:
<br>
{
<br/>
top: 12 vp,
<br/>
right: 12 vp,
<br/>
bottom: 12 vp,
<br/>
left: 12 vp
<br/>
} |
...
...
zh-cn/application-dev/reference/arkui-ts/ts-basic-gestures-longpressgesture.md
浏览文件 @
80252784
# LongPressGesture
# LongPressGesture
用于触发长按手势事件,触发长按手势的最少手指数为1,最短时间为500毫秒。
> **说明:**
> **说明:**
> 从API Version 7开始支持。后续版本如有新增内容,则采用上角标单独标记该内容的起始版本。
> 从API Version 7开始支持。后续版本如有新增内容,则采用上角标单独标记该内容的起始版本。
...
...
zh-cn/application-dev/reference/arkui-ts/ts-basic-gestures-pangesture.md
浏览文件 @
80252784
# PanGesture
# PanGesture
用于触发拖动手势事件,滑动的最小距离为5vp时拖动手势识别成功。
> **说明:**
> **说明:**
> 从API Version 7开始支持。后续版本如有新增内容,则采用上角标单独标记该内容的起始版本。
> 从API Version 7开始支持。后续版本如有新增内容,则采用上角标单独标记该内容的起始版本。
...
...
zh-cn/application-dev/reference/arkui-ts/ts-basic-gestures-pinchgesture.md
浏览文件 @
80252784
# PinchGesture
# PinchGesture
用于触发捏合手势,触发捏合手势的最少手指为2指,最大为5指,最小识别距离为3vp。
> **说明:**
> **说明:**
> 从API Version 7开始支持。后续版本如有新增内容,则采用上角标单独标记该内容的起始版本。
> 从API Version 7开始支持。后续版本如有新增内容,则采用上角标单独标记该内容的起始版本。
...
...
zh-cn/application-dev/reference/arkui-ts/ts-basic-gestures-rotationgesture.md
浏览文件 @
80252784
# RotationGesture
# RotationGesture
用于触发旋转手势事件,触发旋转手势的最少手指为2指,最大为5指,最小改变度数为1度。
> **说明:**
> **说明:**
> 从API Version 7开始支持。后续版本如有新增内容,则采用上角标单独标记该内容的起始版本。
> 从API Version 7开始支持。后续版本如有新增内容,则采用上角标单独标记该内容的起始版本。
...
...
zh-cn/application-dev/reference/arkui-ts/ts-basic-gestures-swipegesture.md
浏览文件 @
80252784
# SwipeGesture
# SwipeGesture
用于触发滑动事件,滑动最小速度为100vp/s时识别成功。
> **说明:**
> **说明:**
> 从API Version 8开始支持。后续版本如有新增内容,则采用上角标单独标记该内容的起始版本。
> 从API Version 8开始支持。后续版本如有新增内容,则采用上角标单独标记该内容的起始版本。
...
...
zh-cn/application-dev/reference/arkui-ts/ts-basic-gestures-tapgesture.md
浏览文件 @
80252784
# TapGesture
# TapGesture
支持单次点击、多次点击识别。
> **说明:**
> **说明:**
> 从API Version 7开始支持。后续版本如有新增内容,则采用上角标单独标记该内容的起始版本。
> 从API Version 7开始支持。后续版本如有新增内容,则采用上角标单独标记该内容的起始版本。
...
...
zh-cn/application-dev/reference/arkui-ts/ts-combined-gestures.md
浏览文件 @
80252784
# 组合手势
# 组合手势
手势识别组,多种手势组合为复合手势,支持连续识别、并行识别和互斥识别。
> **说明:**
> **说明:**
> 从API Version 7开始支持。后续版本如有新增内容,则采用上角标单独标记该内容的起始版本。
> 从API Version 7开始支持。后续版本如有新增内容,则采用上角标单独标记该内容的起始版本。
...
...
zh-cn/application-dev/reference/arkui-ts/ts-components-canvas-lottie.md
浏览文件 @
80252784
# Lottie
# Lottie
提供Lottie动画。
> **说明:**
> **说明:**
> 从 API Version 8 开始支持。后续版本如有新增内容,则采用上角标单独标记该内容的起始版本。
> 从 API Version 8 开始支持。后续版本如有新增内容,则采用上角标单独标记该内容的起始版本。
...
...
zh-cn/application-dev/reference/arkui-ts/ts-container-alphabet-indexer.md
浏览文件 @
80252784
# AlphabetIndexer
# AlphabetIndexer
可以与容器组件联动用于按逻辑结构快速定位容器显示区域的组件。
> **说明:**
> **说明:**
> 该组件从API Version 7开始支持。后续版本如有新增内容,则采用上角标单独标记该内容的起始版本。
> 该组件从API Version 7开始支持。后续版本如有新增内容,则采用上角标单独标记该内容的起始版本。
字母索引条。
## 权限列表
## 权限列表
无
无
...
...
zh-cn/application-dev/reference/arkui-ts/ts-container-badge.md
浏览文件 @
80252784
# Badge
# Badge
可以附加在单个组件上用于信息标记的容器组件。
> **说明:**
> **说明:**
> 该组件从API Version 7开始支持。后续版本如有新增内容,则采用上角标单独标记该内容的起始版本。
> 该组件从API Version 7开始支持。后续版本如有新增内容,则采用上角标单独标记该内容的起始版本。
新事件标记组件,在组件上提供事件信息展示能力。
## 权限列表
## 权限列表
无
无
...
...
zh-cn/application-dev/reference/arkui-ts/ts-container-flex.md
浏览文件 @
80252784
# Flex
# Flex
应用弹性方式布局子组件的容器组件。
> **说明:**
> **说明:**
> 该组件从API Version 7开始支持。后续版本如有新增内容,则采用上角标单独标记该内容的起始版本。
> 该组件从API Version 7开始支持。后续版本如有新增内容,则采用上角标单独标记该内容的起始版本。
弹性布局组件。
## 权限列表
## 权限列表
无
无
...
...
zh-cn/application-dev/reference/arkui-ts/ts-container-refresh.md
浏览文件 @
80252784
# Refresh
# Refresh
可以进行页面下拉操作并显示刷新动效的容器组件。
> **说明:**
> **说明:**
> 该组件从API Version 8开始支持。后续版本如有新增内容,则采用上角标单独标记该内容的起始版本。
> 该组件从API Version 8开始支持。后续版本如有新增内容,则采用上角标单独标记该内容的起始版本。
下拉刷新容器。
## 权限列表
## 权限列表
无
无
...
...
zh-cn/application-dev/reference/arkui-ts/ts-drawing-components-circle.md
浏览文件 @
80252784
# Circle
# Circle
用于绘制圆形的组件。
> **说明:**
> **说明:**
> 该组件从API Version 7开始支持。后续版本如有新增内容,则采用上角标单独标记该内容的起始版本。
> 该组件从API Version 7开始支持。后续版本如有新增内容,则采用上角标单独标记该内容的起始版本。
圆形绘制组件。
## 权限列表
## 权限列表
无
无
...
...
zh-cn/application-dev/reference/arkui-ts/ts-explicit-animation.md
浏览文件 @
80252784
# 显式动画
# 显式动画
提供显示动画接口。
> **说明:**
> **说明:**
> 从API Version 7开始支持。后续版本如有新增内容,则采用上角标单独标记该内容的起始版本。
> 从API Version 7开始支持。后续版本如有新增内容,则采用上角标单独标记该内容的起始版本。
...
...
zh-cn/application-dev/reference/arkui-ts/ts-gesture-settings.md
浏览文件 @
80252784
# 绑定手势方法
# 绑定手势方法
为组件绑定不同类型的手势事件,并设置事件的响应方法。
> **说明:**
> **说明:**
> 从API Version 7开始支持。后续版本如有新增内容,则采用上角标单独标记该内容的起始版本。
> 从API Version 7开始支持。后续版本如有新增内容,则采用上角标单独标记该内容的起始版本。
...
...
zh-cn/application-dev/reference/arkui-ts/ts-interpolation-calculation.md
浏览文件 @
80252784
# 插值计算
# 插值计算
设置动画插值曲线,用于构造阶梯曲线对象、构造三阶贝塞尔曲线对象和构造弹簧曲线对象。
> **说明:**
> **说明:**
> 从API Version 7开始支持。后续版本如有新增内容,则采用上角标单独标记该内容的起始版本。
> 从API Version 7开始支持。后续版本如有新增内容,则采用上角标单独标记该内容的起始版本。
...
@@ -48,10 +50,10 @@ stepsCurve(count: number, end: boolean):ICurve
...
@@ -48,10 +50,10 @@ stepsCurve(count: number, end: boolean):ICurve
**参数:**
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| 参数名 | 类型 | 必填 | 说明 |
| ------ | ------- | ----| ------------------------------------------------------------ |
| ------ | ------- | ----| ------------------------------------------------------------ |
| count | number | 是 | 阶梯的数量,需要为正整数。 |
| count | number | 是 | 阶梯的数量,需要为正整数。 |
| end | boolean | 是 | 在每个间隔的起点或是终点发生阶跃变化。
<br>
-true:在终点发生阶跃变化。
<br>
-false:在起点发生阶跃变化。 |
| end | boolean | 是 | 在每个间隔的起点或是终点发生阶跃变化。
<br>
-true:在终点发生阶跃变化。
<br>
-false:在起点发生阶跃变化。 |
**返回值:**
**返回值:**
...
@@ -77,12 +79,12 @@ cubicBezierCurve(x1: number, y1: number, x2: number, y2: number):ICurve
...
@@ -77,12 +79,12 @@ cubicBezierCurve(x1: number, y1: number, x2: number, y2: number):ICurve
**参数:**
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| 参数名 | 类型 | 必填 | 说明 |
| ---- | ------ | ---- | -------------- |
| ---- | ------ | ---- | -------------- |
| x1 | number | 是 | 确定贝塞尔曲线第一点横坐标。 |
| x1 | number | 是 | 确定贝塞尔曲线第一点横坐标。 |
| y1 | number | 是 | 确定贝塞尔曲线第一点纵坐标。 |
| y1 | number | 是 | 确定贝塞尔曲线第一点纵坐标。 |
| x2 | number | 是 | 确定贝塞尔曲线第二点横坐标。 |
| x2 | number | 是 | 确定贝塞尔曲线第二点横坐标。 |
| y2 | number | 是 | 确定贝塞尔曲线第二点纵坐标。 |
| y2 | number | 是 | 确定贝塞尔曲线第二点纵坐标。 |
**返回值:**
**返回值:**
...
@@ -185,10 +187,10 @@ steps(count: number, end: boolean): string
...
@@ -185,10 +187,10 @@ steps(count: number, end: boolean): string
**参数:**
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| 参数名 | 类型 | 必填 | 说明 |
| ------ | ------- | ----| ------------------------------------------------------------ |
| ------ | ------- | ----| ------------------------------------------------------------ |
| count | number | 是 | 阶梯的数量,需要为正整数。 |
| count | number | 是 | 阶梯的数量,需要为正整数。 |
| end | boolean | 是 | 在每个间隔的起点或是终点发生阶跃变化。
<br>
-true:在终点发生阶跃变化。
<br>
-false:在起点发生阶跃变化。 |
| end | boolean | 是 | 在每个间隔的起点或是终点发生阶跃变化。
<br>
-true:在终点发生阶跃变化。
<br>
-false:在起点发生阶跃变化。 |
## Curves.cubicBezier<sup>(deprecated)</sup>
## Curves.cubicBezier<sup>(deprecated)</sup>
...
@@ -200,12 +202,12 @@ cubicBezier(x1: number, y1: number, x2: number, y2: number): string
...
@@ -200,12 +202,12 @@ cubicBezier(x1: number, y1: number, x2: number, y2: number): string
**参数:**
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| 参数名 | 类型 | 必填 | 说明 |
| ---- | ------ | ---- | -------------- |
| ---- | ------ | ---- | -------------- |
| x1 | number | 是 | 确定贝塞尔曲线第一点横坐标。 |
| x1 | number | 是 | 确定贝塞尔曲线第一点横坐标。 |
| y1 | number | 是 | 确定贝塞尔曲线第一点纵坐标。 |
| y1 | number | 是 | 确定贝塞尔曲线第一点纵坐标。 |
| x2 | number | 是 | 确定贝塞尔曲线第二点横坐标。 |
| x2 | number | 是 | 确定贝塞尔曲线第二点横坐标。 |
| y2 | number | 是 | 确定贝塞尔曲线第二点纵坐标。 |
| y2 | number | 是 | 确定贝塞尔曲线第二点纵坐标。 |
## Curves.spring<sup>(deprecated)</sup>
## Curves.spring<sup>(deprecated)</sup>
...
@@ -227,21 +229,21 @@ spring(velocity: number, mass: number, stiffness: number, damping: number): stri
...
@@ -227,21 +229,21 @@ spring(velocity: number, mass: number, stiffness: number, damping: number): stri
## Curve枚举说明
## Curve枚举说明
| 名称 | 描述 |
| 名称 | 描述 |
| ------------------- | ---------------------------------------- |
| ------------------- | ---------------------------------------- |
| Linear | 表示动画从头到尾的速度都是相同的。 |
| Linear | 表示动画从头到尾的速度都是相同的。 |
| Ease | 表示动画以低速开始,然后加快,在结束前变慢,CubicBezier(0.25,
0.1,
0.25,
1.0)。 |
| Ease | 表示动画以低速开始,然后加快,在结束前变慢,CubicBezier(0.25,
0.1,
0.25,
1.0)。 |
| EaseIn | 表示动画以低速开始,CubicBezier(0.42,
0.0,
1.0,
1.0)。 |
| EaseIn | 表示动画以低速开始,CubicBezier(0.42,
0.0,
1.0,
1.0)。 |
| EaseOut | 表示动画以低速结束,CubicBezier(0.0,
0.0,
0.58,
1.0)。 |
| EaseOut | 表示动画以低速结束,CubicBezier(0.0,
0.0,
0.58,
1.0)。 |
| EaseInOut | 表示动画以低速开始和结束,CubicBezier(0.42,
0.0,
0.58,
1.0)。 |
| EaseInOut | 表示动画以低速开始和结束,CubicBezier(0.42,
0.0,
0.58,
1.0)。 |
| FastOutSlowIn | 标准曲线,cubic-bezier(0.4,
0.0,
0.2,
1.0)。 |
| FastOutSlowIn | 标准曲线,cubic-bezier(0.4,
0.0,
0.2,
1.0)。 |
| LinearOutSlowIn | 减速曲线,cubic-bezier(0.0,
0.0,
0.2,
1.0)。 |
| LinearOutSlowIn | 减速曲线,cubic-bezier(0.0,
0.0,
0.2,
1.0)。 |
| FastOutLinearIn | 加速曲线,cubic-bezier(0.4,
0.0,
1.0,
1.0)。 |
| FastOutLinearIn | 加速曲线,cubic-bezier(0.4,
0.0,
1.0,
1.0)。 |
| ExtremeDeceleration | 急缓曲线,cubic-bezier(0.0,
0.0,
0.0,
1.0)。 |
| ExtremeDeceleration | 急缓曲线,cubic-bezier(0.0,
0.0,
0.0,
1.0)。 |
| Sharp | 锐利曲线,cubic-bezier(0.33,
0.0,
0.67,
1.0)。 |
| Sharp | 锐利曲线,cubic-bezier(0.33,
0.0,
0.67,
1.0)。 |
| Rhythm | 节奏曲线,cubic-bezier(0.7,
0.0,
0.2,
1.0)。 |
| Rhythm | 节奏曲线,cubic-bezier(0.7,
0.0,
0.2,
1.0)。 |
| Smooth | 平滑曲线,cubic-bezier(0.4,
0.0,
0.4,
1.0)。 |
| Smooth | 平滑曲线,cubic-bezier(0.4,
0.0,
0.4,
1.0)。 |
| Friction | 阻尼曲线,CubicBezier(0.2,
0.0,
0.2,
1.0)。 |
| Friction | 阻尼曲线,CubicBezier(0.2,
0.0,
0.2,
1.0)。 |
## 整体示例
## 整体示例
...
...
zh-cn/application-dev/reference/arkui-ts/ts-matrix-transformation.md
浏览文件 @
80252784
# 矩阵变换
# 矩阵变换
可对图形进行平移、旋转和缩放等。
> **说明:**
> **说明:**
> 从API Version 7开始支持。后续版本如有新增内容,则采用上角标单独标记该内容的起始版本。
> 从API Version 7开始支持。后续版本如有新增内容,则采用上角标单独标记该内容的起始版本。
...
...
zh-cn/application-dev/reference/arkui-ts/ts-media-components-video.md
浏览文件 @
80252784
# Video
# Video
用于播放单个视频并控制其播放状态的组件。
> **说明:**
> **说明:**
> 该组件从API Version 7开始支持。后续版本如有新增内容,则采用上角标单独标记该内容的起始版本。
> 该组件从API Version 7开始支持。后续版本如有新增内容,则采用上角标单独标记该内容的起始版本。
视频播放组件。
## 权限列表
## 权限列表
使用网络视频时,需要在config或者module.json对应的"abilities"中添加网络使用权限ohos.permission.INTERNET。
使用网络视频时,需要在config或者module.json对应的"abilities"中添加网络使用权限ohos.permission.INTERNET。
...
...
zh-cn/application-dev/reference/arkui-ts/ts-methods-menu.md
浏览文件 @
80252784
# 菜单
# 菜单
在页面范围内关闭通过
[
bindContextMenu
](
./ts-universal-attributes-menu.md#属性
)
属性绑定的菜单。
> **说明:**
> **说明:**
> 从 API Version 8 开始支持。后续版本如有新增内容,则采用上角标单独标记该内容的起始版本。
> 从 API Version 8 开始支持。后续版本如有新增内容,则采用上角标单独标记该内容的起始版本。
...
...
zh-cn/application-dev/reference/arkui-ts/ts-universal-attributes-click.md
浏览文件 @
80252784
# 点击控制
# 点击控制
设置组件是否可触摸。
> **说明:**
> **说明:**
> 从API Version 7开始支持。后续版本如有新增内容,则采用上角标单独标记该内容的起始版本。
> 从API Version 7开始支持。后续版本如有新增内容,则采用上角标单独标记该内容的起始版本。
...
...
zh-cn/application-dev/reference/arkui-ts/ts-universal-attributes-component-id.md
浏览文件 @
80252784
zh-cn/application-dev/reference/arkui-ts/ts-universal-attributes-enable.md
浏览文件 @
80252784
# 禁用控制
# 禁用控制
可交互状态下组件响应点击事件。
> **说明:**
> **说明:**
> 从API Version 7开始支持。后续版本如有新增内容,则采用上角标单独标记该内容的起始版本。
> 从API Version 7开始支持。后续版本如有新增内容,则采用上角标单独标记该内容的起始版本。
...
...
zh-cn/application-dev/reference/arkui-ts/ts-universal-attributes-focus.md
浏览文件 @
80252784
# 焦点控制
# 焦点控制
自定义组件的走焦效果,可设置组件是否走焦和具体的走焦顺序,tab键或者方向键切换焦点。
> **说明:**
> **说明:**
> 从API Version 8开始支持。后续版本如有新增内容,则采用上角标单独标记该内容的起始版本。
> 从API Version 8开始支持。后续版本如有新增内容,则采用上角标单独标记该内容的起始版本。
...
...
zh-cn/application-dev/reference/arkui-ts/ts-universal-attributes-gradient-color.md
浏览文件 @
80252784
# 颜色渐变
# 颜色渐变
设置组件的颜色渐变效果。
> **说明:**
> **说明:**
> 从API Version 7开始支持。后续版本如有新增内容,则采用上角标单独标记该内容的起始版本。
> 从API Version 7开始支持。后续版本如有新增内容,则采用上角标单独标记该内容的起始版本。
...
...
zh-cn/application-dev/reference/arkui-ts/ts-universal-attributes-hover-effect.md
浏览文件 @
80252784
# 悬浮态效果
# 悬浮态效果
设置组件的鼠标悬浮态显示效果。
> **说明:**
> **说明:**
> 从API Version 8开始支持。后续版本如有新增内容,则采用上角标单独标记该内容的起始版本。
> 从API Version 8开始支持。后续版本如有新增内容,则采用上角标单独标记该内容的起始版本。
...
...
zh-cn/application-dev/reference/arkui-ts/ts-universal-attributes-image-effect.md
浏览文件 @
80252784
# 图像效果
# 图像效果
例如背景模糊、内容模糊和灰度效果等。
> **说明:**
> **说明:**
> 从API Version 7开始支持。后续版本如有新增内容,则采用上角标单独标记该内容的起始版本。
> 从API Version 7开始支持。后续版本如有新增内容,则采用上角标单独标记该内容的起始版本。
...
...
zh-cn/application-dev/reference/arkui-ts/ts-universal-attributes-layout-constraints.md
浏览文件 @
80252784
# 布局约束
# 布局约束
通过组件的宽高比和显示优先级约束组件显示效果。
> **说明:**
> **说明:**
> 从API Version 7开始支持。后续版本如有新增内容,则采用上角标单独标记该内容的起始版本。
> 从API Version 7开始支持。后续版本如有新增内容,则采用上角标单独标记该内容的起始版本。
...
...
zh-cn/application-dev/reference/arkui-ts/ts-universal-attributes-location.md
浏览文件 @
80252784
# 位置设置
# 位置设置
设置组件的对齐方式、布局方向和显示位置。
> **说明:**
> **说明:**
> 从API Version 7开始支持。后续版本如有新增内容,则采用上角标单独标记该内容的起始版本。
> 从API Version 7开始支持。后续版本如有新增内容,则采用上角标单独标记该内容的起始版本。
...
...
zh-cn/application-dev/reference/arkui-ts/ts-universal-attributes-menu.md
浏览文件 @
80252784
# Menu控制
# Menu控制
为组件绑定弹出式菜单,弹出式菜单以垂直列表形式显示菜单项,可通过长按、点击或鼠标右键触发。
> **说明:**
> **说明:**
> 从API Version 7开始支持。后续版本如有新增内容,则采用上角标单独标记该内容的起始版本。
> 从API Version 7开始支持。后续版本如有新增内容,则采用上角标单独标记该内容的起始版本。
...
...
zh-cn/application-dev/reference/arkui-ts/ts-universal-attributes-overlay.md
浏览文件 @
80252784
# 浮层
# 浮层
设置组件的遮罩文本。
> **说明:**
> **说明:**
> 从API Version 7开始支持。后续版本如有新增内容,则采用上角标单独标记该内容的起始版本。
> 从API Version 7开始支持。后续版本如有新增内容,则采用上角标单独标记该内容的起始版本。
...
...
zh-cn/application-dev/reference/arkui-ts/ts-universal-attributes-popup.md
浏览文件 @
80252784
# Popup控制
# Popup控制
设置组件点击时弹出的气泡框状态。
> **说明:**
> **说明:**
> 从API Version 7开始支持。后续版本如有新增内容,则采用上角标单独标记该内容的起始版本。
> 从API Version 7开始支持。后续版本如有新增内容,则采用上角标单独标记该内容的起始版本。
...
...
zh-cn/application-dev/reference/arkui-ts/ts-universal-attributes-sharp-clipping.md
浏览文件 @
80252784
# 形状裁剪
# 形状裁剪
用于对组件进行裁剪、遮罩处理。
> **说明:**
> **说明:**
> 从API Version 7开始支持。后续版本如有新增内容,则采用上角标单独标记该内容的起始版本。
> 从API Version 7开始支持。后续版本如有新增内容,则采用上角标单独标记该内容的起始版本。
...
...
zh-cn/application-dev/reference/arkui-ts/ts-universal-attributes-size.md
浏览文件 @
80252784
# 尺寸设置
# 尺寸设置
用于设置组件的宽高、边距等显示尺寸进行设置。
> **说明:**
> **说明:**
> 从API Version 7开始支持。后续版本如有新增内容,则采用上角标单独标记该内容的起始版本。
> 从API Version 7开始支持。后续版本如有新增内容,则采用上角标单独标记该内容的起始版本。
...
...
zh-cn/application-dev/reference/arkui-ts/ts-universal-attributes-transformation.md
浏览文件 @
80252784
# 图形变换
# 图形变换
用于对组件进行旋转、平移、缩放、矩阵变换等操作。
> **说明:**
> **说明:**
> 从API Version 7开始支持。后续版本如有新增内容,则采用上角标单独标记该内容的起始版本。
> 从API Version 7开始支持。后续版本如有新增内容,则采用上角标单独标记该内容的起始版本。
...
...
zh-cn/application-dev/reference/arkui-ts/ts-universal-attributes-visibility.md
浏览文件 @
80252784
# 显隐控制
# 显隐控制
控制组件是否可见。
> **说明:**
> **说明:**
> 从API Version 7开始支持。后续版本如有新增内容,则采用上角标单独标记该内容的起始版本。
> 从API Version 7开始支持。后续版本如有新增内容,则采用上角标单独标记该内容的起始版本。
...
...
zh-cn/application-dev/reference/arkui-ts/ts-universal-attributes-z-order.md
浏览文件 @
80252784
# Z序控制
# Z序控制
组件的Z序,指明了该组件在堆叠组件中的位置。
> **说明:**
> **说明:**
> 从API Version 7开始支持。后续版本如有新增内容,则采用上角标单独标记该内容的起始版本。
> 从API Version 7开始支持。后续版本如有新增内容,则采用上角标单独标记该内容的起始版本。
...
...
zh-cn/application-dev/reference/arkui-ts/ts-universal-component-area-change-event.md
浏览文件 @
80252784
# 组件区域变化事件
# 组件区域变化事件
组件区域变化事件指组件显示的尺寸、位置等发生变化时触发的事件。
> **说明:**
> **说明:**
> 从API Version 8开始支持。后续版本如有新增内容,则采用上角标单独标记该内容的起始版本。
> 从API Version 8开始支持。后续版本如有新增内容,则采用上角标单独标记该内容的起始版本。
...
...
zh-cn/application-dev/reference/arkui-ts/ts-universal-events-click.md
浏览文件 @
80252784
# 点击事件
# 点击事件
点击事件指组件被点击时触发的事件。
> **说明:**
> **说明:**
> 从API Version 7开始支持。后续版本如有新增内容,则采用上角标单独标记该内容的起始版本。
> 从API Version 7开始支持。后续版本如有新增内容,则采用上角标单独标记该内容的起始版本。
## 支持设备
| 手机 | 平板 | 智慧屏 | 智能穿戴 |
| ---- | ---- | ------ | -------- |
| 支持 | 支持 | 不支持 | 不支持 |
## 权限列表
## 权限列表
...
...
zh-cn/application-dev/reference/arkui-ts/ts-universal-events-drag-drop.md
浏览文件 @
80252784
# 拖拽事件
# 拖拽事件
拖拽事件指被长按后拖拽时触发的事件。
> **说明:**
> **说明:**
> 从API Version 8开始支持。后续版本如有新增内容,则采用上角标单独标记该内容的起始版本。
> 从API Version 8开始支持。后续版本如有新增内容,则采用上角标单独标记该内容的起始版本。
...
...
zh-cn/application-dev/reference/arkui-ts/ts-universal-events-key.md
浏览文件 @
80252784
# 按键事件
# 按键事件
按键事件指组件与键盘、遥控器等按键设备交互时触发的事件。
> **说明:**
> **说明:**
> 从API Version 7开始支持。后续版本如有新增内容,则采用上角标单独标记该内容的起始版本。
> 从API Version 7开始支持。后续版本如有新增内容,则采用上角标单独标记该内容的起始版本。
...
...
zh-cn/application-dev/reference/arkui-ts/ts-universal-events-show-hide.md
浏览文件 @
80252784
# 挂载卸载事件
# 挂载卸载事件
挂载卸载事件指组件从组件树上挂载、卸载时触发的事件。
> **说明:**
> **说明:**
> 从API Version 7开始支持。后续版本如有新增内容,则采用上角标单独标记该内容的起始版本。
> 从API Version 7开始支持。后续版本如有新增内容,则采用上角标单独标记该内容的起始版本。
...
...
zh-cn/application-dev/reference/arkui-ts/ts-universal-events-touch.md
浏览文件 @
80252784
# 触摸事件
# 触摸事件
当手指放在组件上、滑动或从组件上移开时触发。
> **说明:**
> **说明:**
> 从API Version 7开始支持。后续版本如有新增内容,则采用上角标单独标记该内容的起始版本。
> 从API Version 7开始支持。后续版本如有新增内容,则采用上角标单独标记该内容的起始版本。
...
...
zh-cn/application-dev/reference/arkui-ts/ts-universal-focus-event.md
浏览文件 @
80252784
# 焦点事件
# 焦点事件
焦点事件指页面焦点在组件间移动时触发的事件,组件可使用焦点事件来更改内容。
> **说明:**
> **说明:**
> 从API Version 8开始支持。后续版本如有新增内容,则采用上角标单独标记该内容的起始版本。
> 从API Version 8开始支持。后续版本如有新增内容,则采用上角标单独标记该内容的起始版本。
...
...
zh-cn/application-dev/reference/arkui-ts/ts-universal-mouse-key.md
浏览文件 @
80252784
# 鼠标事件
# 鼠标事件
在单个动作触发多个事件时,事件的顺序是固定的,遵循xxx的顺序调用处理程序。
> **说明:**
> **说明:**
> 从API Version 8开始支持。后续版本如有新增内容,则采用上角标单独标记该内容的起始版本。
> 从API Version 8开始支持。后续版本如有新增内容,则采用上角标单独标记该内容的起始版本。
...
...
编辑
预览
Markdown
is supported
0%
请重试
或
添加新附件
.
添加附件
取消
You are about to add
0
people
to the discussion. Proceed with caution.
先完成此消息的编辑!
取消
想要评论请
注册
或
登录