Skip to content
体验新版
项目
组织
正在加载...
登录
切换导航
打开侧边栏
OpenHarmony
Docs
提交
52ae4725
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看板
未验证
提交
52ae4725
编写于
3月 22, 2022
作者:
O
openharmony_ci
提交者：
Gitee
3月 22, 2022
浏览文件
操作
浏览文件
下载
差异文件
!2326 一致性问题修改
Merge pull request !2326 from LiAn/master
上级
17a9f75e
478aa079
变更
8
隐藏空白更改
内联
并排
Showing
8 changed file
with
2462 addition
and
2458 deletion
+2462
-2458
zh-cn/application-dev/reference/apis/js-apis-fileio.md
zh-cn/application-dev/reference/apis/js-apis-fileio.md
+571
-571
zh-cn/application-dev/reference/apis/js-apis-i18n.md
zh-cn/application-dev/reference/apis/js-apis-i18n.md
+483
-483
zh-cn/application-dev/reference/apis/js-apis-intl.md
zh-cn/application-dev/reference/apis/js-apis-intl.md
+240
-240
zh-cn/application-dev/reference/apis/js-apis-resource-manager.md
...pplication-dev/reference/apis/js-apis-resource-manager.md
+218
-208
zh-cn/application-dev/reference/apis/js-apis-sensor.md
zh-cn/application-dev/reference/apis/js-apis-sensor.md
+722
-728
zh-cn/application-dev/reference/apis/js-apis-update.md
zh-cn/application-dev/reference/apis/js-apis-update.md
+104
-104
zh-cn/application-dev/reference/apis/js-apis-vibrator.md
zh-cn/application-dev/reference/apis/js-apis-vibrator.md
+50
-50
zh-cn/application-dev/reference/apis/js-apis-workScheduler.md
...n/application-dev/reference/apis/js-apis-workScheduler.md
+74
-74
未找到文件。
zh-cn/application-dev/reference/apis/js-apis-fileio.md
浏览文件 @
52ae4725
...
...
@@ -45,13 +45,13 @@ stat(path: string): Promise<Stat>
**系统能力**
：SystemCapability.FileManagement.File.FileIO
-
参数：
| 参数名
| 类型 | 必填 | 说明
|
| ----
---- | -------- | -------- |
-------- |
| path | string | 是 | 待获取文件的绝对路径。 |
| 参数名
| 类型 | 必填 | 说明
|
| ----
| ------ | ---- | ---
-------- |
| path | string | 是
| 待获取文件的绝对路径。 |
-
返回值：
| 类型
| 说明
|
| --------
|
-------- |
| 类型
| 说明
|
| --------
-------------------- | --
-------- |
| Promise
<
[Stat](#stat)
>
| 表示文件的具体信息。 |
-
示例：
...
...
@@ -73,10 +73,10 @@ stat(path:string, callback:AsyncCallback<Stat>): void
**系统能力**
：SystemCapability.FileManagement.File.FileIO
-
参数：
| 参数名
| 类型 | 必填 | 说明
|
| -------- | --------
| -------- |
-------- |
| path
| string | 是 | 待获取文件的绝对路径。
|
| callback | AsyncCallback
<
[Stat](#stat)
>
| 是 | 异步获取文件的信息之后的回调。 |
| 参数名
| 类型 | 必填 | 说明
|
| -------- | --------
-------------------------- | ---- | -------
-------- |
| path
| string | 是 | 待获取文件的绝对路径。
|
| callback | AsyncCallback
<
[Stat](#stat)
>
| 是
| 异步获取文件的信息之后的回调。 |
-
示例：
```
js
...
...
@@ -95,14 +95,14 @@ statSync(path:string): Stat
**系统能力**
：SystemCapability.FileManagement.File.FileIO
-
参数：
| 参数名
| 类型 | 必填 | 说明
|
| ----
---- | -------- | -------- |
-------- |
| path | string | 是 | 待获取文件的绝对路径。 |
| 参数名
| 类型 | 必填 | 说明
|
| ----
| ------ | ---- | ---
-------- |
| path | string | 是
| 待获取文件的绝对路径。 |
-
返回值：
| 类型
| 说明
|
| --------
|
-------- |
| 类型
| 说明
|
| --------
----- | --
-------- |
|
[
Stat
](
#stat
)
| 表示文件的具体信息。 |
-
示例：
...
...
@@ -121,13 +121,13 @@ opendir(path: string): Promise<Dir>
**系统能力**
：SystemCapability.FileManagement.File.FileIO
-
参数：
| 参数名
| 类型 | 必填 | 说明
|
| ----
---- | -------- | -------- |
-------- |
| path | string | 是 | 待打开文件目录的绝对路径。 |
| 参数名
| 类型 | 必填 | 说明
|
| ----
| ------ | ---- | -----
-------- |
| path | string | 是
| 待打开文件目录的绝对路径。 |
-
返回值：
| 类型
| 说明
|
| -------- | -------- |
| 类型
| 说明
|
| --------
------------------
| -------- |
| Promise
<
[Dir](#dir)
>
| 返回Dir对象。 |
-
示例：
...
...
@@ -149,10 +149,10 @@ opendir(path: string, callback: AsyncCallback<Dir>): void
**系统能力**
：SystemCapability.FileManagement.File.FileIO
-
参数：
| 参数名
| 类型 | 必填 | 说明
|
| -------- | --------
| -------- |
-------- |
| path
| string | 是 | 待打开文件目录的绝对路径。
|
| callback | AsyncCallback
<
[Dir](#dir)
>
| 是 | 异步打开文件目录之后的回调。 |
| 参数名
| 类型 | 必填 | 说明
|
| -------- | --------
------------------------ | ---- | ------
-------- |
| path
| string | 是 | 待打开文件目录的绝对路径。
|
| callback | AsyncCallback
<
[Dir](#dir)
>
| 是
| 异步打开文件目录之后的回调。 |
-
示例：
```
js
...
...
@@ -173,13 +173,13 @@ opendirSync(path: string): Dir
-
参数：
| 参数名
| 类型 | 必填 | 说明
|
| ----
---- | -------- | -------- |
-------- |
| path | string | 是 | 待打开文件目录的绝对路径。 |
| 参数名
| 类型 | 必填 | 说明
|
| ----
| ------ | ---- | -----
-------- |
| path | string | 是
| 待打开文件目录的绝对路径。 |
-
返回值：
| 类型
| 说明
|
| -------- | -------- |
| 类型
| 说明
|
| --------
---
| -------- |
|
[
Dir
](
#dir
)
| 返回Dir对象。 |
-
示例：
...
...
@@ -199,14 +199,14 @@ access(path: string, mode?: number): Promise<void>
**系统能力**
：SystemCapability.FileManagement.File.FileIO
-
参数：.
| 参数名
| 类型 | 必填 | 说明
|
| ----
---- | -------- | -------- |
-------- |
| path | string | 是
| 待访问文件的绝对路径。
|
| mode | number | 否 | 访问文件时的选项，可给定如下选项，以按位或的方式使用多个选项，默认给定0。
<br/>
确认当前进程是否具有对应权限：
<br/>
-
0：确认文件是否存在。
<br/>
-
1：确认当前进程是否具有可执行权限。
<br/>
-
2：确认当前进程是否具有写权限。
<br/>
-
4：确认当前进程是否具有读权限。 |
| 参数名
| 类型 | 必填 | 说明
|
| ----
| ------ | ---- | --------------------------------
-------- |
| path | string | 是
| 待访问文件的绝对路径。
|
| mode | number | 否
| 访问文件时的选项，可给定如下选项，以按位或的方式使用多个选项，默认给定0。
<br/>
确认当前进程是否具有对应权限：
<br/>
-
0：确认文件是否存在。
<br/>
-
1：确认当前进程是否具有可执行权限。
<br/>
-
2：确认当前进程是否具有写权限。
<br/>
-
4：确认当前进程是否具有读权限。 |
-
返回值：
| 类型
| 说明
|
| --------
|
-------- |
| 类型
| 说明
|
| --------
----------- | --------------------
-------- |
| Promise
<
void
>
| Promise实例，用于异步获取结果。本调用将返回空值。 |
-
示例：
...
...
@@ -228,11 +228,11 @@ access(path: string, mode: number, callback: AsyncCallback<void>): void
**系统能力**
：SystemCapability.FileManagement.File.FileIO
-
参数：
| 参数名
| 类型 | 必填 | 说明
|
| -------- | --------
| -------- |
-------- |
| path
| string | 是 | 待访问文件的绝对路径。
|
| mode
| number | 否
| 访问文件时的选项，可给定如下选项，以按位或的方式使用多个选项，默认给定0。
<br/>
确认当前进程是否具有对应权限：
<br/>
-
0：确认文件是否存在。
<br/>
-
1：确认当前进程是否具有可执行权限。
<br/>
-
2：确认当前进程是否具有写权限。
<br/>
-
4：确认当前进程是否具有读权限。 |
| callback | AsyncCallback
<
void
>
| 是
| 异步检查当前进程是否可访问某文件之后的回调。
|
| 参数名
| 类型 | 必填 | 说明
|
| -------- | --------
----------------- | ---- | --------------------------------
-------- |
| path
| string | 是 | 待访问文件的绝对路径。
|
| mode
| number | 否
| 访问文件时的选项，可给定如下选项，以按位或的方式使用多个选项，默认给定0。
<br/>
确认当前进程是否具有对应权限：
<br/>
-
0：确认文件是否存在。
<br/>
-
1：确认当前进程是否具有可执行权限。
<br/>
-
2：确认当前进程是否具有写权限。
<br/>
-
4：确认当前进程是否具有读权限。 |
| callback | AsyncCallback
<
void
>
| 是
| 异步检查当前进程是否可访问某文件之后的回调。
|
-
示例：
```
js
...
...
@@ -251,10 +251,10 @@ accessSync(path: string, mode?: number): void
**系统能力**
：SystemCapability.FileManagement.File.FileIO
-
参数：
| 参数名
| 类型 | 必填 | 说明
|
| ----
---- | -------- | -------- |
-------- |
| path | string | 是
| 待访问文件的绝对路径。
|
| mode | number | 否 | 访问文件时的选项，可给定如下选项，以按位或的方式使用多个选项，默认给定0。
<br/>
确认当前进程是否具有对应权限：
<br/>
-
0：确认文件是否存在。
<br/>
-
1：确认当前进程是否具有可执行权限。
<br/>
-
2：确认当前进程是否具有写权限。
<br/>
-
4：确认当前进程是否具有读权限。 |
| 参数名
| 类型 | 必填 | 说明
|
| ----
| ------ | ---- | --------------------------------
-------- |
| path | string | 是
| 待访问文件的绝对路径。
|
| mode | number | 否
| 访问文件时的选项，可给定如下选项，以按位或的方式使用多个选项，默认给定0。
<br/>
确认当前进程是否具有对应权限：
<br/>
-
0：确认文件是否存在。
<br/>
-
1：确认当前进程是否具有可执行权限。
<br/>
-
2：确认当前进程是否具有写权限。
<br/>
-
4：确认当前进程是否具有读权限。 |
-
示例：
```
js
...
...
@@ -275,13 +275,13 @@ close(fd: number):Promise<void>
**系统能力**
：SystemCapability.FileManagement.File.FileIO
-
参数：
| 参数名
| 类型 | 必填 | 说明
|
| ----
---- | -------- | -------- |
-------- |
| fd
| number | 是
| 待关闭文件的文件描述符。 |
| 参数名
| 类型 | 必填 | 说明
|
| ----
| ------ | ---- | ----
-------- |
| fd
| number | 是
| 待关闭文件的文件描述符。 |
-
返回值：
| 类型
| 说明
|
| --------
|
-------- |
| 类型
| 说明
|
| --------
----------- | --------------------
-------- |
| Promise
<
void
>
| Promise实例，用于异步获取结果。本调用将返回空值。 |
-
示例：
...
...
@@ -304,10 +304,10 @@ close(fd: number, callback:AsyncCallback<void>): void
**系统能力**
：SystemCapability.FileManagement.File.FileIO
-
参数：
| 参数名
| 类型 | 必填 | 说明
|
| -------- | --------
| -------- |
-------- |
| fd
| number | 是
| 待关闭文件的文件描述符。 |
| callback | AsyncCallback
<
void
>
| 是 | 异步关闭文件之后的回调。 |
| 参数名
| 类型 | 必填 | 说明
|
| -------- | --------
----------------- | ---- | ----
-------- |
| fd
| number | 是
| 待关闭文件的文件描述符。 |
| callback | AsyncCallback
<
void
>
| 是
| 异步关闭文件之后的回调。 |
-
示例：
```
js
...
...
@@ -327,9 +327,9 @@ closeSync(fd: number): void
**系统能力**
：SystemCapability.FileManagement.File.FileIO
-
参数：
| 参数名
| 类型 | 必填 | 说明
|
| ----
---- | -------- | -------- |
-------- |
| fd
| number | 是
| 待关闭文件的文件描述符。 |
| 参数名
| 类型 | 必填 | 说明
|
| ----
| ------ | ---- | ----
-------- |
| fd
| number | 是
| 待关闭文件的文件描述符。 |
-
示例：
```
js
...
...
@@ -346,8 +346,8 @@ close(): Promise<void>
**系统能力**
：SystemCapability.FileManagement.File.FileIO
-
返回值：
| 类型
| 说明
|
| --------
|
-------- |
| 类型
| 说明
|
| --------
----------- | --------------------
-------- |
| Promise
<
void
>
| Promise实例，用于异步获取结果。本调用将返回空值。 |
-
示例：
...
...
@@ -369,9 +369,9 @@ close(callback: AsyncCallback<void>): void
**系统能力**
：SystemCapability.FileManagement.File.FileIO
-
参数：
| 参数名
| 类型 | 必填 | 说明
|
| -------- | --------
| -------- |
-------- |
| callback | AsyncCallback
<
void
>
| 是 | 异步关闭文件流之后的回调。 |
| 参数名
| 类型 | 必填 | 说明
|
| -------- | --------
----------------- | ---- | -----
-------- |
| callback | AsyncCallback
<
void
>
| 是
| 异步关闭文件流之后的回调。 |
-
示例：
```
js
...
...
@@ -390,15 +390,15 @@ copyFile(src:string | number, dest:string | number, mode?:number):Promise<voi
**系统能力**
：SystemCapability.FileManagement.File.FileIO
-
参数：
| 参数名
| 类型 | 必填 | 说明
|
| ----
---- | -------- | -------- |
-------- |
| src
| string
\|
number | 是 | 待复制文件的路径或待复制文件的描述符。
|
| dest | string
\|
number | 是
| 目标文件路径或目标文件描述符。
|
| mode | number
| 否
| mode提供覆盖文件的选项，当前仅支持0，且默认为0。
<br/>
0：完全覆盖目标文件，未覆盖部分将被裁切掉。 |
| 参数名
| 类型 | 必填 | 说明
|
| ----
| -------------------------- | ---- | --------------------------------
-------- |
| src
| string
\|
number | 是 | 待复制文件的路径或待复制文件的描述符。
|
| dest | string
\|
number | 是
| 目标文件路径或目标文件描述符。
|
| mode | number
| 否
| mode提供覆盖文件的选项，当前仅支持0，且默认为0。
<br/>
0：完全覆盖目标文件，未覆盖部分将被裁切掉。 |
-
返回值：
| 类型
| 说明
|
| --------
|
-------- |
| 类型
| 说明
|
| --------
----------- | --------------------
-------- |
| Promise
<
void
>
| Promise实例，用于异步获取结果。本调用将返回空值。 |
-
示例：
...
...
@@ -420,12 +420,12 @@ copyFile(src: string | number, dest: string | number, mode: number, callback: As
**系统能力**
：SystemCapability.FileManagement.File.FileIO
-
参数：
| 参数名
| 类型 | 必填 | 说明
|
| -------- | --------
| -------- |
-------- |
| src
| string
\|
number | 是 | 待复制文件的路径或待复制文件的描述符。
|
| dest
| string
\|
number | 是 | 目标文件路径或目标文件描述符。
|
| mode
| number | 否
| mode提供覆盖文件的选项，当前仅支持0，且默认为0。
<br/>
0：完全覆盖目标文件，未覆盖部分将被裁切掉。 |
| callback | AsyncCallback
<
void
>
| 是 | 异步复制文件之后的回调。
|
| 参数名
| 类型 | 必填 | 说明
|
| -------- | --------
------------------ | ---- | --------------------------------
-------- |
| src
| string
\|
number | 是 | 待复制文件的路径或待复制文件的描述符。
|
| dest
| string
\|
number | 是 | 目标文件路径或目标文件描述符。
|
| mode
| number | 否
| mode提供覆盖文件的选项，当前仅支持0，且默认为0。
<br/>
0：完全覆盖目标文件，未覆盖部分将被裁切掉。 |
| callback | AsyncCallback
<
void
>
| 是 | 异步复制文件之后的回调。
|
-
示例：
```
js
...
...
@@ -444,11 +444,11 @@ copyFileSync(src: string | number, dest: string | number, mode?: number): void
**系统能力**
：SystemCapability.FileManagement.File.FileIO
-
参数：
| 参数名
| 类型 | 必填 | 说明
|
| ----
---- | -------- | -------- |
-------- |
| src
| string
\|
number | 是 | 待复制文件的路径或待复制文件的描述符。
|
| dest | string
\|
number | 是
| 目标文件路径或目标文件描述符。
|
| mode | number
| 否
| mode提供覆盖文件的选项，当前仅支持0，且默认为0。
<br/>
0：完全覆盖目标文件，未覆盖部分将被裁切掉。 |
| 参数名
| 类型 | 必填 | 说明
|
| ----
| -------------------------- | ---- | --------------------------------
-------- |
| src
| string
\|
number | 是 | 待复制文件的路径或待复制文件的描述符。
|
| dest | string
\|
number | 是
| 目标文件路径或目标文件描述符。
|
| mode | number
| 否
| mode提供覆盖文件的选项，当前仅支持0，且默认为0。
<br/>
0：完全覆盖目标文件，未覆盖部分将被裁切掉。 |
-
示例：
```
js
...
...
@@ -465,14 +465,14 @@ mkdir(path:string, mode?: number): Promise<void>
**系统能力**
：SystemCapability.FileManagement.File.FileIO
-
参数：
| 参数名
| 类型 | 必填 | 说明
|
| ----
---- | -------- | -------- |
-------- |
| path | string | 是
| 待创建目录的绝对路径。
|
| 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：其余用户具有可执行权限。 |
| 参数名
| 类型 | 必填 | 说明
|
| ----
| ------ | ---- | --------------------------------
-------- |
| path | string | 是
| 待创建目录的绝对路径。
|
| 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实例，用于异步获取结果。本调用将返回空值。 |
-
示例：
...
...
@@ -494,11 +494,11 @@ mkdir(path: string, mode: number, callback: AsyncCallback<void>): void
**系统能力**
：SystemCapability.FileManagement.File.FileIO
-
参数：
| 参数名
| 类型 | 必填 | 说明
|
| -------- | --------
| -------- |
-------- |
| path
| string | 是 | 待创建目录的绝对路径。
|
| 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：其余用户具有可执行权限。 |
| callback | AsyncCallback
<
void
>
| 是
| 异步创建目录操作完成之后的回调。
|
| 参数名
| 类型 | 必填 | 说明
|
| -------- | --------
----------------- | ---- | --------------------------------
-------- |
| path
| string | 是 | 待创建目录的绝对路径。
|
| 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：其余用户具有可执行权限。 |
| callback | AsyncCallback
<
void
>
| 是
| 异步创建目录操作完成之后的回调。
|
-
示例：
```
js
...
...
@@ -519,10 +519,10 @@ mkdirSync(path: string, mode?: number): void
**系统能力**
：SystemCapability.FileManagement.File.FileIO
-
参数：
| 参数名
| 类型 | 必填 | 说明
|
| ----
---- | -------- | -------- |
-------- |
| path | string | 是
| 待创建目录的绝对路径。
|
| 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：其余用户具有可执行权限。 |
| 参数名
| 类型 | 必填 | 说明
|
| ----
| ------ | ---- | --------------------------------
-------- |
| path | string | 是
| 待创建目录的绝对路径。
|
| 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：其余用户具有可执行权限。 |
-
示例：
```
js
...
...
@@ -539,15 +539,15 @@ open(path: string, flags?: number, mode?: number): Promise<number>
**系统能力**
：SystemCapability.FileManagement.File.FileIO
-
参数：
| 参数名
| 类型 | 必填 | 说明
|
| -----
--- | -------- | -------- |
-------- |
| path
| string | 是 | 待打开文件的绝对路径。
|
| flags | number | 否 | 打开文件的选项，必须指定如下选项中的一个，默认以只读方式打开：
<br/>
-
0o0：只读打开。
<br/>
-
0o1：只写打开。
<br/>
-
0o2：读写打开。
<br/>
同时，也可给定如下选项，以按位或的方式追加，默认不给定任何额外选项：
<br/>
-
0o100：若文件不存在，则创建文件。使用该选项时必须指定第三个参数
mode。
<br/>
-
0o200：如果追加了0o100选项，且文件已经存在，则出错。
<br/>
-
0o1000：如果文件存在且以只写或读写的方式打开文件，则将其长度裁剪为零。
<br/>
-
0o2000：以追加方式打开，后续写将追加到文件末尾。
<br/>
-
0o4000：如果path指向FIFO、块特殊文件或字符特殊文件，则本次打开及后续
IO
进行非阻塞操作。
<br/>
-
0o200000：如果path指向目录，则出错。
<br/>
-
0o400000：如果path指向符号链接，则出错。
<br/>
-
0o4010000：以同步IO的方式打开文件。 |
| 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：其余用户具有可执行权限。 |
| 参数名
| 类型 | 必填 | 说明
|
| -----
| ------ | ---- | --------------------------------
-------- |
| path
| string | 是 | 待打开文件的绝对路径。
|
| flags | number | 否
| 打开文件的选项，必须指定如下选项中的一个，默认以只读方式打开：
<br/>
-
0o0：只读打开。
<br/>
-
0o1：只写打开。
<br/>
-
0o2：读写打开。
<br/>
同时，也可给定如下选项，以按位或的方式追加，默认不给定任何额外选项：
<br/>
-
0o100：若文件不存在，则创建文件。使用该选项时必须指定第三个参数
mode。
<br/>
-
0o200：如果追加了0o100选项，且文件已经存在，则出错。
<br/>
-
0o1000：如果文件存在且以只写或读写的方式打开文件，则将其长度裁剪为零。
<br/>
-
0o2000：以追加方式打开，后续写将追加到文件末尾。
<br/>
-
0o4000：如果path指向FIFO、块特殊文件或字符特殊文件，则本次打开及后续
IO
进行非阻塞操作。
<br/>
-
0o200000：如果path指向目录，则出错。
<br/>
-
0o400000：如果path指向符号链接，则出错。
<br/>
-
0o4010000：以同步IO的方式打开文件。 |
| 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
>
| 打开文件的文件描述符。 |
-
示例：
...
...
@@ -569,12 +569,12 @@ open(path: string, flags: number, mode: number, callback: AsyncCallback<numbe
**系统能力**
：SystemCapability.FileManagement.File.FileIO
-
参数：
| 参数名
| 类型 | 必填 | 说明
|
| -------- | --------
| -------- |
-------- |
| path
| string | 是 | 待打开文件的绝对路径。
|
| flags
| number | 是
| 打开文件的选项，必须指定如下选项中的一个，默认以只读方式打开：
<br/>
-
0o0：只读打开。
<br/>
-
0o1：只写打开。
<br/>
-
0o2：读写打开。
<br/>
同时，也可给定如下选项，以按位或的方式追加，默认不给定任何额外选项：
<br/>
-
0o100：若文件不存在，则创建文件。使用该选项时必须指定第三个参数
mode。
<br/>
-
0o200：如果追加了0o100选项，且文件已经存在，则出错。
<br/>
-
0o1000：如果文件存在且以只写或读写的方式打开文件，则将其长度裁剪为零。
<br/>
-
0o2000：以追加方式打开，后续写将追加到文件末尾。
<br/>
-
0o4000：如果path指向FIFO、块特殊文件或字符特殊文件，则本次打开及后续
IO
进行非阻塞操作。
<br/>
-
0o200000：如果path指向目录，则出错。
<br/>
-
0o400000：如果path指向符号链接，则出错。
<br/>
-
0o4010000：以同步IO的方式打开文件。 |
| 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：其余用户具有可执行权限。 |
| callback | AsyncCallback
<
void
>
| 是
| 异步打开文件之后的回调。
|
| 参数名
| 类型 | 必填 | 说明
|
| -------- | --------
----------------------- | ---- | --------------------------------
-------- |
| path
| string | 是 | 待打开文件的绝对路径。
|
| flags
| number | 是
| 打开文件的选项，必须指定如下选项中的一个，默认以只读方式打开：
<br/>
-
0o0：只读打开。
<br/>
-
0o1：只写打开。
<br/>
-
0o2：读写打开。
<br/>
同时，也可给定如下选项，以按位或的方式追加，默认不给定任何额外选项：
<br/>
-
0o100：若文件不存在，则创建文件。使用该选项时必须指定第三个参数
mode。
<br/>
-
0o200：如果追加了0o100选项，且文件已经存在，则出错。
<br/>
-
0o1000：如果文件存在且以只写或读写的方式打开文件，则将其长度裁剪为零。
<br/>
-
0o2000：以追加方式打开，后续写将追加到文件末尾。
<br/>
-
0o4000：如果path指向FIFO、块特殊文件或字符特殊文件，则本次打开及后续
IO
进行非阻塞操作。
<br/>
-
0o200000：如果path指向目录，则出错。
<br/>
-
0o400000：如果path指向符号链接，则出错。
<br/>
-
0o4010000：以同步IO的方式打开文件。 |
| 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：其余用户具有可执行权限。 |
| callback | AsyncCallback
<
void
>
| 是
| 异步打开文件之后的回调。
|
-
示例：
```
js
...
...
@@ -593,15 +593,15 @@ openSync(path:string, flags?:number, mode?:number): number
**系统能力**
：SystemCapability.FileManagement.File.FileIO
-
参数：
| 参数名
| 类型 | 必填 | 说明
|
| -----
--- | -------- | -------- |
-------- |
| path
| string | 是 | 待打开文件的绝对路径。
|
| flags | number | 否 | 打开文件的选项，必须指定如下选项中的一个，默认以只读方式打开：
<br/>
-
0o0：只读打开。
<br/>
-
0o1：只写打开。
<br/>
-
0o2：读写打开。
<br/>
同时，也可给定如下选项，以按位或的方式追加，默认不给定任何额外选项：
<br/>
-
0o100：若文件不存在，则创建文件。使用该选项时必须指定第三个参数
mode。
<br/>
-
0o200：如果追加了0o100选项，且文件已经存在，则出错。
<br/>
-
0o1000：如果文件存在且以只写或读写的方式打开文件，则将其长度裁剪为零。
<br/>
-
0o2000：以追加方式打开，后续写将追加到文件末尾。
<br/>
-
0o4000：如果path指向FIFO、块特殊文件或字符特殊文件，则本次打开及后续
IO
进行非阻塞操作。
<br/>
-
0o200000：如果path指向目录，则出错。
<br/>
-
0o400000：如果path指向符号链接，则出错。
<br/>
-
0o4010000：以同步IO的方式打开文件。 |
| 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：其余用户具有可执行权限。
<br/>
创建出的文件权限受umask影响，umask随进程启动确定，其修改当前不开放。 |
| 参数名
| 类型 | 必填 | 说明
|
| -----
| ------ | ---- | --------------------------------
-------- |
| path
| string | 是 | 待打开文件的绝对路径。
|
| flags | number | 否
| 打开文件的选项，必须指定如下选项中的一个，默认以只读方式打开：
<br/>
-
0o0：只读打开。
<br/>
-
0o1：只写打开。
<br/>
-
0o2：读写打开。
<br/>
同时，也可给定如下选项，以按位或的方式追加，默认不给定任何额外选项：
<br/>
-
0o100：若文件不存在，则创建文件。使用该选项时必须指定第三个参数
mode。
<br/>
-
0o200：如果追加了0o100选项，且文件已经存在，则出错。
<br/>
-
0o1000：如果文件存在且以只写或读写的方式打开文件，则将其长度裁剪为零。
<br/>
-
0o2000：以追加方式打开，后续写将追加到文件末尾。
<br/>
-
0o4000：如果path指向FIFO、块特殊文件或字符特殊文件，则本次打开及后续
IO
进行非阻塞操作。
<br/>
-
0o200000：如果path指向目录，则出错。
<br/>
-
0o400000：如果path指向符号链接，则出错。
<br/>
-
0o4010000：以同步IO的方式打开文件。 |
| 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：其余用户具有可执行权限。
<br/>
创建出的文件权限受umask影响，umask随进程启动确定，其修改当前不开放。 |
-
返回值：
| 类型
| 说明
|
| ------
-- |
-------- |
| 类型
| 说明
|
| ------
| ---
-------- |
| number | 打开文件的文件描述符。 |
-
示例：
...
...
@@ -623,15 +623,15 @@ read(fd: number, buffer: ArrayBuffer, options?: {
**系统能力**
：SystemCapability.FileManagement.File.FileIO
-
参数：
| 参数名
| 类型 | 必填 | 说明
|
| -------
- | -------- | -------- |
-------- |
| fd
| number | 是 | 待读取文件的文件描述符。
|
| buffer
| ArrayBuffer | 是 | 用于保存读取到的文件数据的缓冲区。
|
| options | Object
| 否
| 支持如下选项：
<br/>
-
offset，number类型，表示将数据读取到缓冲区的位置，即相对于缓冲区首地址的偏移。可选，默认为0。
<br/>
-
length，number类型，表示期望读取数据的长度。可选，默认缓冲区长度减去偏移长度。
<br/>
-
position，number类型，表示期望读取文件的位置。可选，默认从当前位置开始读。 |
| 参数名
| 类型 | 必填 | 说明
|
| -------
| ----------- | ---- | --------------------------------
-------- |
| fd
| number | 是 | 待读取文件的文件描述符。
|
| buffer
| ArrayBuffer | 是 | 用于保存读取到的文件数据的缓冲区。
|
| options | Object
| 否
| 支持如下选项：
<br/>
-
offset，number类型，表示将数据读取到缓冲区的位置，即相对于缓冲区首地址的偏移。可选，默认为0。
<br/>
-
length，number类型，表示期望读取数据的长度。可选，默认缓冲区长度减去偏移长度。
<br/>
-
position，number类型，表示期望读取文件的位置。可选，默认从当前位置开始读。 |
-
返回值：
| 类型
| 说明
|
| --------
| --
------ |
| 类型
| 说明
|
| --------
-------------------------- |
------ |
| Promise
<
[ReadOut](#readout)
>
| 读取的结果。 |
-
示例：
...
...
@@ -659,12 +659,12 @@ read(fd: number, buffer: ArrayBuffer, options: {
**系统能力**
：SystemCapability.FileManagement.File.FileIO
-
参数：
| 参数名
| 类型 | 必填 | 说明
|
| -------- | --------
| -------- |
-------- |
| fd
| number | 是 | 待读取文件的文件描述符。
|
| buffer
| ArrayBuffer | 是 | 用于保存读取到的文件数据的缓冲区。
|
| options
| Object | 否
| 支持如下选项：
<br/>
-
offset，number类型，表示将数据读取到缓冲区的位置，即相对于缓冲区首地址的偏移。可选，默认为0。
<br/>
-
length，number类型，表示期望读取数据的长度。可选，默认缓冲区长度减去偏移长度。
<br/>
-
position，number类型，表示期望读取文件的位置。可选，默认从当前位置开始读。 |
| callback | AsyncCallback
<
[ReadOut](#readout)
>
| 是
| 异步读取数据之后的回调。
|
| 参数名
| 类型 | 必填 | 说明
|
| -------- | --------
-------------------------------- | ---- | --------------------------------
-------- |
| fd
| number | 是 | 待读取文件的文件描述符。
|
| buffer
| ArrayBuffer | 是 | 用于保存读取到的文件数据的缓冲区。
|
| options
| Object | 否
| 支持如下选项：
<br/>
-
offset，number类型，表示将数据读取到缓冲区的位置，即相对于缓冲区首地址的偏移。可选，默认为0。
<br/>
-
length，number类型，表示期望读取数据的长度。可选，默认缓冲区长度减去偏移长度。
<br/>
-
position，number类型，表示期望读取文件的位置。可选，默认从当前位置开始读。 |
| callback | AsyncCallback
<
[ReadOut](#readout)
>
| 是
| 异步读取数据之后的回调。
|
-
示例：
```
js
...
...
@@ -691,15 +691,15 @@ readSync(fd: number, buffer: ArrayBuffer, options?: {
**系统能力**
：SystemCapability.FileManagement.File.FileIO
-
参数：
| 参数名
| 类型 | 必填 | 说明
|
| -------
- | -------- | -------- |
-------- |
| fd
| number | 是 | 待读取文件的文件描述符。
|
| buffer
| ArrayBuffer | 是 | 用于保存读取到的文件数据的缓冲区。
|
| options | Object
| 否
| 支持如下选项：
<br/>
-
offset，number类型，表示将数据读取到缓冲区的位置，即相对于缓冲区首地址的偏移。可选，默认为0。
<br/>
-
length，number类型，表示期望读取数据的长度。可选，默认缓冲区长度减去偏移长度。
<br/>
-
position，number类型，表示期望读取文件的位置。可选，默认从当前位置开始读。 |
| 参数名
| 类型 | 必填 | 说明
|
| -------
| ----------- | ---- | --------------------------------
-------- |
| fd
| number | 是 | 待读取文件的文件描述符。
|
| buffer
| ArrayBuffer | 是 | 用于保存读取到的文件数据的缓冲区。
|
| options | Object
| 否
| 支持如下选项：
<br/>
-
offset，number类型，表示将数据读取到缓冲区的位置，即相对于缓冲区首地址的偏移。可选，默认为0。
<br/>
-
length，number类型，表示期望读取数据的长度。可选，默认缓冲区长度减去偏移长度。
<br/>
-
position，number类型，表示期望读取文件的位置。可选，默认从当前位置开始读。 |
-
返回值：
| 类型
| 说明
|
| ------
--
| -------- |
| 类型
| 说明
|
| ------ | -------- |
| number | 实际读取的长度。 |
-
示例：
...
...
@@ -719,13 +719,13 @@ rmdir(path: string): Promise<void>
**系统能力**
：SystemCapability.FileManagement.File.FileIO
-
参数：
| 参数名
| 类型 | 必填 | 说明
|
| ----
---- | -------- | -------- |
-------- |
| path | string | 是 | 待删除目录的绝对路径。 |
| 参数名
| 类型 | 必填 | 说明
|
| ----
| ------ | ---- | ---
-------- |
| path | string | 是
| 待删除目录的绝对路径。 |
-
返回值：
| 类型
| 说明
|
| --------
|
-------- |
| 类型
| 说明
|
| --------
----------- | --------------------
-------- |
| Promise
<
void
>
| Promise实例，用于异步获取结果。本调用将返回空值。 |
-
示例：
...
...
@@ -747,10 +747,10 @@ rmdir(path: string, callback:AsyncCallback<void>): void
**系统能力**
：SystemCapability.FileManagement.File.FileIO
-
参数：
| 参数名
| 类型 | 必填 | 说明
|
| -------- | --------
| -------- |
-------- |
| path
| string | 是 | 待删除目录的绝对路径。
|
| callback | AsyncCallback
<
void
>
| 是 | 异步删除目录之后的回调。 |
| 参数名
| 类型 | 必填 | 说明
|
| -------- | --------
----------------- | ---- | ----
-------- |
| path
| string | 是 | 待删除目录的绝对路径。
|
| callback | AsyncCallback
<
void
>
| 是
| 异步删除目录之后的回调。 |
-
示例：
```
js
...
...
@@ -769,9 +769,9 @@ rmdirSync(path: string): void
**系统能力**
：SystemCapability.FileManagement.File.FileIO
-
参数：
| 参数名
| 类型 | 必填 | 说明
|
| ----
---- | -------- | -------- |
-------- |
| path | string | 是 | 待删除目录的绝对路径。 |
| 参数名
| 类型 | 必填 | 说明
|
| ----
| ------ | ---- | ---
-------- |
| path | string | 是
| 待删除目录的绝对路径。 |
-
示例：
```
js
...
...
@@ -788,13 +788,13 @@ unlink(path:string): Promise<void>
**系统能力**
：SystemCapability.FileManagement.File.FileIO
-
参数：
| 参数名
| 类型 | 必填 | 说明
|
| ----
---- | -------- | -------- |
-------- |
| path | string | 是 | 待删除文件的绝对路径。 |
| 参数名
| 类型 | 必填 | 说明
|
| ----
| ------ | ---- | ---
-------- |
| path | string | 是
| 待删除文件的绝对路径。 |
-
返回值：
| 类型
| 说明
|
| --------
|
-------- |
| 类型
| 说明
|
| --------
----------- | --------------------
-------- |
| Promise
<
void
>
| Promise实例，用于异步获取结果。本调用将返回空值。 |
-
示例：
...
...
@@ -816,10 +816,10 @@ unlink(path:string, callback:AsyncCallback<void>): void
**系统能力**
：SystemCapability.FileManagement.File.FileIO
-
参数：
| 参数名
| 类型 | 必填 | 说明
|
| -------- | --------
| -------- |
-------- |
| path
| string | 是 | 待删除文件的绝对路径。
|
| callback | AsyncCallback
<
void
>
| 是 | 异步删除文件之后的回调。 |
| 参数名
| 类型 | 必填 | 说明
|
| -------- | --------
----------------- | ---- | ----
-------- |
| path
| string | 是 | 待删除文件的绝对路径。
|
| callback | AsyncCallback
<
void
>
| 是
| 异步删除文件之后的回调。 |
-
示例：
```
js
...
...
@@ -840,9 +840,9 @@ unlinkSync(path: string): void
**系统能力**
：SystemCapability.FileManagement.File.FileIO
-
参数：
| 参数名
| 类型 | 必填 | 说明
|
| ----
---- | -------- | -------- |
-------- |
| path | string | 是 | 待删除文件的绝对路径。 |
| 参数名
| 类型 | 必填 | 说明
|
| ----
| ------ | ---- | ---
-------- |
| path | string | 是
| 待删除文件的绝对路径。 |
-
示例：
```
js
...
...
@@ -864,15 +864,15 @@ write(fd: number, buffer: ArrayBuffer | string, options?: {
**系统能力**
：SystemCapability.FileManagement.File.FileIO
-
参数：
| 参数名
| 类型 | 必填 | 说明
|
| -------
- | -------- | -------- |
-------- |
| fd
| number | 是 | 待写入文件的文件描述符。
|
| buffer
| ArrayBuffer
\|
string | 是 | 待写入文件的数据，可来自缓冲区或字符串。
|
| options | Object
| 否
| 支持如下选项：
<br/>
-
offset，number类型，表示期望写入数据的位置相对于数据首地址的偏移。可选，默认为0。
<br/>
-
length，number类型，表示期望写入数据的长度。可选，默认缓冲区长度减去偏移长度。
<br/>
-
position，number类型，表示期望写入文件的位置。可选，默认从当前位置开始写。
<br/>
-
encoding，string类型，当数据是string类型时有效，表示数据的编码方式，默认
'utf-8'。仅支持
'utf-8'。 |
| 参数名
| 类型 | 必填 | 说明
|
| -------
| ------------------------------- | ---- | --------------------------------
-------- |
| fd
| number | 是 | 待写入文件的文件描述符。
|
| buffer
| ArrayBuffer
\|
string | 是 | 待写入文件的数据，可来自缓冲区或字符串。
|
| options | Object
| 否
| 支持如下选项：
<br/>
-
offset，number类型，表示期望写入数据的位置相对于数据首地址的偏移。可选，默认为0。
<br/>
-
length，number类型，表示期望写入数据的长度。可选，默认缓冲区长度减去偏移长度。
<br/>
-
position，number类型，表示期望写入文件的位置。可选，默认从当前位置开始写。
<br/>
-
encoding，string类型，当数据是string类型时有效，表示数据的编码方式，默认
'utf-8'。仅支持
'utf-8'。 |
-
返回值：
| 类型
| 说明
|
| -------- | -------- |
| 类型
| 说明
|
| --------
-------------
| -------- |
| Promise
<
number
>
| 实际写入的长度。 |
-
示例：
...
...
@@ -900,12 +900,12 @@ write(fd: number, buffer: ArrayBuffer | string, options: {
**系统能力**
：SystemCapability.FileManagement.File.FileIO
-
参数：
| 参数名
| 类型 | 必填 | 说明
|
| -------- | --------
| -------- |
-------- |
| fd
| number | 是 | 待写入文件的文件描述符。
|
| buffer
| ArrayBuffer
\|
string | 是 | 待写入文件的数据，可来自缓冲区或字符串。
|
| options
| Object | 否
| 支持如下选项：
<br/>
-
offset，number类型，表示期望写入数据的位置相对于数据首地址的偏移。可选，默认为0。
<br/>
-
length，number类型，表示期望写入数据的长度。可选，默认缓冲区长度减去偏移长度。
<br/>
-
position，number类型，表示期望写入文件的位置。可选，默认从当前位置开始写。
<br/>
-
encoding，string类型，当数据是string类型时有效，表示数据的编码方式，默认
'utf-8'。仅支持
'utf-8'。 |
| callback | AsyncCallback
<
number
>
| 是 | 异步将数据写入完成后执行的回调函数。
|
| 参数名
| 类型 | 必填 | 说明
|
| -------- | --------
----------------------- | ---- | --------------------------------
-------- |
| fd
| number | 是 | 待写入文件的文件描述符。
|
| buffer
| ArrayBuffer
\|
string | 是 | 待写入文件的数据，可来自缓冲区或字符串。
|
| options
| Object | 否
| 支持如下选项：
<br/>
-
offset，number类型，表示期望写入数据的位置相对于数据首地址的偏移。可选，默认为0。
<br/>
-
length，number类型，表示期望写入数据的长度。可选，默认缓冲区长度减去偏移长度。
<br/>
-
position，number类型，表示期望写入文件的位置。可选，默认从当前位置开始写。
<br/>
-
encoding，string类型，当数据是string类型时有效，表示数据的编码方式，默认
'utf-8'。仅支持
'utf-8'。 |
| callback | AsyncCallback
<
number
>
| 是 | 异步将数据写入完成后执行的回调函数。
|
-
示例：
```
js
...
...
@@ -932,15 +932,15 @@ writeSync(fd: number, buffer: ArrayBuffer | string, options?: {
**系统能力**
：SystemCapability.FileManagement.File.FileIO
-
参数：
| 参数名
| 类型 | 必填 | 说明
|
| -------
- | -------- | -------- |
-------- |
| fd
| number | 是 | 待写入文件的文件描述符。
|
| buffer
| ArrayBuffer
\|
string | 是 | 待写入文件的数据，可来自缓冲区或字符串。
|
| options | Object
| 否
| 支持如下选项：
<br/>
-
offset，number类型，表示期望写入数据的位置相对于数据首地址的偏移。可选，默认为0。
<br/>
-
length，number类型，表示期望写入数据的长度。可选，默认缓冲区长度减去偏移长度。
<br/>
-
position，number类型，表示期望写入文件的位置。可选，默认从当前位置开始写。
<br/>
-
encoding，string类型，当数据是string类型时有效，表示数据的编码方式，默认
'utf-8'。仅支持
'utf-8'。 |
| 参数名
| 类型 | 必填 | 说明
|
| -------
| ------------------------------- | ---- | --------------------------------
-------- |
| fd
| number | 是 | 待写入文件的文件描述符。
|
| buffer
| ArrayBuffer
\|
string | 是 | 待写入文件的数据，可来自缓冲区或字符串。
|
| options | Object
| 否
| 支持如下选项：
<br/>
-
offset，number类型，表示期望写入数据的位置相对于数据首地址的偏移。可选，默认为0。
<br/>
-
length，number类型，表示期望写入数据的长度。可选，默认缓冲区长度减去偏移长度。
<br/>
-
position，number类型，表示期望写入文件的位置。可选，默认从当前位置开始写。
<br/>
-
encoding，string类型，当数据是string类型时有效，表示数据的编码方式，默认
'utf-8'。仅支持
'utf-8'。 |
-
返回值：
| 类型
| 说明
|
| ------
--
| -------- |
| 类型
| 说明
|
| ------ | -------- |
| number | 实际写入的长度。 |
-
示例：
...
...
@@ -959,14 +959,14 @@ hash(path: string, algorithm: string): Promise<string>
**系统能力**
：SystemCapability.FileManagement.File.FileIO
-
参数：
| 参数名
| 类型 | 必填 | 说明
|
| --------
| -------- | -------- |
-------- |
| path
| string | 是 | 待计算哈希值文件的绝对路径。
|
| algorithm | string | 是 | 哈希计算采用的算法。可选
"md5"、"sha1"
或
"sha256"。建议采用安全强度更高的
"sha256"。 |
| 参数名
| 类型 | 必填 | 说明
|
| --------
- | ------ | ---- | --------------------------------
-------- |
| path
| string | 是 | 待计算哈希值文件的绝对路径。
|
| algorithm | string | 是
| 哈希计算采用的算法。可选
"md5"、"sha1"
或
"sha256"。建议采用安全强度更高的
"sha256"。 |
-
返回值：
| 类型
| 说明
|
| --------
|
-------- |
| 类型
| 说明
|
| --------
------------- | ------------------
-------- |
| Promise
<
string
>
| 文件的哈希值。表示为十六进制数字串，所有字母均大写。 |
-
示例：
...
...
@@ -988,11 +988,11 @@ hash(path: string, algorithm: string, callback: AsyncCallback<string>): vo
**系统能力**
：SystemCapability.FileManagement.File.FileIO
-
参数：
| 参数名
| 类型 | 必填 | 说明
|
| --------
| -------- | -------- |
-------- |
| path
| string | 是 | 待计算哈希值文件的绝对路径。
|
| algorithm | string
| 是
| 哈希计算采用的算法。可选
"md5"、"sha1"
或
"sha256"。建议采用安全强度更高的
"sha256"。 |
| callback
| AsyncCallback
<
string
>
| 是
| 异步计算文件哈希操之后的回调函数（其中给定文件哈希值表示为十六进制数字串，所有字母均大写）。 |
| 参数名
| 类型 | 必填 | 说明
|
| --------
- | --------------------------- | ---- | --------------------------------
-------- |
| path
| string | 是 | 待计算哈希值文件的绝对路径。
|
| algorithm | string
| 是
| 哈希计算采用的算法。可选
"md5"、"sha1"
或
"sha256"。建议采用安全强度更高的
"sha256"。 |
| callback
| AsyncCallback
<
string
>
| 是
| 异步计算文件哈希操之后的回调函数（其中给定文件哈希值表示为十六进制数字串，所有字母均大写）。 |
-
示例：
```
js
...
...
@@ -1013,14 +1013,14 @@ chmod(path: string, mode: number):Promise<void>
**系统能力**
：SystemCapability.FileManagement.File.FileIO
-
参数：
| 参数名
| 类型 | 必填 | 说明
|
| ----
---- | -------- | -------- |
-------- |
| path | string | 是
| 待改变文件权限的绝对路径。
|
| 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：其余用户具有可执行权限。 |
| 参数名
| 类型 | 必填 | 说明
|
| ----
| ------ | ---- | --------------------------------
-------- |
| path | string | 是
| 待改变文件权限的绝对路径。
|
| 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实例，用于异步获取结果。本调用将返回空值。 |
-
示例：
...
...
@@ -1042,11 +1042,11 @@ chmod(path: string, mode: number, callback: AsyncCallback<void>): void
**系统能力**
：SystemCapability.FileManagement.File.FileIO
-
参数：
| 参数名
| 类型 | 必填 | 说明
|
| -------- | --------
| -------- |
-------- |
| path
| string | 是 | 待改变文件权限的绝对路径。
|
| 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
>
| 是
| 异步改变文件权限之后的回调。
|
| 参数名
| 类型 | 必填 | 说明
|
| -------- | --------
----------------- | ---- | --------------------------------
-------- |
| path
| string | 是 | 待改变文件权限的绝对路径。
|
| 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
>
| 是
| 异步改变文件权限之后的回调。
|
-
示例：
```
js
...
...
@@ -1065,10 +1065,10 @@ chmodSync(path: string, mode: number): void
**系统能力**
：SystemCapability.FileManagement.File.FileIO
-
参数：
| 参数名
| 类型 | 必填 | 说明
|
| ----
---- | -------- | -------- |
-------- |
| path | string | 是
| 待改变文件权限的绝对路径。
|
| 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：其余用户具有可执行权限。 |
| 参数名
| 类型 | 必填 | 说明
|
| ----
| ------ | ---- | --------------------------------
-------- |
| path | string | 是
| 待改变文件权限的绝对路径。
|
| 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
...
...
@@ -1085,13 +1085,13 @@ fstat(fd: number): Promise<Stat>
**系统能力**
：SystemCapability.FileManagement.File.FileIO
-
参数：
| 参数名
| 类型 | 必填 | 说明
|
| ----
---- | -------- | -------- |
-------- |
| fd
| number | 是
| 待获取文件的文件描述符。 |
| 参数名
| 类型 | 必填 | 说明
|
| ----
| ------ | ---- | ----
-------- |
| fd
| number | 是
| 待获取文件的文件描述符。 |
-
返回值：
| 类型
| 说明
|
| --------
|
-------- |
| 类型
| 说明
|
| --------
-------------------- | --
-------- |
| Promise
<
[Stat](#stat)
>
| 表示文件的具体信息。 |
-
示例：
...
...
@@ -1113,10 +1113,10 @@ fstat(fd: number, callback: AsyncCallback<Stat>): void
**系统能力**
：SystemCapability.FileManagement.File.FileIO
-
参数：
| 参数名
| 类型 | 必填 | 说明
|
| -------- | --------
| -------- |
-------- |
| fd
| number | 是 | 待获取文件的文件描述符。
|
| callback | AsyncCallback
<
[Stat](#stat)
>
| 是 | 异步获取文件状态信息之后的回调。 |
| 参数名
| 类型 | 必填 | 说明
|
| -------- | --------
-------------------------- | ---- | --------
-------- |
| fd
| number | 是 | 待获取文件的文件描述符。
|
| callback | AsyncCallback
<
[Stat](#stat)
>
| 是
| 异步获取文件状态信息之后的回调。 |
-
示例：
```
js
...
...
@@ -1136,13 +1136,13 @@ fstatSync(fd: number): Stat
**系统能力**
：SystemCapability.FileManagement.File.FileIO
-
参数：
| 参数名
| 类型 | 必填 | 说明
|
| ----
---- | -------- | -------- |
-------- |
| fd
| number | 是
| 待获取文件的文件描述符。 |
| 参数名
| 类型 | 必填 | 说明
|
| ----
| ------ | ---- | ----
-------- |
| fd
| number | 是
| 待获取文件的文件描述符。 |
-
返回值：
| 类型
| 说明
|
| --------
|
-------- |
| 类型
| 说明
|
| --------
----- | --
-------- |
|
[
Stat
](
#stat
)
| 表示文件的具体信息。 |
-
示例：
...
...
@@ -1161,14 +1161,14 @@ ftruncate(fd: number, len?: number): Promise<void>
**系统能力**
：SystemCapability.FileManagement.File.FileIO
-
参数：
| 参数名
| 类型 | 必填 | 说明
|
| ----
---- | -------- | -------- |
-------- |
| fd
| number | 是 | 待截断文件的文件描述符。
|
| len
| number | 是
| 文件截断后的长度，以字节为单位。 |
| 参数名
| 类型 | 必填 | 说明
|
| ----
| ------ | ---- | --------
-------- |
| fd
| number | 是 | 待截断文件的文件描述符。
|
| len
| number | 是
| 文件截断后的长度，以字节为单位。 |
-
返回值：
| 类型
| 说明
|
| --------
|
-------- |
| 类型
| 说明
|
| --------
----------- | --------------------
-------- |
| Promise
<
void
>
| Promise实例，用于异步获取结果。本调用将返回空值。 |
-
示例：
...
...
@@ -1191,11 +1191,11 @@ ftruncate(fd: number, len: number, callback:AsyncCallback<void>): void
**系统能力**
：SystemCapability.FileManagement.File.FileIO
-
参数：
| 参数名
| 类型 | 必填 | 说明
|
| -------- | --------
| -------- |
-------- |
| fd
| number | 是 | 待截断文件的文件描述符。
|
| len
| number | 是
| 文件截断后的长度，以字节为单位。 |
| callback | AsyncCallback
<
void
>
| 是
| 异步截断文件的信息之后的回调。
|
| 参数名
| 类型 | 必填 | 说明
|
| -------- | --------
----------------- | ---- | --------
-------- |
| fd
| number | 是 | 待截断文件的文件描述符。
|
| len
| number | 是
| 文件截断后的长度，以字节为单位。 |
| callback | AsyncCallback
<
void
>
| 是
| 异步截断文件的信息之后的回调。
|
-
示例：
```
js
...
...
@@ -1214,10 +1214,10 @@ ftruncateSync(fd: number, len?: number): void
**系统能力**
：SystemCapability.FileManagement.File.FileIO
-
参数：
| 参数名
| 类型 | 必填 | 说明
|
| ----
---- | -------- | -------- |
-------- |
| fd
| number | 是 | 待截断文件的文件描述符。
|
| len
| number | 否
| 文件截断后的长度，以字节为单位。 |
| 参数名
| 类型 | 必填 | 说明
|
| ----
| ------ | ---- | --------
-------- |
| fd
| number | 是 | 待截断文件的文件描述符。
|
| len
| number | 否
| 文件截断后的长度，以字节为单位。 |
-
示例：
```
js
...
...
@@ -1234,14 +1234,14 @@ truncate(path: string, len?: number): Promise<void>
**系统能力**
：SystemCapability.FileManagement.File.FileIO
-
参数：
| 参数名
| 类型 | 必填 | 说明
|
| ----
---- | -------- | -------- |
-------- |
| path | string | 是
| 待截断文件的绝对路径。
|
| len
| number | 是
| 文件截断后的长度，以字节为单位。 |
| 参数名
| 类型 | 必填 | 说明
|
| ----
| ------ | ---- | --------
-------- |
| path | string | 是
| 待截断文件的绝对路径。
|
| len
| number | 是
| 文件截断后的长度，以字节为单位。 |
-
返回值：
| 类型
| 说明
|
| --------
|
-------- |
| 类型
| 说明
|
| --------
----------- | --------------------
-------- |
| Promise
<
void
>
| Promise实例，用于异步获取结果。本调用将返回空值。 |
-
示例：
...
...
@@ -1263,11 +1263,11 @@ truncate(path: string, len: number, callback:AsyncCallback<void>): void
**系统能力**
：SystemCapability.FileManagement.File.FileIO
-
参数：
| 参数名
| 类型 | 必填 | 说明
|
| -------- | --------
| -------- |
-------- |
| path
| string | 是 | 待截断文件的绝对路径。
|
| len
| number | 是
| 文件截断后的长度，以字节为单位。 |
| callback | AsyncCallback
<
void
>
| 是
| 异步截断文件的信息之后的回调。
|
| 参数名
| 类型 | 必填 | 说明
|
| -------- | --------
----------------- | ---- | --------
-------- |
| path
| string | 是 | 待截断文件的绝对路径。
|
| len
| number | 是
| 文件截断后的长度，以字节为单位。 |
| callback | AsyncCallback
<
void
>
| 是
| 异步截断文件的信息之后的回调。
|
-
示例：
```
js
...
...
@@ -1286,10 +1286,10 @@ truncateSync(path: string, len?: number): void
**系统能力**
：SystemCapability.FileManagement.File.FileIO
-
参数：
| 参数名
| 类型 | 必填 | 说明
|
| ----
---- | -------- | -------- |
-------- |
| path | string | 是
| 待截断文件的绝对路径。
|
| len
| number | 否
| 文件截断后的长度，以字节为单位。 |
| 参数名
| 类型 | 必填 | 说明
|
| ----
| ------ | ---- | --------
-------- |
| path | string | 是
| 待截断文件的绝对路径。
|
| len
| number | 否
| 文件截断后的长度，以字节为单位。 |
-
示例：
```
js
...
...
@@ -1310,14 +1310,14 @@ readText(filePath: string, options?: {
**系统能力**
：SystemCapability.FileManagement.File.FileIO
-
参数：
| 参数名
| 类型 | 必填 | 说明
|
| -------- | ------
-- | -------- |
-------- |
| filePath | string | 是
| 待读取文件的绝对路径。
|
| options
| Object | 否
| 支持如下选项：
<br/>
-
position，number类型，表示期望读取文件的位置。可选，默认从当前位置开始读取。
<br/>
-
length，number类型，表示期望读取数据的长度。可选，默认缓冲区长度减去偏移长度。
<br/>
-
encoding，string类型，当数据是
string
类型时有效，表示数据的编码方式，默认
'utf-8'，仅支持
'utf-8'。 |
| 参数名
| 类型 | 必填 | 说明
|
| -------- | ------
| ---- | --------------------------------
-------- |
| filePath | string | 是
| 待读取文件的绝对路径。
|
| options
| Object | 否
| 支持如下选项：
<br/>
-
position，number类型，表示期望读取文件的位置。可选，默认从当前位置开始读取。
<br/>
-
length，number类型，表示期望读取数据的长度。可选，默认缓冲区长度减去偏移长度。
<br/>
-
encoding，string类型，当数据是
string
类型时有效，表示数据的编码方式，默认
'utf-8'，仅支持
'utf-8'。 |
-
返回值：
| 类型
| 说明
|
| --------
|
-------- |
| 类型
| 说明
|
| --------
------------- | --
-------- |
| Promise
<
string
>
| 返回读取文件的内容。 |
-
示例：
...
...
@@ -1343,11 +1343,11 @@ readText(filePath: string, options: {
**系统能力**
：SystemCapability.FileManagement.File.FileIO
-
参数：
| 参数名
| 类型 | 必填 | 说明
|
| -------- | --------
| -------- |
-------- |
| filePath | string
| 是 | 待读取文件的绝对路径。
|
| options
| Object | 否
| 支持如下选项：
<br/>
-
position，number类型，表示期望读取文件的位置。可选，默认从当前位置开始读取。
<br/>
-
length，number类型，表示期望读取数据的长度。可选，默认缓冲区长度减去偏移长度。
<br/>
-
encoding，string类型，当数据是
string
类型时有效，表示数据的编码方式，默认
'utf-8'，仅支持
'utf-8'。 |
| callback | AsyncCallback
<
string
>
| 是
| 异步通过文本方式读取文件之后的回调。
|
| 参数名
| 类型 | 必填 | 说明
|
| -------- | --------
------------------- | ---- | --------------------------------
-------- |
| filePath | string
| 是 | 待读取文件的绝对路径。
|
| options
| Object | 否
| 支持如下选项：
<br/>
-
position，number类型，表示期望读取文件的位置。可选，默认从当前位置开始读取。
<br/>
-
length，number类型，表示期望读取数据的长度。可选，默认缓冲区长度减去偏移长度。
<br/>
-
encoding，string类型，当数据是
string
类型时有效，表示数据的编码方式，默认
'utf-8'，仅支持
'utf-8'。 |
| callback | AsyncCallback
<
string
>
| 是
| 异步通过文本方式读取文件之后的回调。
|
-
示例：
```
js
...
...
@@ -1370,14 +1370,14 @@ readTextSync(filePath: string, options?: {
**系统能力**
：SystemCapability.FileManagement.File.FileIO
-
参数：
| 参数名
| 类型 | 必填 | 说明
|
| -------- | ------
-- | -------- |
-------- |
| filePath | string | 是
| 待读取文件的绝对路径。
|
| options
| Object | 否
| 支持如下选项：
<br/>
-
position，number类型，表示期望读取文件的位置。可选，默认从当前位置开始读取。
<br/>
-
length，number类型，表示期望读取数据的长度。可选，默认缓冲区长度减去偏移长度。
<br/>
-
encoding，string类型，当数据是
string
类型时有效，表示数据的编码方式，默认
'utf-8'，仅支持
'utf-8'。 |
| 参数名
| 类型 | 必填 | 说明
|
| -------- | ------
| ---- | --------------------------------
-------- |
| filePath | string | 是
| 待读取文件的绝对路径。
|
| options
| Object | 否
| 支持如下选项：
<br/>
-
position，number类型，表示期望读取文件的位置。可选，默认从当前位置开始读取。
<br/>
-
length，number类型，表示期望读取数据的长度。可选，默认缓冲区长度减去偏移长度。
<br/>
-
encoding，string类型，当数据是
string
类型时有效，表示数据的编码方式，默认
'utf-8'，仅支持
'utf-8'。 |
-
返回值：
| 类型
| 说明
|
| --------
|
-------- |
| 类型
| 说明
|
| --------
------------- | --
-------- |
| Promise
<
string
>
| 返回读取文件的内容。 |
-
示例：
...
...
@@ -1395,13 +1395,13 @@ lstat(path: string): Promise<Stat>
**系统能力**
：SystemCapability.FileManagement.File.FileIO
-
参数：
| 参数名
| 类型 | 必填 | 说明
|
| ----
---- | -------- | -------- |
-------- |
| path | string | 是 | 目标文件的绝对路径，指向链接状态。 |
| 参数名
| 类型 | 必填 | 说明
|
| ----
| ------ | ---- | ---------
-------- |
| path | string | 是
| 目标文件的绝对路径，指向链接状态。 |
-
返回值：
| 类型
| 说明
|
| --------
|
-------- |
| 类型
| 说明
|
| --------
-------------------- | --
-------- |
| Promise
<
[Stat](#stat)
>
| 表示文件的具体信息。 |
-
示例：
...
...
@@ -1423,10 +1423,10 @@ lstat(path:string, callback:AsyncCallback<Stat>): void
**系统能力**
：SystemCapability.FileManagement.File.FileIO
-
参数：
| 参数名
| 类型 | 必填 | 说明
|
| -------- | --------
| -------- |
-------- |
| path
| string | 是
| 目标文件的绝对路径，指向链接状态。 |
| callback | AsyncCallback
<
[Stat](#stat)
>
| 是
| 异步获取链接状态信息之后的回调。
|
| 参数名
| 类型 | 必填 | 说明
|
| -------- | --------
-------------------------- | ---- | ---------
-------- |
| path
| string | 是
| 目标文件的绝对路径，指向链接状态。 |
| callback | AsyncCallback
<
[Stat](#stat)
>
| 是
| 异步获取链接状态信息之后的回调。
|
-
示例：
```
js
...
...
@@ -1445,13 +1445,13 @@ lstatSync(path:string): Stat
**系统能力**
：SystemCapability.FileManagement.File.FileIO
-
参数：
| 参数名
| 类型 | 必填 | 说明
|
| ----
---- | -------- | -------- |
-------- |
| path | string | 是 | 目标文件的绝对路径，指向链接状态。 |
| 参数名
| 类型 | 必填 | 说明
|
| ----
| ------ | ---- | ---------
-------- |
| path | string | 是
| 目标文件的绝对路径，指向链接状态。 |
-
返回值：
| 类型
| 说明
|
| --------
|
-------- |
| 类型
| 说明
|
| --------
----- | --
-------- |
|
[
Stat
](
#stat
)
| 表示文件的具体信息。 |
-
示例：
...
...
@@ -1473,14 +1473,14 @@ read(buffer: ArrayBuffer, options?: {
**系统能力**
：SystemCapability.FileManagement.File.FileIO
-
参数：
| 参数名
| 类型 | 必填 | 说明
|
| -------
- | -------- | -------- |
-------- |
| buffer
| ArrayBuffer | 是 | 用于保存读取到的文件数据的缓冲区。
|
| options | Object
| 否
| 支持如下选项：
<br/>
-
offset，number类型，表示将数据读取到缓冲区的位置，即相对于缓冲区首地址的偏移。可选，默认为0。
<br/>
-
length，number类型，表示期望读取数据的长度。可选，默认缓冲区长度减去偏移长度。 |
| 参数名
| 类型 | 必填 | 说明
|
| -------
| ----------- | ---- | --------------------------------
-------- |
| buffer
| ArrayBuffer | 是 | 用于保存读取到的文件数据的缓冲区。
|
| options | Object
| 否
| 支持如下选项：
<br/>
-
offset，number类型，表示将数据读取到缓冲区的位置，即相对于缓冲区首地址的偏移。可选，默认为0。
<br/>
-
length，number类型，表示期望读取数据的长度。可选，默认缓冲区长度减去偏移长度。 |
-
返回值：
| 类型
| 说明
|
| --------
| --
------ |
| 类型
| 说明
|
| --------
-------------------------- |
------ |
| Promise
<
[ReadOut](#readout)
>
| 读取的结果。 |
-
示例：
...
...
@@ -1506,11 +1506,11 @@ read(buffer: ArrayBuffer, options: {
**系统能力**
：SystemCapability.FileManagement.File.FileIO
-
参数：
| 参数名
| 类型 | 必填 | 说明
|
| -------- | --------
| -------- |
-------- |
| buffer
| ArrayBuffer | 是 | 用于保存读取到的文件数据的缓冲区。
|
| options
| Object | 否
| 支持如下选项：
<br/>
-
offset，number类型，表示将数据读取到缓冲区的位置，即相对于缓冲区首地址的偏移。可选，默认为0。
<br/>
-
length，number类型，表示期望读取数据的长度。可选，默认缓冲区长度减去偏移长度。 |
| callback | AsyncCallback
<
[ReadOut](#readout)
>
| 是
| 异步从文件读取数据之后的回调。
|
| 参数名
| 类型 | 必填 | 说明
|
| -------- | --------
-------------------------------- | ---- | --------------------------------
-------- |
| buffer
| ArrayBuffer | 是 | 用于保存读取到的文件数据的缓冲区。
|
| options
| Object | 否
| 支持如下选项：
<br/>
-
offset，number类型，表示将数据读取到缓冲区的位置，即相对于缓冲区首地址的偏移。可选，默认为0。
<br/>
-
length，number类型，表示期望读取数据的长度。可选，默认缓冲区长度减去偏移长度。 |
| callback | AsyncCallback
<
[ReadOut](#readout)
>
| 是
| 异步从文件读取数据之后的回调。
|
-
示例
```
js
...
...
@@ -1532,14 +1532,14 @@ rename(oldPath: string, newPath: string): Promise<void>
**系统能力**
：SystemCapability.FileManagement.File.FileIO
-
参数：
| 参数名
| 类型 | 必填 | 说明
|
| -------
- | -------- | -------- |
-------- |
| oldPath | string | 是 | 目标文件的当前绝对路径。 |
| Newpath | String | 是
| 目标文件的新绝对路径。
|
| 参数名
| 类型 | 必填 | 说明
|
| -------
| ------ | ---- | ----
-------- |
| oldPath | string | 是
| 目标文件的当前绝对路径。 |
| Newpath | String | 是
| 目标文件的新绝对路径。
|
-
返回值：
| 类型
| 说明
|
| --------
|
-------- |
| 类型
| 说明
|
| --------
----------- | --------------------
-------- |
| Promise
<
void
>
| Promise实例，用于异步获取结果。本调用将返回空值。 |
-
示例：
...
...
@@ -1561,11 +1561,11 @@ rename(oldPath: string, newPath: string, callback: AsyncCallback<void>): v
**系统能力**
：SystemCapability.FileManagement.File.FileIO
-
参数：
| 参数名
| 类型 | 必填 | 说明
|
| -------- | --------
| -------- |
-------- |
| oldpath
| string | 是 | 目标文件的当前绝对路径。
|
| Newpath
| String | 是 | 目标文件的新绝对路径。
|
| Callback | AsyncCallback
<
void
>
| 是 | 异步重命名文件之后的回调。 |
| 参数名
| 类型 | 必填 | 说明
|
| -------- | --------
----------------- | ---- | -----
-------- |
| oldpath
| string | 是 | 目标文件的当前绝对路径。
|
| Newpath
| String | 是 | 目标文件的新绝对路径。
|
| Callback | AsyncCallback
<
void
>
| 是
| 异步重命名文件之后的回调。 |
-
示例：
```
js
...
...
@@ -1583,10 +1583,10 @@ renameSync(oldPath: string, newPath: string): void
**系统能力**
：SystemCapability.FileManagement.File.FileIO
-
参数：
| 参数名
| 类型 | 必填 | 说明
|
| -------
- | -------- | -------- |
-------- |
| oldPath | string | 是 | 目标文件的当前绝对路径。 |
| Newpath | String | 是
| 目标文件的新绝对路径。
|
| 参数名
| 类型 | 必填 | 说明
|
| -------
| ------ | ---- | ----
-------- |
| oldPath | string | 是
| 目标文件的当前绝对路径。 |
| Newpath | String | 是
| 目标文件的新绝对路径。
|
-
示例：
```
js
...
...
@@ -1603,13 +1603,13 @@ fsync(fd: number): Promise<void>
**系统能力**
：SystemCapability.FileManagement.File.FileIO
-
参数：
| 参数名
| 类型 | 必填 | 说明
|
| ----
---- | -------- | -------- |
-------- |
| fd
| number | 是
| 待同步文件的文件描述符。 |
| 参数名
| 类型 | 必填 | 说明
|
| ----
| ------ | ---- | ----
-------- |
| fd
| number | 是
| 待同步文件的文件描述符。 |
-
返回值：
| 类型
| 说明
|
| --------
|
-------- |
| 类型
| 说明
|
| --------
----------- | --------------------
-------- |
| Promise
<
void
>
| Promise实例，用于异步获取结果。本调用将返回空值。 |
-
示例：
...
...
@@ -1631,10 +1631,10 @@ fsync(fd: number, callback: AsyncCallback<void>): void
**系统能力**
：SystemCapability.FileManagement.File.FileIO
-
参数：
| 参数名
| 类型 | 必填 | 说明
|
| -------- | --------
| -------- |
-------- |
| fd
| number | 是 | 待同步文件的文件描述符。
|
| Callback | AsyncCallback
<
void
>
| 是 | 异步将文件数据同步之后的回调。 |
| 参数名
| 类型 | 必填 | 说明
|
| -------- | --------
----------------- | ---- | -------
-------- |
| fd
| number | 是 | 待同步文件的文件描述符。
|
| Callback | AsyncCallback
<
void
>
| 是
| 异步将文件数据同步之后的回调。 |
-
示例：
```
js
...
...
@@ -1653,9 +1653,9 @@ fsyncSync(fd: number): void
**系统能力**
：SystemCapability.FileManagement.File.FileIO
-
参数：
| 参数名
| 类型 | 必填 | 说明
|
| ----
---- | -------- | -------- |
-------- |
| fd
| number | 是
| 待同步文件的文件描述符。 |
| 参数名
| 类型 | 必填 | 说明
|
| ----
| ------ | ---- | ----
-------- |
| fd
| number | 是
| 待同步文件的文件描述符。 |
-
示例：
```
js
...
...
@@ -1672,13 +1672,13 @@ fdatasync(fd: number): Promise<void>
**系统能力**
：SystemCapability.FileManagement.File.FileIO
-
参数：
| 参数名
| 类型 | 必填 | 说明
|
| ----
---- | -------- | -------- |
-------- |
| fd
| number | 是
| 待同步文件的文件描述符。 |
| 参数名
| 类型 | 必填 | 说明
|
| ----
| ------ | ---- | ----
-------- |
| fd
| number | 是
| 待同步文件的文件描述符。 |
-
返回值：
| 类型
| 说明
|
| --------
|
-------- |
| 类型
| 说明
|
| --------
----------- | --------------------
-------- |
| Promise
<
void
>
| Promise实例，用于异步获取结果，本调用将返回空值。 |
-
示例：
...
...
@@ -1700,10 +1700,10 @@ fdatasync(fd: number, callback:AsyncCallback<void>): void
**系统能力**
：SystemCapability.FileManagement.File.FileIO
-
参数：
| 参数名
| 类型 | 必填 | 说明
|
| -------- | --------
| -------- |
-------- |
| fd
| number | 是 | 待同步文件的文件描述符。
|
| callback | AsyncCallback
<
void
>
| 是 | 异步将文件内容数据同步之后的回调。 |
| 参数名
| 类型 | 必填 | 说明
|
| -------- | --------
----------------------- | ---- | ---------
-------- |
| fd
| number | 是 | 待同步文件的文件描述符。
|
| callback | AsyncCallback
<
void
>
| 是
| 异步将文件内容数据同步之后的回调。 |
-
示例：
```
js
...
...
@@ -1722,9 +1722,9 @@ fdatasyncSync(fd: number): void
**系统能力**
：SystemCapability.FileManagement.File.FileIO
-
参数：
| 参数名
| 类型 | 必填 | 说明
|
| ----
---- | -------- | -------- |
-------- |
| fd
| number | 是
| 待同步文件的文件描述符。 |
| 参数名
| 类型 | 必填 | 说明
|
| ----
| ------ | ---- | ----
-------- |
| fd
| number | 是
| 待同步文件的文件描述符。 |
-
示例：
```
js
...
...
@@ -1741,14 +1741,14 @@ symlink(target: string, srcPath: string): Promise<void>
**系统能力**
：SystemCapability.FileManagement.File.FileIO
-
参数：
| 参数名
| 类型 | 必填 | 说明
|
| -------
- | -------- | -------- |
-------- |
| target
| string | 是 | 目标文件的绝对路径。
|
| srcPath | string | 是 | 符号链接文件的绝对路径。 |
| 参数名
| 类型 | 必填 | 说明
|
| -------
| ------ | ---- | ----
-------- |
| target
| string | 是 | 目标文件的绝对路径。
|
| srcPath | string | 是
| 符号链接文件的绝对路径。 |
-
返回值：
| 类型
| 说明
|
| --------
|
-------- |
| 类型
| 说明
|
| --------
----------- | --------------------
-------- |
| Promise
<
void
>
| Promise实例,用于异步获取结果,本调用将返回空值。 |
-
示例：
...
...
@@ -1770,11 +1770,11 @@ symlink(target: string, srcPath: string, callback: AsyncCallback<void>): v
**系统能力**
：SystemCapability.FileManagement.File.FileIO
-
参数：
| 参数名
| 类型 | 必填 | 说明
|
| -------- | --------
| -------- |
-------- |
| target
| string | 是 | 目标文件的绝对路径。
|
| srcPath
| string | 是 | 符号链接文件的绝对路径。
|
| callback | AsyncCallback
<
void
>
| 是 | 异步创建符号链接信息之后的回调。 |
| 参数名
| 类型 | 必填 | 说明
|
| -------- | --------
----------------- | ---- | --------
-------- |
| target
| string | 是 | 目标文件的绝对路径。
|
| srcPath
| string | 是 | 符号链接文件的绝对路径。
|
| callback | AsyncCallback
<
void
>
| 是
| 异步创建符号链接信息之后的回调。 |
-
示例：
```
js
...
...
@@ -1793,10 +1793,10 @@ symlinkSync(target: string, srcPath: string): void
**系统能力**
：SystemCapability.FileManagement.File.FileIO
-
参数：
| 参数名
| 类型 | 必填 | 说明
|
| -------
- | -------- | -------- |
-------- |
| target
| string | 是 | 目标文件的绝对路径。
|
| srcPath | string | 是 | 符号链接文件的绝对路径。 |
| 参数名
| 类型 | 必填 | 说明
|
| -------
| ------ | ---- | ----
-------- |
| target
| string | 是 | 目标文件的绝对路径。
|
| srcPath | string | 是
| 符号链接文件的绝对路径。 |
-
示例：
```
js
...
...
@@ -1813,15 +1813,15 @@ chown(path: string, uid: number, gid: number): Promise<void>
**系统能力**
：SystemCapability.FileManagement.File.FileIO
-
参数：
| 参数名
| 类型 | 必填 | 说明
|
| ----
---- | -------- | -------- |
-------- |
| path | string | 是
| 待改变文件的绝对路径。
|
| uid
| number | 是 | 新的UID（UserID）。
|
| gid
| number | 是
| 新的GID（GroupID）。 |
| 参数名
| 类型 | 必填 | 说明
|
| ----
| ------ | ---- | -------
-------- |
| path | string | 是
| 待改变文件的绝对路径。
|
| uid
| number | 是 | 新的UID（UserID）。
|
| gid
| number | 是
| 新的GID（GroupID）。 |
-
返回值：
| 类型
| 说明
|
| --------
|
-------- |
| 类型
| 说明
|
| --------
----------- | --------------------
-------- |
| Promise
<
void
>
| Promise实例,用于异步获取结果,本调用将返回空值。 |
-
示例：
...
...
@@ -1844,12 +1844,12 @@ chown(path: string, uid: number, gid: number, callback: AsyncCallback<void>
**系统能力**
：SystemCapability.FileManagement.File.FileIO
-
参数：
| 参数名
| 类型 | 必填 | 说明
|
| -------- | --------
| -------- |
-------- |
| path
| string | 是 | 待改变文件的绝对路径。
|
| uid
| number | 是 | 新的UID。
|
| gid
| number | 是 | 新的GID。
|
| callback | AsyncCallback
<
void
>
| 是 | 异步改变文件所有者之后的回调。 |
| 参数名
| 类型 | 必填 | 说明
|
| -------- | --------
----------------- | ---- | -------
-------- |
| path
| string | 是 | 待改变文件的绝对路径。
|
| uid
| number | 是 | 新的UID。
|
| gid
| number | 是 | 新的GID。
|
| callback | AsyncCallback
<
void
>
| 是
| 异步改变文件所有者之后的回调。 |
-
示例：
```
js
...
...
@@ -1869,11 +1869,11 @@ chownSync(path: string, uid: number, gid: number): void
**系统能力**
：SystemCapability.FileManagement.File.FileIO
-
参数：
| 参数名
| 类型 | 必填 | 说明
|
| ----
---- | -------- | -------- |
-------- |
| path | string | 是 | 待改变文件的绝对路径。 |
| uid
| number | 是 | 新的UID。
|
| gid
| number | 是 | 新的GID。
|
| 参数名
| 类型 | 必填 | 说明
|
| ----
| ------ | ---- | ---
-------- |
| path | string | 是
| 待改变文件的绝对路径。 |
| uid
| number | 是 | 新的UID。
|
| gid
| number | 是 | 新的GID。
|
-
示例：
```
js
...
...
@@ -1891,13 +1891,13 @@ mkdtemp(prefix: string): Promise<string>
**系统能力**
：SystemCapability.FileManagement.File.FileIO
-
参数：
| 参数名
| 类型 | 必填 | 说明
|
| ------
-- | -------- | -------- |
-------- |
| prefix | string | 是 | 用随机产生的字符串替换以“XXXXXX”结尾目录路径。 |
| 参数名
| 类型 | 必填 | 说明
|
| ------
| ------ | ---- | -------------------
-------- |
| prefix | string | 是
| 用随机产生的字符串替换以“XXXXXX”结尾目录路径。 |
-
返回值：
| 参数名
| 说明
|
| --------
|
-------- |
| 参数名
| 说明
|
| --------
------------- | --
-------- |
| Promise
<
string
>
| 生成的唯一目录路径。 |
-
示例：
...
...
@@ -1919,10 +1919,10 @@ mkdtemp(prefix: string, callback: AsyncCallback<string>): void
**系统能力**
：SystemCapability.FileManagement.File.FileIO
-
参数：
| 参数名
| 类型 | 必填 | 说明
|
| -------- | --------
| -------- |
-------- |
| prefix
| string | 是
| 用随机产生的字符串替换以“XXXXXX”结尾目录路径。 |
| callback | AsyncCallback
<
string
>
| 是
| 异步创建临时目录之后的回调。
|
| 参数名
| 类型 | 必填 | 说明
|
| -------- | --------
------------------- | ---- | -------------------
-------- |
| prefix
| string | 是
| 用随机产生的字符串替换以“XXXXXX”结尾目录路径。 |
| callback | AsyncCallback
<
string
>
| 是
| 异步创建临时目录之后的回调。
|
-
示例：
```
js
...
...
@@ -1941,13 +1941,13 @@ mkdtempSync(prefix: string): string
**系统能力**
：SystemCapability.FileManagement.File.FileIO
-
参数：
| 参数名
| 类型 | 必填 | 说明
|
| ------
-- | -------- | -------- |
-------- |
| prefix | string | 是 | 用随机产生的字符串替换以“XXXXXX”结尾目录路径。 |
| 参数名
| 类型 | 必填 | 说明
|
| ------
| ------ | ---- | -------------------
-------- |
| prefix | string | 是
| 用随机产生的字符串替换以“XXXXXX”结尾目录路径。 |
-
返回值：
| 参数名
| 说明
|
| ------
-- |
-------- |
| 参数名
| 说明
|
| ------
| --
-------- |
| string | 产生的唯一目录路径。 |
-
示例：
...
...
@@ -1965,14 +1965,14 @@ fchmod(fd: number, mode: number): Promise<void>
**系统能力**
：SystemCapability.FileManagement.File.FileIO
-
参数：
| 参数名
| 类型 | 必填 | 说明
|
| ----
---- | -------- | -------- |
-------- |
| 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：其余用户具有可执行权限。 |
| 参数名
| 类型 | 必填 | 说明
|
| ----
| ------ | ---- | --------------------------------
-------- |
| 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：其余用户具有可执行权限。 |
-
返回值：
| 参数名
| 说明
|
| --------
|
-------- |
| 参数名
| 说明
|
| --------
----------- | --------------------
-------- |
| Promise
<
void
>
| Promise实例,用于异步获取结果,本调用将返回空值。 |
-
示例：
...
...
@@ -1994,11 +1994,11 @@ fchmod(fd: number, mode: number, callback: AsyncCallback<void>): void
**系统能力**
：SystemCapability.FileManagement.File.FileIO
-
参数：
| 参数名
| 类型 | 必填 | 说明
|
| -------- | --------
| -------- |
-------- |
| 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：其余用户具有可执行权限。 |
| callback | AsyncCallback
<
void
>
| 是
| 异步改变文件权限之后的回调。
|
| 参数名
| 类型 | 必填 | 说明
|
| -------- | --------
----------------------- | ---- | --------------------------------
-------- |
| 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：其余用户具有可执行权限。 |
| callback | AsyncCallback
<
void
>
| 是
| 异步改变文件权限之后的回调。
|
-
示例：
```
js
...
...
@@ -2017,10 +2017,10 @@ fchmodSync(fd: number, mode: number): void
**系统能力**
：SystemCapability.FileManagement.File.FileIO
-
参数：
| 参数名
| 类型 | 必填 | 说明
|
| ----
---- | -------- | -------- |
-------- |
| 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：其余用户具有可执行权限。 |
| 参数名
| 类型 | 必填 | 说明
|
| ----
| ------ | ---- | --------------------------------
-------- |
| 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：其余用户具有可执行权限。 |
-
示例：
```
js
...
...
@@ -2037,14 +2037,14 @@ createStream(path: string, mode: string): Promise<Stream>
**系统能力**
：SystemCapability.FileManagement.File.FileIO
-
参数：
| 参数名
| 类型 | 必填 | 说明
|
| ----
---- | -------- | -------- |
-------- |
| path | string | 是
| 待打开文件的绝对路径。
|
| mode | string | 是 | -
r：打开只读文件，该文件必须存在。
<br/>
-
r+：打开可读写的文件，该文件必须存在。
<br/>
-
w：打开只写文件，若文件存在则文件长度清0，即该文件内容会消失。若文件不存在则建立该文件。
<br/>
-
w+：打开可读写文件，若文件存在则文件长度清0，即该文件内容会消失。若文件不存在则建立该文件。
<br/>
-
a：以附加的方式打开只写文件。若文件不存在，则会建立该文件，如果文件存在，写入的数据会被加到文件尾，即文件原先的内容会被保留。
<br/>
-
a+：以附加方式打开可读写的文件。若文件不存在，则会建立该文件，如果文件存在，写入的数据会被加到文件尾后，即文件原先的内容会被保留。 |
| 参数名
| 类型 | 必填 | 说明
|
| ----
| ------ | ---- | --------------------------------
-------- |
| path | string | 是
| 待打开文件的绝对路径。
|
| mode | string | 是
| -
r：打开只读文件，该文件必须存在。
<br/>
-
r+：打开可读写的文件，该文件必须存在。
<br/>
-
w：打开只写文件，若文件存在则文件长度清0，即该文件内容会消失。若文件不存在则建立该文件。
<br/>
-
w+：打开可读写文件，若文件存在则文件长度清0，即该文件内容会消失。若文件不存在则建立该文件。
<br/>
-
a：以附加的方式打开只写文件。若文件不存在，则会建立该文件，如果文件存在，写入的数据会被加到文件尾，即文件原先的内容会被保留。
<br/>
-
a+：以附加方式打开可读写的文件。若文件不存在，则会建立该文件，如果文件存在，写入的数据会被加到文件尾后，即文件原先的内容会被保留。 |
-
返回值：
| 类型
| 说明
|
| --------
|
-------- |
| 类型
| 说明
|
| --------
------------------------- | -
-------- |
| Promise
<
[Stream](#stream7)
>
| 返回文件流的结果。 |
-
示例：
...
...
@@ -2066,11 +2066,11 @@ createStream(path: string, mode: string, callback: AsyncCallback<Stream>):
**系统能力**
：SystemCapability.FileManagement.File.FileIO
-
参数：
| 参数名
| 类型 | 必填 | 说明
|
| -------- | --------
| -------- |
-------- |
| path
| string | 是 | 待打开文件的绝对路径。
|
| mode
| string | 是
| -
r：打开只读文件，该文件必须存在。
<br/>
-
r+：打开可读写的文件，该文件必须存在。
<br/>
-
w：打开只写文件，若文件存在则文件长度清0，即该文件内容会消失。若文件不存在则建立该文件。
<br/>
-
w+：打开可读写文件，若文件存在则文件长度清0，即该文件内容会消失。若文件不存在则建立该文件。
<br/>
-
a：以附加的方式打开只写文件。若文件不存在，则会建立该文件，如果文件存在，写入的数据会被加到文件尾，即文件原先的内容会被保留。
<br/>
-
a+：以附加方式打开可读写的文件。若文件不存在，则会建立该文件，如果文件存在，写入的数据会被加到文件尾后，即文件原先的内容会被保留。 |
| callback | AsyncCallback
<
[Stream](#stream7)
>
| 是
| 异步打开文件流之后的回调。
|
| 参数名
| 类型 | 必填 | 说明
|
| -------- | --------
------------------------------- | ---- | --------------------------------
-------- |
| path
| string | 是 | 待打开文件的绝对路径。
|
| mode
| string | 是
| -
r：打开只读文件，该文件必须存在。
<br/>
-
r+：打开可读写的文件，该文件必须存在。
<br/>
-
w：打开只写文件，若文件存在则文件长度清0，即该文件内容会消失。若文件不存在则建立该文件。
<br/>
-
w+：打开可读写文件，若文件存在则文件长度清0，即该文件内容会消失。若文件不存在则建立该文件。
<br/>
-
a：以附加的方式打开只写文件。若文件不存在，则会建立该文件，如果文件存在，写入的数据会被加到文件尾，即文件原先的内容会被保留。
<br/>
-
a+：以附加方式打开可读写的文件。若文件不存在，则会建立该文件，如果文件存在，写入的数据会被加到文件尾后，即文件原先的内容会被保留。 |
| callback | AsyncCallback
<
[Stream](#stream7)
>
| 是
| 异步打开文件流之后的回调。
|
-
示例：
```
js
...
...
@@ -2089,14 +2089,14 @@ createStreamSync(path: string, mode: string): Stream
**系统能力**
：SystemCapability.FileManagement.File.FileIO
-
参数：
| 参数名
| 类型 | 必填 | 说明
|
| ----
---- | -------- | -------- |
-------- |
| path | string | 是
| 待打开文件的绝对路径。
|
| mode | string | 是 | -
r：打开只读文件，该文件必须存在。
<br/>
-
r+：打开可读写的文件，该文件必须存在。
<br/>
-
w：打开只写文件，若文件存在则文件长度清0，即该文件内容会消失。若文件不存在则建立该文件。
<br/>
-
w+：打开可读写文件，若文件存在则文件长度清0，即该文件内容会消失。若文件不存在则建立该文件。
<br/>
-
a：以附加的方式打开只写文件。若文件不存在，则会建立该文件，如果文件存在，写入的数据会被加到文件尾，即文件原先的内容会被保留。
<br/>
-
a+：以附加方式打开可读写的文件。若文件不存在，则会建立该文件，如果文件存在，写入的数据会被加到文件尾后，即文件原先的内容会被保留。 |
| 参数名
| 类型 | 必填 | 说明
|
| ----
| ------ | ---- | --------------------------------
-------- |
| path | string | 是
| 待打开文件的绝对路径。
|
| mode | string | 是
| -
r：打开只读文件，该文件必须存在。
<br/>
-
r+：打开可读写的文件，该文件必须存在。
<br/>
-
w：打开只写文件，若文件存在则文件长度清0，即该文件内容会消失。若文件不存在则建立该文件。
<br/>
-
w+：打开可读写文件，若文件存在则文件长度清0，即该文件内容会消失。若文件不存在则建立该文件。
<br/>
-
a：以附加的方式打开只写文件。若文件不存在，则会建立该文件，如果文件存在，写入的数据会被加到文件尾，即文件原先的内容会被保留。
<br/>
-
a+：以附加方式打开可读写的文件。若文件不存在，则会建立该文件，如果文件存在，写入的数据会被加到文件尾后，即文件原先的内容会被保留。 |
-
返回值：
| 参数名
| 说明
|
| --------
|
-------- |
| 参数名
| 说明
|
| --------
---------- | -
-------- |
|
[
Stream
](
#stream7
)
| 返回文件流的结果。 |
-
示例：
...
...
@@ -2114,14 +2114,14 @@ fdopenStream(fd: number, mode: string): Promise<Stream>
**系统能力**
：SystemCapability.FileManagement.File.FileIO
-
参数：
| 参数名
| 类型 | 必填 | 说明
|
| ----
---- | -------- | -------- |
-------- |
| fd
| number | 是 | 待打开文件的文件描述符。
|
| mode | string | 是 | -
r：打开只读文件，该文件必须存在。
<br/>
-
r+：打开可读写的文件，该文件必须存在。
<br/>
-
w：打开只写文件，若文件存在则文件长度清0，即该文件内容会消失。若文件不存在则建立该文件。
<br/>
-
w+：打开可读写文件，若文件存在则文件长度清0，即该文件内容会消失。若文件不存在则建立该文件。
<br/>
-
a：以附加的方式打开只写文件。若文件不存在，则会建立该文件，如果文件存在，写入的数据会被加到文件尾，即文件原先的内容会被保留。
<br/>
-
a+：以附加方式打开可读写的文件。若文件不存在，则会建立该文件，如果文件存在，写入的数据会被加到文件尾后，即文件原先的内容会被保留。 |
| 参数名
| 类型 | 必填 | 说明
|
| ----
| ------ | ---- | --------------------------------
-------- |
| fd
| number | 是 | 待打开文件的文件描述符。
|
| mode | string | 是
| -
r：打开只读文件，该文件必须存在。
<br/>
-
r+：打开可读写的文件，该文件必须存在。
<br/>
-
w：打开只写文件，若文件存在则文件长度清0，即该文件内容会消失。若文件不存在则建立该文件。
<br/>
-
w+：打开可读写文件，若文件存在则文件长度清0，即该文件内容会消失。若文件不存在则建立该文件。
<br/>
-
a：以附加的方式打开只写文件。若文件不存在，则会建立该文件，如果文件存在，写入的数据会被加到文件尾，即文件原先的内容会被保留。
<br/>
-
a+：以附加方式打开可读写的文件。若文件不存在，则会建立该文件，如果文件存在，写入的数据会被加到文件尾后，即文件原先的内容会被保留。 |
-
返回值：
| 参数名
| 说明
|
| --------
|
-------- |
| 参数名
| 说明
|
| --------
------------------------- | -
-------- |
| Promise
<
[Stream](#stream7)
>
| 返回文件流的结果。 |
-
示例：
...
...
@@ -2143,11 +2143,11 @@ fdopenStream(fd: number, mode: string, callback: AsyncCallback<Stream>): v
**系统能力**
：SystemCapability.FileManagement.File.FileIO
-
参数：
| 参数名
| 类型 | 必填 | 说明
|
| -------- | --------
| -------- |
-------- |
| fd
| number | 是 | 待打开文件的文件描述符。
|
| mode
| string | 是
| -
r：打开只读文件，该文件必须存在。
<br/>
-
r+：打开可读写的文件，该文件必须存在。
<br/>
-
w：打开只写文件，若文件存在则文件长度清0，即该文件内容会消失。若文件不存在则建立该文件。
<br/>
-
w+：打开可读写文件，若文件存在则文件长度清0，即该文件内容会消失。若文件不存在则建立该文件。
<br/>
-
a：以附加的方式打开只写文件。若文件不存在，则会建立该文件，如果文件存在，写入的数据会被加到文件尾，即文件原先的内容会被保留。
<br/>
-
a+：以附加方式打开可读写的文件。若文件不存在，则会建立该文件，如果文件存在，写入的数据会被加到文件尾后，即文件原先的内容会被保留。 |
| callback | AsyncCallback
<
[Stream](#stream7)
>
| 是
| 异步打开文件流之后的回调。
|
| 参数名
| 类型 | 必填 | 说明
|
| -------- | --------
-------------------------------- | ---- | --------------------------------
-------- |
| fd
| number | 是 | 待打开文件的文件描述符。
|
| mode
| string | 是
| -
r：打开只读文件，该文件必须存在。
<br/>
-
r+：打开可读写的文件，该文件必须存在。
<br/>
-
w：打开只写文件，若文件存在则文件长度清0，即该文件内容会消失。若文件不存在则建立该文件。
<br/>
-
w+：打开可读写文件，若文件存在则文件长度清0，即该文件内容会消失。若文件不存在则建立该文件。
<br/>
-
a：以附加的方式打开只写文件。若文件不存在，则会建立该文件，如果文件存在，写入的数据会被加到文件尾，即文件原先的内容会被保留。
<br/>
-
a+：以附加方式打开可读写的文件。若文件不存在，则会建立该文件，如果文件存在，写入的数据会被加到文件尾后，即文件原先的内容会被保留。 |
| callback | AsyncCallback
<
[Stream](#stream7)
>
| 是
| 异步打开文件流之后的回调。
|
-
示例：
```
js
...
...
@@ -2166,14 +2166,14 @@ fdopenStreamSync(fd: number, mode: string): Stream
**系统能力**
：SystemCapability.FileManagement.File.FileIO
-
参数：
| 参数名
| 类型 | 必填 | 说明
|
| ----
---- | -------- | -------- |
-------- |
| fd
| number | 是 | 待打开文件的文件描述符。
|
| mode | string | 是 | -
r：打开只读文件，该文件必须存在。
<br/>
-
r+：打开可读写的文件，该文件必须存在。
<br/>
-
w：打开只写文件，若文件存在则文件长度清0，即该文件内容会消失。若文件不存在则建立该文件。
<br/>
-
w+：打开可读写文件，若文件存在则文件长度清0，即该文件内容会消失。若文件不存在则建立该文件。
<br/>
-
a：以附加的方式打开只写文件。若文件不存在，则会建立该文件，如果文件存在，写入的数据会被加到文件尾，即文件原先的内容会被保留。
<br/>
-
a+：以附加方式打开可读写的文件。若文件不存在，则会建立该文件，如果文件存在，写入的数据会被加到文件尾后，即文件原先的内容会被保留。 |
| 参数名
| 类型 | 必填 | 说明
|
| ----
| ------ | ---- | --------------------------------
-------- |
| fd
| number | 是 | 待打开文件的文件描述符。
|
| mode | string | 是
| -
r：打开只读文件，该文件必须存在。
<br/>
-
r+：打开可读写的文件，该文件必须存在。
<br/>
-
w：打开只写文件，若文件存在则文件长度清0，即该文件内容会消失。若文件不存在则建立该文件。
<br/>
-
w+：打开可读写文件，若文件存在则文件长度清0，即该文件内容会消失。若文件不存在则建立该文件。
<br/>
-
a：以附加的方式打开只写文件。若文件不存在，则会建立该文件，如果文件存在，写入的数据会被加到文件尾，即文件原先的内容会被保留。
<br/>
-
a+：以附加方式打开可读写的文件。若文件不存在，则会建立该文件，如果文件存在，写入的数据会被加到文件尾后，即文件原先的内容会被保留。 |
-
返回值：
| 参数名
| 说明
|
| --------
|
-------- |
| 参数名
| 说明
|
| --------
---------- | -
-------- |
|
[
Stream
](
#stream7
)
| 返回文件流的结果。 |
-
示例：
...
...
@@ -2191,15 +2191,15 @@ fchown(fd: number, uid: number, gid: number): Promise<void>
**系统能力**
：SystemCapability.FileManagement.File.FileIO
-
参数：
| 参数名
| 类型 | 必填 | 说明
|
| ----
---- | -------- | -------- |
-------- |
| fd
| number | 是
| 待改变文件的文件描述符。 |
| uid
| number | 是 | 文件所有者的UID。
|
| gid
| number | 是 | 文件所有组的GID。
|
| 参数名
| 类型 | 必填 | 说明
|
| ----
| ------ | ---- | ----
-------- |
| fd
| number | 是
| 待改变文件的文件描述符。 |
| uid
| number | 是 | 文件所有者的UID。
|
| gid
| number | 是 | 文件所有组的GID。
|
-
返回值：
| 类型
| 说明
|
| --------
|
-------- |
| 类型
| 说明
|
| --------
----------- | --------------------
-------- |
| Promise
<
void
>
| Promise实例，用于异步获取结果。本调用将返回空值。 |
-
示例：
...
...
@@ -2222,12 +2222,12 @@ fchown(fd: number, uid: number, gid: number, callback: AsyncCallback<void>
**系统能力**
：SystemCapability.FileManagement.File.FileIO
-
参数：
| 参数名
| 类型 | 必填 | 说明
|
| -------- | --------
| -------- |
-------- |
| fd
| number | 是 | 待改变文件的文件描述符。
|
| uid
| number | 是 | 文件所有者的UID。
|
| gid
| number | 是 | 文件所有组的GID。
|
| callback | AsyncCallback
<
void
>
| 是 | 异步改变文件所有者之后的回调。 |
| 参数名
| 类型 | 必填 | 说明
|
| -------- | --------
----------------- | ---- | -------
-------- |
| fd
| number | 是 | 待改变文件的文件描述符。
|
| uid
| number | 是 | 文件所有者的UID。
|
| gid
| number | 是 | 文件所有组的GID。
|
| callback | AsyncCallback
<
void
>
| 是
| 异步改变文件所有者之后的回调。 |
-
示例：
```
js
...
...
@@ -2247,11 +2247,11 @@ fchownSync(fd: number, uid: number, gid: number): void
**系统能力**
：SystemCapability.FileManagement.File.FileIO
-
参数：
| 参数名
| 类型 | 必填 | 说明
|
| ----
---- | -------- | -------- |
-------- |
| fd
| number | 是
| 待改变文件的文件描述符。 |
| uid
| number | 是 | 文件所有者的UID。
|
| gid
| number | 是 | 文件所有组的GID。
|
| 参数名
| 类型 | 必填 | 说明
|
| ----
| ------ | ---- | ----
-------- |
| fd
| number | 是
| 待改变文件的文件描述符。 |
| uid
| number | 是 | 文件所有者的UID。
|
| gid
| number | 是 | 文件所有组的GID。
|
-
示例：
```
js
...
...
@@ -2269,15 +2269,15 @@ lchown(path: string, uid: number, gid: number): Promise<void>
**系统能力**
：SystemCapability.FileManagement.File.FileIO
-
参数：
| 参数名
| 类型 | 必填 | 说明
|
| ----
---- | -------- | -------- |
-------- |
| path | string | 是 | 待打开文件的绝对路径。 |
| uid
| number | 是 | 新的UID。
|
| gid
| number | 是 | 新的GID。
|
| 参数名
| 类型 | 必填 | 说明
|
| ----
| ------ | ---- | ---
-------- |
| path | string | 是
| 待打开文件的绝对路径。 |
| uid
| number | 是 | 新的UID。
|
| gid
| number | 是 | 新的GID。
|
-
返回值：
| 类型
| 说明
|
| --------
|
-------- |
| 类型
| 说明
|
| --------
----------- | --------------------
-------- |
| Promise
<
void
>
| Promise实例，用于异步获取结果。本调用将返回空值。 |
-
示例：
...
...
@@ -2300,12 +2300,12 @@ lchown(path: string, uid: number, gid: number, callback: AsyncCallback<void&g
**系统能力**
：SystemCapability.FileManagement.File.FileIO
-
参数：
| 参数名
| 类型 | 必填 | 说明
|
| -------- | --------
| -------- |
-------- |
| path
| string | 是 | 待打开文件的绝对路径。
|
| uid
| number | 是 | 新的UID。
|
| gid
| number | 是 | 新的GID。
|
| callback | AsyncCallback
<
void
>
| 是 | 异步改变文件所有者之后的回调。 |
| 参数名
| 类型 | 必填 | 说明
|
| -------- | --------
----------------- | ---- | -------
-------- |
| path
| string | 是 | 待打开文件的绝对路径。
|
| uid
| number | 是 | 新的UID。
|
| gid
| number | 是 | 新的GID。
|
| callback | AsyncCallback
<
void
>
| 是
| 异步改变文件所有者之后的回调。 |
-
示例：
```
js
...
...
@@ -2325,11 +2325,11 @@ lchownSync(path: string, uid: number, gid: number): void
**系统能力**
：SystemCapability.FileManagement.File.FileIO
-
参数：
| 参数名
| 类型 | 必填 | 说明
|
| ----
---- | -------- | -------- |
-------- |
| path | string | 是 | 待打开文件的绝对路径。 |
| uid
| number | 是 | 新的UID。
|
| gid
| number | 是 | 新的GID。
|
| 参数名
| 类型 | 必填 | 说明
|
| ----
| ------ | ---- | ---
-------- |
| path | string | 是
| 待打开文件的绝对路径。 |
| uid
| number | 是 | 新的UID。
|
| gid
| number | 是 | 新的GID。
|
-
示例：
```
js
...
...
@@ -2347,15 +2347,15 @@ createWatcher(filename: string, events: number, callback: AsyncCallback<numbe
**系统能力**
：SystemCapability.FileManagement.File.FileIO
-
参数：
| 参数名
| 类型 | 必填 | 说明
|
| -------- | --------
| -------- |
-------- |
| filename | string
| 是 | 待监视文件的绝对路径。
|
| events
| Number | 是
| -
1:
监听文件或者目录是否发生重命名。
<br/>
-
2：监听文件或者目录内容的是否修改。
<br/>
-
3：两者都有。 |
| callback | AsyncCallback
<
number
>
| 是
| 每发生变化一次，调用一次此函数。
|
| 参数名
| 类型 | 必填 | 说明
|
| -------- | --------
------------------------- | ---- | --------------------------------
-------- |
| filename | string
| 是 | 待监视文件的绝对路径。
|
| events
| Number | 是
| -
1:
监听文件或者目录是否发生重命名。
<br/>
-
2：监听文件或者目录内容的是否修改。
<br/>
-
3：两者都有。 |
| callback | AsyncCallback
<
number
>
| 是
| 每发生变化一次，调用一次此函数。
|
-
返回值：
| 参数名
| 说明
|
| --------
|
-------- |
| 参数名
| 说明
|
| --------
------------ | --
-------- |
|
[
Watcher
](
#watcher7
)
| 文件变化监听的实例。 |
-
示例：
...
...
@@ -2372,11 +2372,11 @@ createWatcher(filename: string, events: number, callback: AsyncCallback<numbe
**系统能力**
：以下各项对应的系统能力均为SystemCapability.FileManagement.File.FileIO。
| 名称
| 参数类型 | 可读 | 可写 | 说明
|
| --------
| -------- | -------- | -------- |
-------- |
| bytesRead | number
| 是 | 是 | 实际读取长度。
|
| offset
| number | 是 | 是
| 读取数据相对于缓冲区首地址的偏移。 |
| buffer
| ArrayBufer | 是 | 是 | 保存读取数据的缓冲区。
|
| 名称
| 参数类型 | 可读 | 可写 | 说明
|
| --------
- | ---------- | ---- | ---- | ---------
-------- |
| bytesRead | number
| 是 | 是 | 实际读取长度。
|
| offset
| number | 是 | 是
| 读取数据相对于缓冲区首地址的偏移。 |
| buffer
| ArrayBufer | 是 | 是 | 保存读取数据的缓冲区。
|
## Stat
...
...
@@ -2387,20 +2387,20 @@ createWatcher(filename: string, events: number, callback: AsyncCallback<numbe
### 属性
| 名称
| 参数类型 | 可读 | 可写 | 说明
|
| ------
-- | -------- | -------- | -------- |
-------- |
| dev
| number | 是 | 否 | 标识包含该文件的主设备号。
|
| ino
| number | 是 | 否 | 标识该文件。通常同设备上的不同文件的INO不同。
|
| mode
| number | 是 | 否
| 表示文件类型及权限，其首
4
位表示文件类型，后
12
位表示权限。各特征位的含义如下：
<br/>
-
0o170000：可用于获取文件类型的掩码。
<br/>
-
0o140000：文件是套接字。
<br/>
-
0o120000：文件是符号链接。
<br/>
-
0o100000：文件是一般文件。
<br/>
-
0o060000：文件属于块设备。
<br/>
-
0o040000：文件是目录。
<br/>
-
0o020000：文件是字符设备。
<br/>
-
0o010000：文件是具名管道，即FIFO。
<br/>
-
0o0700：可用于获取用户权限的掩码。
<br/>
-
0o0400：用户读，对于普通文件，所有者可读取文件；对于目录，所有者可读取目录项。
<br/>
-
0o0200：用户写，对于普通文件，所有者可写入文件；对于目录，所有者可创建/删除目录项。
<br/>
-
0o0100：用户执行，对于普通文件，所有者可执行文件；对于目录，所有者可在目录中搜索给定路径名。
<br/>
-
0o0070：可用于获取用户组权限的掩码。
<br/>
-
0o0040：用户组读，对于普通文件，所有用户组可读取文件；对于目录，所有用户组可读取目录项。
<br/>
-
0o0020：用户组写，对于普通文件，所有用户组可写入文件；对于目录，所有用户组可创建/删除目录项。
<br/>
-
0o0010：用户组执行，对于普通文件，所有用户组可执行文件；对于目录，所有用户组是否可在目录中搜索给定路径名。
<br/>
-
0o0007：可用于获取其他用户权限的掩码。
<br/>
-
0o0004：其他读，对于普通文件，其余用户可读取文件；对于目录，其他用户组可读取目录项。
<br/>
-
0o0002：其他写，对于普通文件，其余用户可写入文件；对于目录，其他用户组可创建/删除目录项。
<br/>
-
0o0001：其他执行，对于普通文件，其余用户可执行文件；对于目录，其他用户组可在目录中搜索给定路径名。 |
| nlink
| number | 是 | 否 | 文件的硬链接数。
|
| uid
| number | 是 | 否 | 文件所有者的ID。
|
| gid
| number | 是 | 否 | 文件所有组的ID。
|
| rdev
| number | 是 | 否 | 标识包含该文件的从设备号。
|
| size
| number | 是 | 否 | 文件的大小，以字节为单位。仅对普通文件有效。
|
| blocks | number | 是
| 否 | 文件占用的块数，计算时块大小按512B计算。
|
| atime
| number | 是 | 否 | 上次访问该文件的时间，表示距1970年1月1日0时0分0秒的秒数。
|
| mtime
| number | 是 | 否 | 上次修改该文件的时间，表示距1970年1月1日0时0分0秒的秒数。
|
| ctime
| number | 是 | 否 | 最近改变文件状态的时间，表示距1970年1月1日0时0分0秒的秒数。
|
| 名称
| 参数类型 | 可读 | 可写 | 说明
|
| ------
| ------ | ---- | ---- | --------------------------------
-------- |
| dev
| number | 是 | 否 | 标识包含该文件的主设备号。
|
| ino
| number | 是 | 否 | 标识该文件。通常同设备上的不同文件的INO不同。
|
| mode
| number | 是 | 否
| 表示文件类型及权限，其首
4
位表示文件类型，后
12
位表示权限。各特征位的含义如下：
<br/>
-
0o170000：可用于获取文件类型的掩码。
<br/>
-
0o140000：文件是套接字。
<br/>
-
0o120000：文件是符号链接。
<br/>
-
0o100000：文件是一般文件。
<br/>
-
0o060000：文件属于块设备。
<br/>
-
0o040000：文件是目录。
<br/>
-
0o020000：文件是字符设备。
<br/>
-
0o010000：文件是具名管道，即FIFO。
<br/>
-
0o0700：可用于获取用户权限的掩码。
<br/>
-
0o0400：用户读，对于普通文件，所有者可读取文件；对于目录，所有者可读取目录项。
<br/>
-
0o0200：用户写，对于普通文件，所有者可写入文件；对于目录，所有者可创建/删除目录项。
<br/>
-
0o0100：用户执行，对于普通文件，所有者可执行文件；对于目录，所有者可在目录中搜索给定路径名。
<br/>
-
0o0070：可用于获取用户组权限的掩码。
<br/>
-
0o0040：用户组读，对于普通文件，所有用户组可读取文件；对于目录，所有用户组可读取目录项。
<br/>
-
0o0020：用户组写，对于普通文件，所有用户组可写入文件；对于目录，所有用户组可创建/删除目录项。
<br/>
-
0o0010：用户组执行，对于普通文件，所有用户组可执行文件；对于目录，所有用户组是否可在目录中搜索给定路径名。
<br/>
-
0o0007：可用于获取其他用户权限的掩码。
<br/>
-
0o0004：其他读，对于普通文件，其余用户可读取文件；对于目录，其他用户组可读取目录项。
<br/>
-
0o0002：其他写，对于普通文件，其余用户可写入文件；对于目录，其他用户组可创建/删除目录项。
<br/>
-
0o0001：其他执行，对于普通文件，其余用户可执行文件；对于目录，其他用户组可在目录中搜索给定路径名。 |
| nlink
| number | 是 | 否 | 文件的硬链接数。
|
| uid
| number | 是 | 否 | 文件所有者的ID。
|
| gid
| number | 是 | 否 | 文件所有组的ID。
|
| rdev
| number | 是 | 否 | 标识包含该文件的从设备号。
|
| size
| number | 是 | 否 | 文件的大小，以字节为单位。仅对普通文件有效。
|
| blocks | number | 是
| 否 | 文件占用的块数，计算时块大小按512B计算。
|
| atime
| number | 是 | 否 | 上次访问该文件的时间，表示距1970年1月1日0时0分0秒的秒数。
|
| mtime
| number | 是 | 否 | 上次修改该文件的时间，表示距1970年1月1日0时0分0秒的秒数。
|
| ctime
| number | 是 | 否 | 最近改变文件状态的时间，表示距1970年1月1日0时0分0秒的秒数。
|
### isBlockDevice
...
...
@@ -2412,8 +2412,8 @@ isBlockDevice(): boolean
**系统能力**
：SystemCapability.FileManagement.File.FileIO
-
返回值：
| 类型
| 说明
|
| -------
- |
-------- |
| 类型
| 说明
|
| -------
| --------
-------- |
| boolean | 表示当前目录项是否是块特殊设备。 |
-
示例：
...
...
@@ -2431,8 +2431,8 @@ isCharacterDevice(): boolean
**系统能力**
：SystemCapability.FileManagement.File.FileIO
-
返回值：
| 类型
| 说明
|
| -------
- |
-------- |
| 类型
| 说明
|
| -------
| ---------
-------- |
| boolean | 表示当前目录项是否是字符特殊设备。 |
-
示例：
...
...
@@ -2450,8 +2450,8 @@ isDirectory(): boolean
**系统能力**
：SystemCapability.FileManagement.File.FileIO
-
返回值：
| 类型
| 说明
|
| -------
- |
-------- |
| 类型
| 说明
|
| -------
| -----
-------- |
| boolean | 表示当前目录项是否是目录。 |
-
示例：
...
...
@@ -2469,8 +2469,8 @@ isFIFO(): boolean
**系统能力**
：SystemCapability.FileManagement.File.FileIO
-
返回值：
| 类型
| 说明
|
| -------
- |
-------- |
| 类型
| 说明
|
| -------
| -------------
-------- |
| boolean | 表示当前目录项是否是
FIFO。 |
-
示例：
...
...
@@ -2488,8 +2488,8 @@ isFile(): boolean
**系统能力**
：SystemCapability.FileManagement.File.FileIO
-
返回值：
| 类型
| 说明
|
| -------
- |
-------- |
| 类型
| 说明
|
| -------
| -------
-------- |
| boolean | 表示当前目录项是否是普通文件。 |
-
示例：
...
...
@@ -2507,8 +2507,8 @@ isSocket(): boolean
**系统能力**
：SystemCapability.FileManagement.File.FileIO
-
返回值：
| 类型
| 说明
|
| -------
- |
-------- |
| 类型
| 说明
|
| -------
| ------
-------- |
| boolean | 表示当前目录项是否是套接字。 |
-
示例：
...
...
@@ -2526,8 +2526,8 @@ isSymbolicLink(): boolean
**系统能力**
：SystemCapability.FileManagement.File.FileIO
-
返回值：
| 类型
| 说明
|
| -------
- |
-------- |
| 类型
| 说明
|
| -------
| -------
-------- |
| boolean | 表示当前目录项是否是符号链接。 |
-
示例：
...
...
@@ -2564,9 +2564,9 @@ stop(callback: AsyncCallback<void>): void
**系统能力**
：SystemCapability.FileManagement.File.FileIO
-
参数：
| 参数名
| 类型 | 必填 | 说明
|
| -------- | --------
| -------- |
-------- |
| callback | AsyncCallback
<
void
>
| 是 | 以异步方法关闭watcher监听之后的回调。 |
| 参数名
| 类型 | 必填 | 说明
|
| -------- | --------
----------------- | ---- | --------------
-------- |
| callback | AsyncCallback
<
void
>
| 是
| 以异步方法关闭watcher监听之后的回调。 |
-
示例：
```
js
...
...
@@ -2590,8 +2590,8 @@ close(): Promise<void>
**系统能力**
：SystemCapability.FileManagement.File.FileIO
-
返回值：
| 类型
| 说明
|
| --------
|
-------- |
| 类型
| 说明
|
| --------
----------- | -----
-------- |
| Promise
<
void
>
| 表示异步关闭文件流的结果。 |
-
示例：
...
...
@@ -2614,9 +2614,9 @@ close(callback: AsyncCallback<void>): void
**系统能力**
：SystemCapability.FileManagement.File.FileIO
-
参数：
| 参数名
| 类型 | 必填 | 说明
|
| -------- | --------
| -------- |
-------- |
| callback | AsyncCallback
<
void
>
| 是 | 异步关闭文件流之后的回调。 |
| 参数名
| 类型 | 必填 | 说明
|
| -------- | --------
----------------- | ---- | -----
-------- |
| callback | AsyncCallback
<
void
>
| 是
| 异步关闭文件流之后的回调。 |
-
示例：
```
js
...
...
@@ -2651,8 +2651,8 @@ flush(): Promise<void>
**系统能力**
：SystemCapability.FileManagement.File.FileIO
-
返回值：
| 类型
| 说明
|
| --------
|
-------- |
| 类型
| 说明
|
| --------
----------- | -----
-------- |
| Promise
<
void
>
| 表示异步刷新文件流的结果。 |
-
示例：
...
...
@@ -2675,9 +2675,9 @@ flush(callback: AsyncCallback<void>): void
**系统能力**
：SystemCapability.FileManagement.File.FileIO
-
参数：
| 参数名
| 类型 | 必填 | 说明
|
| -------- | --------
| -------- |
-------- |
| callback | AsyncCallback
<
void
>
| 是 | 异步刷新文件流后的回调函数。 |
| 参数名
| 类型 | 必填 | 说明
|
| -------- | --------
----------------- | ---- | ------
-------- |
| callback | AsyncCallback
<
void
>
| 是
| 异步刷新文件流后的回调函数。 |
-
示例：
```
js
...
...
@@ -2717,14 +2717,14 @@ write(buffer: ArrayBuffer | string, options?: {
**系统能力**
：SystemCapability.FileManagement.File.FileIO
-
参数：
| 参数名
| 类型 | 必填 | 说明
|
| -------
- | -------- | -------- |
-------- |
| buffer
| ArrayBuffer
\|
string | 是 | 待写入文件的数据，可来自缓冲区或字符串。
|
| options | Object
| 否
| 支持如下选项：
<br/>
-
offset，number类型，表示期望写入数据的位置相对于数据首地址的偏移。可选，默认为0。
<br/>
-
length，number类型，表示期望写入数据的长度。可选，默认缓冲区长度减去偏移长度。
<br/>
-
position，number类型，表示期望写入文件的位置。可选，默认从当前位置开始写。
<br/>
-
encoding，string类型，当数据是string类型时有效，表示数据的编码方式，默认
'utf-8'。仅支持
'utf-8'。 |
| 参数名
| 类型 | 必填 | 说明
|
| -------
| ------------------------------- | ---- | --------------------------------
-------- |
| buffer
| ArrayBuffer
\|
string | 是 | 待写入文件的数据，可来自缓冲区或字符串。
|
| options | Object
| 否
| 支持如下选项：
<br/>
-
offset，number类型，表示期望写入数据的位置相对于数据首地址的偏移。可选，默认为0。
<br/>
-
length，number类型，表示期望写入数据的长度。可选，默认缓冲区长度减去偏移长度。
<br/>
-
position，number类型，表示期望写入文件的位置。可选，默认从当前位置开始写。
<br/>
-
encoding，string类型，当数据是string类型时有效，表示数据的编码方式，默认
'utf-8'。仅支持
'utf-8'。 |
-
返回值：
| 类型
| 说明
|
| -------- | -------- |
| 类型
| 说明
|
| --------
-------------
| -------- |
| Promise
<
number
>
| 实际写入的长度。 |
-
示例：
...
...
@@ -2752,11 +2752,11 @@ write(buffer: ArrayBuffer | string, options: {
**系统能力**
：SystemCapability.FileManagement.File.FileIO
-
参数：
| 参数名
| 类型 | 必填 | 说明
|
| -------- | --------
| -------- |
-------- |
| buffer
| ArrayBuffer
\|
string | 是 | 待写入文件的数据，可来自缓冲区或字符串。
|
| options
| Object | 否
| 支持如下选项：
<br/>
-
offset，number类型，表示期望写入数据的位置相对于数据首地址的偏移。可选，默认为0。
<br/>
-
length，number类型，表示期望写入数据的长度。可选，默认缓冲区长度减去偏移长度。
<br/>
-
position，number类型，表示期望写入文件的位置。可选，默认从当前位置开始写。
<br/>
-
encoding，string类型，当数据是string类型时有效，表示数据的编码方式，默认
'utf-8'。仅支持
'utf-8'。 |
| callback | AsyncCallback
<
number
>
| 是 | 异步写入完成后执行的回调函数。
|
| 参数名
| 类型 | 必填 | 说明
|
| -------- | --------
----------------------- | ---- | --------------------------------
-------- |
| buffer
| ArrayBuffer
\|
string | 是 | 待写入文件的数据，可来自缓冲区或字符串。
|
| options
| Object | 否
| 支持如下选项：
<br/>
-
offset，number类型，表示期望写入数据的位置相对于数据首地址的偏移。可选，默认为0。
<br/>
-
length，number类型，表示期望写入数据的长度。可选，默认缓冲区长度减去偏移长度。
<br/>
-
position，number类型，表示期望写入文件的位置。可选，默认从当前位置开始写。
<br/>
-
encoding，string类型，当数据是string类型时有效，表示数据的编码方式，默认
'utf-8'。仅支持
'utf-8'。 |
| callback | AsyncCallback
<
number
>
| 是 | 异步写入完成后执行的回调函数。
|
-
示例：
```
js
...
...
@@ -2784,14 +2784,14 @@ writeSync(buffer: ArrayBuffer | string, options?: {
**系统能力**
：SystemCapability.FileManagement.File.FileIO
-
参数：
| 参数名
| 类型 | 必填 | 说明
|
| -------
- | -------- | -------- |
-------- |
| buffer
| ArrayBuffer
\|
string | 是 | 待写入文件的数据，可来自缓冲区或字符串。
|
| options | Object
| 否
| 支持如下选项：
<br/>
-
offset，number类型，表示期望写入数据的位置相对于数据首地址的偏移。可选，默认为0。
<br/>
-
length，number类型，表示期望写入数据的长度。可选，默认缓冲区长度减去偏移长度。
<br/>
-
position，number类型，表示期望写入文件的位置。可选，默认从当前位置开始写。
<br/>
-
encoding，string类型，当数据是string类型时有效，表示数据的编码方式，默认
'utf-8'。仅支持
'utf-8'。 |
| 参数名
| 类型 | 必填 | 说明
|
| -------
| ------------------------------- | ---- | --------------------------------
-------- |
| buffer
| ArrayBuffer
\|
string | 是 | 待写入文件的数据，可来自缓冲区或字符串。
|
| options | Object
| 否
| 支持如下选项：
<br/>
-
offset，number类型，表示期望写入数据的位置相对于数据首地址的偏移。可选，默认为0。
<br/>
-
length，number类型，表示期望写入数据的长度。可选，默认缓冲区长度减去偏移长度。
<br/>
-
position，number类型，表示期望写入文件的位置。可选，默认从当前位置开始写。
<br/>
-
encoding，string类型，当数据是string类型时有效，表示数据的编码方式，默认
'utf-8'。仅支持
'utf-8'。 |
-
返回值：
| 类型
| 说明
|
| ------
--
| -------- |
| 类型
| 说明
|
| ------ | -------- |
| number | 实际写入的长度。 |
-
示例：
...
...
@@ -2814,14 +2814,14 @@ read(buffer: ArrayBuffer, options?: {
**系统能力**
：SystemCapability.FileManagement.File.FileIO
-
参数：
| 参数名
| 类型 | 必填 | 说明
|
| -------
- | -------- | -------- |
-------- |
| buffer
| ArrayBuffer | 是 | 用于读取文件的缓冲区。
|
| options | Object
| 否
| 支持如下选项：
<br/>
-
offset，number类型，表示将数据读取到缓冲区的位置，即相对于缓冲区首地址的偏移。可选，默认为0。
<br/>
-
length，number类型，表示期望读取数据的长度。可选，默认缓冲区长度减去偏移长度。
<br/>
-
position，number类型，表示期望读取文件的位置。可选，默认从当前位置开始读。 |
| 参数名
| 类型 | 必填 | 说明
|
| -------
| ----------- | ---- | --------------------------------
-------- |
| buffer
| ArrayBuffer | 是 | 用于读取文件的缓冲区。
|
| options | Object
| 否
| 支持如下选项：
<br/>
-
offset，number类型，表示将数据读取到缓冲区的位置，即相对于缓冲区首地址的偏移。可选，默认为0。
<br/>
-
length，number类型，表示期望读取数据的长度。可选，默认缓冲区长度减去偏移长度。
<br/>
-
position，number类型，表示期望读取文件的位置。可选，默认从当前位置开始读。 |
-
返回值：
| 类型
| 说明
|
| --------
| --
------ |
| 类型
| 说明
|
| --------
-------------------------- |
------ |
| Promise
<
[ReadOut](#readout)
>
| 读取的结果。 |
-
示例：
...
...
@@ -2848,11 +2848,11 @@ read(buffer: ArrayBuffer, options: {
**系统能力**
：SystemCapability.FileManagement.File.FileIO
-
参数：
| 参数名
| 类型 | 必填 | 说明
|
| -------- | --------
| -------- |
-------- |
| buffer
| ArrayBuffer | 是 | 用于读取文件的缓冲区。
|
| options
| Object | 否
| 支持如下选项：
<br/>
-
offset，number类型，表示将数据读取到缓冲区的位置，即相对于缓冲区首地址的偏移。可选，默认为0。
<br/>
-
length，number类型，表示期望读取数据的长度。可选，默认缓冲区长度减去偏移长度。
<br/>
-
position，number类型，表示期望读取文件的位置。可选，默认从当前位置开始读。 |
| callback | AsyncCallback
<
[ReadOut](#readout)
>
| 是
| 异步从流文件读取数据之后的回调。
|
| 参数名
| 类型 | 必填 | 说明
|
| -------- | --------
-------------------------------- | ---- | --------------------------------
-------- |
| buffer
| ArrayBuffer | 是 | 用于读取文件的缓冲区。
|
| options
| Object | 否
| 支持如下选项：
<br/>
-
offset，number类型，表示将数据读取到缓冲区的位置，即相对于缓冲区首地址的偏移。可选，默认为0。
<br/>
-
length，number类型，表示期望读取数据的长度。可选，默认缓冲区长度减去偏移长度。
<br/>
-
position，number类型，表示期望读取文件的位置。可选，默认从当前位置开始读。 |
| callback | AsyncCallback
<
[ReadOut](#readout)
>
| 是
| 异步从流文件读取数据之后的回调。
|
-
示例：
```
js
...
...
@@ -2878,14 +2878,14 @@ readSync(buffer: ArrayBuffer, options?: {
**系统能力**
：SystemCapability.FileManagement.File.FileIO
-
参数：
| 参数名
| 类型 | 必填 | 说明
|
| -------
- | -------- | -------- |
-------- |
| buffer
| ArrayBuffer | 是 | 用于读取文件的缓冲区。
|
| options | Object
| 否
| 支持如下选项：
<br/>
-
offset，number类型，表示将数据读取到缓冲区的位置，即相对于缓冲区首地址的偏移。可选，默认为0。
<br/>
-
length，number类型，表示期望读取数据的长度。可选，默认缓冲区长度减去偏移长度。
<br/>
-
position，number类型，表示期望读取文件的位置。可选，默认从当前位置开始读。 |
| 参数名
| 类型 | 必填 | 说明
|
| -------
| ----------- | ---- | --------------------------------
-------- |
| buffer
| ArrayBuffer | 是 | 用于读取文件的缓冲区。
|
| options | Object
| 否
| 支持如下选项：
<br/>
-
offset，number类型，表示将数据读取到缓冲区的位置，即相对于缓冲区首地址的偏移。可选，默认为0。
<br/>
-
length，number类型，表示期望读取数据的长度。可选，默认缓冲区长度减去偏移长度。
<br/>
-
position，number类型，表示期望读取文件的位置。可选，默认从当前位置开始读。 |
-
返回值：
| 类型
| 说明
|
| ------
--
| -------- |
| 类型
| 说明
|
| ------ | -------- |
| number | 实际读取的长度。 |
-
示例：
...
...
@@ -2909,8 +2909,8 @@ read(): Promise<Dirent>
**系统能力**
：SystemCapability.FileManagement.File.FileIO
-
返回值：
| 类型
| 说明
|
| --------
|
-------- |
| 类型
| 说明
|
| --------
------------------------ | -----
-------- |
| Promise
<
[Dirent](#dirent)
>
| 表示异步读取目录项的结果。 |
-
示例：
...
...
@@ -2933,9 +2933,9 @@ read(callback: AsyncCallback<Dirent>): void
**系统能力**
：SystemCapability.FileManagement.File.FileIO
-
参数：
| 参数名
| 类型 | 必填 | 说明
|
| -------- | --------
| -------- |
-------- |
| callback | AsyncCallback
<
[Dirent](#dirent)
>
| 是 | 异步读取下一个目录项之后的回调。 |
| 参数名
| 类型 | 必填 | 说明
|
| -------- | --------
------------------------------ | ---- | --------
-------- |
| callback | AsyncCallback
<
[Dirent](#dirent)
>
| 是
| 异步读取下一个目录项之后的回调。 |
-
示例：
```
js
...
...
@@ -2958,8 +2958,8 @@ readSync(): Dirent
**系统能力**
：SystemCapability.FileManagement.File.FileIO
-
返回值：
| 类型
| 说明
|
| -------- | -------- |
| 类型
| 说明
|
| --------
---------
| -------- |
|
[
Dirent
](
#dirent
)
| 表示一个目录项。 |
-
示例：
...
...
@@ -2992,9 +2992,9 @@ closeSync(): void
### 属性
| 名称
| 参数类型 | 可读 | 可写 | 说明
|
| ----
---- | -------- | -------- | -------- | -
------- |
| name | string | 是
| 否
| 目录项的名称。 |
| 名称
| 参数类型 | 可读 | 可写 | 说明
|
| ----
| ------ | ---- | ---- |
------- |
| name | string | 是
| 否
| 目录项的名称。 |
### isBlockDevice
...
...
@@ -3006,8 +3006,8 @@ isBlockDevice(): boolean
**系统能力**
：SystemCapability.FileManagement.File.FileIO
-
返回值：
| 类型
| 说明
|
| -------
- |
-------- |
| 类型
| 说明
|
| -------
| --------
-------- |
| boolean | 表示当前目录项是否是块特殊设备。 |
-
示例：
...
...
@@ -3026,8 +3026,8 @@ isCharacterDevice(): boolean
**系统能力**
：SystemCapability.FileManagement.File.FileIO
-
返回值：
| 类型
| 说明
|
| -------
- |
-------- |
| 类型
| 说明
|
| -------
| ---------
-------- |
| boolean | 表示当前目录项是否是字符特殊设备。 |
-
示例：
...
...
@@ -3046,8 +3046,8 @@ isDirectory(): boolean
**系统能力**
：SystemCapability.FileManagement.File.FileIO
-
返回值：
| 类型
| 说明
|
| -------
- |
-------- |
| 类型
| 说明
|
| -------
| -----
-------- |
| boolean | 表示当前目录项是否是目录。 |
-
示例：
...
...
@@ -3066,8 +3066,8 @@ isFIFO(): boolean
**系统能力**
：SystemCapability.FileManagement.File.FileIO
-
返回值：
| 类型
| 说明
|
| -------
- |
-------- |
| 类型
| 说明
|
| -------
| -------
-------- |
| boolean | 表示当前目录项是否是FIFO。 |
-
示例：
...
...
@@ -3086,8 +3086,8 @@ isFile(): boolean
**系统能力**
：SystemCapability.FileManagement.File.FileIO
-
返回值：
| 类型
| 说明
|
| -------
- |
-------- |
| 类型
| 说明
|
| -------
| -------
-------- |
| boolean | 表示当前目录项是否是普通文件。 |
-
示例：
...
...
@@ -3106,8 +3106,8 @@ isSocket(): boolean
**系统能力**
：SystemCapability.FileManagement.File.FileIO
-
返回值：
| 类型
| 说明
|
| -------
- |
-------- |
| 类型
| 说明
|
| -------
| ------
-------- |
| boolean | 表示当前目录项是否是套接字。 |
-
示例：
...
...
@@ -3126,8 +3126,8 @@ isSymbolicLink(): boolean
**系统能力**
：SystemCapability.FileManagement.File.FileIO
-
返回值：
| 类型
| 说明
|
| -------
- |
-------- |
| 类型
| 说明
|
| -------
| -------
-------- |
| boolean | 表示当前目录项是否是符号链接。 |
-
示例：
...
...
zh-cn/application-dev/reference/apis/js-apis-i18n.md
浏览文件 @
52ae4725
...
...
@@ -2,7 +2,7 @@
>  **说明：**
> - 本模块首批接口从API version 7开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。
>
>
> - I18N模块包含国际化能力增强接口（未在ECMA 402中定义）。
...
...
@@ -21,19 +21,19 @@ getDisplayLanguage(language: string, locale: string, sentenceCase?: boolean): st
**系统能力**
：SystemCapability.Global.I18n
-
参数：
| 参数名 | 类型 | 必填 | 说明
|
| -------- | -------- | -------- |
-------- |
| language | string | 是 | 指定语言。
|
| locale | string | 是 | 显示指定语言的区域ID。
|
| sentenceCase | boolean | 否
| 本地化显示文本是否要首字母大写。 |
**参数：**
| 参数名 | 类型 | 必填 | 说明
|
| ------------ | ------- | ---- | --------
-------- |
| language | string | 是 | 指定语言。
|
| locale | string | 是 | 显示指定语言的区域ID。
|
| sentenceCase | boolean | 否
| 本地化显示文本是否要首字母大写。 |
-
返回值：
| 类型 | 说明
|
| -------- |
-------- |
| string | 指定语言的本地化显示文本。 |
**返回值：**
| 类型 | 说明
|
| ------ | -----
-------- |
| string | 指定语言的本地化显示文本。 |
-
示例：
**示例：**
```
i18n.getDisplayLanguage("zh", "en-GB", true);
i18n.getDisplayLanguage("zh", "en-GB");
...
...
@@ -48,19 +48,19 @@ getDisplayCountry(country: string, locale: string, sentenceCase?: boolean): stri
**系统能力**
：SystemCapability.Global.I18n
-
参数：
| 参数名 | 类型 | 必填 | 说明
|
| -------- | -------- | -------- |
-------- |
| country | string | 是 | 指定国家。
|
| locale | string | 是 | 显示指定国家的区域ID。
|
| sentenceCase | boolean | 否
| 本地化显示文本是否要首字母大写。 |
**参数：**
| 参数名 | 类型 | 必填 | 说明
|
| ------------ | ------- | ---- | --------
-------- |
| country | string | 是 | 指定国家。
|
| locale | string | 是 | 显示指定国家的区域ID。
|
| sentenceCase | boolean | 否
| 本地化显示文本是否要首字母大写。 |
-
返回值：
| 类型 | 说明
|
| -------- |
-------- |
| string | 指定国家的本地化显示文本。 |
**返回值：**
| 类型 | 说明
|
| ------ | -----
-------- |
| string | 指定国家的本地化显示文本。 |
-
示例：
**示例：**
```
i18n.getDisplayCountry("zh-CN", "en-GB", true);
i18n.getDisplayCountry("zh-CN", "en-GB");
...
...
@@ -75,17 +75,17 @@ isRTL(locale: string): boolean
**系统能力**
：SystemCapability.Global.I18n
-
参数：
| 参数名 | 类型 | 说明
|
| -------- | -------- | -
------- |
| locale | string | 指定区域ID。 |
**参数：**
| 参数名 | 类型 | 说明
|
| ------ | ------ |
------- |
| locale | string | 指定区域ID。 |
-
返回值：
| 类型 | 说明
|
| -------- |
-------- |
| boolean | true表示该locale从右至左显示语言；false表示该locale从左至右显示语言。 |
**返回值：**
| 类型 | 说明
|
| ------- | --------------------------------
-------- |
| boolean | true表示该locale从右至左显示语言；false表示该locale从左至右显示语言。 |
-
示例：
**示例：**
```
i18n.isRTL("zh-CN");// 中文不是RTL语言，返回false
i18n.isRTL("ar-EG");// 阿语是RTL语言，返回true
...
...
@@ -100,12 +100,12 @@ getSystemLanguage(): string
**系统能力**
：SystemCapability.Global.I18n
-
返回值：
| 类型 | 说明
|
| -------- | -
------- |
| string | 系统语言ID。 |
**返回值：**
| 类型 | 说明
|
| ------ |
------- |
| string | 系统语言ID。 |
-
示例：
**示例：**
```
i18n.getSystemLanguage();
```
...
...
@@ -119,17 +119,17 @@ setSystemLanguage(language: string): boolean
**系统能力**
：SystemCapability.Global.I18n
-
参数：
| 参数名 | 类型 | 说明
|
| -------- | -------- | ---
----- |
| language | string | 语言ID。 |
**参数：**
| 参数名 | 类型 | 说明
|
| -------- | ------ |
----- |
| language | string | 语言ID。 |
-
返回值：
| 类型 | 说明
|
| -------- |
-------- |
| boolean | 返回true，表示系统语言设置成功；返回false，表示系统语言设置失败。 |
**返回值：**
| 类型 | 说明
|
| ------- | -----------------------------
-------- |
| boolean | 返回true，表示系统语言设置成功；返回false，表示系统语言设置失败。 |
-
示例：
**示例：**
```
i18n.setSystemLanguage('zh');
```
...
...
@@ -137,18 +137,18 @@ setSystemLanguage(language: string): boolean
## i18n.getSystemLanguages
getSystemLanguages(): Array
<string>
getSystemLanguages(): Array
<
string
>
获取系统支持的语言列表。
**系统能力**
：SystemCapability.Global.I18n
-
返回值：
| 类型 | 说明
|
| -------- |
-------- |
| Array
<string>
| 系统支持的语言ID列表。 |
**返回值：**
| 类型 | 说明
|
| ------------------- | ----
-------- |
| Array
<
string
>
| 系统支持的语言ID列表。 |
-
示例：
**示例：**
```
i18n.getSystemLanguages();
```
...
...
@@ -156,23 +156,23 @@ getSystemLanguages(): Array<string>
## i18n.getSystemCountries
getSystemCountries(language: string): Array
<string>
getSystemCountries(language: string): Array
<
string
>
获取针对输入语言系统支持的区域列表。
**系统能力**
：SystemCapability.Global.I18n
-
参数：
| 参数名 | 类型 | 说明
|
| -------- | -------- | ---
----- |
| language | string | 语言ID。 |
**参数：**
| 参数名 | 类型 | 说明
|
| -------- | ------ |
----- |
| language | string | 语言ID。 |
-
返回值：
| 类型 | 说明
|
| -------- |
-------- |
| Array
<string>
| 系统支持的区域ID列表。 |
**返回值：**
| 类型 | 说明
|
| ------------------- | ----
-------- |
| Array
<
string
>
| 系统支持的区域ID列表。 |
-
示例：
**示例：**
```
i18n.getSystemCountries('zh');
```
...
...
@@ -186,12 +186,12 @@ getSystemRegion(): string
**系统能力**
：SystemCapability.Global.I18n
-
返回值：
| 类型 | 说明
|
| -------- | -
------- |
| string | 系统地区ID。 |
**返回值：**
| 类型 | 说明
|
| ------ |
------- |
| string | 系统地区ID。 |
-
示例：
**示例：**
```
i18n.getSystemRegion();
```
...
...
@@ -205,17 +205,17 @@ setSystemRegion(region: string): boolean
**系统能力**
：SystemCapability.Global.I18n
-
参数：
| 参数名 | 类型 | 说明
|
| -------- | -------- | ---
----- |
| region | string | 地区ID。 |
**参数：**
| 参数名 | 类型 | 说明
|
| ------ | ------ |
----- |
| region | string | 地区ID。 |
-
返回值：
| 类型 | 说明
|
| -------- |
-------- |
| boolean | 返回true，表示系统区域设置成功；返回false，表示系统区域设置失败。 |
**返回值：**
| 类型 | 说明
|
| ------- | -----------------------------
-------- |
| boolean | 返回true，表示系统区域设置成功；返回false，表示系统区域设置失败。 |
-
示例：
**示例：**
```
i18n.setSystemRegion();
```
...
...
@@ -229,12 +229,12 @@ getSystemLocale(): string
**系统能力**
：SystemCapability.Global.I18n
-
返回值：
| 类型 | 说明
|
| -------- | -
------- |
| string | 系统区域ID。 |
**返回值：**
| 类型 | 说明
|
| ------ |
------- |
| string | 系统区域ID。 |
-
示例：
**示例：**
```
i18n.getSystemLocale();
```
...
...
@@ -248,17 +248,17 @@ setSystemLocale(locale: string): boolean
**系统能力**
：SystemCapability.Global.I18n
-
参数：
| 参数名 | 类型 | 说明
|
| -------- | -------- |
-------- |
| locale | string | 指定区域ID，例如zh-CN。 |
**参数：**
| 参数名 | 类型 | 说明
|
| ------ | ------ | -------
-------- |
| locale | string | 指定区域ID，例如zh-CN。 |
-
返回值：
| 类型 | 说明
|
| -------- |
-------- |
| boolean | 返回true，表示系统Locale设置成功；返回false，表示系统Locale设置失败。 |
**返回值：**
| 类型 | 说明
|
| ------- | --------------------------------
-------- |
| boolean | 返回true，表示系统Locale设置成功；返回false，表示系统Locale设置失败。 |
-
示例：
**示例：**
```
i18n.setSystemLocale('zh-CN');
```
...
...
@@ -272,18 +272,18 @@ isSuggested(language: string, region?: string): boolean
**系统能力**
：SystemCapability.Global.I18n
-
参数：
| 参数名 | 类型 | 必填 | 说明
|
| -------- | -------- | -------- |
-------- |
| language | string | 是
| 合法的语言ID，例如zh。 |
| region | string | 否 | 合法的地区ID，例如CN
|
**参数：**
| 参数名 | 类型 | 必填 | 说明
|
| -------- | ------ | ---- | -----
-------- |
| language | string | 是
| 合法的语言ID，例如zh。 |
| region | string | 否 | 合法的地区ID，例如CN
|
-
返回值：
| 类型 | 说明
|
| -------- |
-------- |
| boolean | 返回true，表示当前语言和地区匹配；返回false，表示当前语言和地区不匹配。 |
**返回值：**
| 类型 | 说明
|
| ------- | --------------------------------
-------- |
| boolean | 返回true，表示当前语言和地区匹配；返回false，表示当前语言和地区不匹配。 |
-
示例：
**示例：**
```
i18n.isSuggested('zh', 'CN');
```
...
...
@@ -297,18 +297,18 @@ getCalendar(locale: string, type? : string): Calendar
**系统能力**
：SystemCapability.Global.I18n
-
参数：
| 参数名 | 类型 | 必填 | 说明
|
| -------- | -------- | -------- |
-------- |
| locale | string | 是 | 合法的locale值，例如zh-Hans-CN。
|
| type | string | 否
| 合法的日历类型，目前合法的类型有buddhist,
chinese,
coptic,
ethiopic,
hebrew,
gregory,
indian,
islamic_civil,
islamic_tbla,
islamic_umalqura,
japanese,
persian。当type没有给出时，采用区域默认的日历类型。 |
**参数：**
| 参数名 | 类型 | 必填 | 说明
|
| ------ | ------ | ---- | --------------------------------
-------- |
| locale | string | 是 | 合法的locale值，例如zh-Hans-CN。
|
| type | string | 否
| 合法的日历类型，目前合法的类型有buddhist,
chinese,
coptic,
ethiopic,
hebrew,
gregory,
indian,
islamic_civil,
islamic_tbla,
islamic_umalqura,
japanese,
persian。当type没有给出时，采用区域默认的日历类型。 |
-
返回值：
| 类型 | 说明
|
| -------- | ---
----- |
|
[
Calendar
](
#calendar8
)
| 日历对象。 |
**返回值：**
| 类型 | 说明
|
| ---------------------- |
----- |
|
[
Calendar
](
#calendar8
)
| 日历对象。 |
-
示例：
**示例：**
```
i18n.getCalendar("zh-Hans", "gregory");
```
...
...
@@ -325,12 +325,12 @@ setTime(date: Date): void
**系统能力**
：SystemCapability.Global.I18n
-
参数：
| 参数名 | 类型 | 必填 | 说明
|
| -------- | -------- | -------- |
-------- |
| date | Date | 是
| 将要设置的日历对象的内部时间日期。 |
**参数：**
| 参数名 | 类型 | 必填 | 说明
|
| ---- | ---- | ---- | ---------
-------- |
| date | Date | 是
| 将要设置的日历对象的内部时间日期。 |
-
示例：
**示例：**
```
var calendar = I18n.getCalendar("en-US", "gregory");
var date = new Date(2021, 10, 7, 8, 0, 0, 0);
...
...
@@ -346,12 +346,12 @@ setTime(time: number): void
**系统能力**
：SystemCapability.Global.I18n
-
参数：
| 参数名 | 类型 | 必填 | 说明
|
| -------- | -------- | -------- |
-------- |
| time | number | 是
| time为从1970.1.1
00:00:00
GMT逝去的毫秒数。 |
**参数：**
| 参数名 | 类型 | 必填 | 说明
|
| ---- | ------ | ---- | --------------------------------
-------- |
| time | number | 是
| time为从1970.1.1
00:00:00
GMT逝去的毫秒数。 |
-
示例：
**示例：**
```
var calendar = I18n.getCalendar("en-US", "gregory");
calendar.setTime(10540800000);
...
...
@@ -366,17 +366,17 @@ set(year: number, month: number, date:number, hour?: number, minute?: number, se
**系统能力**
：SystemCapability.Global.I18n
-
参数：
| 参数名 | 类型 | 必填 | 说明
|
| -------- | -------- | -------- | --
------ |
| year | number | 是 | 设置的年。
|
| month | number | 是 | 设置的月。
|
| date | number | 是 | 设置的日。
|
| hour | number | 否
| 设置的小时。 |
| minute | number | 否
| 设置的分钟。 |
| second | number | 否 | 设置的秒。
|
**参数：**
| 参数名 | 类型 | 必填 | 说明
|
| ------ | ------ | ---- |
------ |
| year | number | 是 | 设置的年。
|
| month | number | 是 | 设置的月。
|
| date | number | 是 | 设置的日。
|
| hour | number | 否
| 设置的小时。 |
| minute | number | 否
| 设置的分钟。 |
| second | number | 否 | 设置的秒。
|
-
示例：
**示例：**
```
var calendar = i18n.getCalendar("zh-Hans");
calendar.setTime(2021, 10, 1, 8, 0, 0); // set time to 2021.10.1 08:00:00
...
...
@@ -391,12 +391,12 @@ setTimeZone(timezone: string): void
**系统能力**
：SystemCapability.Global.I18n
-
参数：
| 参数名 | 类型 | 必填 | 说明
|
| -------- | -------- | -------- |
-------- |
| timezone | string | 是
| 设置的时区id，如“Asia/Shanghai”。 |
**参数：**
| 参数名 | 类型 | 必填 | 说明
|
| -------- | ------ | ---- | -----------------
-------- |
| timezone | string | 是
| 设置的时区id，如“Asia/Shanghai”。 |
-
示例：
**示例：**
```
var calendar = i18n.getCalendar("zh-Hans");
calendar.setTimeZone("Asia/Shanghai");
...
...
@@ -411,12 +411,12 @@ getTimeZone(): string
**系统能力**
：SystemCapability.Global.I18n
-
返回值：
| 类型 | 说明
|
| -------- |
-------- |
| string | 日历对象的时区id。 |
**返回值：**
| 类型 | 说明
|
| ------ | --
-------- |
| string | 日历对象的时区id。 |
-
示例：
**示例：**
```
var calendar = i18n.getCalendar("zh-Hans");
calendar.setTimeZone("Asia/Shanghai");
...
...
@@ -432,12 +432,12 @@ getFirstDayOfWeek(): number
**系统能力**
：SystemCapability.Global.I18n
-
返回值：
| 类型 | 说明
|
| -------- |
-------- |
| number | 获取一周的起始日，1代表周日，7代表周六。 |
**返回值：**
| 类型 | 说明
|
| ------ | -------------
-------- |
| number | 获取一周的起始日，1代表周日，7代表周六。 |
-
示例：
**示例：**
```
var calendar = I18n.getCalendar("en-US", "gregory");
calendar.getFirstDayOfWeek();
...
...
@@ -452,12 +452,12 @@ setFirstDayOfWeek(value: number): void
**系统能力**
：SystemCapability.Global.I18n
-
参数：
| 参数名 | 类型 | 必填 | 说明
|
| -------- | -------- | -------- |
-------- |
| value | number | 否
| 设置一周的起始日，1代表周日，7代表周六。 |
**参数：**
| 参数名 | 类型 | 必填 | 说明
|
| ----- | ------ | ---- | -------------
-------- |
| value | number | 否
| 设置一周的起始日，1代表周日，7代表周六。 |
-
示例：
**示例：**
```
var calendar = i18n.getCalendar("zh-Hans");
calendar.setFirstDayOfWeek(0);
...
...
@@ -472,12 +472,12 @@ getMinimalDaysInFirstWeek(): number
**系统能力**
：SystemCapability.Global.I18n
-
返回值：
| 类型 | 说明
|
| -------- |
-------- |
| number | 一年中第一周的最小天数。 |
**返回值：**
| 类型 | 说明
|
| ------ | ----
-------- |
| number | 一年中第一周的最小天数。 |
-
示例：
**示例：**
```
var calendar = i18n.getCalendar("zh-Hans");
calendar.getMinimalDaysInFirstWeek();
...
...
@@ -492,12 +492,12 @@ setMinimalDaysInFirstWeek(value: number): void
**系统能力**
：SystemCapability.Global.I18n
-
参数：
| 参数名 | 类型 | 必填 | 说明
|
| -------- | -------- | -------- |
-------- |
| value | number | 否
| 一年中第一周的最小天数。 |
**参数：**
| 参数名 | 类型 | 必填 | 说明
|
| ----- | ------ | ---- | ----
-------- |
| value | number | 否
| 一年中第一周的最小天数。 |
-
示例：
**示例：**
```
var calendar = i18n.getCalendar("zh-Hans");
calendar.setMinimalDaysInFirstWeek(3);
...
...
@@ -512,17 +512,17 @@ get(field: string): number
**系统能力**
：SystemCapability.Global.I18n
-
参数：
| 参数名 | 类型 | 必填 | 说明
|
| -------- | -------- | -------- |
-------- |
| field | string | 是
| 通过field来获取日历对象相应的值。目前支持的field值有
era,
year,
month,
week_of_year,
week_of_month,
date,
day_of_year,
day_of_week,
day_of_week_in_month,
hour,
hour_of_day,
minute,
second,
millisecond,
zone_offset,
dst_offset,
year_woy,
dow_local,
extended_year,
julian_day,
milliseconds_in_day,
is_leap_month。 |
**参数：**
| 参数名 | 类型 | 必填 | 说明
|
| ----- | ------ | ---- | --------------------------------
-------- |
| field | string | 是
| 通过field来获取日历对象相应的值。目前支持的field值有
era,
year,
month,
week_of_year,
week_of_month,
date,
day_of_year,
day_of_week,
day_of_week_in_month,
hour,
hour_of_day,
minute,
second,
millisecond,
zone_offset,
dst_offset,
year_woy,
dow_local,
extended_year,
julian_day,
milliseconds_in_day,
is_leap_month。 |
-
返回值：
| 类型 | 说明
|
| -------- |
-------- |
| number | 与field相关联的值，如当前Calendar对象的内部日期的年份为1990，get("year")返回1990。 |
**返回值：**
| 类型 | 说明
|
| ------ | --------------------------------
-------- |
| number | 与field相关联的值，如当前Calendar对象的内部日期的年份为1990，get("year")返回1990。 |
-
示例：
**示例：**
```
var calendar = i18n.getCalendar("zh-Hans");
calendar.setTime(2021, 10, 1, 8, 0, 0); // set time to 2021.10.1 08:00:00
...
...
@@ -538,17 +538,17 @@ getDisplayName(locale: string): string
**系统能力**
：SystemCapability.Global.I18n
-
参数：
| 参数名 | 类型 | 必填 | 说明
|
| -------- | -------- | -------- |
-------- |
| locale | string | 是
| locale指定获取哪个区域下该calendar的名字，如buddhist在en-US上显示的名称为“Buddhist
Calendar”。 |
**参数：**
| 参数名 | 类型 | 必填 | 说明
|
| ------ | ------ | ---- | --------------------------------
-------- |
| locale | string | 是
| locale指定获取哪个区域下该calendar的名字，如buddhist在en-US上显示的名称为“Buddhist
Calendar”。 |
-
返回值：
| 类型 | 说明
|
| -------- |
-------- |
| string | 日历在locale所指示的区域的名字。 |
**返回值：**
| 类型 | 说明
|
| ------ | -----------
-------- |
| string | 日历在locale所指示的区域的名字。 |
-
示例：
**示例：**
```
var calendar = i18n.getCalendar("en-US", "buddhist");
calendar.getDisplayName("zh"); // 佛历
...
...
@@ -563,17 +563,17 @@ isWeekend(date?: Date): boolean
**系统能力**
：SystemCapability.Global.I18n
-
参数：
| 参数名 | 类型 | 必填 | 说明
|
| -------- | -------- | -------- |
-------- |
| date | Date | 否
| 判断日期在日历中是否是周末。如果date没有给出，判断calendar当前日期是否为周末。 |
**参数：**
| 参数名 | 类型 | 必填 | 说明
|
| ---- | ---- | ---- | --------------------------------
-------- |
| date | Date | 否
| 判断日期在日历中是否是周末。如果date没有给出，判断calendar当前日期是否为周末。 |
-
返回值：
| 类型 | 说明
|
| -------- |
-------- |
| boolean | 当所判断的日期为周末时，返回
true，否则返回false。 |
**返回值：**
| 类型 | 说明
|
| ------- | ---------------------------
-------- |
| boolean | 当所判断的日期为周末时，返回
true，否则返回false。 |
-
示例：
**示例：**
```
var calendar = i18n.getCalendar("zh-Hans");
calendar.setTime(2021, 11, 11, 8, 0, 0); // set time to 2021.11.11 08:00:00
...
...
@@ -595,12 +595,12 @@ constructor(country: string, options?: PhoneNumberFormatOptions)
**系统能力**
：SystemCapability.Global.I18n
参数：
| 参数名
| 类型 | 必填 | 说明
|
| -------
- | -------- | -------- |
-------- |
| country | string
| 是
| 表示电话号码所属国家或地区代码。 |
| options |
[
PhoneNumberFormatOptions
](
#phonenumberformatoptions8
)
| 否
| 电话号码格式化对象的相关选项。
|
| 参数名
| 类型 | 必填 | 说明
|
| -------
| ---------------------------------------- | ---- | --------
-------- |
| country | string
| 是
| 表示电话号码所属国家或地区代码。 |
| options |
[
PhoneNumberFormatOptions
](
#phonenumberformatoptions8
)
| 否
| 电话号码格式化对象的相关选项。
|
-
示例：
**示例：**
```
var phoneNumberFormat= new i18n.PhoneNumberFormat("CN", {"type": "E164"});
```
...
...
@@ -614,17 +614,17 @@ isValidNumber(number: string): boolean
**系统能力**
：SystemCapability.Global.I18n
-
参数：
| 参数名 | 类型 | 必填 | 说明
|
| -------- | -------- | -------- |
-------- |
| number | string | 是
| 待判断的电话号码。 |
**参数：**
| 参数名 | 类型 | 必填 | 说明
|
| ------ | ------ | ---- | -
-------- |
| number | string | 是
| 待判断的电话号码。 |
-
返回值：
| 类型 | 说明
|
| -------- |
-------- |
| boolean | 返回true表示电话号码的格式正确，返回false表示电话号码的格式错误。 |
**返回值：**
| 类型 | 说明
|
| ------- | -----------------------------
-------- |
| boolean | 返回true表示电话号码的格式正确，返回false表示电话号码的格式错误。 |
-
示例：
**示例：**
```
var phonenumberfmt = new i18n.PhoneNumberFormat("CN");
phonenumberfmt.isValidNumber("15812312312");
...
...
@@ -639,17 +639,17 @@ format(number: string): string
**系统能力**
：SystemCapability.Global.I18n
-
参数：
| 参数名 | 类型 | 必填 | 说明
|
| -------- | -------- | -------- |
-------- |
| number | string | 是
| 待格式化的电话号码。 |
**参数：**
| 参数名 | 类型 | 必填 | 说明
|
| ------ | ------ | ---- | --
-------- |
| number | string | 是
| 待格式化的电话号码。 |
-
返回值：
| 类型 | 说明
|
| -------- |
-------- |
| string | 格式化后的电话号码。 |
**返回值：**
| 类型 | 说明
|
| ------ | --
-------- |
| string | 格式化后的电话号码。 |
-
示例：
**示例：**
```
var phonenumberfmt = new i18n.PhoneNumberFormat("CN");
phonenumberfmt.format("15812312312");
...
...
@@ -662,9 +662,9 @@ format(number: string): string
**系统能力**
：以下各项对应的系统能力均为SystemCapability.Global.I18n
| 名称
| 参数类型 | 可读 | 可写 | 说明
|
| ----
---- | -------- | -------- | -------- |
-------- |
| type | string | 是
| 是
| 表示对电话号码格式化的类型，取值范围："E164",
"INTERNATIONAL",
"NATIONAL",
"RFC3966"。 |
| 名称
| 参数类型 | 可读 | 可写 | 说明
|
| ----
| ------ | ---- | ---- | --------------------------------
-------- |
| type | string | 是
| 是
| 表示对电话号码格式化的类型，取值范围："E164",
"INTERNATIONAL",
"NATIONAL",
"RFC3966"。 |
## UnitInfo<sup>8+</sup>
...
...
@@ -673,10 +673,10 @@ format(number: string): string
**系统能力**
：以下各项对应的系统能力均为SystemCapability.Global.I18n
| 名称
| 参数类型 | 可读 | 可写 | 说明
|
| --------
| -------- | -------- | -------- |
-------- |
| unit
| string | 是 | 是
| 单位的名称，如："meter",
"inch",
"cup"等。 |
| measureSystem | string | 是
| 是
| 单位的度量体系，取值包括："SI",
"US",
"UK"。 |
| 名称
| 参数类型 | 可读 | 可写 | 说明
|
| --------
----- | ------ | ---- | ---- | --------------------------------
-------- |
| unit
| string | 是 | 是
| 单位的名称，如："meter",
"inch",
"cup"等。 |
| measureSystem | string | 是
| 是
| 单位的度量体系，取值包括："SI",
"US",
"UK"。 |
## Util<sup>8+</sup>
...
...
@@ -690,21 +690,21 @@ unitConvert(fromUnit: UnitInfo, toUnit: UnitInfo, value: number, locale: string,
**系统能力**
：SystemCapability.Global.I18n
-
参数：
| 参数名 | 类型 | 必填 | 说明
|
| -------- | -------- | -------- |
-------- |
| fromUnit |
[
UnitInfo
](
#unitinfo8
)
| 是 | 要被转换的单位。
|
| toUnit |
[
UnitInfo
](
#unitinfo8
)
| 是 | 要转换为的单位。
|
| value | number | 是 | 要被转换的单位的数量值。
|
| locale | string | 是 | 格式化时使用的区域参数，如：zh-Hans-CN。
|
| style | string | 否
| 格式化使用的风格，取值包括："long",
"short",
"medium"。 |
**参数：**
| 参数名 | 类型 | 必填 | 说明
|
| -------- | ---------------------- | ---- | --------------------------------
-------- |
| fromUnit |
[
UnitInfo
](
#unitinfo8
)
| 是 | 要被转换的单位。
|
| toUnit |
[
UnitInfo
](
#unitinfo8
)
| 是 | 要转换为的单位。
|
| value | number | 是 | 要被转换的单位的数量值。
|
| locale | string | 是 | 格式化时使用的区域参数，如：zh-Hans-CN。
|
| style | string | 否
| 格式化使用的风格，取值包括："long",
"short",
"medium"。 |
-
返回值：
| 类型 | 说明
|
| -------- |
-------- |
| string | 按照toUnit的单位格式化后，得到的字符串。 |
**返回值：**
| 类型 | 说明
|
| ------ | ---------------
-------- |
| string | 按照toUnit的单位格式化后，得到的字符串。 |
-
示例：
**示例：**
```
I18n.Util.unitConvert({unit: "cup", measureSystem: "US"}, {unit: "liter", measureSystem: "SI"}, 1000, "en-US", "long");
```
...
...
@@ -718,17 +718,17 @@ getInstance(locale?:string): IndexUtil
**系统能力**
：SystemCapability.Global.I18n
-
参数：
| 参数名 | 类型 | 必填 | 说明
|
| -------- | -------- | -------- |
-------- |
| locale | string | 否
| 包含区域设置信息的字符串，包括语言以及可选的脚本和区域。 |
**参数：**
| 参数名 | 类型 | 必填 | 说明
|
| ------ | ------ | ---- | --------------------
-------- |
| locale | string | 否
| 包含区域设置信息的字符串，包括语言以及可选的脚本和区域。 |
-
返回值：
| 类型 | 说明
|
| -------- |
-------- |
|
[
IndexUtil
](
#indexutil8
)
| locale对应的IndexUtil对象。 |
**返回值：**
| 类型 | 说明
|
| ------------------------ | -------------
-------- |
|
[
IndexUtil
](
#indexutil8
)
| locale对应的IndexUtil对象。 |
-
示例：
**示例：**
```
var indexUtil= i18n.IndexUtil.getInstance("zh-CN");
```
...
...
@@ -745,12 +745,12 @@ getIndexList(): Array<string>
**系统能力**
：SystemCapability.Global.I18n
-
返回值：
| 类型 | 说明
|
| -------- |
-------- |
| Array
<
string
>
| 返回当前locale对应的索引列表。 |
**返回值：**
| 类型 | 说明
|
| ------------------- | ----------
-------- |
| Array
<
string
>
| 返回当前locale对应的索引列表。 |
-
示例：
**示例：**
```
var indexUtil = i18n.getInstance("zh-CN");
var indexList = indexUtil.getIndexList();
...
...
@@ -765,12 +765,12 @@ addLocale(locale: string): void
**系统能力**
：SystemCapability.Global.I18n
-
参数：
| 参数名 | 类型 | 必填 | 说明
|
| -------- | -------- | -------- |
-------- |
| locale | string | 是
| 包含区域设置信息的字符串，包括语言以及可选的脚本和区域。 |
**参数：**
| 参数名 | 类型 | 必填 | 说明
|
| ------ | ------ | ---- | --------------------
-------- |
| locale | string | 是
| 包含区域设置信息的字符串，包括语言以及可选的脚本和区域。 |
-
示例：
**示例：**
```
var indexUtil = i18n.getInstance("zh-CN");
indexUtil.addLocale("en-US");
...
...
@@ -785,17 +785,17 @@ getIndex(text: string): string
**系统能力**
：SystemCapability.Global.I18n
-
参数：
| 参数名 | 类型 | 必填 | 说明
|
| -------- | -------- | -------- |
-------- |
| text | string | 是
| 待计算索引值的输入文本。 |
**参数：**
| 参数名 | 类型 | 必填 | 说明
|
| ---- | ------ | ---- | ----
-------- |
| text | string | 是
| 待计算索引值的输入文本。 |
-
返回值：
| 类型 | 说明
|
| -------- |
-------- |
| string | 输入文本对应的索引值。 |
**返回值：**
| 类型 | 说明
|
| ------ | ---
-------- |
| string | 输入文本对应的索引值。 |
-
示例：
**示例：**
```
var indexUtil= i18n.getInstance("zh-CN");
indexUtil.getIndex("hi"); // 返回h
...
...
@@ -813,17 +813,17 @@ isDigit(char: string): boolean
**系统能力**
：SystemCapability.Global.I18n
-
参数：
| 参数名 | 类型 | 必填 | 说明
|
| -------- | -------- | -------- | ---
----- |
| char | string | 是
| 输入字符。 |
**参数：**
| 参数名 | 类型 | 必填 | 说明
|
| ---- | ------ | ---- |
----- |
| char | string | 是
| 输入字符。 |
-
返回值：
| 类型 | 说明
|
| -------- |
-------- |
| boolean | 返回true表示输入的字符是数字，返回false表示输入的字符不是数字。 |
**返回值：**
| 类型 | 说明
|
| ------- | ----------------------------
-------- |
| boolean | 返回true表示输入的字符是数字，返回false表示输入的字符不是数字。 |
-
示例：
**示例：**
```
var isdigit = Character.isDigit("1"); // 返回true
```
...
...
@@ -837,17 +837,17 @@ isSpaceChar(char: string): boolean
**系统能力**
：SystemCapability.Global.I18n
-
参数：
| 参数名 | 类型 | 必填 | 说明
|
| -------- | -------- | -------- | ---
----- |
| char | string | 是
| 输入字符。 |
**参数：**
| 参数名 | 类型 | 必填 | 说明
|
| ---- | ------ | ---- |
----- |
| char | string | 是
| 输入字符。 |
-
返回值：
| 类型 | 说明
|
| -------- |
-------- |
| boolean | 返回true表示输入的字符是空格符，返回false表示输入的字符不是空格符。 |
**返回值：**
| 类型 | 说明
|
| ------- | ------------------------------
-------- |
| boolean | 返回true表示输入的字符是空格符，返回false表示输入的字符不是空格符。 |
-
示例：
**示例：**
```
var isspacechar = Character.isSpaceChar("a"); // 返回false
```
...
...
@@ -861,17 +861,17 @@ isWhitespace(char: string): boolean
**系统能力**
：SystemCapability.Global.I18n
-
参数：
| 参数名 | 类型 | 必填 | 说明
|
| -------- | -------- | -------- | ---
----- |
| char | string | 是
| 输入字符。 |
**参数：**
| 参数名 | 类型 | 必填 | 说明
|
| ---- | ------ | ---- |
----- |
| char | string | 是
| 输入字符。 |
-
返回值：
| 类型 | 说明
|
| -------- |
-------- |
| boolean | 返回true表示输入的字符是空白符，返回false表示输入的字符不是空白符。 |
**返回值：**
| 类型 | 说明
|
| ------- | ------------------------------
-------- |
| boolean | 返回true表示输入的字符是空白符，返回false表示输入的字符不是空白符。 |
-
示例：
**示例：**
```
var iswhitespace = Character.isWhitespace("a"); // 返回false
```
...
...
@@ -885,17 +885,17 @@ isRTL(char: string): boolean
**系统能力**
：SystemCapability.Global.I18n
-
参数：
| 参数名 | 类型 | 必填 | 说明
|
| -------- | -------- | -------- | ---
----- |
| char | string | 是
| 输入字符。 |
**参数：**
| 参数名 | 类型 | 必填 | 说明
|
| ---- | ------ | ---- |
----- |
| char | string | 是
| 输入字符。 |
-
返回值：
| 类型 | 说明
|
| -------- |
-------- |
| boolean | 返回true表示输入的字符是从右到左语言的字符，返回false表示输入的字符不是从右到左语言的字符。 |
**返回值：**
| 类型 | 说明
|
| ------- | --------------------------------
-------- |
| boolean | 返回true表示输入的字符是从右到左语言的字符，返回false表示输入的字符不是从右到左语言的字符。 |
-
示例：
**示例：**
```
var isrtl = Character.isRTL("a"); // 返回false
```
...
...
@@ -909,17 +909,17 @@ isIdeograph(char: string): boolean
**系统能力**
：SystemCapability.Global.I18n
-
参数：
| 参数名 | 类型 | 必填 | 说明
|
| -------- | -------- | -------- | ---
----- |
| char | string | 是
| 输入字符。 |
**参数：**
| 参数名 | 类型 | 必填 | 说明
|
| ---- | ------ | ---- |
----- |
| char | string | 是
| 输入字符。 |
-
返回值：
| 类型 | 说明
|
| -------- |
-------- |
| boolean | 返回true表示输入的字符是表意文字，返回false表示输入的字符不是表意文字。 |
**返回值：**
| 类型 | 说明
|
| ------- | --------------------------------
-------- |
| boolean | 返回true表示输入的字符是表意文字，返回false表示输入的字符不是表意文字。 |
-
示例：
**示例：**
```
var isideograph = Character.isIdeograph("a"); // 返回false
```
...
...
@@ -933,17 +933,17 @@ isLetter(char: string): boolean
**系统能力**
：SystemCapability.Global.I18n
-
参数：
| 参数名 | 类型 | 必填 | 说明
|
| -------- | -------- | -------- | ---
----- |
| char | string | 是
| 输入字符。 |
**参数：**
| 参数名 | 类型 | 必填 | 说明
|
| ---- | ------ | ---- |
----- |
| char | string | 是
| 输入字符。 |
-
返回值：
| 类型 | 说明
|
| -------- |
-------- |
| boolean | 返回true表示输入的字符是字母，返回false表示输入的字符不是字母。 |
**返回值：**
| 类型 | 说明
|
| ------- | ----------------------------
-------- |
| boolean | 返回true表示输入的字符是字母，返回false表示输入的字符不是字母。 |
-
示例：
**示例：**
```
var isletter = Character.isLetter("a"); // 返回true
```
...
...
@@ -957,17 +957,17 @@ isLowerCase(char: string): boolean
**系统能力**
：SystemCapability.Global.I18n
-
参数：
| 参数名 | 类型 | 必填 | 说明
|
| -------- | -------- | -------- | ---
----- |
| char | string | 是
| 输入字符。 |
**参数：**
| 参数名 | 类型 | 必填 | 说明
|
| ---- | ------ | ---- |
----- |
| char | string | 是
| 输入字符。 |
-
返回值：
| 类型 | 说明
|
| -------- |
-------- |
| boolean | 返回true表示输入的字符是小写字母，返回false表示输入的字符不是小写字母。 |
**返回值：**
| 类型 | 说明
|
| ------- | --------------------------------
-------- |
| boolean | 返回true表示输入的字符是小写字母，返回false表示输入的字符不是小写字母。 |
-
示例：
**示例：**
```
var islowercase = Character.isLowerCase("a"); // 返回true
```
...
...
@@ -981,17 +981,17 @@ isUpperCase(char: string): boolean
**系统能力**
：SystemCapability.Global.I18n
-
参数：
| 参数名 | 类型 | 必填 | 说明
|
| -------- | -------- | -------- | ---
----- |
| char | string | 是
| 输入字符。 |
**参数：**
| 参数名 | 类型 | 必填 | 说明
|
| ---- | ------ | ---- |
----- |
| char | string | 是
| 输入字符。 |
-
返回值：
| 类型 | 说明
|
| -------- |
-------- |
| boolean | 返回true表示输入的字符是大写字母，返回false表示输入的字符不是大写字母。 |
**返回值：**
| 类型 | 说明
|
| ------- | --------------------------------
-------- |
| boolean | 返回true表示输入的字符是大写字母，返回false表示输入的字符不是大写字母。 |
-
示例：
**示例：**
```
var isuppercase = Character.isUpperCase("a"); // 返回false
```
...
...
@@ -1005,17 +1005,17 @@ getType(char: string): string
**系统能力**
：SystemCapability.Global.I18n
-
参数：
| 参数名 | 类型 | 必填 | 说明
|
| -------- | -------- | -------- | ---
----- |
| char | string | 是
| 输入字符。 |
**参数：**
| 参数名 | 类型 | 必填 | 说明
|
| ---- | ------ | ---- |
----- |
| char | string | 是
| 输入字符。 |
-
返回值：
| 类型 | 说明
|
| -------- |
-------- |
| string | 输入字符的一般类别值。 |
**返回值：**
| 类型 | 说明
|
| ------ | ---
-------- |
| string | 输入字符的一般类别值。 |
-
示例：
**示例：**
```
var type = Character.getType("a");
```
...
...
@@ -1029,17 +1029,17 @@ getLineInstance(locale: string): BreakIterator
**系统能力**
：SystemCapability.Global.I18n
-
参数：
| 参数名 | 类型 | 必填 | 说明
|
| -------- | -------- | -------- |
-------- |
| locale | string | 是
| 合法的locale值，例如zh-Hans-CN。生成的
[
BreakIterator
](
#breakiterator8
)
将按照locale所指定的区域的规则来进行断句。 |
**参数：**
| 参数名 | 类型 | 必填 | 说明
|
| ------ | ------ | ---- | --------------------------------
-------- |
| locale | string | 是
| 合法的locale值，例如zh-Hans-CN。生成的
[
BreakIterator
](
#breakiterator8
)
将按照locale所指定的区域的规则来进行断句。 |
-
返回值：
| 类型 | 说明
|
| -------- |
-------- |
|
[
BreakIterator
](
#breakiterator8
)
| 用于进行断句的处理器。 |
**返回值：**
| 类型 | 说明
|
| -------------------------------- | ---
-------- |
|
[
BreakIterator
](
#breakiterator8
)
| 用于进行断句的处理器。 |
-
示例：
**示例：**
```
i18n.getLineInstance("en");
```
...
...
@@ -1056,12 +1056,12 @@ setLineBreakText(text: string): void
**系统能力**
：SystemCapability.Global.I18n
-
参数：
| 参数名 | 类型 | 必填 | 说明
|
| -------- | -------- | -------- |
-------- |
| text | string | 是
| 指定BreakIterator进行断句的文本。 |
**参数：**
| 参数名 | 类型 | 必填 | 说明
|
| ---- | ------ | ---- | ---------------
-------- |
| text | string | 是
| 指定BreakIterator进行断句的文本。 |
-
示例：
**示例：**
```
iterator = I18n.getLineInstance("en");
iterator.setLineBreakText("Apple is my favorite fruit.");
...
...
@@ -1076,12 +1076,12 @@ getLineBreakText(): string
**系统能力**
：SystemCapability.Global.I18n
-
返回值：
| 类型 | 说明
|
| -------- |
-------- |
| string | BreakIterator对象正在处理的文本 |
**返回值：**
| 类型 | 说明
|
| ------ | --------------
-------- |
| string | BreakIterator对象正在处理的文本 |
-
示例：
**示例：**
```
iterator = I18n.getLineInstance("en");
iterator.setLineBreakText("Apple is my favorite fruit.");
...
...
@@ -1097,12 +1097,12 @@ current(): number
**系统能力**
：SystemCapability.Global.I18n
-
返回值：
| 类型 | 说明
|
| -------- |
-------- |
| number | BreakIterator在当前所处理的文本中的位置。 |
**返回值：**
| 类型 | 说明
|
| ------ | -------------------
-------- |
| number | BreakIterator在当前所处理的文本中的位置。 |
-
示例：
**示例：**
```
iterator = I18n.getLineInstance("en");
iterator.setLineBreakText("Apple is my favorite fruit.");
...
...
@@ -1118,12 +1118,12 @@ first(): number
**系统能力**
：SystemCapability.Global.I18n
-
返回值：
| 类型 | 说明
|
| -------- |
-------- |
| number | 被处理文本的第一个分割点的偏移量。 |
**返回值：**
| 类型 | 说明
|
| ------ | ---------
-------- |
| number | 被处理文本的第一个分割点的偏移量。 |
-
示例：
**示例：**
```
iterator = I18n.getLineInstance("en");
iterator.setLineBreakText("Apple is my favorite fruit.");
...
...
@@ -1139,12 +1139,12 @@ last(): number
**系统能力**
：SystemCapability.Global.I18n
-
返回值：
| 类型 | 说明
|
| -------- |
-------- |
| number | 被处理的文本的最后一个分割点的偏移量 |
**返回值：**
| 类型 | 说明
|
| ------ | ----------
-------- |
| number | 被处理的文本的最后一个分割点的偏移量 |
-
示例：
**示例：**
```
iterator = I18n.getLineInstance("en");
iterator.setLineBreakText("Apple is my favorite fruit.");
...
...
@@ -1160,17 +1160,17 @@ next(index?: number): number
**系统能力**
：SystemCapability.Global.I18n
-
参数：
| 参数名 | 类型 | 必填 | 说明
|
| -------- | -------- | -------- |
-------- |
| index | number | 否
|
[
BreakIterator
](
#breakiterator8
)
将要移动的分割点数，正数代表向后移动，负数代表向前移动。若index没有给出，则按照index=1处理。 |
**参数：**
| 参数名 | 类型 | 必填 | 说明
|
| ----- | ------ | ---- | --------------------------------
-------- |
| index | number | 否
|
[
BreakIterator
](
#breakiterator8
)
将要移动的分割点数，正数代表向后移动，负数代表向前移动。若index没有给出，则按照index=1处理。 |
-
返回值：
| 类型 | 说明
|
| -------- |
-------- |
| number | 返回移动了index个分割点后，当前
[
BreakIterator
](
#breakiterator8
)
在文本中的位置。若移动index个分割点后超出了所处理的文本的长度范围，返回-1。 |
**返回值：**
| 类型 | 说明
|
| ------ | --------------------------------
-------- |
| number | 返回移动了index个分割点后，当前
[
BreakIterator
](
#breakiterator8
)
在文本中的位置。若移动index个分割点后超出了所处理的文本的长度范围，返回-1。 |
-
示例：
**示例：**
```
iterator = I18n.getLineInstance("en");
iterator.setLineBreakText("Apple is my favorite fruit.");
...
...
@@ -1188,12 +1188,12 @@ previous(): number
**系统能力**
：SystemCapability.Global.I18n
-
返回值：
| 类型 | 说明
|
| -------- |
-------- |
| number | 返回移动到前一个分割点后，当前
[
BreakIterator
](
#breakiterator8
)
在文本中的位置。若移动index个分割点后超出了所处理的文本的长度范围，返回-1。 |
**返回值：**
| 类型 | 说明
|
| ------ | --------------------------------
-------- |
| number | 返回移动到前一个分割点后，当前
[
BreakIterator
](
#breakiterator8
)
在文本中的位置。若移动index个分割点后超出了所处理的文本的长度范围，返回-1。 |
-
示例：
**示例：**
```
iterator = I18n.getLineInstance("en");
iterator.setLineBreakText("Apple is my favorite fruit.");
...
...
@@ -1211,17 +1211,17 @@ following(offset: number): number
**系统能力**
：SystemCapability.Global.I18n
-
参数：
| 参数名 | 类型 | 必填 | 说明
|
| -------- | -------- | -------- |
-------- |
| offset | number | 是
| 将
[
BreakIterator
](
#breakiterator8
)
对象的位置设置到由offset所指定的位置的下一个分割点。 |
**参数：**
| 参数名 | 类型 | 必填 | 说明
|
| ------ | ------ | ---- | --------------------------------
-------- |
| offset | number | 是
| 将
[
BreakIterator
](
#breakiterator8
)
对象的位置设置到由offset所指定的位置的下一个分割点。 |
-
返回值：
| 类型 | 说明
|
| -------- |
-------- |
| number | 返回
[
BreakIterator
](
#breakiterator8
)
移动后的位置，如果由offset所指定的位置的下一个分割点超出了文本的范围则返回-1。 |
**返回值：**
| 类型 | 说明
|
| ------ | --------------------------------
-------- |
| number | 返回
[
BreakIterator
](
#breakiterator8
)
移动后的位置，如果由offset所指定的位置的下一个分割点超出了文本的范围则返回-1。 |
-
示例：
**示例：**
```
iterator = I18n.getLineInstance("en");
iterator.setLineBreakText("Apple is my favorite fruit.");
...
...
@@ -1239,17 +1239,17 @@ isBoundary(offset: number): boolean
**系统能力**
：SystemCapability.Global.I18n
-
参数：
| 参数名 | 类型 | 必填 | 说明
|
| -------- | -------- | -------- |
-------- |
| offset | number | 是
| 指定需要进行判断的位置 |
**参数：**
| 参数名 | 类型 | 必填 | 说明
|
| ------ | ------ | ---- | ---
-------- |
| offset | number | 是
| 指定需要进行判断的位置 |
-
返回值：
| 类型 | 说明
|
| -------- |
-------- |
| boolean | 如果是一个分割点返回true,
否则返回false。 |
**返回值：**
| 类型 | 说明
|
| ------- | -----------------------
-------- |
| boolean | 如果是一个分割点返回true,
否则返回false。 |
-
示例：
**示例：**
```
iterator = I18n.getLineInstance("en");
iterator.setLineBreakText("Apple is my favorite fruit.");
...
...
@@ -1266,12 +1266,12 @@ is24HourClock(): boolean
**系统能力**
：SystemCapability.Global.I18n
-
返回值：
| 类型 | 说明
|
| -------- |
-------- |
| boolean | 返回true，表示系统24小时开关开启；返回false，表示系统24小时开关关闭。 |
**返回值：**
| 类型 | 说明
|
| ------- | --------------------------------
-------- |
| boolean | 返回true，表示系统24小时开关开启；返回false，表示系统24小时开关关闭。 |
-
示例：
**示例：**
```
var is24HourClock = i18n.is24HourClock();
```
...
...
@@ -1285,17 +1285,17 @@ set24HourClock(option: boolean): boolean
**系统能力**
：SystemCapability.Global.I18n
-
参数：
| 参数名 | 类型 | 必填 | 说明
|
| -------- | -------- | -------- |
-------- |
| option | boolean | 是
| option为true，表示开启系统24小时制开关；返回false，表示关闭系统24小时开关。 |
**参数：**
| 参数名 | 类型 | 必填 | 说明
|
| ------ | ------- | ---- | --------------------------------
-------- |
| option | boolean | 是
| option为true，表示开启系统24小时制开关；返回false，表示关闭系统24小时开关。 |
-
返回值：
| 类型 | 说明
|
| -------- |
-------- |
| boolean | 返回true，表示修改成功；返回false，表示修改失败。 |
**返回值：**
| 类型 | 说明
|
| ------- | ---------------------
-------- |
| boolean | 返回true，表示修改成功；返回false，表示修改失败。 |
-
示例：
**示例：**
```
// 将系统时间设置为24小时制
var success = I18n.set24HourClock(true);
...
...
@@ -1310,18 +1310,18 @@ addPreferredLanguage(language: string, index?: number): boolean
**系统能力**
：SystemCapability.Global.I18n
-
参数：
| 参数名 | 类型 | 必填 | 说明
|
| -------- | -------- | -------- |
-------- |
| language | string | 是 | 待添加的偏好语言。
|
| index | number | 否
| 偏好语言的添加位置。 |
**参数：**
| 参数名 | 类型 | 必填 | 说明
|
| -------- | ------ | ---- | --
-------- |
| language | string | 是 | 待添加的偏好语言。
|
| index | number | 否
| 偏好语言的添加位置。 |
-
返回值：
| 类型 | 说明
|
| -------- |
-------- |
| boolean | 返回true，表示添加成功；返回false，表示添加失败。 |
**返回值：**
| 类型 | 说明
|
| ------- | ---------------------
-------- |
| boolean | 返回true，表示添加成功；返回false，表示添加失败。 |
-
示例：
**示例：**
```
// 将语言zh-CN添加到系统偏好语言列表中
var language = 'zh-CN';
...
...
@@ -1338,17 +1338,17 @@ removePreferredLanguage(index: number): boolean
**系统能力**
：SystemCapability.Global.I18n
-
参数：
| 参数名 | 类型 | 必填 | 说明
|
| -------- | -------- | -------- |
-------- |
| index | number | 是
| 待删除偏好语言在系统偏好语言列表中的位置。 |
**参数：**
| 参数名 | 类型 | 必填 | 说明
|
| ----- | ------ | ---- | -------------
-------- |
| index | number | 是
| 待删除偏好语言在系统偏好语言列表中的位置。 |
-
返回值：
| 类型 | 说明
|
| -------- |
-------- |
| boolean | 返回true，表示删除成功；返回false，表示删除失败。 |
**返回值：**
| 类型 | 说明
|
| ------- | ---------------------
-------- |
| boolean | 返回true，表示删除成功；返回false，表示删除失败。 |
-
示例：
**示例：**
```
// 删除系统偏好语言列表中的第一个偏好语言
var index = 0;
...
...
@@ -1358,18 +1358,18 @@ removePreferredLanguage(index: number): boolean
## i18n.getPreferredLanguageList<sup>8+</sup>
getPreferredLanguageList(): Array
<string>
getPreferredLanguageList(): Array
<
string
>
获取系统偏好语言列表。
**系统能力**
：SystemCapability.Global.I18n
-
返回值：
| 类型 | 说明
|
| -------- |
-------- |
| Array
<string>
| 系统偏好语言列表。 |
**返回值：**
| 类型 | 说明
|
| ------------------- | -
-------- |
| Array
<
string
>
| 系统偏好语言列表。 |
-
示例：
**示例：**
```
var preferredLanguageList = i18n.getPreferredLanguageList();
```
...
...
@@ -1383,12 +1383,12 @@ getFirstPreferredLanguage(): string
**系统能力**
：SystemCapability.Global.I18n
-
返回值：
| 类型 | 说明
|
| -------- |
-------- |
| string | 偏好语言列表中的第一个语言。 |
**返回值：**
| 类型 | 说明
|
| ------ | ------
-------- |
| string | 偏好语言列表中的第一个语言。 |
-
示例：
**示例：**
```
var firstPreferredLanguage = i18n.getFirstPreferredLanguage();
```
...
...
@@ -1402,17 +1402,17 @@ getTimeZone(zoneID?: string): TimeZone
**系统能力**
：SystemCapability.Global.I18n
-
参数：
| 参数名 | 类型 | 必填 | 说明
|
| -------- | -------- | -------- | ---
----- |
| zondID | string | 否
| 时区ID。 |
**参数：**
| 参数名 | 类型 | 必填 | 说明
|
| ------ | ------ | ---- |
----- |
| zondID | string | 否
| 时区ID。 |
-
返回值：
| 类型 | 说明
|
| -------- |
-------- |
| TimeZone | 时区ID对应的时区对象。 |
**返回值：**
| 类型 | 说明
|
| -------- | ----
-------- |
| TimeZone | 时区ID对应的时区对象。 |
-
示例：
**示例：**
```
var timezone = i18n.getTimeZone();
```
...
...
@@ -1429,12 +1429,12 @@ getID(): string
**系统能力**
：SystemCapability.Global.I18n
-
返回值：
| 类型 | 说明
|
| -------- |
-------- |
| string | 时区对象对应的时区ID。 |
**返回值：**
| 类型 | 说明
|
| ------ | ----
-------- |
| string | 时区对象对应的时区ID。 |
-
示例：
**示例：**
```
var timezone = i18n.getTimeZone();
timezone.getID();
...
...
@@ -1449,18 +1449,18 @@ getDisplayName(locale?: string, isDST?: boolean): string
**系统能力**
：SystemCapability.Global.I18n
-
参数：
| 参数名 | 类型 | 必填 | 说明
|
| -------- | -------- | -------- |
-------- |
| locale | string | 否 | 区域ID。
|
| isDST | boolean | 否
| 表示获取时区对象的表示时是否考虑夏令时。 |
**参数：**
| 参数名 | 类型 | 必填 | 说明
|
| ------ | ------- | ---- | ------------
-------- |
| locale | string | 否 | 区域ID。
|
| isDST | boolean | 否
| 表示获取时区对象的表示时是否考虑夏令时。 |
-
返回值：
| 类型 | 说明
|
| -------- |
-------- |
| string | 时区对象在指定区域的表示。 |
**返回值：**
| 类型 | 说明
|
| ------ | -----
-------- |
| string | 时区对象在指定区域的表示。 |
-
示例：
**示例：**
```
var timezone = i18n.getTimeZone();
timezone.getDisplayName("zh-CN", false);
...
...
@@ -1475,12 +1475,12 @@ getRawOffset(): number
**系统能力**
：SystemCapability.Global.I18n
-
返回值：
| 类型 | 说明
|
| -------- |
-------- |
| number | 时区对象表示的时区与UTC时区的偏差。 |
**返回值：**
| 类型 | 说明
|
| ------ | -----------
-------- |
| number | 时区对象表示的时区与UTC时区的偏差。 |
-
示例：
**示例：**
```
var timezone = i18n.getTimeZone();
timezone.getRawOffset();
...
...
@@ -1495,12 +1495,12 @@ getOffset(date?: number): number
**系统能力**
：SystemCapability.Global.I18n
-
返回值：
| 类型 | 说明
|
| -------- |
-------- |
| number | 某一时刻时区对象表示的时区与UTC时区的偏差。 |
**返回值：**
| 类型 | 说明
|
| ------ | ---------------
-------- |
| number | 某一时刻时区对象表示的时区与UTC时区的偏差。 |
-
示例：
**示例：**
```
var timezone = i18n.getTimeZone();
timezone.getOffset(1234567890);
...
...
zh-cn/application-dev/reference/apis/js-apis-intl.md
浏览文件 @
52ae4725
...
...
@@ -2,7 +2,7 @@
>  **说明：**
> - 本模块首批接口从API version 6开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。
>
>
> - Intl模块包含国际化能力基础接口（在ECMA 402中定义）。
...
...
@@ -20,18 +20,18 @@ import Intl from '@ohos.intl';
**系统能力**
：以下各项对应的系统能力均为SystemCapability.Global.I18n
| 名称
| 参数类型 | 可读 | 可写 | 说明
|
| --------
| -------- | -------- | -------- |
-------- |
| language
| string | 是 | 否 | 与区域设置关联的语，
如：zh。
|
| script
| string | 是 | 否 | 语言的书写方式，如：Hans。
|
| region
| string | 是 | 否 | 与区域设置相关的地区，如：CN。
|
| baseName
| string | 是 | 否 | Locale的基本核心信息（由语言脚本与地区组成），如：zh-Hans-CN。
|
| caseFirst
| string | 是 | 否
| 区域的整理规则是否考虑大小写，取值包括："upper",
"lower",
"false"。 |
| calendar
| string | 是 | 否
| 区域的日历信息，取值包括："buddhist",
"chinese",
"coptic","dangi",
"ethioaa",
"ethiopic",
"gregory",
"hebrew",
"indian",
"islamic",
"islamic-umalqura",
"islamic-tbla",
"islamic-civil",
"islamic-rgsa",
"iso8601",
"japanese",
"persian",
"roc",
"islamicc"。 |
| collation
| string | 是 | 否
| 区域的排序规则，取值包括："big5han",
"compat",
"dict",
"direct",
"ducet",
"eor",
"gb2312",
"phonebk",
"phonetic",
"pinyin",
"reformed",
"searchjl",
"stroke",
"trad",
"unihan",
"zhuyin"。 |
| hourCycle
| string | 是 | 否
| 区域的时制信息，取值包括："h12",
"h23",
"h11",
"h24"。 |
| numberingSystem | string
| 是 | 否
| 区域使用的数字系统，取值包括："adlm",
"ahom",
"arab",
"arabext",
"bali",
"beng",
"bhks",
"brah",
"cakm",
"cham",
"deva",
"diak",
"fullwide",
"gong",
"gonm",
"gujr",
"guru",
"hanidec",
"hmng",
"hmnp",
"java",
"kali",
"khmr",
"knda",
"lana",
"lanatham",
"laoo",
"latn",
"lepc",
"limb",
"mathbold",
"mathdbl",
"mathmono",
"mathsanb",
"mathsans",
"mlym",
"modi",
"mong",
"mroo",
"mtei",
"mymr",
"mymrshan",
"mymrtlng",
"newa",
"nkoo",
"olck",
"orya",
"osma",
"rohg",
"saur",
"segment",
"shrd",
"sind",
"sinh",
"sora",
"sund",
"takr",
"talu",
"tamldec",
"telu",
"thai",
"tibt",
"tirh",
"vaii",
"wara",
"wcho"。 |
| numeric
| boolean | 是 | 否 | 是否对数字字符具有特殊的排序规则处理。
|
| 名称
| 参数类型 | 可读 | 可写 | 说明
|
| --------
------- | ------- | ---- | ---- | --------------------------------
-------- |
| language
| string | 是 | 否 | 与区域设置关联的语，
如：zh。
|
| script
| string | 是 | 否 | 语言的书写方式，如：Hans。
|
| region
| string | 是 | 否 | 与区域设置相关的地区，如：CN。
|
| baseName
| string | 是 | 否 | Locale的基本核心信息（由语言脚本与地区组成），如：zh-Hans-CN。
|
| caseFirst
| string | 是 | 否
| 区域的整理规则是否考虑大小写，取值包括："upper",
"lower",
"false"。 |
| calendar
| string | 是 | 否
| 区域的日历信息，取值包括："buddhist",
"chinese",
"coptic","dangi",
"ethioaa",
"ethiopic",
"gregory",
"hebrew",
"indian",
"islamic",
"islamic-umalqura",
"islamic-tbla",
"islamic-civil",
"islamic-rgsa",
"iso8601",
"japanese",
"persian",
"roc",
"islamicc"。 |
| collation
| string | 是 | 否
| 区域的排序规则，取值包括："big5han",
"compat",
"dict",
"direct",
"ducet",
"eor",
"gb2312",
"phonebk",
"phonetic",
"pinyin",
"reformed",
"searchjl",
"stroke",
"trad",
"unihan",
"zhuyin"。 |
| hourCycle
| string | 是 | 否
| 区域的时制信息，取值包括："h12",
"h23",
"h11",
"h24"。 |
| numberingSystem | string
| 是 | 否
| 区域使用的数字系统，取值包括："adlm",
"ahom",
"arab",
"arabext",
"bali",
"beng",
"bhks",
"brah",
"cakm",
"cham",
"deva",
"diak",
"fullwide",
"gong",
"gonm",
"gujr",
"guru",
"hanidec",
"hmng",
"hmnp",
"java",
"kali",
"khmr",
"knda",
"lana",
"lanatham",
"laoo",
"latn",
"lepc",
"limb",
"mathbold",
"mathdbl",
"mathmono",
"mathsanb",
"mathsans",
"mlym",
"modi",
"mong",
"mroo",
"mtei",
"mymr",
"mymrshan",
"mymrtlng",
"newa",
"nkoo",
"olck",
"orya",
"osma",
"rohg",
"saur",
"segment",
"shrd",
"sind",
"sinh",
"sora",
"sund",
"takr",
"talu",
"tamldec",
"telu",
"thai",
"tibt",
"tirh",
"vaii",
"wara",
"wcho"。 |
| numeric
| boolean | 是 | 否 | 是否对数字字符具有特殊的排序规则处理。
|
### constructor<sup>8+</sup>
...
...
@@ -42,7 +42,7 @@ constructor()
**系统能力**
：SystemCapability.Global.I18n
-
示例：
**示例：**
```
var locale = new Intl.Locale();
```
...
...
@@ -56,13 +56,13 @@ constructor(locale: string, options?: LocaleOptions)
**系统能力**
：SystemCapability.Global.I18n
-
参数：
| 参数名 | 类型 | 必填 | 说明
|
| -------- | -------- | -------- |
-------- |
| locale | string | 是
| 包含区域设置信息的字符串，包括语言以及可选的脚本和区域。 |
| options | LocaleOptions | 否 | 用于创建区域对象的选项。
|
**参数：**
| 参数名 | 类型 | 必填 | 说明
|
| ------- | ------------- | ---- | --------------------
-------- |
| locale | string | 是
| 包含区域设置信息的字符串，包括语言以及可选的脚本和区域。 |
| options | LocaleOptions | 否 | 用于创建区域对象的选项。
|
-
示例：
**示例：**
```
var locale = new Intl.Locale("zh-CN");
```
...
...
@@ -76,12 +76,12 @@ toString(): string
**系统能力**
：SystemCapability.Global.I18n
-
返回值：
| 类型 | 说明
|
| -------- |
-------- |
| string | 字符串形式的区域信息。 |
**返回值：**
| 类型 | 说明
|
| ------ | ---
-------- |
| string | 字符串形式的区域信息。 |
-
示例：
**示例：**
```
var locale = new Intl.Locale("zh-CN");
locale.toString();
...
...
@@ -96,12 +96,12 @@ maximize(): Locale
**系统能力**
：SystemCapability.Global.I18n
-
返回值：
| 类型 | 说明
|
| -------- |
-------- |
|
[
Locale
](
#locale
)
| 最大化后的区域对象。 |
**返回值：**
| 类型 | 说明
|
| ----------------- | --
-------- |
|
[
Locale
](
#locale
)
| 最大化后的区域对象。 |
-
示例：
**示例：**
```
var locale = new Intl.Locale("zh-CN");
locale.maximize();
...
...
@@ -116,12 +116,12 @@ minimize(): Locale
**系统能力**
：SystemCapability.Global.I18n
-
返回值：
| 类型 | 说明
|
| -------- |
-------- |
|
[
Locale
](
#locale
)
| 最小化后的区域对象。 |
**返回值：**
| 类型 | 说明
|
| ----------------- | --
-------- |
|
[
Locale
](
#locale
)
| 最小化后的区域对象。 |
-
示例：
**示例：**
```
var locale = new Intl.Locale("zh-CN");
locale.minimize();
...
...
@@ -134,14 +134,14 @@ minimize(): Locale
**系统能力**
：以下各项对应的系统能力均为SystemCapability.Global.I18n
| 名称
| 参数类型 | 可读 | 可写 | 说明
|
| --------
| -------- | -------- | -------- |
-------- |
| calendar
| string | 是 | 是
| 日历参数，如："buddhist", "chinese", "coptic", "dangi", "ethioaa", "ethiopic", "gregory", "hebrew", "indian", "islamic", "islamic-umalqura", "islamic-tbla", "islamic-civil", "islamic-rgsa", "iso8601", "japanese", "persian", "roc", "islamicc"。 |
| collation
| string | 是 | 是
| 排序参数，取值包括："big5han", "compat", "dict", "direct", "ducet", "emoji", "eor", "gb2312", "phonebk", "phonetic", "pinyin", "reformed ", "search", "searchjl", "standard", "stroke", "trad", "unihan", "zhuyin"。 |
| hourCycle
| string | 是 | 是
| 时制格式，取值包括："h11",
"h12",
"h23",
"h24"。 |
| numberingSystem | string
| 是 | 是
| 数字系统，取值包括："adlm",
"ahom",
"arab",
"arabext",
"bali",
"beng",
"bhks",
"brah",
"cakm",
"cham",
"deva",
"diak",
"fullwide",
"gong",
"gonm",
"gujr",
"guru",
"hanidec",
"hmng",
"hmnp",
"java",
"kali",
"khmr",
"knda",
"lana",
"lanatham",
"laoo",
"latn",
"lepc",
"limb",
"mathbold",
"mathdbl",
"mathmono",
"mathsanb",
"mathsans",
"mlym",
"modi",
"mong",
"mroo",
"mtei",
"mymr",
"mymrshan",
"mymrtlng",
"newa",
"nkoo",
"olck",
"orya",
"osma",
"rohg",
"saur",
"segment",
"shrd",
"sind",
"sinh",
"sora",
"sund",
"takr",
"talu",
"tamldec",
"telu",
"thai",
"tibt",
"tirh",
"vaii",
"wara",
"wcho"。 |
| numeric
| boolean | 是 | 是 | 是否使用12小时制。
|
| caseFirst
| string | 是 | 是
| 表示大写、小写的排序顺序，取值范围："upper",
"lower",
"false"。 |
| 名称
| 参数类型 | 可读 | 可写 | 说明
|
| --------
------- | ------- | ---- | ---- | --------------------------------
-------- |
| calendar
| string | 是 | 是
| 日历参数，如："buddhist", "chinese", "coptic", "dangi", "ethioaa", "ethiopic", "gregory", "hebrew", "indian", "islamic", "islamic-umalqura", "islamic-tbla", "islamic-civil", "islamic-rgsa", "iso8601", "japanese", "persian", "roc", "islamicc"。 |
| collation
| string | 是 | 是
| 排序参数，取值包括："big5han", "compat", "dict", "direct", "ducet", "emoji", "eor", "gb2312", "phonebk", "phonetic", "pinyin", "reformed ", "search", "searchjl", "standard", "stroke", "trad", "unihan", "zhuyin"。 |
| hourCycle
| string | 是 | 是
| 时制格式，取值包括："h11",
"h12",
"h23",
"h24"。 |
| numberingSystem | string
| 是 | 是
| 数字系统，取值包括："adlm",
"ahom",
"arab",
"arabext",
"bali",
"beng",
"bhks",
"brah",
"cakm",
"cham",
"deva",
"diak",
"fullwide",
"gong",
"gonm",
"gujr",
"guru",
"hanidec",
"hmng",
"hmnp",
"java",
"kali",
"khmr",
"knda",
"lana",
"lanatham",
"laoo",
"latn",
"lepc",
"limb",
"mathbold",
"mathdbl",
"mathmono",
"mathsanb",
"mathsans",
"mlym",
"modi",
"mong",
"mroo",
"mtei",
"mymr",
"mymrshan",
"mymrtlng",
"newa",
"nkoo",
"olck",
"orya",
"osma",
"rohg",
"saur",
"segment",
"shrd",
"sind",
"sinh",
"sora",
"sund",
"takr",
"talu",
"tamldec",
"telu",
"thai",
"tibt",
"tirh",
"vaii",
"wara",
"wcho"。 |
| numeric
| boolean | 是 | 是 | 是否使用12小时制。
|
| caseFirst
| string | 是 | 是
| 表示大写、小写的排序顺序，取值范围："upper",
"lower",
"false"。 |
## DateTimeFormat
...
...
@@ -155,7 +155,7 @@ constructor()
**系统能力**
：SystemCapability.Global.I18n
-
示例：
**示例：**
```
var datefmt= new Intl.DateTimeFormat();
```
...
...
@@ -163,25 +163,25 @@ constructor()
### constructor
constructor(locale: string | Array
<string>
, options?: DateTimeOptions)
constructor(locale: string | Array
<
string
>
, options?: DateTimeOptions)
创建时间日期格式化对象。
**系统能力**
：SystemCapability.Global.I18n
-
参数：
| 参数名 | 类型 | 必填 | 说明
|
| -------- | -------- | -------- |
-------- |
| locale | string
\|
Array
<string>
| 是
| 包含区域设置信息的字符串，包括语言以及可选的脚本和区域。 |
| options |
[
DateTimeOptions
](
#datetimeoptions
)
| 否 | 用于创建时间日期格式化的选项。
|
**参数：**
| 参数名 | 类型 | 必填 | 说明
|
| ------- | ----------------------------------- | ---- | --------------------
-------- |
| locale | string
\|
Array
<
string
>
| 是
| 包含区域设置信息的字符串，包括语言以及可选的脚本和区域。 |
| options |
[
DateTimeOptions
](
#datetimeoptions
)
| 否 | 用于创建时间日期格式化的选项。
|
-
示例：
**示例：**
```
var datefmt= new Intl.DateTimeFormat("zh-CN", { dateStyle: 'full', timeStyle: 'medium' });
```
-
示例：
**示例：**
```
var datefmt= new Intl.DateTimeFormat(["ban", "zh"], { dateStyle: 'full', timeStyle: 'medium' });
```
...
...
@@ -195,17 +195,17 @@ format(date: Date): string
**系统能力**
：SystemCapability.Global.I18n
-
参数：
| 参数名 | 类型 | 必填 | 说明
|
| -------- | -------- | -------- | -
------- |
| date | Date | 是
| 时间日期对象。 |
**参数：**
| 参数名 | 类型 | 必填 | 说明
|
| ---- | ---- | ---- |
------- |
| date | Date | 是
| 时间日期对象。 |
-
返回值：
| 类型 | 说明
|
| -------- |
-------- |
| string | 格式化后的时间日期字符串 |
**返回值：**
| 类型 | 说明
|
| ------ | ----
-------- |
| string | 格式化后的时间日期字符串 |
-
示例：
**示例：**
```
var date = new Date(2021, 11, 17, 3, 24, 0);
var datefmt = new Intl.DateTimeFormat("en-GB");
...
...
@@ -221,18 +221,18 @@ formatRange(startDate: Date, endDate: Date): string
**系统能力**
：SystemCapability.Global.I18n
-
参数：
| 参数名 | 类型 | 必填 | 说明
|
| -------- | -------- | ----
---- | -------- |
| startDate | Date | 是
| 起始的时间日期。 |
| endDate | Date | 是
| 结束的时间日期。 |
**参数：**
| 参数名 | 类型 | 必填 | 说明
|
| --------- | ---- |
---- | -------- |
| startDate | Date | 是
| 起始的时间日期。 |
| endDate | Date | 是
| 结束的时间日期。 |
-
返回值：
| 类型 | 说明
|
| -------- |
-------- |
| string | 格式化后的时间日期段字符串。 |
**返回值：**
| 类型 | 说明
|
| ------ | ------
-------- |
| string | 格式化后的时间日期段字符串。 |
-
示例：
**示例：**
```
var startDate = new Date(2021, 11, 17, 3, 24, 0);
var endDate = new Date(2021, 11, 18, 3, 24, 0);
...
...
@@ -249,12 +249,12 @@ resolvedOptions(): DateTimeOptions
**系统能力**
：SystemCapability.Global.I18n
-
返回值：
| 类型 | 说明
|
| -------- |
-------- |
|
[
DateTimeOptions
](
#datetimeoptions
)
| DateTimeFormat
对象的格式化选项。 |
**返回值：**
| 类型 | 说明
|
| ----------------------------------- | ---------------------
-------- |
|
[
DateTimeOptions
](
#datetimeoptions
)
| DateTimeFormat
对象的格式化选项。 |
-
示例：
**示例：**
```
var datefmt = new Intl.DateTimeFormat("en-GB");
datefmt.resolvedOptions();
...
...
@@ -267,27 +267,27 @@ resolvedOptions(): DateTimeOptions
**系统能力**
：以下各项对应的系统能力均为SystemCapability.Global.I18n
| 名称
| 参数类型 | 可读 | 可写 | 说明
|
| --------
| -------- | -------- | -------- |
-------- |
| locale
| string | 是 | 否 | 区域参数，
如：zh-Hans-CN。
|
| dateStyle
| string | 是 | 是
| 日期显示格式，取值包括："long",
"short",
"medium",
"full"。 |
| timeStyle
| string | 是 | 是
| 时间显示格式，取值包括："long",
"short",
"medium",
"full"。 |
| hourCycle
| string | 是 | 是
| 时制格式，取值包括："h11",
"h12",
"h23",
"h24"。 |
| timeZone
| string | 是 | 是 | 使用的时区（合法的IANA时区ID）。
|
| numberingSystem | string
| 是 | 是
| 数字系统，取值包括："adlm",
"ahom",
"arab",
"arabext",
"bali",
"beng",
"bhks",
"brah",
"cakm",
"cham",
"deva",
"diak",
"fullwide",
"gong",
"gonm",
"gujr",
"guru",
"hanidec",
"hmng",
"hmnp",
"java",
"kali",
"khmr",
"knda",
"lana",
"lanatham",
"laoo",
"latn",
"lepc",
"limb",
"mathbold",
"mathdbl",
"mathmono",
"mathsanb",
"mathsans",
"mlym",
"modi",
"mong",
"mroo",
"mtei",
"mymr",
"mymrshan",
"mymrtlng",
"newa",
"nkoo",
"olck",
"orya",
"osma",
"rohg",
"saur",
"segment",
"shrd",
"sind",
"sinh",
"sora",
"sund",
"takr",
"talu",
"tamldec",
"telu",
"thai",
"tibt",
"tirh",
"vaii",
"wara",
"wcho"。 |
| hour12
| boolean | 是 | 是 | 是否使用12小时制。
|
| weekday
| string | 是 | 是
| 工作日的显示格式，取值包括："long",
"short",
"narrow"。 |
| era
| string | 是 | 是
| 时代的显示格式，取值包括："long",
"short",
"narrow"。 |
| year
| string | 是 | 是 | 年份的显示格式，取值包括："numeric",
"2-digit"。
|
| month
| string | 是 | 是
| 月份的显示格式，取值包括："numeric",
"2-digit",
"long",
"short",
"narrow"。 |
| day
| string | 是 | 是 | 日期的显示格式，取值包括："numeric",
"2-digit"。
|
| hour
| string | 是 | 是 | 小时的显示格式，取值包括："numeric",
"2-digit"。
|
| minute
| string | 是 | 是 | 分钟的显示格式，取值包括："numeric",
"2-digit"。
|
| second
| string | 是 | 是 | 秒钟的显示格式，取值包括："numeric",
"2-digit"。
|
| timeZoneName
| string | 是 | 是 | 时区名称的本地化表示。
|
| dayPeriod
| string | 是 | 是
| 时段的显示格式，取值包括："long",
"short",
"narrow"。 |
| localeMatcher
| string | 是 | 是
| 要使用的区域匹配算法，取值包括："lookup",
"best
fit"。 |
| formatMatcher
| string | 是 | 是
| 要使用的格式匹配算法，取值包括："basic",
"best
fit"。 |
| 名称
| 参数类型 | 可读 | 可写 | 说明
|
| --------
------- | ------- | ---- | ---- | --------------------------------
-------- |
| locale
| string | 是 | 否 | 区域参数，
如：zh-Hans-CN。
|
| dateStyle
| string | 是 | 是
| 日期显示格式，取值包括："long",
"short",
"medium",
"full"。 |
| timeStyle
| string | 是 | 是
| 时间显示格式，取值包括："long",
"short",
"medium",
"full"。 |
| hourCycle
| string | 是 | 是
| 时制格式，取值包括："h11",
"h12",
"h23",
"h24"。 |
| timeZone
| string | 是 | 是 | 使用的时区（合法的IANA时区ID）。
|
| numberingSystem | string
| 是 | 是
| 数字系统，取值包括："adlm",
"ahom",
"arab",
"arabext",
"bali",
"beng",
"bhks",
"brah",
"cakm",
"cham",
"deva",
"diak",
"fullwide",
"gong",
"gonm",
"gujr",
"guru",
"hanidec",
"hmng",
"hmnp",
"java",
"kali",
"khmr",
"knda",
"lana",
"lanatham",
"laoo",
"latn",
"lepc",
"limb",
"mathbold",
"mathdbl",
"mathmono",
"mathsanb",
"mathsans",
"mlym",
"modi",
"mong",
"mroo",
"mtei",
"mymr",
"mymrshan",
"mymrtlng",
"newa",
"nkoo",
"olck",
"orya",
"osma",
"rohg",
"saur",
"segment",
"shrd",
"sind",
"sinh",
"sora",
"sund",
"takr",
"talu",
"tamldec",
"telu",
"thai",
"tibt",
"tirh",
"vaii",
"wara",
"wcho"。 |
| hour12
| boolean | 是 | 是 | 是否使用12小时制。
|
| weekday
| string | 是 | 是
| 工作日的显示格式，取值包括："long",
"short",
"narrow"。 |
| era
| string | 是 | 是
| 时代的显示格式，取值包括："long",
"short",
"narrow"。 |
| year
| string | 是 | 是 | 年份的显示格式，取值包括："numeric",
"2-digit"。
|
| month
| string | 是 | 是
| 月份的显示格式，取值包括："numeric",
"2-digit",
"long",
"short",
"narrow"。 |
| day
| string | 是 | 是 | 日期的显示格式，取值包括："numeric",
"2-digit"。
|
| hour
| string | 是 | 是 | 小时的显示格式，取值包括："numeric",
"2-digit"。
|
| minute
| string | 是 | 是 | 分钟的显示格式，取值包括："numeric",
"2-digit"。
|
| second
| string | 是 | 是 | 秒钟的显示格式，取值包括："numeric",
"2-digit"。
|
| timeZoneName
| string | 是 | 是 | 时区名称的本地化表示。
|
| dayPeriod
| string | 是 | 是
| 时段的显示格式，取值包括："long",
"short",
"narrow"。 |
| localeMatcher
| string | 是 | 是
| 要使用的区域匹配算法，取值包括："lookup",
"best
fit"。 |
| formatMatcher
| string | 是 | 是
| 要使用的格式匹配算法，取值包括："basic",
"best
fit"。 |
## NumberFormat
...
...
@@ -301,7 +301,7 @@ constructor()
**系统能力**
：SystemCapability.Global.I18n
-
示例：
**示例：**
```
var numfmt = new Intl.NumberFormat();
```
...
...
@@ -309,19 +309,19 @@ constructor()
### constructor
constructor(locale: string | Array
<string>
, options?: NumberOptions)
constructor(locale: string | Array
<
string
>
, options?: NumberOptions)
创建数字格式化对象。
**系统能力**
：SystemCapability.Global.I18n
参数：
| 参数名
| 类型 | 必填 | 说明
|
| -------
- | -------- | -------- |
-------- |
| locale
| string
\|
Array
<string>
| 是
| 包含区域设置信息的字符串，包括语言以及可选的脚本和区域。 |
| options |
[
NumberOptions
](
#numberoptions
)
| 否
| 用于创建数字格式化的选项。
|
| 参数名
| 类型 | 必填 | 说明
|
| -------
| ------------------------------- | ---- | --------------------
-------- |
| locale
| string
\|
Array
<
string
>
| 是
| 包含区域设置信息的字符串，包括语言以及可选的脚本和区域。 |
| options |
[
NumberOptions
](
#numberoptions
)
| 否
| 用于创建数字格式化的选项。
|
-
示例：
**示例：**
```
var numfmt = new Intl.NumberFormat("en-GB", {style:'decimal', notation:"scientific"});
```
...
...
@@ -335,18 +335,18 @@ format(number: number): string;
**系统能力**
：SystemCapability.Global.I18n
-
参数：
| 参数名 | 类型 | 必填 | 说明
|
| -------- | -------- | -------- | ----
---- |
| number | number | 是
| 数字对象 |
**参数：**
| 参数名 | 类型 | 必填 | 说明
|
| ------ | ------ | ---- |
---- |
| number | number | 是
| 数字对象 |
-
返回值：
| 类型 | 说明
|
| -------- |
-------- |
| string | 格式化后的数字字符串 |
**返回值：**
| 类型 | 说明
|
| ------ | --
-------- |
| string | 格式化后的数字字符串 |
-
示例：
**示例：**
```
var numfmt = new Intl.NumberFormat(["en-GB", "zh"], {style:'decimal', notation:"scientific"});
numfmt.format(1223);
...
...
@@ -361,13 +361,13 @@ resolvedOptions(): NumberOptions
**系统能力**
：SystemCapability.Global.I18n
-
返回值：
| 类型 | 说明
|
| -------- |
-------- |
|
[
NumberOptions
](
#numberoptions
)
| NumberFormat
对象的格式化选项。 |
**返回值：**
| 类型 | 说明
|
| ------------------------------- | -------------------
-------- |
|
[
NumberOptions
](
#numberoptions
)
| NumberFormat
对象的格式化选项。 |
-
示例：
**示例：**
```
var numfmt = new Intl.NumberFormat(["en-GB", "zh"], {style:'decimal', notation:"scientific"});
numfmt.resolvedOptions();
...
...
@@ -380,27 +380,27 @@ resolvedOptions(): NumberOptions
**系统能力**
：以下各项对应的系统能力均为SystemCapability.Global.I18n
| 名称
| 参数类型 | 可读 | 可写 | 说明
|
| --------
| -------- | -------- | -------- |
-------- |
| locale
| string | 是 | 否 | 区域参数，
如："zh-Hans-CN"。
|
| currency
| string | 是 | 是 | 货币单位，
如："EUR"，"CNY"，"USD"等。
|
| currencySign
| string | 是 | 是
| 货币单位的符号显示，取值包括：
"symbol"，"narrowSymbol"，"code"，"name"
。 |
| currencyDisplay
| string | 是 | 是
| 货币的显示方式，取值包括："symbol",
"narrowSymbol",
"code",
"name"。 |
| unit
| string | 是 | 是 | 单位名称，如："meter"，"inch"，“hectare”等。
|
| unitDisplay
| string | 是 | 是
| 单位的显示格式，取值包括："long",
"short",
"medium"。 |
| unitUsage
| string | 是 | 是
| 单位的使用场景，取值包括："default",
"area-land-agricult",
"area-land-commercl",
"area-land-residntl",
"length-person",
"length-person-small",
"length-rainfall",
"length-road",
"length-road-small",
"length-snowfall",
"length-vehicle",
"length-visiblty",
"length-visiblty-small",
"length-person-informal",
"length-person-small-informal",
"length-road-informal",
"speed-road-travel",
"speed-wind",
"temperature-person",
"temperature-weather",
"volume-vehicle-fuel"。 |
| signDisplay
| string | 是 | 是
| 数字符号的显示格式，取值包括："auto",
"never",
"always",
"expectZero"。 |
| compactDisplay
| string | 是 | 是 | 紧凑型的显示格式，取值包括："long",
"short"。
|
| notation
| string | 是 | 是
| 数字的格式化规格，取值包括："standard",
"scientific",
"engineering",
"compact"。 |
| localeMatcher
| string | 是 | 是
| 要使用的区域匹配算法，取值包括："lookup",
"best
fit"。 |
| style
| string | 是 | 是
| 数字的显示格式，取值包括："decimal",
"currency",
"percent",
"unit"。 |
| numberingSystem
| string | 是 | 是
| 数字系统，取值包括："adlm",
"ahom",
"arab",
"arabext",
"bali",
"beng",
"bhks",
"brah",
"cakm",
"cham",
"deva",
"diak",
"fullwide",
"gong",
"gonm",
"gujr",
"guru",
"hanidec",
"hmng",
"hmnp",
"java",
"kali",
"khmr",
"knda",
"lana",
"lanatham",
"laoo",
"latn",
"lepc",
"limb",
"mathbold",
"mathdbl",
"mathmono",
"mathsanb",
"mathsans",
"mlym",
"modi",
"mong",
"mroo",
"mtei",
"mymr",
"mymrshan",
"mymrtlng",
"newa",
"nkoo",
"olck",
"orya",
"osma",
"rohg",
"saur",
"segment",
"shrd",
"sind",
"sinh",
"sora",
"sund",
"takr",
"talu",
"tamldec",
"telu",
"thai",
"tibt",
"tirh",
"vaii",
"wara",
"wcho"。 |
| useGrouping
| boolean | 是 | 是 | 是否分组显示。
|
| minimumIntegerDigits
| number | 是 | 是 | 表示要使用的最小整数位数，取值范围：1~21。
|
| minimumFractionDigits
| number | 是 | 是 | 表示要使用的最小分数位数，取值范围：0~20。
|
| maximumFractionDigits
| number | 是 | 是 | 表示要使用的最大分数位数，取值范围：1~21。
|
| minimumSignificantDigits | number
| 是 | 是 | 表示要使用的最低有效位数，取值范围：1~21。
|
| maximumSignificantDigits | number
| 是 | 是 | 表示要使用的最大有效位数，取值范围：1~21。
|
| 名称
| 参数类型 | 可读 | 可写 | 说明
|
| --------
---------------- | ------- | ---- | ---- | --------------------------------
-------- |
| locale
| string | 是 | 否 | 区域参数，
如："zh-Hans-CN"。
|
| currency
| string | 是 | 是 | 货币单位，
如："EUR"，"CNY"，"USD"等。
|
| currencySign
| string | 是 | 是
| 货币单位的符号显示，取值包括：
"symbol"，"narrowSymbol"，"code"，"name"
。 |
| currencyDisplay
| string | 是 | 是
| 货币的显示方式，取值包括："symbol",
"narrowSymbol",
"code",
"name"。 |
| unit
| string | 是 | 是 | 单位名称，如："meter"，"inch"，“hectare”等。
|
| unitDisplay
| string | 是 | 是
| 单位的显示格式，取值包括："long",
"short",
"medium"。 |
| unitUsage
| string | 是 | 是
| 单位的使用场景，取值包括："default",
"area-land-agricult",
"area-land-commercl",
"area-land-residntl",
"length-person",
"length-person-small",
"length-rainfall",
"length-road",
"length-road-small",
"length-snowfall",
"length-vehicle",
"length-visiblty",
"length-visiblty-small",
"length-person-informal",
"length-person-small-informal",
"length-road-informal",
"speed-road-travel",
"speed-wind",
"temperature-person",
"temperature-weather",
"volume-vehicle-fuel"。 |
| signDisplay
| string | 是 | 是
| 数字符号的显示格式，取值包括："auto",
"never",
"always",
"expectZero"。 |
| compactDisplay
| string | 是 | 是 | 紧凑型的显示格式，取值包括："long",
"short"。
|
| notation
| string | 是 | 是
| 数字的格式化规格，取值包括："standard",
"scientific",
"engineering",
"compact"。 |
| localeMatcher
| string | 是 | 是
| 要使用的区域匹配算法，取值包括："lookup",
"best
fit"。 |
| style
| string | 是 | 是
| 数字的显示格式，取值包括："decimal",
"currency",
"percent",
"unit"。 |
| numberingSystem
| string | 是 | 是
| 数字系统，取值包括："adlm",
"ahom",
"arab",
"arabext",
"bali",
"beng",
"bhks",
"brah",
"cakm",
"cham",
"deva",
"diak",
"fullwide",
"gong",
"gonm",
"gujr",
"guru",
"hanidec",
"hmng",
"hmnp",
"java",
"kali",
"khmr",
"knda",
"lana",
"lanatham",
"laoo",
"latn",
"lepc",
"limb",
"mathbold",
"mathdbl",
"mathmono",
"mathsanb",
"mathsans",
"mlym",
"modi",
"mong",
"mroo",
"mtei",
"mymr",
"mymrshan",
"mymrtlng",
"newa",
"nkoo",
"olck",
"orya",
"osma",
"rohg",
"saur",
"segment",
"shrd",
"sind",
"sinh",
"sora",
"sund",
"takr",
"talu",
"tamldec",
"telu",
"thai",
"tibt",
"tirh",
"vaii",
"wara",
"wcho"。 |
| useGrouping
| boolean | 是 | 是 | 是否分组显示。
|
| minimumIntegerDigits
| number | 是 | 是 | 表示要使用的最小整数位数，取值范围：1~21。
|
| minimumFractionDigits
| number | 是 | 是 | 表示要使用的最小分数位数，取值范围：0~20。
|
| maximumFractionDigits
| number | 是 | 是 | 表示要使用的最大分数位数，取值范围：1~21。
|
| minimumSignificantDigits | number
| 是 | 是 | 表示要使用的最低有效位数，取值范围：1~21。
|
| maximumSignificantDigits | number
| 是 | 是 | 表示要使用的最大有效位数，取值范围：1~21。
|
## Collator<sup>8+</sup>
...
...
@@ -414,7 +414,7 @@ constructor()
**系统能力**
：SystemCapability.Global.I18n
-
示例：
**示例：**
```
var collator = new Intl.Collator();
```
...
...
@@ -422,20 +422,20 @@ constructor()
### constructor<sup>8+</sup>
constructor(locale: string | Array
<string>
, options?: CollatorOptions)
constructor(locale: string | Array
<
string
>
, options?: CollatorOptions)
创建排序对象。
**系统能力**
：SystemCapability.Global.I18n
-
参数：
**参数：**
| 参数名 | 类型 | 必填 | 说明
|
| -------- | -------- | -------- |
-------- |
| locale | string
\|
Array
<string>
| 是
| 包含区域设置信息的字符串，包括语言以及可选的脚本和区域。 |
| options |
[
CollatorOptions
](
#collatoroptions
)
| 否 | 用于创建排序对象的选项。
|
| 参数名 | 类型 | 必填 | 说明
|
| ------- | ----------------------------------- | ---- | --------------------
-------- |
| locale | string
\|
Array
<
string
>
| 是
| 包含区域设置信息的字符串，包括语言以及可选的脚本和区域。 |
| options |
[
CollatorOptions
](
#collatoroptions
)
| 否 | 用于创建排序对象的选项。
|
-
示例：
**示例：**
```
var collator = new Intl.Collator("zh-CN", {localeMatcher: "lookup", usage: "sort"});
```
...
...
@@ -449,18 +449,18 @@ compare(first: string, second: string): number
**系统能力**
：SystemCapability.Global.I18n
-
参数：
| 参数名 | 类型 | 必填 | 说明
|
| -------- | -------- | -------- |
-------- |
| first | string | 是 | 进行比较第一个字符串。
|
| second | string | 是
| 进行比较的第二个字符串。 |
**参数：**
| 参数名 | 类型 | 必填 | 说明
|
| ------ | ------ | ---- | ----
-------- |
| first | string | 是 | 进行比较第一个字符串。
|
| second | string | 是
| 进行比较的第二个字符串。 |
-
返回值：
| 类型 | 说明
|
| -------- |
-------- |
| number | 比较结果。当number为负数，表示first排序在second之前；当number为0，表示first与second排序相同；当number为正数，表示first排序在second之后。 |
**返回值：**
| 类型 | 说明
|
| ------ | --------------------------------
-------- |
| number | 比较结果。当number为负数，表示first排序在second之前；当number为0，表示first与second排序相同；当number为正数，表示first排序在second之后。 |
-
示例：
**示例：**
```
var collator = new Intl.Collator("zh-Hans");
collator.compare("first", "second");
...
...
@@ -475,12 +475,12 @@ resolvedOptions(): CollatorOptions
**系统能力**
：SystemCapability.Global.I18n
-
返回值：
| 类型 | 说明
|
| -------- |
-------- |
|
[
CollatorOptions
](
#collatoroptions
)
| 返回的Collator对象的属性。 |
**返回值：**
| 类型 | 说明
|
| ----------------------------------- | ---------
-------- |
|
[
CollatorOptions
](
#collatoroptions
)
| 返回的Collator对象的属性。 |
-
示例：
**示例：**
```
var collator = new Intl.Collator("zh-Hans");
var options = collator.resolvedOptions();
...
...
@@ -493,15 +493,15 @@ resolvedOptions(): CollatorOptions
**系统能力**
：以下各项对应的系统能力均为SystemCapability.Global.I18n
| 名称
| 参数类型 | 可读 | 可写 | 说明
|
| --------
| -------- | -------- | -------- |
-------- |
| localeMatcher
| string | 是 | 是
| locale匹配算法，取值范围："best
fit",
"lookup"。 |
| usage
| string | 是 | 是 | 比较的用途，取值范围："sort",
"search"。
|
| sensitivity
| string | 是 | 是
| 表示字符串中的哪些差异会导致非零结果值，取值范围："base",
"accent",
"case",
"variant"。 |
| ignorePunctuation | boolean | 是
| 是 | 表示是否忽略标点符号，取值范围：true,
false。
|
| collation
| string | 是 | 是
| 排序规则，取值范围："big5han",
"compat",
"dict",
"direct",
"ducet",
"eor",
"gb2312",
"phonebk",
"phonetic",
"pinyin",
"reformed",
"searchjl",
"stroke",
"trad",
"unihan",
"zhuyin"。 |
| numeric
| boolean | 是 | 是 | 是否使用数字排序，取值范围：true,
false。
|
| caseFirst
| string | 是 | 是
| 表示大写、小写的排序顺序，取值范围："upper",
"lower",
"false"。 |
| 名称
| 参数类型 | 可读 | 可写 | 说明
|
| --------
--------- | ------- | ---- | ---- | --------------------------------
-------- |
| localeMatcher
| string | 是 | 是
| locale匹配算法，取值范围："best
fit",
"lookup"。 |
| usage
| string | 是 | 是 | 比较的用途，取值范围："sort",
"search"。
|
| sensitivity
| string | 是 | 是
| 表示字符串中的哪些差异会导致非零结果值，取值范围："base",
"accent",
"case",
"variant"。 |
| ignorePunctuation | boolean | 是
| 是 | 表示是否忽略标点符号，取值范围：true,
false。
|
| collation
| string | 是 | 是
| 排序规则，取值范围："big5han",
"compat",
"dict",
"direct",
"ducet",
"eor",
"gb2312",
"phonebk",
"phonetic",
"pinyin",
"reformed",
"searchjl",
"stroke",
"trad",
"unihan",
"zhuyin"。 |
| numeric
| boolean | 是 | 是 | 是否使用数字排序，取值范围：true,
false。
|
| caseFirst
| string | 是 | 是
| 表示大写、小写的排序顺序，取值范围："upper",
"lower",
"false"。 |
## PluralRules<sup>8+</sup>
...
...
@@ -515,7 +515,7 @@ constructor()
**系统能力**
：SystemCapability.Global.I18n
-
示例：
**示例：**
```
var pluralRules = new Intl.PluralRules();
```
...
...
@@ -523,19 +523,19 @@ constructor()
### constructor<sup>8+</sup>
constructor(locale: string | Array
<string>
, options?: PluralRulesOptions)
constructor(locale: string | Array
<
string
>
, options?: PluralRulesOptions)
创建PluralRules对象。
**系统能力**
：SystemCapability.Global.I18n
参数：
| 参数名
| 类型 | 必填 | 说明
|
| -------
- | -------- | -------- |
-------- |
| locale
| string
\|
Array
<string>
| 是
| 包含区域设置信息的字符串，包括语言以及可选的脚本和区域。 |
| options |
[
PluralRulesOptions
](
#pluralrulesoptions
)
| 否
| 用于创建单复数对象的选项。
|
| 参数名
| 类型 | 必填 | 说明
|
| -------
| ---------------------------------------- | ---- | --------------------
-------- |
| locale
| string
\|
Array
<
string
>
| 是
| 包含区域设置信息的字符串，包括语言以及可选的脚本和区域。 |
| options |
[
PluralRulesOptions
](
#pluralrulesoptions
)
| 否
| 用于创建单复数对象的选项。
|
-
示例：
**示例：**
```
var pluralRules= new Intl.PluraRules("zh-CN", {"localeMatcher": "lookup", "type": "cardinal"});
```
...
...
@@ -549,17 +549,17 @@ select(n: number): string
**系统能力**
：SystemCapability.Global.I18n
-
参数：
| 参数名 | 类型 | 必填 | 说明
|
| -------- | -------- | -------- |
-------- |
| n | number | 是
| 待获取单复数类别的数字。 |
**参数：**
| 参数名 | 类型 | 必填 | 说明
|
| ---- | ------ | ---- | ----
-------- |
| n | number | 是
| 待获取单复数类别的数字。 |
-
返回值：
| 类型 | 说明
|
| -------- |
-------- |
| string | 单复数类别，取值包括："zero"，"one"，"two",
"few",
"many",
"others"。 |
**返回值：**
| 类型 | 说明
|
| ------ | --------------------------------
-------- |
| string | 单复数类别，取值包括："zero"，"one"，"two",
"few",
"many",
"others"。 |
-
示例：
**示例：**
```
var pluralRules = new Intl.PluralRules("zh-Hans");
pluralRules.select(1);
...
...
@@ -572,15 +572,15 @@ select(n: number): string
**系统能力**
：以下各项对应的系统能力均为SystemCapability.Global.I18n
| 名称
| 参数类型 | 可读 | 可写 | 说明
|
| --------
| -------- | -------- | -------- |
-------- |
| localeMatcher
| string | 是 | 是
| locale匹配算法，取值包括："best
fit",
"lookup"。 |
| type
| string | 是 | 是 | 排序的类型，取值包括："cardinal",
"ordinal"。
|
| minimumIntegerDigits
| number | 是 | 是 | 表示要使用的最小整数位数，取值范围：1~21。
|
| minimumFractionDigits
| number | 是 | 是 | 表示要使用的最小分数位数，取值范围：0~20。
|
| maximumFractionDigits
| number | 是 | 是 | 表示要使用的最大分数位数，取值范围：1~21。
|
| minimumSignificantDigits | number | 是
| 是 | 表示要使用的最低有效位数，取值范围：1~21。
|
| maximumSignificantDigits | number | 是
| 是 | 表示要使用的最大有效位数，取值范围：1~21。
|
| 名称
| 参数类型 | 可读 | 可写 | 说明
|
| --------
---------------- | ------ | ---- | ---- | --------------------------------
-------- |
| localeMatcher
| string | 是 | 是
| locale匹配算法，取值包括："best
fit",
"lookup"。 |
| type
| string | 是 | 是 | 排序的类型，取值包括："cardinal",
"ordinal"。
|
| minimumIntegerDigits
| number | 是 | 是 | 表示要使用的最小整数位数，取值范围：1~21。
|
| minimumFractionDigits
| number | 是 | 是 | 表示要使用的最小分数位数，取值范围：0~20。
|
| maximumFractionDigits
| number | 是 | 是 | 表示要使用的最大分数位数，取值范围：1~21。
|
| minimumSignificantDigits | number | 是
| 是 | 表示要使用的最低有效位数，取值范围：1~21。
|
| maximumSignificantDigits | number | 是
| 是 | 表示要使用的最大有效位数，取值范围：1~21。
|
## RelativeTimeFormat<sup>8+</sup>
...
...
@@ -594,7 +594,7 @@ constructor()
**系统能力**
：SystemCapability.Global.I18n
-
示例：
**示例：**
```
var relativetimefmt = new Intl.RelativeTimeFormat();
```
...
...
@@ -602,19 +602,19 @@ constructor()
### constructor<sup>8+</sup>
constructor(locale: string | Array
<string>
, options?: RelativeTimeFormatInputOptions)
constructor(locale: string | Array
<
string
>
, options?: RelativeTimeFormatInputOptions)
创建相对时间格式化对象。
**系统能力**
：SystemCapability.Global.I18n
参数：
| 参数名
| 类型 | 必填 | 说明
|
| -------
- | -------- | -------- |
-------- |
| locale
| string
\|
Array
<string>
| 是
| 包含区域设置信息的字符串，包括语言以及可选的脚本和区域。 |
| options |
[
RelativeTimeFormatInputOptions
](
#relativetimeformatinputoptions
)
| 否
| 用于创建相对时间格式化对象的选项。
|
| 参数名
| 类型 | 必填 | 说明
|
| -------
| ---------------------------------------- | ---- | --------------------
-------- |
| locale
| string
\|
Array
<
string
>
| 是
| 包含区域设置信息的字符串，包括语言以及可选的脚本和区域。 |
| options |
[
RelativeTimeFormatInputOptions
](
#relativetimeformatinputoptions
)
| 否
| 用于创建相对时间格式化对象的选项。
|
-
示例：
**示例：**
```
var relativeTimeFormat = new Intl.RelativeTimeFormat("zh-CN", {"localeMatcher": "lookup", "numeric": "always", "style": "long"});
```
...
...
@@ -628,18 +628,18 @@ format(value: number, unit: string): string
**系统能力**
：SystemCapability.Global.I18n
-
参数：
| 参数名 | 类型 | 必填 | 说明
|
| -------- | -------- | -------- |
-------- |
| value | number | 是 | 相对时间格式化的数值。
|
| unit | string | 是
| 相对时间格式化的单位，取值包括："year",
"quarter",
"month",
"week",
"day",
"hour",
"minute",
"second"。 |
**参数：**
| 参数名 | 类型 | 必填 | 说明
|
| ----- | ------ | ---- | --------------------------------
-------- |
| value | number | 是 | 相对时间格式化的数值。
|
| unit | string | 是
| 相对时间格式化的单位，取值包括："year",
"quarter",
"month",
"week",
"day",
"hour",
"minute",
"second"。 |
-
返回值：
| 类型 | 说明
|
| -------- |
-------- |
| string | 格式化后的相对时间。 |
**返回值：**
| 类型 | 说明
|
| ------ | --
-------- |
| string | 格式化后的相对时间。 |
-
示例：
**示例：**
```
var relativetimefmt = new Intl.RelativeTimeFormat("zh-CN");
relativetimefmt.format(3, "quarter")
...
...
@@ -648,24 +648,24 @@ format(value: number, unit: string): string
### formatToParts<sup>8+</sup>
formatToParts(value: number, unit: string): Array
<object>
formatToParts(value: number, unit: string): Array
<
object
>
返回一个对象数组，表示可用于自定义区域设置格式的相对时间格式。
**系统能力**
：SystemCapability.Global.I18n
-
参数：
| 参数名 | 类型 | 必填 | 说明
|
| -------- | -------- | -------- |
-------- |
| value | number | 是 | 相对时间格式化的数值。
|
| unit | string | 是
| 相对时间格式化的单位，取值包括："year",
"quarter",
"month",
"week",
"day",
"hour",
"minute",
"second"。 |
**参数：**
| 参数名 | 类型 | 必填 | 说明
|
| ----- | ------ | ---- | --------------------------------
-------- |
| value | number | 是 | 相对时间格式化的数值。
|
| unit | string | 是
| 相对时间格式化的单位，取值包括："year",
"quarter",
"month",
"week",
"day",
"hour",
"minute",
"second"。 |
-
返回值：
| 类型 | 说明
|
| -------- |
-------- |
| Array
<object>
| 返回可用于自定义区域设置格式的相对时间格式的对象数组。 |
**返回值：**
| 类型 | 说明
|
| ------------------- | -------------------
-------- |
| Array
<
object
>
| 返回可用于自定义区域设置格式的相对时间格式的对象数组。 |
-
示例：
**示例：**
```
var relativetimefmt = new Intl.RelativeTimeFormat("en", {"numeric": "auto"});
var parts = relativetimefmt.format(10, "seconds");
...
...
@@ -680,12 +680,12 @@ resolvedOptions(): RelativeTimeFormatResolvedOptions
**系统能力**
：SystemCapability.Global.I18n
-
返回值：
| 类型 | 说明
|
| -------- |
-------- |
|
[
RelativeTimeFormatResolvedOptions
](
#relativetimeformatresolvedoptions
)
| RelativeTimeFormat
对象的格式化选项。 |
**返回值：**
| 类型 | 说明
|
| ---------------------------------------- | -------------------------
-------- |
|
[
RelativeTimeFormatResolvedOptions
](
#relativetimeformatresolvedoptions
)
| RelativeTimeFormat
对象的格式化选项。 |
-
示例：
**示例：**
```
var relativetimefmt= new Intl.RelativeTimeFormat("en-GB");
relativetimefmt.resolvedOptions();
...
...
@@ -698,11 +698,11 @@ resolvedOptions(): RelativeTimeFormatResolvedOptions
**系统能力**
：以下各项对应的系统能力均为SystemCapability.Global.I18n
| 名称
| 参数类型 | 可读 | 可写 | 说明
|
| --------
| -------- | -------- | -------- |
-------- |
| localeMatcher | string | 是
| 是
| locale匹配算法，取值包括："best
fit",
"lookup"。 |
| numeric
| string | 是 | 是 | 输出消息的格式，取值包括："always",
"auto"。
|
| style
| string | 是 | 是
| 国际化消息的长度，取值包括："long",
"short",
"narrow"。 |
| 名称
| 参数类型 | 可读 | 可写 | 说明
|
| --------
----- | ------ | ---- | ---- | --------------------------------
-------- |
| localeMatcher | string | 是
| 是
| locale匹配算法，取值包括："best
fit",
"lookup"。 |
| numeric
| string | 是 | 是 | 输出消息的格式，取值包括："always",
"auto"。
|
| style
| string | 是 | 是
| 国际化消息的长度，取值包括："long",
"short",
"narrow"。 |
## RelativeTimeFormatResolvedOptions<sup>8+</sup><a name=relativetimeformatresolvedoptions></a>
...
...
@@ -711,9 +711,9 @@ resolvedOptions(): RelativeTimeFormatResolvedOptions
**系统能力**
：以下各项对应的系统能力均为SystemCapability.Global.I18n
| 名称
| 参数类型 | 可读 | 可写 | 说明
|
| --------
| -------- | -------- | -------- |
-------- |
| locale
| string | 是 | 是 | 包含区域设置信息的字符串，包括语言以及可选的脚本和区域。
|
| numeric
| string | 是 | 是 | 输出消息的格式，取值包括："always",
"auto"。
|
| style
| string | 是 | 是
| 国际化消息的长度，取值包括："long",
"short",
"narrow"。 |
| numberingSystem | string | 是
| 是 | 使用的数字系统。
|
| 名称
| 参数类型 | 可读 | 可写 | 说明
|
| --------
------- | ------ | ---- | ---- | --------------------------------
-------- |
| locale
| string | 是 | 是 | 包含区域设置信息的字符串，包括语言以及可选的脚本和区域。
|
| numeric
| string | 是 | 是 | 输出消息的格式，取值包括："always",
"auto"。
|
| style
| string | 是 | 是
| 国际化消息的长度，取值包括："long",
"short",
"narrow"。 |
| numberingSystem | string | 是
| 是 | 使用的数字系统。
|
zh-cn/application-dev/reference/apis/js-apis-resource-manager.md
浏览文件 @
52ae4725
#
资源管理
资源管理
>  **说明：**
> 本模块首批接口从API version 6开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。
...
...
@@ -18,12 +18,12 @@ getResourceManager(callback: AsyncCallback<ResourceManager>): void
**系统能力**
：SystemCapability.Global.ResourceManager
-
参数：
| 参数名 | 类型 | 必填 | 说明
|
| -------- | -------- | -------- |
-------- |
| callback | AsyncCallback
<
[ResourceManager](#resourcemanager)
>
| 是
| callback方式返回ResourceManager对象 |
**参数：**
| 参数名 | 类型 | 必填 | 说明
|
| -------- | ---------------------------------------- | ---- | ---------------------
-------- |
| callback | AsyncCallback
<
[ResourceManager](#resourcemanager)
>
| 是
| callback方式返回ResourceManager对象 |
-
示例：
**示例：**
```
resourceManager.getResourceManager((error, mgr) => {
if (error != null) {
...
...
@@ -49,13 +49,13 @@ getResourceManager(bundleName: string, callback: AsyncCallback<ResourceManage
**系统能力**
：SystemCapability.Global.ResourceManager
-
参数：
| 参数名 | 类型 | 必填 | 说明
|
| -------- | -------- | -------- |
-------- |
| bundleName | string | 是 | 指定应用的Bundle名称
|
| callback | AsyncCallback
<
[ResourceManager](#resourcemanager)
>
| 是
| callback方式返回ResourceManager对象 |
**参数：**
| 参数名 | 类型 | 必填 | 说明
|
| ---------- | ---------------------------------------- | ---- | ---------------------
-------- |
| bundleName | string | 是 | 指定应用的Bundle名称
|
| callback | AsyncCallback
<
[ResourceManager](#resourcemanager)
>
| 是
| callback方式返回ResourceManager对象 |
-
示例：
**示例：**
```
resourceManager.getResourceManager("com.example.myapplication", (error, mgr) => {
});
...
...
@@ -70,12 +70,12 @@ getResourceManager(): Promise<ResourceManager>
**系统能力**
：SystemCapability.Global.ResourceManager
-
返回值：
| 类型 | 说明
|
| -------- |
-------- |
| Promise
<
[ResourceManager](#resourcemanager)
>
| Promise方式返回资源管理对象 |
**返回值：**
| 类型 | 说明
|
| ---------------------------------------- | ---------
-------- |
| Promise
<
[ResourceManager](#resourcemanager)
>
| Promise方式返回资源管理对象 |
-
示例：
**示例：**
```
resourceManager.getResourceManager().then(mgr => {
mgr.getString(0x1000000, (error, value) => {
...
...
@@ -99,22 +99,22 @@ getResourceManager(bundleName: string): Promise<ResourceManager>
**系统能力**
：SystemCapability.Global.ResourceManager
-
参数：
| 参数名 | 类型 | 必填 | 说明
|
| -------- | -------- | -------- |
-------- |
| bundleName | string | 是
| 指定应用的Bundle名称 |
**参数：**
| 参数名 | 类型 | 必填 | 说明
|
| ---------- | ------ | ---- | -----
-------- |
| bundleName | string | 是
| 指定应用的Bundle名称 |
-
返回值：
| 类型 | 说明
|
| -------- |
-------- |
| Promise
<
[ResourceManager](#resourcemanager)
>
| Promise方式返回的资源管理对象 |
**返回值：**
| 类型 | 说明
|
| ---------------------------------------- | ----------
-------- |
| Promise
<
[ResourceManager](#resourcemanager)
>
| Promise方式返回的资源管理对象 |
-
示例：
**示例：**
```
resourceManager.getResourceManager("com.example.myapplication").then(mgr => {
}).catch(error => {
});
```
...
...
@@ -123,72 +123,82 @@ getResourceManager(bundleName: string): Promise<ResourceManager>
用于表示设备屏幕方向。
| 名称 | 默认值 | 说明 |
| -------- | -------- | -------- |
| DIRECTION_VERTICAL | 0 | 竖屏
<br/>
**系统能力**
：SystemCapability.Global.ResourceManager |
| DIRECTION_HORIZONTAL | 1 | 横屏
<br/>
**系统能力**
：SystemCapability.Global.ResourceManager |
**系统能力**
：以下各项对应的系统能力均为SystemCapability.Global.ResourceManager
| 名称 | 默认值 | 说明 |
| -------------------- | ---- | ---- |
| DIRECTION_VERTICAL | 0 | 竖屏 |
| DIRECTION_HORIZONTAL | 1 | 横屏 |
## DeviceType
用于表示当前设备类型。
| 名称 | 默认值 | 说明 |
| -------- | -------- | -------- |
| DEVICE_TYPE_PHONE | 0x00 | 手机
<br/>
**系统能力**
：SystemCapability.Global.ResourceManager |
| DEVICE_TYPE_TABLET | 0x01 | 平板
<br/>
**系统能力**
：SystemCapability.Global.ResourceManager |
| DEVICE_TYPE_CAR | 0x02 | 汽车
<br/>
**系统能力**
：SystemCapability.Global.ResourceManager |
| DEVICE_TYPE_PC | 0x03 | 电脑
<br/>
**系统能力**
：SystemCapability.Global.ResourceManager |
| DEVICE_TYPE_TV | 0x04 | 电视
<br/>
**系统能力**
：SystemCapability.Global.ResourceManager |
| DEVICE_TYPE_WEARABLE | 0x06 | 穿戴
<br/>
**系统能力**
：SystemCapability.Global.ResourceManager |
**系统能力**
：以下各项对应的系统能力均为SystemCapability.Global.ResourceManager
| 名称 | 默认值 | 说明 |
| -------------------- | ---- | ---- |
| DEVICE_TYPE_PHONE | 0x00 | 手机 |
| DEVICE_TYPE_TABLET | 0x01 | 平板 |
| DEVICE_TYPE_CAR | 0x02 | 汽车 |
| DEVICE_TYPE_PC | 0x03 | 电脑 |
| DEVICE_TYPE_TV | 0x04 | 电视 |
| DEVICE_TYPE_WEARABLE | 0x06 | 穿戴 |
## ScreenDensity
用于表示当前设备屏幕密度。
| 名称 | 默认值 | 说明 |
| -------- | -------- | -------- |
| SCREEN_SDPI | 120 | 小规模的屏幕密度
<br/>
**系统能力**
：SystemCapability.Global.ResourceManager |
| SCREEN_MDPI | 160 | 中规模的屏幕密度
<br/>
**系统能力**
：SystemCapability.Global.ResourceManager |
| SCREEN_LDPI | 240 | 大规模的屏幕密度
<br/>
**系统能力**
：SystemCapability.Global.ResourceManager |
| SCREEN_XLDPI | 320 | 特大规模的屏幕密度
<br/>
**系统能力**
：SystemCapability.Global.ResourceManager |
| SCREEN_XXLDPI | 480 | 超大规模的屏幕密度
<br/>
**系统能力**
：SystemCapability.Global.ResourceManager |
| SCREEN_XXXLDPI | 640 | 超特大规模的屏幕密度
<br/>
**系统能力**
：SystemCapability.Global.ResourceManager |
**系统能力**
：以下各项对应的系统能力均为SystemCapability.Global.ResourceManager
| 名称 | 默认值 | 说明 |
| -------------- | ---- | ---------- |
| SCREEN_SDPI | 120 | 小规模的屏幕密度 |
| SCREEN_MDPI | 160 | 中规模的屏幕密度 |
| SCREEN_LDPI | 240 | 大规模的屏幕密度 |
| SCREEN_XLDPI | 320 | 特大规模的屏幕密度 |
| SCREEN_XXLDPI | 480 | 超大规模的屏幕密度 |
| SCREEN_XXXLDPI | 640 | 超特大规模的屏幕密度 |
## Configuration
表示当前设备的状态。
**系统能力**
：以下各项对应的系统能力均为SystemCapability.Global.ResourceManager
| 名称
| 参数类型 | 可读 | 可写 | 说明
|
| --------
| -------- | -------- | ----
---- | -------- |
| direction |
[
Direction
](
#direction
)
| 是
| 否 | 当前设备屏幕方向
<br/>
**系统能力**
：SystemCapability.Global.ResourceManager
|
| locale
| string | 是 | 否 | 当前系统语言
<br/>
**系统能力**
：SystemCapability.Global.ResourceManager
|
| 名称
| 参数类型 | 可读 | 可写 | 说明
|
| --------
- | ----------------------- | ---- |
---- | -------- |
| direction |
[
Direction
](
#direction
)
| 是
| 否 | 当前设备屏幕方向
|
| locale
| string | 是 | 否 | 当前系统语言
|
## DeviceCapability
表示设备支持的能力。
**系统能力**
：以下各项对应的系统能力均为SystemCapability.Global.ResourceManager
| 名称
| 参数类型 | 可读 | 可写 | 说明
|
| --------
| -------- | -------- | ----
---- | -------- |
| screenDensity |
[
ScreenDensity
](
#screendensity
)
| 是
| 否 | 当前设备屏幕密度
<br/>
**系统能力**
：SystemCapability.Global.ResourceManager
|
| deviceType
|
[
DeviceType
](
#devicetype
)
| 是 | 否 | 当前设备类型
<br/>
**系统能力**
：SystemCapability.Global.ResourceManager
|
| 名称
| 参数类型 | 可读 | 可写 | 说明
|
| --------
----- | ------------------------------- | ---- |
---- | -------- |
| screenDensity |
[
ScreenDensity
](
#screendensity
)
| 是
| 否 | 当前设备屏幕密度
|
| deviceType
|
[
DeviceType
](
#devicetype
)
| 是 | 否 | 当前设备类型
|
## RawFileDescriptor<sup>8+</sup>
表示rawfile的descriptor信息。
<br/><b>
系统能力：
</b>
以下各项对应的系统能力均为SystemCapability.Global.ResourceManager
表示rawfile的descriptor信息。
<br>
**系统能力：**
以下各项对应的系统能力均为SystemCapability.Global.ResourceManager
| 名称
| 类型 | 说明
|
| ------
-- | -------- |
-------- |
| fd | number | rawfile的descriptor |
| offset | number | rawfile的起始偏移量 |
| length | number | rawfile的文件长度 |
| 名称
| 类型 | 说明
|
| ------
| ------ | ----------
-------- |
| fd
| number | rawfile的descriptor |
| offset | number | rawfile的起始偏移量
|
| length | number | rawfile的文件长度
|
## ResourceManager
...
...
@@ -197,7 +207,7 @@ getResourceManager(bundleName: string): Promise<ResourceManager>
>  **说明：**
> - ResourceManager涉及到的方法，仅限基于TS扩展的声明式开发范式使用。
>
>
> - 资源文件在工程的resources目录中定义，id可通过$r(资源地址).id的方式获取，例如$r('app.string.test').id。
...
...
@@ -209,13 +219,13 @@ getString(resId: number, callback: AsyncCallback<string>): void
**系统能力**
：SystemCapability.Global.ResourceManager
-
参数：
| 参数名 | 类型 | 必填 | 说明
|
| -------- | -------- | -------- |
-------- |
| resId | number | 是 | 资源ID值
|
| callback | AsyncCallback
<
string
>
| 是
| 异步回调，用于返回获取的字符串 |
**参数：**
| 参数名 | 类型 | 必填 | 说明
|
| -------- | --------------------------- | ---- | -------
-------- |
| resId | number | 是 | 资源ID值
|
| callback | AsyncCallback
<
string
>
| 是
| 异步回调，用于返回获取的字符串 |
-
示例：
**示例：**
```
resourceManager.getResourceManager((error, mgr) => {
mgr.getString($r('app.string.test').id, (error, value) => {
...
...
@@ -237,17 +247,17 @@ getString(resId: number): Promise<string>
**系统能力**
：SystemCapability.Global.ResourceManager
-
参数：
| 参数名 | 类型 | 必填 | 说明
|
| -------- | -------- | -------- | ---
----- |
| resId | number | 是
| 资源ID值 |
**参数：**
| 参数名 | 类型 | 必填 | 说明
|
| ----- | ------ | ---- |
----- |
| resId | number | 是
| 资源ID值 |
-
返回值：
| 类型 | 说明
|
| -------- |
-------- |
| Promise
<
string
>
| 资源ID值对应的字符串 |
**返回值：**
| 类型 | 说明
|
| --------------------- | ---
-------- |
| Promise
<
string
>
| 资源ID值对应的字符串 |
-
示例：
**示例：**
```
resourceManager.getResourceManager((error, mgr) => {
mgr.getString($r('app.string.test').id).then(value => {
...
...
@@ -267,13 +277,13 @@ getStringArray(resId: number, callback: AsyncCallback<Array<string>>
**系统能力**
：SystemCapability.Global.ResourceManager
-
参数：
| 参数名 | 类型 | 必填 | 说明
|
| -------- | -------- | -------- |
-------- |
| resId | number | 是 | 资源ID值
|
| callback | AsyncCallback
<
Array
<
string
>>
| 是
| 异步回调，用于返回获取的字符串数组 |
**参数：**
| 参数名 | 类型 | 必填 | 说明
|
| -------- | ---------------------------------------- | ---- | ---------
-------- |
| resId | number | 是 | 资源ID值
|
| callback | AsyncCallback
<
Array
<
string
>>
| 是
| 异步回调，用于返回获取的字符串数组 |
-
示例：
**示例：**
```
resourceManager.getResourceManager((error, mgr) => {
mgr.getStringArray($r('app.strarray.test').id, (error, value) => {
...
...
@@ -295,17 +305,17 @@ getStringArray(resId: number): Promise<Array<string>>
**系统能力**
：SystemCapability.Global.ResourceManager
-
参数：
| 参数名 | 类型 | 必填 | 说明
|
| -------- | -------- | -------- | ---
----- |
| resId | number | 是
| 资源ID值 |
**参数：**
| 参数名 | 类型 | 必填 | 说明
|
| ----- | ------ | ---- |
----- |
| resId | number | 是
| 资源ID值 |
-
返回值：
| 类型 | 说明
|
| -------- |
-------- |
| Promise
<
Array
<
string
>>
| 资源ID值对应的字符串数组 |
**返回值：**
| 类型 | 说明
|
| ---------------------------------- | -----
-------- |
| Promise
<
Array
<
string
>>
| 资源ID值对应的字符串数组 |
-
示例：
**示例：**
```
resourceManager.getResourceManager((error, mgr) => {
mgr.getStringArray($r('app.strarray.test').id).then(value => {
...
...
@@ -325,13 +335,13 @@ getMedia(resId: number, callback: AsyncCallback<Uint8Array>): void
**系统能力**
：SystemCapability.Global.ResourceManager
-
参数：
| 参数名 | 类型 | 必填 | 说明
|
| -------- | -------- | -------- |
-------- |
| resId | number | 是 | 资源ID值
|
| callback | AsyncCallback
<
Uint8Array
>
| 是
| 异步回调，用于返回获取的媒体文件内容 |
**参数：**
| 参数名 | 类型 | 必填 | 说明
|
| -------- | ------------------------------- | ---- | ----------
-------- |
| resId | number | 是 | 资源ID值
|
| callback | AsyncCallback
<
Uint8Array
>
| 是
| 异步回调，用于返回获取的媒体文件内容 |
-
示例：
**示例：**
```
resourceManager.getResourceManager((error, mgr) => {
mgr.getMedia($r('app.media.test').id, (error, value) => {
...
...
@@ -353,17 +363,17 @@ getMedia(resId: number): Promise<Uint8Array>
**系统能力**
：SystemCapability.Global.ResourceManager
-
参数：
| 参数名 | 类型 | 必填 | 说明
|
| -------- | -------- | -------- | ---
----- |
| resId | number | 是
| 资源ID值 |
**参数：**
| 参数名 | 类型 | 必填 | 说明
|
| ----- | ------ | ---- |
----- |
| resId | number | 是
| 资源ID值 |
-
返回值：
| 类型 | 说明
|
| -------- |
-------- |
| Promise
<
Uint8Array
>
| 资源ID值对应的媒体文件内容 |
**返回值：**
| 类型 | 说明
|
| ------------------------- | ------
-------- |
| Promise
<
Uint8Array
>
| 资源ID值对应的媒体文件内容 |
-
示例：
**示例：**
```
resourceManager.getResourceManager((error, mgr) => {
mgr.getMedia($r('app.media.test').id).then(value => {
...
...
@@ -383,13 +393,13 @@ getMediaBase64(resId: number, callback: AsyncCallback<string>): void
**系统能力**
：SystemCapability.Global.ResourceManager
-
参数：
| 参数名 | 类型 | 必填 | 说明
|
| -------- | -------- | -------- |
-------- |
| resId | number | 是 | 资源ID值
|
| callback | AsyncCallback
<
string
>
| 是
| 异步回调，用于返回获取的图片资源Base64编码 |
**参数：**
| 参数名 | 类型 | 必填 | 说明
|
| -------- | --------------------------- | ---- | ----------------
-------- |
| resId | number | 是 | 资源ID值
|
| callback | AsyncCallback
<
string
>
| 是
| 异步回调，用于返回获取的图片资源Base64编码 |
-
示例：
**示例：**
```
resourceManager.getResourceManager((error, mgr) => {
mgr.getMediaBase64($r('app.media.test').id, (error, value) => {
...
...
@@ -411,17 +421,17 @@ getMediaBase64(resId: number): Promise<string>
**系统能力**
：SystemCapability.Global.ResourceManager
-
参数：
| 参数名 | 类型 | 必填 | 说明
|
| -------- | -------- | -------- | ---
----- |
| resId | number | 是
| 资源ID值 |
**参数：**
| 参数名 | 类型 | 必填 | 说明
|
| ----- | ------ | ---- |
----- |
| resId | number | 是
| 资源ID值 |
-
返回值：
| 类型 | 说明
|
| -------- |
-------- |
| Promise
<
string
>
| 资源ID值对应的图片资源Base64编码 |
**返回值：**
| 类型 | 说明
|
| --------------------- | ------------
-------- |
| Promise
<
string
>
| 资源ID值对应的图片资源Base64编码 |
-
示例：
**示例：**
```
resourceManager.getResourceManager((error, mgr) => {
mgr.getMediaBase64($r('app.media.test').id).then(value => {
...
...
@@ -441,12 +451,12 @@ getConfiguration(callback: AsyncCallback<Configuration>): void
**系统能力**
：SystemCapability.Global.ResourceManager
-
参数：
| 参数名 | 类型 | 必填 | 说明
|
| -------- | -------- | -------- |
-------- |
| callback | AsyncCallback
<
[Configuration](#configuration)
>
| 是
| 异步回调，用于返回设备的Configuration |
**参数：**
| 参数名 | 类型 | 必填 | 说明
|
| -------- | ---------------------------------------- | ---- | -----------------
-------- |
| callback | AsyncCallback
<
[Configuration](#configuration)
>
| 是
| 异步回调，用于返回设备的Configuration |
-
示例：
**示例：**
```
resourceManager.getResourceManager((error, mgr) => {
mgr.getConfiguration((error, value) => {
...
...
@@ -468,12 +478,12 @@ getConfiguration(): Promise<Configuration>
**系统能力**
：SystemCapability.Global.ResourceManager
-
返回值：
| 类型 | 说明
|
| -------- |
-------- |
| Promise
<
[Configuration](#configuration)
>
| 设备的Configuration |
**返回值：**
| 类型 | 说明
|
| ---------------------------------------- | --------
-------- |
| Promise
<
[Configuration](#configuration)
>
| 设备的Configuration |
-
示例：
**示例：**
```
resourceManager.getResourceManager((error, mgr) => {
mgr.getConfiguration().then(value => {
...
...
@@ -493,12 +503,12 @@ getDeviceCapability(callback: AsyncCallback<DeviceCapability>): void
**系统能力**
：SystemCapability.Global.ResourceManager
-
参数：
| 参数名 | 类型 | 必填 | 说明
|
| -------- | -------- | -------- |
-------- |
| callback | AsyncCallback
<
[DeviceCapability](#devicecapability)
>
| 是
| 异步回调，用于返回设备的DeviceCapability |
**参数：**
| 参数名 | 类型 | 必填 | 说明
|
| -------- | ---------------------------------------- | ---- | --------------------
-------- |
| callback | AsyncCallback
<
[DeviceCapability](#devicecapability)
>
| 是
| 异步回调，用于返回设备的DeviceCapability |
-
示例：
**示例：**
```
resourceManager.getResourceManager((error, mgr) => {
mgr.getDeviceCapability((error, value) => {
...
...
@@ -520,12 +530,12 @@ getDeviceCapability(): Promise<DeviceCapability>
**系统能力**
：SystemCapability.Global.ResourceManager
-
返回值：
| 类型 | 说明
|
| -------- |
-------- |
| Promise
<
[DeviceCapability](#devicecapability)
>
| 设备的DeviceCapability |
**返回值：**
| 类型 | 说明
|
| ---------------------------------------- | -----------
-------- |
| Promise
<
[DeviceCapability](#devicecapability)
>
| 设备的DeviceCapability |
-
示例：
**示例：**
```
resourceManager.getResourceManager((error, mgr) => {
mgr.getDeviceCapability().then(value => {
...
...
@@ -545,14 +555,14 @@ getPluralString(resId: number, num: number, callback: AsyncCallback<string>
**系统能力**
：SystemCapability.Global.ResourceManager
-
参数：
| 参数名 | 类型 | 必填 | 说明
|
| -------- | -------- | -------- |
-------- |
| resId | number | 是 | 资源ID值
|
| num | number | 是 | 数量值
|
| callback | AsyncCallback
<
string
>
| 是
| 异步回调，返回根据指定数量获取指定ID字符串表示的单复数字符串 |
**参数：**
| 参数名 | 类型 | 必填 | 说明
|
| -------- | --------------------------- | ---- | -----------------------
-------- |
| resId | number | 是 | 资源ID值
|
| num | number | 是 | 数量值
|
| callback | AsyncCallback
<
string
>
| 是
| 异步回调，返回根据指定数量获取指定ID字符串表示的单复数字符串 |
-
示例：
**示例：**
```
resourceManager.getResourceManager((error, mgr) => {
mgr.getPluralString($r("app.plural.test").id, 1, (error, value) => {
...
...
@@ -574,18 +584,18 @@ getPluralString(resId: number, num: number): Promise<string>
**系统能力**
：SystemCapability.Global.ResourceManager
-
参数：
| 参数名 | 类型 | 必填 | 说明
|
| -------- | -------- | -------- | ---
----- |
| resId | number | 是
| 资源ID值 |
| num | number | 是 | 数量值
|
**参数：**
| 参数名 | 类型 | 必填 | 说明
|
| ----- | ------ | ---- |
----- |
| resId | number | 是
| 资源ID值 |
| num | number | 是 | 数量值
|
-
返回值：
| 类型 | 说明
|
| -------- |
-------- |
| Promise
<
string
>
| 根据提供的数量获取对应ID字符串表示的单复数字符串 |
**返回值：**
| 类型 | 说明
|
| --------------------- | -----------------
-------- |
| Promise
<
string
>
| 根据提供的数量获取对应ID字符串表示的单复数字符串 |
-
示例：
**示例：**
```
resourceManager.getResourceManager((error, mgr) => {
mgr.getPluralString($r("app.plural.test").id, 1).then(value => {
...
...
@@ -604,13 +614,13 @@ getRawFile(path: string, callback: AsyncCallback<Uint8Array>): void
**系统能力**
：SystemCapability.Global.ResourceManager
-
参数：
| 参数名 | 类型 | 必填 | 说明
|
| -------- | -------- | -------- |
-------- |
| path | string | 是 | rawfile文件路径
|
| callback | AsyncCallback
<
Uint8Array
>
| 是
| 异步回调，用于返回获取的rawfile文件内容 |
**参数：**
| 参数名 | 类型 | 必填 | 说明
|
| -------- | ------------------------------- | ---- | ---------------
-------- |
| path | string | 是 | rawfile文件路径
|
| callback | AsyncCallback
<
Uint8Array
>
| 是
| 异步回调，用于返回获取的rawfile文件内容 |
-
示例：
**示例：**
```
resourceManager.getResourceManager((error, mgr) => {
mgr.getRawFile("test.xml", (error, value) => {
...
...
@@ -631,17 +641,17 @@ getRawFile(path: string): Promise<Uint8Array>
**系统能力**
：SystemCapability.Global.ResourceManager
-
参数：
| 参数名 | 类型 | 必填 | 说明
|
| -------- | -------- | -------- |
-------- |
| path | string | 是
| rawfile文件路径 |
**参数：**
| 参数名 | 类型 | 必填 | 说明
|
| ---- | ------ | ---- | ---
-------- |
| path | string | 是
| rawfile文件路径 |
-
返回值：
| 类型 | 说明
|
| -------- |
-------- |
| Promise
<
Uint8Array
>
| rawfile文件内容 |
**返回值：**
| 类型 | 说明
|
| ------------------------- | ---
-------- |
| Promise
<
Uint8Array
>
| rawfile文件内容 |
-
示例：
**示例：**
```
resourceManager.getResourceManager((error, mgr) => {
mgr.getRawFile("test.xml").then(value => {
...
...
@@ -660,13 +670,13 @@ getRawFileDescriptor(path: string, callback: AsyncCallback<RawFileDescriptor&
**系统能力**
：SystemCapability.Global.ResourceManager
-
参数：
| 参数名 | 类型 | 必填 | 说明
|
| -------- | -------- | -------- |
-------- |
| path | string | 是 | rawfile文件路径
|
| callback | AsyncCallback
<
[RawFileDescriptor](#RawFileDescriptor
<sup>
8+
</sup>
)
>
| 是
| 异步回调，用于返回获取的rawfile文件的descriptor |
**参数：**
| 参数名 | 类型 | 必填 | 说明
|
| -------- | ---------------------------------------- | ---- | ------------------------
-------- |
| path | string | 是 | rawfile文件路径
|
| callback | AsyncCallback
<
[RawFileDescriptor](#rawfiledescriptor8+
</sup
)>
| 是
| 异步回调，用于返回获取的rawfile文件的descriptor |
-
示例：
**示例：**
```
resourceManager.getResourceManager((error, mgr) => {
mgr.getRawFileDescriptor("test.xml", (error, value) => {
...
...
@@ -689,17 +699,17 @@ getRawFileDescriptor(path: string): Promise<RawFileDescriptor>
**系统能力**
：SystemCapability.Global.ResourceManager
-
参数：
| 参数名 | 类型 | 必填 | 说明
|
| -------- | -------- | -------- |
-------- |
| path | string | 是
| rawfile文件路径 |
**参数：**
| 参数名 | 类型 | 必填 | 说明
|
| ---- | ------ | ---- | ---
-------- |
| path | string | 是
| rawfile文件路径 |
-
返回值：
| 类型 | 说明
|
| -------- |
-------- |
| Promise
<
[RawFileDescriptor](#RawFileDescriptor
<sup>
8+
</sup>
)
>
| rawfile文件descriptor |
**返回值：**
| 类型 | 说明
|
| ---------------------------------------- | -----------
-------- |
| Promise
<[RawFileDescriptor](#rawfiledescriptor8
)>
| rawfile文件descriptor |
-
示例：
**示例：**
```
resourceManager.getResourceManager((error, mgr) => {
mgr.getRawFileDescriptor("test.xml").then(value => {
...
...
@@ -720,13 +730,13 @@ closeRawFileDescriptor(path: string, callback: AsyncCallback<void>): void
**系统能力**
：SystemCapability.Global.ResourceManager
-
参数：
| 参数名 | 类型 | 必填 | 说明
|
| -------- | -------- | -------- |
-------- |
| path | string | 是
| rawfile文件路径 |
| callback | AsyncCallback
<
void
>
| 是 | 异步回调
|
**参数：**
| 参数名 | 类型 | 必填 | 说明
|
| -------- | ------------------------- | ---- | ---
-------- |
| path | string | 是
| rawfile文件路径 |
| callback | AsyncCallback
<void>
| 是 | 异步回调
|
-
示例：
**示例：**
```
resourceManager.getResourceManager((error, mgr) => {
mgr.closeRawFileDescriptor("test.xml", (error, value) => {
...
...
@@ -745,17 +755,17 @@ closeRawFileDescriptor(path: string): Promise<void>
**系统能力**
：SystemCapability.Global.ResourceManager
-
参数：
| 参数名 | 类型 | 必填 | 说明
|
| -------- | -------- | -------- |
-------- |
| path | string | 是
| rawfile文件路径 |
**参数：**
| 参数名 | 类型 | 必填 | 说明
|
| ---- | ------ | ---- | ---
-------- |
| path | string | 是
| rawfile文件路径 |
-
返回值：
| 类型 | 说明
|
| -------- | ----
---- |
| Promise
<
void
>
| 无返回值 |
**返回值：**
| 类型 | 说明
|
| ------------------- |
---- |
| Promise
<void>
| 无返回值 |
-
示例：
**示例：**
```
resourceManager.getResourceManager((error, mgr) => {
mgr.closeRawFileDescriptor("test.xml").then(value => {
...
...
@@ -768,13 +778,13 @@ closeRawFileDescriptor(path: string): Promise<void>
### release<sup>7+</sup>
release()
;
release()
用户释放创建的resourceManager。
**系统能力**
：SystemCapability.Global.ResourceManager
-
示例：
**示例：**
```
resourceManager.getResourceManager((error, mgr) => {
mgr.release((error, value) => {
...
...
zh-cn/application-dev/reference/apis/js-apis-sensor.md
浏览文件 @
52ae4725
...
...
@@ -22,14 +22,14 @@ on(type: SensorType.SENSOR_TYPE_ID_ACCELEROMETER, callback: Callback<Acceler
**系统能力**
：SystemCapability.Sensors.Sensor
-
参数：
| 参数名 | 类型 | 必填 | 说明
|
| -------- | -------- | -------- |
-------- |
| type |
[
SensorType
](
#sensortype
)
| 是
| 要订阅的加速度传感器类型为SENSOR_TYPE_ID_ACCELEROMETER。 |
| callback | Callback
<
[AccelerometerResponse](#accelerometerresponse)
>
| 是
| 注册加速度传感器的回调函数，上报的数据类型为AccelerometerResponse。 |
| options |
[
Options
](
#options
)
| 否 | 可选参数列表，设置上报频率，默认值为200000000ns。
|
**参数：**
| 参数名 | 类型 | 必填 | 说明
|
| -------- | ---------------------------------------- | ---- | --------------------------------
-------- |
| type |
[
SensorType
](
#sensortype
)
| 是
| 要订阅的加速度传感器类型为SENSOR_TYPE_ID_ACCELEROMETER。 |
| callback | Callback
<
[AccelerometerResponse](#accelerometerresponse)
>
| 是
| 注册加速度传感器的回调函数，上报的数据类型为AccelerometerResponse。 |
| options |
[
Options
](
#options
)
| 否 | 可选参数列表，设置上报频率，默认值为200000000ns。
|
-
示例：
**示例：**
```
sensor.on(sensor.SensorType.SENSOR_TYPE_ID_ACCELEROMETER,function(data){
console.info('X-coordinate component: ' + data.x);
...
...
@@ -51,14 +51,14 @@ on(type: SensorType.SENSOR_TYPE_ID_LINEAR_ACCELERATION,callback:Callback<Line
**系统能力**
：SystemCapability.Sensors.Sensor
-
参数：
| 参数名 | 类型 | 必填 | 说明
|
| -------- | -------- | -------- |
-------- |
| type |
[
SensorType
](
#sensortype
)
| 是
| 要订阅的线性加速度传感器类型为SENSOR_TYPE_ID_LINEAR_ACCELERATION。 |
| callback | Callback
<
[LinearAccelerometerResponse](#linearaccelerometerresponse)
>
| 是
| 注册线性加速度传感器的回调函数，上报的数据类型为LinearAccelerometerResponse。 |
| options |
[
Options
](
#options
)
| 否 | 可选参数列表，设置上报频率，默认值为200000000ns。
|
**参数：**
| 参数名 | 类型 | 必填 | 说明
|
| -------- | ---------------------------------------- | ---- | --------------------------------
-------- |
| type |
[
SensorType
](
#sensortype
)
| 是
| 要订阅的线性加速度传感器类型为SENSOR_TYPE_ID_LINEAR_ACCELERATION。 |
| callback | Callback
<
[LinearAccelerometerResponse](#linearaccelerometerresponse)
>
| 是
| 注册线性加速度传感器的回调函数，上报的数据类型为LinearAccelerometerResponse。 |
| options |
[
Options
](
#options
)
| 否 | 可选参数列表，设置上报频率，默认值为200000000ns。
|
-
示例：
**示例：**
```
sensor.on(sensor.SensorType.SENSOR_TYPE_ID_LINEAR_ACCELERATION,function(data){
console.info('X-coordinate component: ' + data.x);
...
...
@@ -80,14 +80,14 @@ on(type: SensorType.SENSOR_TYPE_ID_ACCELEROMETER_UNCALIBRATED,callback: Callback
**系统能力**
：SystemCapability.Sensors.Sensor
-
参数：
| 参数名 | 类型 | 必填 | 说明
|
| -------- | -------- | -------- |
-------- |
| type |
[
SensorType
](
#sensortype
)
| 是
| 要订阅的未校准加速度计传感器类型为SENSOR_TYPE_ID_ACCELEROMETER_UNCALIBRATED。 |
| callback | Callback
<
[AccelerometerUncalibratedResponse](#accelerometeruncalibratedresponse)
>
| 是
| 注册未校准加速度计传感器的回调函数，上报的数据类型为AccelerometerUncalibratedResponse。 |
| options |
[
Options
](
#options
)
| 否 | 可选参数列表，设置上报频率，默认值为200000000ns。
|
**参数：**
| 参数名 | 类型 | 必填 | 说明
|
| -------- | ---------------------------------------- | ---- | --------------------------------
-------- |
| type |
[
SensorType
](
#sensortype
)
| 是
| 要订阅的未校准加速度计传感器类型为SENSOR_TYPE_ID_ACCELEROMETER_UNCALIBRATED。 |
| callback | Callback
<
[AccelerometerUncalibratedResponse](#accelerometeruncalibratedresponse)
>
| 是
| 注册未校准加速度计传感器的回调函数，上报的数据类型为AccelerometerUncalibratedResponse。 |
| options |
[
Options
](
#options
)
| 否 | 可选参数列表，设置上报频率，默认值为200000000ns。
|
-
示例：
**示例：**
```
sensor.on(sensor.SensorType.SENSOR_TYPE_ID_ACCELEROMETER_UNCALIBRATED,function(data){
console.info('X-coordinate component: ' + data.x);
...
...
@@ -110,14 +110,14 @@ on(type: SensorType.SENSOR_TYPE_ID_GRAVITY, callback: Callback<GravityRespons
**系统能力**
：SystemCapability.Sensors.Sensor
-
参数：
| 参数名 | 类型 | 必填 | 说明
|
| -------- | -------- | -------- |
-------- |
| type |
[
SensorType
](
#sensortype
)
| 是 | 要订阅的重力传感器类型为SENSOR_TYPE_ID_GRAVITY。
|
| callback | Callback
<
[GravityResponse](#gravityresponse)
>
| 是
| 注册重力传感器的回调函数，上报的数据类型为GravityResponse。 |
| options |
[
Options
](
#options
)
| 否 | 可选参数列表，设置上报频率，默认值为200000000ns。
|
**参数：**
| 参数名 | 类型 | 必填 | 说明
|
| -------- | ---------------------------------------- | ---- | -----------------------------
-------- |
| type |
[
SensorType
](
#sensortype
)
| 是 | 要订阅的重力传感器类型为SENSOR_TYPE_ID_GRAVITY。
|
| callback | Callback
<
[GravityResponse](#gravityresponse)
>
| 是
| 注册重力传感器的回调函数，上报的数据类型为GravityResponse。 |
| options |
[
Options
](
#options
)
| 否 | 可选参数列表，设置上报频率，默认值为200000000ns。
|
-
示例：
**示例：**
```
sensor.on(sensor.SensorType.SENSOR_TYPE_ID_GRAVITY,function(data){
console.info('X-coordinate component: ' + data.x);
...
...
@@ -139,14 +139,14 @@ on(type: SensorType.SENSOR_TYPE_ID_GYROSCOPE, callback: Callback<GyroscopeRes
**系统能力**
：SystemCapability.Sensors.Sensor
-
参数：
| 参数名 | 类型 | 必填 | 说明
|
| -------- | -------- | -------- |
-------- |
| type |
[
SensorType
](
#sensortype
)
| 是 | 要订阅的陀螺仪传感器类型为SENSOR_TYPE_ID_GYROSCOPE。
|
| callback | Callback
<
[GyroscopeResponse](#gyroscoperesponse)
>
| 是
| 注册陀螺仪传感器的回调函数，上报的数据类型为GyroscopeResponse。 |
| options |
[
Options
](
#options
)
| 否 | 可选参数列表，设置上报频率，默认值为200000000ns。
|
**参数：**
| 参数名 | 类型 | 必填 | 说明
|
| -------- | ---------------------------------------- | ---- | --------------------------------
-------- |
| type |
[
SensorType
](
#sensortype
)
| 是 | 要订阅的陀螺仪传感器类型为SENSOR_TYPE_ID_GYROSCOPE。
|
| callback | Callback
<
[GyroscopeResponse](#gyroscoperesponse)
>
| 是
| 注册陀螺仪传感器的回调函数，上报的数据类型为GyroscopeResponse。 |
| options |
[
Options
](
#options
)
| 否 | 可选参数列表，设置上报频率，默认值为200000000ns。
|
-
示例：
**示例：**
```
sensor.on(sensor.SensorType.SENSOR_TYPE_ID_GYROSCOPE,function(data){
console.info('X-coordinate component: ' + data.x);
...
...
@@ -168,14 +168,14 @@ on(type: SensorType.SENSOR_TYPE_ID_GYROSCOPE_UNCALIBRATED,callback:Callback<G
**系统能力**
：SystemCapability.Sensors.Sensor
-
参数：
| 参数名 | 类型 | 必填 | 说明
|
| -------- | -------- | -------- |
-------- |
| type |
[
SensorType
](
#sensortype
)
| 是
| 要订阅的未校准陀螺仪传感器类型为SENSOR_TYPE_ID_GYROSCOPE_UNCALIBRATED。 |
| callback | Callback
<
[GyroscopeUncalibratedResponse](#gyroscopeuncalibratedresponse)
>
| 是
| 注册未校准陀螺仪传感器的回调函数，上报的数据类型为GyroscopeUncalibratedResponse。 |
| options |
[
Options
](
#options
)
| 否 | 可选参数列表，设置上报频率。
|
**参数：**
| 参数名 | 类型 | 必填 | 说明
|
| -------- | ---------------------------------------- | ---- | --------------------------------
-------- |
| type |
[
SensorType
](
#sensortype
)
| 是
| 要订阅的未校准陀螺仪传感器类型为SENSOR_TYPE_ID_GYROSCOPE_UNCALIBRATED。 |
| callback | Callback
<
[GyroscopeUncalibratedResponse](#gyroscopeuncalibratedresponse)
>
| 是
| 注册未校准陀螺仪传感器的回调函数，上报的数据类型为GyroscopeUncalibratedResponse。 |
| options |
[
Options
](
#options
)
| 否 | 可选参数列表，设置上报频率。
|
-
示例：
**示例：**
```
sensor.on(sensor.SensorType.SENSOR_TYPE_ID_GYROSCOPE_UNCALIBRATED,function(data){
console.info('X-coordinate component: ' + data.x);
...
...
@@ -198,14 +198,14 @@ on(type: SensorType.SENSOR_TYPE_ID_SIGNIFICANT_MOTION, callback: Callback<Sig
**系统能力**
：SystemCapability.Sensors.Sensor
-
参数：
| 参数名 | 类型 | 必填 | 说明
|
| -------- | -------- | -------- |
-------- |
| type |
[
SensorType
](
#sensortype
)
| 是
| 要订阅的大幅动作传感器类型为SENSOR_TYPE_ID_SIGNIFICANT_MOTION。 |
| callback | Callback
<
[SignificantMotionResponse](#significantmotionresponse)
>
| 是
| 注册有效运动传感器的回调函数，上报的数据类型为SignificantMotionResponse。 |
| options |
[
Options
](
#options
)
| 否 | 可选参数列表，设置上报频率，默认值为200000000ns。
|
**参数：**
| 参数名 | 类型 | 必填 | 说明
|
| -------- | ---------------------------------------- | ---- | --------------------------------
-------- |
| type |
[
SensorType
](
#sensortype
)
| 是
| 要订阅的大幅动作传感器类型为SENSOR_TYPE_ID_SIGNIFICANT_MOTION。 |
| callback | Callback
<
[SignificantMotionResponse](#significantmotionresponse)
>
| 是
| 注册有效运动传感器的回调函数，上报的数据类型为SignificantMotionResponse。 |
| options |
[
Options
](
#options
)
| 否 | 可选参数列表，设置上报频率，默认值为200000000ns。
|
-
示例：
**示例：**
```
sensor.on(sensor.SensorType.SENSOR_TYPE_ID_SIGNIFICANT_MOTION,function(data){
console.info('Scalar data: ' + data.scalar);
...
...
@@ -225,14 +225,14 @@ on(type: SensorType.SENSOR_TYPE_ID_PEDOMETER_DETECTION, callback: Callback<Pe
**系统能力**
：SystemCapability.Sensors.Sensor
-
参数：
| 参数名 | 类型 | 必填 | 说明
|
| -------- | -------- | -------- |
-------- |
| type |
[
SensorType
](
#sensortype
)
| 是
| 要订阅的计步检测传感器类型为SENSOR_TYPE_ID_PEDOMETER_DETECTION。 |
| callback | Callback
<
[PedometerDetectionResponse](#pedometerdetectionresponse)
>
| 是
| 注册计步检测传感器的回调函数，上报的数据类型为PedometerDetectionResponse。 |
| options |
[
Options
](
#options
)
| 否 | 可选参数列表，设置上报频率，默认值为200000000ns。
|
**参数：**
| 参数名 | 类型 | 必填 | 说明
|
| -------- | ---------------------------------------- | ---- | --------------------------------
-------- |
| type |
[
SensorType
](
#sensortype
)
| 是
| 要订阅的计步检测传感器类型为SENSOR_TYPE_ID_PEDOMETER_DETECTION。 |
| callback | Callback
<
[PedometerDetectionResponse](#pedometerdetectionresponse)
>
| 是
| 注册计步检测传感器的回调函数，上报的数据类型为PedometerDetectionResponse。 |
| options |
[
Options
](
#options
)
| 否 | 可选参数列表，设置上报频率，默认值为200000000ns。
|
-
示例：
**示例：**
```
sensor.on(sensor.SensorType.SENSOR_TYPE_ID_PEDOMETER_DETECTION,function(data){
console.info('Scalar data: ' + data.scalar);
...
...
@@ -252,14 +252,14 @@ on(type: SensorType.SENSOR_TYPE_ID_PEDOMETER, callback: Callback<PedometerRes
**系统能力**
：SystemCapability.Sensors.Sensor
-
参数：
| 参数名 | 类型 | 必填 | 说明
|
| -------- | -------- | -------- |
-------- |
| type |
[
SensorType
](
#sensortype
)
| 是 | 要订阅的计步传感器类型为SENSOR_TYPE_ID_PEDOMETER。
|
| callback | Callback
<
[PedometerResponse](#pedometerresponse)
>
| 是
| 注册计步传感器的回调函数，上报的数据类型为PedometerResponse。 |
| options |
[
Options
](
#options
)
| 否 | 可选参数列表，设置上报频率，默认值为200000000ns。
|
**参数：**
| 参数名 | 类型 | 必填 | 说明
|
| -------- | ---------------------------------------- | ---- | -------------------------------
-------- |
| type |
[
SensorType
](
#sensortype
)
| 是 | 要订阅的计步传感器类型为SENSOR_TYPE_ID_PEDOMETER。
|
| callback | Callback
<
[PedometerResponse](#pedometerresponse)
>
| 是
| 注册计步传感器的回调函数，上报的数据类型为PedometerResponse。 |
| options |
[
Options
](
#options
)
| 否 | 可选参数列表，设置上报频率，默认值为200000000ns。
|
-
示例：
**示例：**
```
sensor.on(sensor.SensorType.SENSOR_TYPE_ID_PEDOMETER,function(data){
console.info('Steps: ' + data.steps);
...
...
@@ -277,14 +277,14 @@ on(type:SensorType.SENSOR_TYPE_ID_AMBIENT_TEMPERATURE,callback:Callback<Ambie
**系统能力**
：SystemCapability.Sensors.Sensor
-
参数：
| 参数名 | 类型 | 必填 | 说明
|
| -------- | -------- | -------- |
-------- |
| type |
[
SensorType
](
#sensortype
)
| 是
| 要订阅的环境温度传感器类型为SENSOR_TYPE_ID_AMBIENT_TEMPERATURE。 |
| callback | Callback
<
[AmbientTemperatureResponse](#ambienttemperatureresponse)
>
| 是
| 注册环境温度传感器的回调函数，上报的数据类型为AmbientTemperatureResponse。 |
| options |
[
Options
](
#options
)
| 否 | 可选参数列表，设置上报频率，默认值为200000000ns。
|
**参数：**
| 参数名 | 类型 | 必填 | 说明
|
| -------- | ---------------------------------------- | ---- | --------------------------------
-------- |
| type |
[
SensorType
](
#sensortype
)
| 是
| 要订阅的环境温度传感器类型为SENSOR_TYPE_ID_AMBIENT_TEMPERATURE。 |
| callback | Callback
<
[AmbientTemperatureResponse](#ambienttemperatureresponse)
>
| 是
| 注册环境温度传感器的回调函数，上报的数据类型为AmbientTemperatureResponse。 |
| options |
[
Options
](
#options
)
| 否 | 可选参数列表，设置上报频率，默认值为200000000ns。
|
-
示例：
**示例：**
```
sensor.on(sensor.SensorType.SENSOR_TYPE_ID_AMBIENT_TEMPERATURE,function(data){
console.info('Temperature: ' + data.temperature);
...
...
@@ -302,14 +302,14 @@ on(type: SensorType.SENSOR_TYPE_ID_MAGNETIC_FIELD, callback: Callback<Magneti
**系统能力**
：SystemCapability.Sensors.Sensor
-
参数：
| 参数名 | 类型 | 必填 | 说明
|
| -------- | -------- | -------- |
-------- |
| type |
[
SensorType
](
#sensortype
)
| 是
| 要订阅的磁场传感器类型为SENSOR_TYPE_ID_MAGNETIC_FIELD。 |
| callback | Callback
<
[MagneticFieldResponse](#magneticfieldresponse)
>
| 是
| 注册磁场传感器的回调函数，上报的数据类型为MagneticFieldResponse。 |
| options |
[
Options
](
#options
)
| 否 | 可选参数列表，设置上报频率，默认值为200000000ns。
|
**参数：**
| 参数名 | 类型 | 必填 | 说明
|
| -------- | ---------------------------------------- | ---- | --------------------------------
-------- |
| type |
[
SensorType
](
#sensortype
)
| 是
| 要订阅的磁场传感器类型为SENSOR_TYPE_ID_MAGNETIC_FIELD。 |
| callback | Callback
<
[MagneticFieldResponse](#magneticfieldresponse)
>
| 是
| 注册磁场传感器的回调函数，上报的数据类型为MagneticFieldResponse。 |
| options |
[
Options
](
#options
)
| 否 | 可选参数列表，设置上报频率，默认值为200000000ns。
|
-
示例：
**示例：**
```
sensor.on(sensor.SensorType.SENSOR_TYPE_ID_MAGNETIC_FIELD,function(data){
console.info('X-coordinate component: ' + data.x);
...
...
@@ -323,20 +323,20 @@ on(type: SensorType.SENSOR_TYPE_ID_MAGNETIC_FIELD, callback: Callback<Magneti
## sensor.on(SensorType.SENSOR_TYPE_ID_MAGNETIC_FIELD_UNCALIBRATED)
on(type: SensorType.SENSOR_TYPE_ID_MAGNETIC_FIELD_UNCALIBRATED,callback: Callback
<
MagneticFieldUncalibratedResponse
>
, options: Options): void
on(type: SensorType.SENSOR_TYPE_ID_MAGNETIC_FIELD_UNCALIBRATED,callback: Callback
<
MagneticFieldUncalibratedResponse
>
, options
?
: Options): void
监听未校准磁场传感器的数据变化。如果多次调用该接口，仅最后一次调用生效。
**系统能力**
：SystemCapability.Sensors.Sensor
-
参数：
| 参数名 | 类型 | 必填 | 说明
|
| -------- | -------- | -------- |
-------- |
| type |
[
SensorType
](
#sensortype
)
| 是
| 要订阅的未校准磁场传感器类型为SENSOR_TYPE_ID_MAGNETIC_FIELD_UNCALIBRATED。 |
| callback | Callback
<
[MagneticFieldUncalibratedResponse](#magneticfielduncalibratedresponse)
>
| 是
| 注册未校准磁场传感器的回调函数，上报的数据类型为MagneticFieldUncalibratedResponse。 |
| options |
[
Options
](
#options
)
| 否 | 可选参数列表，设置上报频率，默认值为200000000ns。
|
**参数：**
| 参数名 | 类型 | 必填 | 说明
|
| -------- | ---------------------------------------- | ---- | --------------------------------
-------- |
| type |
[
SensorType
](
#sensortype
)
| 是
| 要订阅的未校准磁场传感器类型为SENSOR_TYPE_ID_MAGNETIC_FIELD_UNCALIBRATED。 |
| callback | Callback
<
[MagneticFieldUncalibratedResponse](#magneticfielduncalibratedresponse)
>
| 是
| 注册未校准磁场传感器的回调函数，上报的数据类型为MagneticFieldUncalibratedResponse。 |
| options |
[
Options
](
#options
)
| 否 | 可选参数列表，设置上报频率，默认值为200000000ns。
|
-
示例：
**示例：**
```
sensor.on(sensor.SensorType.SENSOR_TYPE_ID_MAGNETIC_FIELD_UNCALIBRATED,function(data){
console.info('X-coordinate component: ' + data.x);
...
...
@@ -359,14 +359,14 @@ on(type: SensorType.SENSOR_TYPE_ID_PROXIMITY, callback: Callback<ProximityRes
**系统能力**
：SystemCapability.Sensors.Sensor
-
参数：
| 参数名 | 类型 | 必填 | 说明
|
| -------- | -------- | -------- |
-------- |
| type |
[
SensorType
](
#sensortype
)
| 是 | 要订阅的接近光传感器类型为SENSOR_TYPE_ID_PROXIMITY。
|
| callback | Callback
<
[ProximityResponse](#proximityresponse)
>
| 是
| 注册接近光传感器的回调函数，上报的数据类型为ProximityResponse。 |
| options |
[
Options
](
#options
)
| 否 | 可选参数列表，设置上报频率，默认值为200000000ns。
|
**参数：**
| 参数名 | 类型 | 必填 | 说明
|
| -------- | ---------------------------------------- | ---- | --------------------------------
-------- |
| type |
[
SensorType
](
#sensortype
)
| 是 | 要订阅的接近光传感器类型为SENSOR_TYPE_ID_PROXIMITY。
|
| callback | Callback
<
[ProximityResponse](#proximityresponse)
>
| 是
| 注册接近光传感器的回调函数，上报的数据类型为ProximityResponse。 |
| options |
[
Options
](
#options
)
| 否 | 可选参数列表，设置上报频率，默认值为200000000ns。
|
-
示例：
**示例：**
```
sensor.on(sensor.SensorType.SENSOR_TYPE_ID_PROXIMITY,function(data){
console.info('Distance: ' + data.distance);
...
...
@@ -384,14 +384,14 @@ on(type: SensorType.SENSOR_TYPE_ID_HUMIDITY, callback: Callback<HumidityRespo
**系统能力**
：SystemCapability.Sensors.Sensor
-
参数：
| 参数名 | 类型 | 必填 | 说明
|
| -------- | -------- | -------- |
-------- |
| type |
[
SensorType
](
#sensortype
)
| 是 | 要订阅的湿度传感器类型为SENSOR_TYPE_ID_HUMIDITY。
|
| callback | Callback
<
[HumidityResponse](#humidityresponse)
>
| 是
| 注册湿度传感器的回调函数，上报的数据类型为HumidityResponse。 |
| options |
[
Options
](
#options
)
| 否 | 可选参数列表，设置上报频率，默认值为200000000ns。
|
**参数：**
| 参数名 | 类型 | 必填 | 说明
|
| -------- | ---------------------------------------- | ---- | ------------------------------
-------- |
| type |
[
SensorType
](
#sensortype
)
| 是 | 要订阅的湿度传感器类型为SENSOR_TYPE_ID_HUMIDITY。
|
| callback | Callback
<
[HumidityResponse](#humidityresponse)
>
| 是
| 注册湿度传感器的回调函数，上报的数据类型为HumidityResponse。 |
| options |
[
Options
](
#options
)
| 否 | 可选参数列表，设置上报频率，默认值为200000000ns。
|
-
示例：
**示例：**
```
sensor.on(sensor.SensorType.SENSOR_TYPE_ID_HUMIDITY,function(data){
console.info('Humidity: ' + data.humidity);
...
...
@@ -409,14 +409,14 @@ on(type: SensorType.SENSOR_TYPE_ID_BAROMETER, callback: Callback<BarometerRes
**系统能力**
：SystemCapability.Sensors.Sensor
-
参数：
| 参数名 | 类型 | 必填 | 说明
|
| -------- | -------- | -------- |
-------- |
| type |
[
SensorType
](
#sensortype
)
| 是 | 要订阅的气压计传感器类型为SENSOR_TYPE_ID_BAROMETER。
|
| callback | Callback
<
[BarometerResponse](#barometerresponse)
>
| 是
| 注册气压计传感器的回调函数，上报的数据类型为BarometerResponse。 |
| options |
[
Options
](
#options
)
| 否 | 可选参数列表，设置上报频率，默认值为200000000ns。
|
**参数：**
| 参数名 | 类型 | 必填 | 说明
|
| -------- | ---------------------------------------- | ---- | --------------------------------
-------- |
| type |
[
SensorType
](
#sensortype
)
| 是 | 要订阅的气压计传感器类型为SENSOR_TYPE_ID_BAROMETER。
|
| callback | Callback
<
[BarometerResponse](#barometerresponse)
>
| 是
| 注册气压计传感器的回调函数，上报的数据类型为BarometerResponse。 |
| options |
[
Options
](
#options
)
| 否 | 可选参数列表，设置上报频率，默认值为200000000ns。
|
-
示例：
**示例：**
```
sensor.on(sensor.SensorType.SENSOR_TYPE_ID_BAROMETER,function(data){
console.info('Atmospheric pressure: ' + data.pressure);
...
...
@@ -434,14 +434,14 @@ on(type: SensorType.SENSOR_TYPE_ID_HALL, callback: Callback<HallResponse>,
**系统能力**
：SystemCapability.Sensors.Sensor
-
参数：
| 参数名 | 类型 | 必填 | 说明
|
| -------- | -------- | -------- |
-------- |
| type |
[
SensorType
](
#sensortype
)
| 是 | 要订阅的霍尔传感器类型为SENSOR_TYPE_ID_HALL。
|
| callback | Callback
<
[HallResponse](#hallresponse)
>
| 是
| 注册霍尔传感器的回调函数，上报的数据类型为
HallResponse。 |
| options |
[
Options
](
#options
)
| 否 | 可选参数列表，设置上报频率，默认值为200000000ns。
|
**参数：**
| 参数名 | 类型 | 必填 | 说明
|
| -------- | ---------------------------------------- | ---- | --------------------------------
-------- |
| type |
[
SensorType
](
#sensortype
)
| 是 | 要订阅的霍尔传感器类型为SENSOR_TYPE_ID_HALL。
|
| callback | Callback
<
[HallResponse](#hallresponse)
>
| 是
| 注册霍尔传感器的回调函数，上报的数据类型为
HallResponse。 |
| options |
[
Options
](
#options
)
| 否 | 可选参数列表，设置上报频率，默认值为200000000ns。
|
-
示例：
**示例：**
```
sensor.on(sensor.SensorType.SENSOR_TYPE_ID_HALL,function(data){
console.info('Status: ' + data.status);
...
...
@@ -459,14 +459,14 @@ on(type: SensorType.SENSOR_TYPE_ID_AMBIENT_LIGHT, callback: Callback<LightRes
**系统能力**
：SystemCapability.Sensors.Sensor
-
参数：
| 参数名 | 类型 | 必填 | 说明
|
| -------- | -------- | -------- |
-------- |
| type |
[
SensorType
](
#sensortype
)
| 是
| 要订阅的环境光传感器类型为SENSOR_TYPE_ID_AMBIENT_LIGHT。 |
| callback | Callback
<
[LightResponse](#lightresponse)
>
| 是 | 注册环境光传感器的回调函数，上报的数据类型为LightResponse。
|
| options |
[
Options
](
#options
)
| 否 | 可选参数列表，设置上报频率，默认值为200000000ns。
|
**参数：**
| 参数名 | 类型 | 必填 | 说明
|
| -------- | ---------------------------------------- | ---- | --------------------------------
-------- |
| type |
[
SensorType
](
#sensortype
)
| 是
| 要订阅的环境光传感器类型为SENSOR_TYPE_ID_AMBIENT_LIGHT。 |
| callback | Callback
<
[LightResponse](#lightresponse)
>
| 是 | 注册环境光传感器的回调函数，上报的数据类型为LightResponse。
|
| options |
[
Options
](
#options
)
| 否 | 可选参数列表，设置上报频率，默认值为200000000ns。
|
-
示例：
**示例：**
```
sensor.on(sensor.SensorType.SENSOR_TYPE_ID_AMBIENT_LIGHT,function(data){
console.info(' Illumination: ' + data.intensity);
...
...
@@ -484,14 +484,14 @@ on(type: SensorType.SENSOR_TYPE_ID_ORIENTATION, callback: Callback<Orientatio
**系统能力**
：SystemCapability.Sensors.Sensor
-
参数：
| 参数名 | 类型 | 必填 | 说明
|
| -------- | -------- | -------- |
-------- |
| type |
[
SensorType
](
#sensortype
)
| 是 | 要订阅的方向传感器类型为SENSOR_TYPE_ID_ORIENTATION
|
| callback | Callback
<
[OrientationResponse](#orientationresponse)
>
| 是
| 注册方向传感器的回调函数，上报的数据类型为OrientationResponse。 |
| options |
[
Options
](
#options
)
| 否 | 可选参数列表，设置上报频率，默认值为200000000ns。
|
**参数：**
| 参数名 | 类型 | 必填 | 说明
|
| -------- | ---------------------------------------- | ---- | --------------------------------
-------- |
| type |
[
SensorType
](
#sensortype
)
| 是 | 要订阅的方向传感器类型为SENSOR_TYPE_ID_ORIENTATION
|
| callback | Callback
<
[OrientationResponse](#orientationresponse)
>
| 是
| 注册方向传感器的回调函数，上报的数据类型为OrientationResponse。 |
| options |
[
Options
](
#options
)
| 否 | 可选参数列表，设置上报频率，默认值为200000000ns。
|
-
示例：
**示例：**
```
sensor.on(sensor.SensorType.SENSOR_TYPE_ID_ORIENTATION,function(data){
console.info('The device rotates at an angle around the X axis: ' + data.beta);
...
...
@@ -512,14 +512,14 @@ on(type: SensorType.SENSOR_TYPE_ID_HEART_RATE, callback: Callback<HeartRateRe
**系统能力**
：SystemCapability.Sensors.Sensor
-
参数：
**参数：**
| 参数名
| 类型 | 必填 | 说明
|
| -------- | ----------------------------------------
--------------- | ---- | --------------------
---------------------------------------- |
| type |
[
SensorType
](
#sensortype
)
| 是 | 要订阅的心率传感器类型为SENSOR_TYPE_ID_HEART_RATE。
|
| callback | Callback
<
[HeartRateResponse](#heartrateresponse)
>
| 是 | 注册一次心率传感器的回调函数，上报的数据类型为HeartRateResponse。 |
| 参数名
| 类型 | 必填 | 说明
|
| -------- | ----------------------------------------
| ---- |
---------------------------------------- |
| type |
[
SensorType
](
#sensortype
)
| 是 | 要订阅的心率传感器类型为SENSOR_TYPE_ID_HEART_RATE。
|
| callback | Callback
<
[HeartRateResponse](#heartrateresponse)
>
| 是
| 注册一次心率传感器的回调函数，上报的数据类型为HeartRateResponse。 |
-
示例：
**示例：**
```
sensor.on(sensor.SensorType.SENSOR_TYPE_ID_HEART_RATE,function(data){
...
...
@@ -537,14 +537,14 @@ on(type: SensorType.SENSOR_TYPE_ID_ROTATION_VECTOR,callback: Callback<Rotatio
**系统能力**
：SystemCapability.Sensors.Sensor
-
参数：
| 参数名 | 类型 | 必填 | 说明
|
| -------- | -------- | -------- |
-------- |
| type |
[
SensorType
](
#sensortype
)
| 是
| 要订阅的旋转矢量传感器类型为SENSOR_TYPE_ID_ROTATION_VECTOR。 |
| callback | Callback
<
[RotationVectorResponse](#rotationvectorresponse)
>
| 是
| 注册旋转矢量传感器的回调函数，上报的数据类型为RotationVectorResponse。 |
| options |
[
Options
](
#options
)
| 否 | 可选参数列表，设置上报频率，默认值为200000000ns。
|
**参数：**
| 参数名 | 类型 | 必填 | 说明
|
| -------- | ---------------------------------------- | ---- | --------------------------------
-------- |
| type |
[
SensorType
](
#sensortype
)
| 是
| 要订阅的旋转矢量传感器类型为SENSOR_TYPE_ID_ROTATION_VECTOR。 |
| callback | Callback
<
[RotationVectorResponse](#rotationvectorresponse)
>
| 是
| 注册旋转矢量传感器的回调函数，上报的数据类型为RotationVectorResponse。 |
| options |
[
Options
](
#options
)
| 否 | 可选参数列表，设置上报频率，默认值为200000000ns。
|
-
示例：
**示例：**
```
sensor.on(sensor.SensorType.SENSOR_TYPE_ID_ROTATION_VECTOR,function(data){
console.info('X-coordinate component: ' + data.x);
...
...
@@ -565,14 +565,14 @@ on(type: SensorType.SENSOR_TYPE_ID_WEAR_DETECTION, callback: Callback<WearDet
**系统能力**
：SystemCapability.Sensors.Sensor
-
参数：
| 参数名 | 类型 | 必填 | 说明
|
| -------- | -------- | -------- |
-------- |
| type |
[
SensorType
](
#sensortype
)
| 是
| 要订阅的佩戴检测传感器类型为SENSOR_TYPE_ID_WEAR_DETECTION。 |
| callback | Callback
<
[WearDetectionResponse](#weardetectionresponse)
>
| 是
| 注册佩戴检测传感器的回调函数，上报的数据类型为WearDetectionResponse。 |
| options |
[
Options
](
#options
)
| 否 | 可选参数列表，设置上报频率，默认值为200000000ns。
|
**参数：**
| 参数名 | 类型 | 必填 | 说明
|
| -------- | ---------------------------------------- | ---- | --------------------------------
-------- |
| type |
[
SensorType
](
#sensortype
)
| 是
| 要订阅的佩戴检测传感器类型为SENSOR_TYPE_ID_WEAR_DETECTION。 |
| callback | Callback
<
[WearDetectionResponse](#weardetectionresponse)
>
| 是
| 注册佩戴检测传感器的回调函数，上报的数据类型为WearDetectionResponse。 |
| options |
[
Options
](
#options
)
| 否 | 可选参数列表，设置上报频率，默认值为200000000ns。
|
-
示例：
**示例：**
```
sensor.on(sensor.SensorType.SENSOR_TYPE_ID_WEAR_DETECTION,function(data){
console.info('Wear status: ' + data.value);
...
...
@@ -592,13 +592,13 @@ once(type: SensorType.SENSOR_TYPE_ID_ACCELEROMETER, callback: Callback<Accele
**系统能力**
：SystemCapability.Sensors.Sensor
-
参数：
| 参数名 | 类型 | 必填 | 说明
|
| -------- | -------- | -------- |
-------- |
| type |
[
SensorType
](
#sensortype
)
| 是 | 加速度传感器类型为SENSOR_TYPE_ID_ACCELEROMETER。
|
| callback | Callback
<
[AccelerometerResponse](#accelerometerresponse)
>
| 是
| 注册一次加速度传感器的回调函数，上报的数据类型为AccelerometerResponse。 |
**参数：**
| 参数名 | 类型 | 必填 | 说明
|
| -------- | ---------------------------------------- | ---- | --------------------------------
-------- |
| type |
[
SensorType
](
#sensortype
)
| 是 | 加速度传感器类型为SENSOR_TYPE_ID_ACCELEROMETER。
|
| callback | Callback
<
[AccelerometerResponse](#accelerometerresponse)
>
| 是
| 注册一次加速度传感器的回调函数，上报的数据类型为AccelerometerResponse。 |
-
示例：
**示例：**
```
sensor.once(sensor.SensorType.SENSOR_TYPE_ID_ACCELEROMETER,function(data){
console.info('X-coordinate component: ' + data.x);
...
...
@@ -619,13 +619,13 @@ once(type: SensorType.SENSOR_TYPE_ID_LINEAR_ACCELERATION,callback:Callback<Li
**系统能力**
：SystemCapability.Sensors.Sensor
-
参数：
| 参数名 | 类型 | 必填 | 说明
|
| -------- | -------- | -------- |
-------- |
| type |
[
SensorType
](
#sensortype
)
| 是
| 线性加速度传感器类型为SENSOR_TYPE_ID_LINEAR_ACCELERATION。 |
| callback | Callback
<
[LinearAccelerometerResponse](#linearaccelerometerresponse)
>
| 是
| 注册一次线性加速度传感器的回调函数，上报的数据类型为LinearAccelerometerResponse。 |
**参数：**
| 参数名 | 类型 | 必填 | 说明
|
| -------- | ---------------------------------------- | ---- | --------------------------------
-------- |
| type |
[
SensorType
](
#sensortype
)
| 是
| 线性加速度传感器类型为SENSOR_TYPE_ID_LINEAR_ACCELERATION。 |
| callback | Callback
<
[LinearAccelerometerResponse](#linearaccelerometerresponse)
>
| 是
| 注册一次线性加速度传感器的回调函数，上报的数据类型为LinearAccelerometerResponse。 |
-
示例：
**示例：**
```
sensor.once(sensor.SensorType.SENSOR_TYPE_ID_LINEAR_ACCELERATION, function(data) {
console.info('X-coordinate component: ' + data.x);
...
...
@@ -646,13 +646,13 @@ once(type: SensorType.SENSOR_TYPE_ID_ACCELEROMETER_UNCALIBRATED,callback: Callba
**系统能力**
：SystemCapability.Sensors.Sensor
-
参数：
| 参数名 | 类型 | 必填 | 说明
|
| -------- | -------- | -------- |
-------- |
| type |
[
SensorType
](
#sensortype
)
| 是
| 未校准加速度传感器类型为SENSOR_TYPE_ID_ACCELEROMETER_UNCALIBRATED。 |
| callback | Callback
<
[AccelerometerUncalibratedResponse](#accelerometeruncalibratedresponse)
>
| 是
| 注册一次未校准加速度传感器的回调函数，上报的数据类型为AccelerometerUncalibratedResponse。 |
**参数：**
| 参数名 | 类型 | 必填 | 说明
|
| -------- | ---------------------------------------- | ---- | --------------------------------
-------- |
| type |
[
SensorType
](
#sensortype
)
| 是
| 未校准加速度传感器类型为SENSOR_TYPE_ID_ACCELEROMETER_UNCALIBRATED。 |
| callback | Callback
<
[AccelerometerUncalibratedResponse](#accelerometeruncalibratedresponse)
>
| 是
| 注册一次未校准加速度传感器的回调函数，上报的数据类型为AccelerometerUncalibratedResponse。 |
-
示例：
**示例：**
```
sensor.once(sensor.SensorType.SENSOR_TYPE_ID_ACCELEROMETER_UNCALIBRATED, function(data) {
console.info('X-coordinate component: ' + data.x);
...
...
@@ -674,13 +674,13 @@ once(type: SensorType.SENSOR_TYPE_ID_GRAVITY, callback: Callback<GravityRespo
**系统能力**
：SystemCapability.Sensors.Sensor
-
参数：
| 参数名 | 类型 | 必填 | 说明
|
| -------- | -------- | -------- |
-------- |
| type |
[
SensorType
](
#sensortype
)
| 是 | 重力传感器类型为SENSOR_TYPE_ID_GRAVITY。
|
| callback | Callback
<
[GravityResponse](#gravityresponse)
>
| 是
| 注册一次重力传感器的回调函数，上报的数据类型为GravityResponse。 |
**参数：**
| 参数名 | 类型 | 必填 | 说明
|
| -------- | ---------------------------------------- | ---- | -------------------------------
-------- |
| type |
[
SensorType
](
#sensortype
)
| 是 | 重力传感器类型为SENSOR_TYPE_ID_GRAVITY。
|
| callback | Callback
<
[GravityResponse](#gravityresponse)
>
| 是
| 注册一次重力传感器的回调函数，上报的数据类型为GravityResponse。 |
-
示例：
**示例：**
```
sensor.once(sensor.SensorType.SENSOR_TYPE_ID_GRAVITY, function(data) {
console.info('X-coordinate component: ' + data.x);
...
...
@@ -701,13 +701,13 @@ once(type: SensorType.SENSOR_TYPE_ID_GYROSCOPE, callback: Callback<GyroscopeR
**系统能力**
：SystemCapability.Sensors.Sensor
-
参数：
| 参数名 | 类型 | 必填 | 说明
|
| -------- | -------- | -------- |
-------- |
| type |
[
SensorType
](
#sensortype
)
| 是 | 陀螺仪传感器类型为SENSOR_TYPE_ID_GYROSCOPE。
|
| callback | Callback
<
[GyroscopeResponse](#gyroscoperesponse)
>
| 是
| 注册一次陀螺仪传感器的回调函数，上报的数据类型为GyroscopeResponse。 |
**参数：**
| 参数名 | 类型 | 必填 | 说明
|
| -------- | ---------------------------------------- | ---- | --------------------------------
-------- |
| type |
[
SensorType
](
#sensortype
)
| 是 | 陀螺仪传感器类型为SENSOR_TYPE_ID_GYROSCOPE。
|
| callback | Callback
<
[GyroscopeResponse](#gyroscoperesponse)
>
| 是
| 注册一次陀螺仪传感器的回调函数，上报的数据类型为GyroscopeResponse。 |
-
示例：
**示例：**
```
sensor.once(sensor.SensorType.SENSOR_TYPE_ID_GYROSCOPE, function(data) {
console.info('X-coordinate component: ' + data.x);
...
...
@@ -728,13 +728,13 @@ once(type: SensorType.SENSOR_TYPE_ID_GYROSCOPE_UNCALIBRATED,callback: Callback&l
**系统能力**
：SystemCapability.Sensors.Sensor
-
参数：
| 参数名 | 类型 | 必填 | 说明
|
| -------- | -------- | -------- |
-------- |
| type |
[
SensorType
](
#sensortype
)
| 是
| 未校准陀螺仪传感器类型为SENSOR_TYPE_ID_GYROSCOPE_UNCALIBRATED。 |
| callback | Callback
<
[GyroscopeUncalibratedResponse](#gyroscopeuncalibratedresponse)
>
| 是
| 注册一次未校准陀螺仪传感器的回调函数，上报的数据类型为GyroscopeUncalibratedResponse。 |
**参数：**
| 参数名 | 类型 | 必填 | 说明
|
| -------- | ---------------------------------------- | ---- | --------------------------------
-------- |
| type |
[
SensorType
](
#sensortype
)
| 是
| 未校准陀螺仪传感器类型为SENSOR_TYPE_ID_GYROSCOPE_UNCALIBRATED。 |
| callback | Callback
<
[GyroscopeUncalibratedResponse](#gyroscopeuncalibratedresponse)
>
| 是
| 注册一次未校准陀螺仪传感器的回调函数，上报的数据类型为GyroscopeUncalibratedResponse。 |
-
示例：
**示例：**
```
sensor.once(sensor.SensorType.SENSOR_TYPE_ID_GYROSCOPE_UNCALIBRATED, function(data) {
console.info('X-coordinate component: ' + data.x);
...
...
@@ -756,13 +756,13 @@ once(type: SensorType.SENSOR_TYPE_ID_SIGNIFICANT_MOTION,callback: Callback<Si
**系统能力**
：SystemCapability.Sensors.Sensor
-
参数：
| 参数名 | 类型 | 必填 | 说明
|
| -------- | -------- | -------- |
-------- |
| type |
[
SensorType
](
#sensortype
)
| 是
| 有效运动传感器类型为SENSOR_TYPE_ID_SIGNIFICANT_MOTION。 |
| callback | Callback
<
[SignificantMotionResponse](#significantmotionresponse)
>
| 是
| 注册一次有效运动传感器的回调函数，上报的数据类型为SignificantMotionResponse。 |
**参数：**
| 参数名 | 类型 | 必填 | 说明
|
| -------- | ---------------------------------------- | ---- | --------------------------------
-------- |
| type |
[
SensorType
](
#sensortype
)
| 是
| 有效运动传感器类型为SENSOR_TYPE_ID_SIGNIFICANT_MOTION。 |
| callback | Callback
<
[SignificantMotionResponse](#significantmotionresponse)
>
| 是
| 注册一次有效运动传感器的回调函数，上报的数据类型为SignificantMotionResponse。 |
-
示例：
**示例：**
```
sensor.once(sensor.SensorType.SENSOR_TYPE_ID_SIGNIFICANT_MOTION, function(data) {
console.info('Scalar data: ' + data.scalar);
...
...
@@ -781,13 +781,13 @@ once(type: SensorType.SENSOR_TYPE_ID_PEDOMETER_DETECTION,callback: Callback<P
**系统能力**
：SystemCapability.Sensors.Sensor
-
参数：
| 参数名 | 类型 | 必填 | 说明
|
| -------- | -------- | -------- |
-------- |
| type |
[
SensorType
](
#sensortype
)
| 是
| 计步检测传感器类型为SENSOR_TYPE_ID_PEDOMETER_DETECTION。 |
| callback | Callback
<
[PedometerDetectionResponse](#pedometerdetectionresponse)
>
| 是
| 注册一次计步检测传感器的回调函数，上报的数据类型为PedometerDetectionResponse。 |
**参数：**
| 参数名 | 类型 | 必填 | 说明
|
| -------- | ---------------------------------------- | ---- | --------------------------------
-------- |
| type |
[
SensorType
](
#sensortype
)
| 是
| 计步检测传感器类型为SENSOR_TYPE_ID_PEDOMETER_DETECTION。 |
| callback | Callback
<
[PedometerDetectionResponse](#pedometerdetectionresponse)
>
| 是
| 注册一次计步检测传感器的回调函数，上报的数据类型为PedometerDetectionResponse。 |
-
示例：
**示例：**
```
sensor.once(sensor.SensorType.SENSOR_TYPE_ID_PEDOMETER_DETECTION, function(data) {
console.info('Scalar data: ' + data.scalar);
...
...
@@ -806,13 +806,13 @@ once(type: SensorType.SENSOR_TYPE_ID_PEDOMETER, callback: Callback<PedometerR
**系统能力**
：SystemCapability.Sensors.Sensor
-
参数：
| 参数名 | 类型 | 必填 | 说明
|
| -------- | -------- | -------- |
-------- |
| type |
[
SensorType
](
#sensortype
)
| 是 | 计步传感器类型为SENSOR_TYPE_ID_PEDOMETER。
|
| callback | Callback
<
[PedometerResponse](#pedometerresponse)
>
| 是
| 注册一次计步传感器的回调函数，上报的数据类型为PedometerResponse。 |
**参数：**
| 参数名 | 类型 | 必填 | 说明
|
| -------- | ---------------------------------------- | ---- | --------------------------------
-------- |
| type |
[
SensorType
](
#sensortype
)
| 是 | 计步传感器类型为SENSOR_TYPE_ID_PEDOMETER。
|
| callback | Callback
<
[PedometerResponse](#pedometerresponse)
>
| 是
| 注册一次计步传感器的回调函数，上报的数据类型为PedometerResponse。 |
-
示例：
**示例：**
```
sensor.once(sensor.SensorType.SENSOR_TYPE_ID_PEDOMETER, function(data) {
console.info('Steps: ' + data.steps);
...
...
@@ -829,13 +829,13 @@ once(type: SensorType.SENSOR_TYPE_ID_AMBIENT_TEMPERATURE,callback: Callback<A
**系统能力**
：SystemCapability.Sensors.Sensor
-
参数：
| 参数名 | 类型 | 必填 | 说明
|
| -------- | -------- | -------- |
-------- |
| type |
[
SensorType
](
#sensortype
)
| 是
| 环境温度传感器类型为SENSOR_TYPE_ID_AMBIENT_TEMPERATURE。 |
| callback | Callback
<
[AmbientTemperatureResponse](#ambienttemperatureresponse)
>
| 是
| 注册一次环境温度传感器的回调函数，上报的数据类型为AmbientTemperatureResponse。 |
**参数：**
| 参数名 | 类型 | 必填 | 说明
|
| -------- | ---------------------------------------- | ---- | --------------------------------
-------- |
| type |
[
SensorType
](
#sensortype
)
| 是
| 环境温度传感器类型为SENSOR_TYPE_ID_AMBIENT_TEMPERATURE。 |
| callback | Callback
<
[AmbientTemperatureResponse](#ambienttemperatureresponse)
>
| 是
| 注册一次环境温度传感器的回调函数，上报的数据类型为AmbientTemperatureResponse。 |
-
示例：
**示例：**
```
sensor.once(sensor.SensorType.SENSOR_TYPE_ID_AMBIENT_TEMPERATURE, function(data) {
console.info('Temperature: ' + data.temperature);
...
...
@@ -852,13 +852,13 @@ once(type: SensorType.SENSOR_TYPE_ID_MAGNETIC_FIELD, callback: Callback<Magne
**系统能力**
：SystemCapability.Sensors.Sensor
-
参数：
| 参数名 | 类型 | 必填 | 说明
|
| -------- | -------- | -------- |
-------- |
| type |
[
SensorType
](
#sensortype
)
| 是 | 磁场传感器类型为SENSOR_TYPE_ID_MAGNETIC_FIELD。
|
| callback | Callback
<
[MagneticFieldResponse](#magneticfieldresponse)
>
| 是
| 注册一次磁场传感器的回调函数，上报的数据类型为MagneticFieldResponse。 |
**参数：**
| 参数名 | 类型 | 必填 | 说明
|
| -------- | ---------------------------------------- | ---- | --------------------------------
-------- |
| type |
[
SensorType
](
#sensortype
)
| 是 | 磁场传感器类型为SENSOR_TYPE_ID_MAGNETIC_FIELD。
|
| callback | Callback
<
[MagneticFieldResponse](#magneticfieldresponse)
>
| 是
| 注册一次磁场传感器的回调函数，上报的数据类型为MagneticFieldResponse。 |
-
示例：
**示例：**
```
sensor.once(sensor.SensorType.SENSOR_TYPE_ID_MAGNETIC_FIELD, function(data) {
console.info('X-coordinate component: ' + data.x);
...
...
@@ -877,13 +877,13 @@ once(type: SensorType.SENSOR_TYPE_ID_MAGNETIC_FIELD_UNCALIBRATED,callback: Callb
**系统能力**
：SystemCapability.Sensors.Sensor
-
参数：
| 参数名 | 类型 | 必填 | 说明
|
| -------- | -------- | -------- |
-------- |
| type |
[
SensorType
](
#sensortype
)
| 是
| 未校准磁场传感器类型为SENSOR_TYPE_ID_MAGNETIC_FIELD_UNCALIBRATED。 |
| callback | Callback
<
[MagneticFieldUncalibratedResponse](#magneticfielduncalibratedresponse)
>
| 是
| 注册一次未校准磁场传感器的回调函数，上报的数据类型为MagneticFieldUncalibratedResponse。 |
**参数：**
| 参数名 | 类型 | 必填 | 说明
|
| -------- | ---------------------------------------- | ---- | --------------------------------
-------- |
| type |
[
SensorType
](
#sensortype
)
| 是
| 未校准磁场传感器类型为SENSOR_TYPE_ID_MAGNETIC_FIELD_UNCALIBRATED。 |
| callback | Callback
<
[MagneticFieldUncalibratedResponse](#magneticfielduncalibratedresponse)
>
| 是
| 注册一次未校准磁场传感器的回调函数，上报的数据类型为MagneticFieldUncalibratedResponse。 |
-
示例：
**示例：**
```
sensor.once(sensor.SensorType.SENSOR_TYPE_ID_MAGNETIC_FIELD_UNCALIBRATED, function(data) {
console.info('X-coordinate component: ' + data.x);
...
...
@@ -905,13 +905,13 @@ once(type: SensorType.SENSOR_TYPE_ID_PROXIMITY, callback: Callback<ProximityR
**系统能力**
：SystemCapability.Sensors.Sensor
-
参数：
| 参数名 | 类型 | 必填 | 说明
|
| -------- | -------- | -------- |
-------- |
| type |
[
SensorType
](
#sensortype
)
| 是 | 接近光传感器类型为SENSOR_TYPE_ID_PROXIMITY。
|
| callback | Callback
<
[ProximityResponse](#proximityresponse)
>
| 是
| 注册一次接近光传感器的回调函数，上报的数据类型为ProximityResponse。 |
**参数：**
| 参数名 | 类型 | 必填 | 说明
|
| -------- | ---------------------------------------- | ---- | --------------------------------
-------- |
| type |
[
SensorType
](
#sensortype
)
| 是 | 接近光传感器类型为SENSOR_TYPE_ID_PROXIMITY。
|
| callback | Callback
<
[ProximityResponse](#proximityresponse)
>
| 是
| 注册一次接近光传感器的回调函数，上报的数据类型为ProximityResponse。 |
-
示例：
**示例：**
```
sensor.once(sensor.SensorType.SENSOR_TYPE_ID_PROXIMITY, function(error, data) {
if (error) {
...
...
@@ -932,13 +932,13 @@ once(type: SensorType.SENSOR_TYPE_ID_HUMIDITY, callback: Callback<HumidityRes
**系统能力**
：SystemCapability.Sensors.Sensor
-
参数：
| 参数名 | 类型 | 必填 | 说明
|
| -------- | -------- | -------- |
-------- |
| type |
[
SensorType
](
#sensortype
)
| 是 | 湿度传感器类型为SENSOR_TYPE_ID_HUMIDITY。
|
| callback | Callback
<
[HumidityResponse](#humidityresponse)
>
| 是
| 注册一次湿度传感器的回调函数，上报的数据类型为HumidityResponse。 |
**参数：**
| 参数名 | 类型 | 必填 | 说明
|
| -------- | ---------------------------------------- | ---- | --------------------------------
-------- |
| type |
[
SensorType
](
#sensortype
)
| 是 | 湿度传感器类型为SENSOR_TYPE_ID_HUMIDITY。
|
| callback | Callback
<
[HumidityResponse](#humidityresponse)
>
| 是
| 注册一次湿度传感器的回调函数，上报的数据类型为HumidityResponse。 |
-
示例：
**示例：**
```
sensor.once(sensor.SensorType.SENSOR_TYPE_ID_HUMIDITY, function(data) {
console.info('Humidity: ' + data.humidity);
...
...
@@ -955,13 +955,13 @@ once(type: SensorType.SENSOR_TYPE_ID_BAROMETER, callback: Callback<BarometerR
**系统能力**
：SystemCapability.Sensors.Sensor
-
参数：
| 参数名 | 类型 | 必填 | 说明
|
| -------- | -------- | -------- |
-------- |
| type |
[
SensorType
](
#sensortype
)
| 是 | 气压计传感器类型为SENSOR_TYPE_ID_BAROMETER。
|
| callback | Callback
<
[BarometerResponse](#barometerresponse)
>
| 是
| 注册一次气压计传感器的回调函数，上报的数据类型为BarometerResponse。 |
**参数：**
| 参数名 | 类型 | 必填 | 说明
|
| -------- | ---------------------------------------- | ---- | --------------------------------
-------- |
| type |
[
SensorType
](
#sensortype
)
| 是 | 气压计传感器类型为SENSOR_TYPE_ID_BAROMETER。
|
| callback | Callback
<
[BarometerResponse](#barometerresponse)
>
| 是
| 注册一次气压计传感器的回调函数，上报的数据类型为BarometerResponse。 |
-
示例：
**示例：**
```
sensor.once(sensor.SensorType.SENSOR_TYPE_ID_BAROMETER, function(data) {
console.info('Atmospheric pressure: ' + data.pressure);
...
...
@@ -978,13 +978,13 @@ once(type: SensorType.SENSOR_TYPE_ID_HALL, callback: Callback<HallResponse>
**系统能力**
：SystemCapability.Sensors.Sensor
-
参数：
| 参数名 | 类型 | 必填 | 说明
|
| -------- | -------- | -------- |
-------- |
| type |
[
SensorType
](
#sensortype
)
| 是 | 霍尔传感器类型为SENSOR_TYPE_ID_HALL。
|
| callback | Callback
<
[HallResponse](#hallresponse)
>
| 是
| 注册一次霍尔传感器的回调函数，上报的数据类型为HallResponse。 |
**参数：**
| 参数名 | 类型 | 必填 | 说明
|
| -------- | ---------------------------------------- | ---- | ----------------------------
-------- |
| type |
[
SensorType
](
#sensortype
)
| 是 | 霍尔传感器类型为SENSOR_TYPE_ID_HALL。
|
| callback | Callback
<
[HallResponse](#hallresponse)
>
| 是
| 注册一次霍尔传感器的回调函数，上报的数据类型为HallResponse。 |
-
示例：
**示例：**
```
sensor.once(sensor.SensorType.SENSOR_TYPE_ID_HALL, function(data) {
console.info('Status: ' + data.status);
...
...
@@ -1001,13 +1001,13 @@ once(type: SensorType.SENSOR_TYPE_ID_AMBIENT_LIGHT, callback: Callback<LightR
**系统能力**
：SystemCapability.Sensors.Sensor
-
参数：
| 参数名 | 类型 | 必填 | 说明
|
| -------- | -------- | -------- |
-------- |
| type |
[
SensorType
](
#sensortype
)
| 是
| 环境光传感器类型为SENSOR_TYPE_ID_AMBIENT_LIGHT。 |
| callback | Callback
<
[LightResponse](#lightresponse)
>
| 是
| 注册一次环境光传感器的回调函数，上报的数据类型为LightResponse。 |
**参数：**
| 参数名 | 类型 | 必填 | 说明
|
| -------- | ---------------------------------------- | ---- | ------------------------------
-------- |
| type |
[
SensorType
](
#sensortype
)
| 是
| 环境光传感器类型为SENSOR_TYPE_ID_AMBIENT_LIGHT。 |
| callback | Callback
<
[LightResponse](#lightresponse)
>
| 是
| 注册一次环境光传感器的回调函数，上报的数据类型为LightResponse。 |
-
示例：
**示例：**
```
sensor.once(sensor.SensorType.SENSOR_TYPE_ID_AMBIENT_LIGHT, function(data) {
console.info(' Illumination: ' + data.intensity);
...
...
@@ -1024,13 +1024,13 @@ once(type: SensorType.SENSOR_TYPE_ID_ORIENTATION, callback: Callback<Orientat
**系统能力**
：SystemCapability.Sensors.Sensor
-
参数：
| 参数名 | 类型 | 必填 | 说明
|
| -------- | -------- | -------- |
-------- |
| type |
[
SensorType
](
#sensortype
)
| 是 | 方向传感器类型为SENSOR_TYPE_ID_ORIENTATION。
|
| callback | Callback
<
[OrientationResponse](#orientationresponse)
>
| 是
| 注册一次方向传感器的回调函数，上报的数据类型为OrientationResponse。 |
**参数：**
| 参数名 | 类型 | 必填 | 说明
|
| -------- | ---------------------------------------- | ---- | --------------------------------
-------- |
| type |
[
SensorType
](
#sensortype
)
| 是 | 方向传感器类型为SENSOR_TYPE_ID_ORIENTATION。
|
| callback | Callback
<
[OrientationResponse](#orientationresponse)
>
| 是
| 注册一次方向传感器的回调函数，上报的数据类型为OrientationResponse。 |
-
示例：
**示例：**
```
sensor.once(sensor.SensorType.SENSOR_TYPE_ID_ORIENTATION, function(data) {
console.info('The device rotates at an angle around the X axis: ' + data.beta);
...
...
@@ -1049,13 +1049,13 @@ once(type: SensorType.SENSOR_TYPE_ID_ROTATION_VECTOR, callback: Callback<Rota
**系统能力**
：SystemCapability.Sensors.Sensor
-
参数：
| 参数名 | 类型 | 必填 | 说明
|
| -------- | -------- | -------- |
-------- |
| type |
[
SensorType
](
#sensortype
)
| 是
| 旋转矢量传感器类型为SENSOR_TYPE_ID_ROTATION_VECTOR。 |
| callback | Callback
<
[RotationVectorResponse](#rotationvectorresponse)
>
| 是
| 注册一次旋转矢量传感器的回调函数，上报的数据类型为RotationVectorResponse。 |
**参数：**
| 参数名 | 类型 | 必填 | 说明
|
| -------- | ---------------------------------------- | ---- | --------------------------------
-------- |
| type |
[
SensorType
](
#sensortype
)
| 是
| 旋转矢量传感器类型为SENSOR_TYPE_ID_ROTATION_VECTOR。 |
| callback | Callback
<
[RotationVectorResponse](#rotationvectorresponse)
>
| 是
| 注册一次旋转矢量传感器的回调函数，上报的数据类型为RotationVectorResponse。 |
-
示例：
**示例：**
```
sensor.once(sensor.SensorType.SENSOR_TYPE_ID_ROTATION_VECTOR, function(data) {
console.info('X-coordinate component: ' + data.x);
...
...
@@ -1077,13 +1077,13 @@ once(type: SensorType.SENSOR_TYPE_ID_HEART_RATE, callback: Callback<HeartRate
**系统能力**
：SystemCapability.Sensors.Sensor
-
参数：
| 参数名 | 类型 | 必填 | 说明
|
| -------- | -------- | -------- |
-------- |
| type |
[
SensorType
](
#sensortype
)
| 是 | 心率传感器类型为SENSOR_TYPE_ID_HEART_RATE。
|
| callback | Callback
<
[HeartRateResponse](#heartrateresponse)
>
| 是
| 注册一次心率传感器的回调函数，上报的数据类型为HeartRateResponse。 |
**参数：**
| 参数名 | 类型 | 必填 | 说明
|
| -------- | ---------------------------------------- | ---- | --------------------------------
-------- |
| type |
[
SensorType
](
#sensortype
)
| 是 | 心率传感器类型为SENSOR_TYPE_ID_HEART_RATE。
|
| callback | Callback
<
[HeartRateResponse](#heartrateresponse)
>
| 是
| 注册一次心率传感器的回调函数，上报的数据类型为HeartRateResponse。 |
-
示例：
**示例：**
```
sensor.once(sensor.SensorType.SENSOR_TYPE_ID_HEART_RATE, function(data) {
console.info("Heart rate: " + data.heartRate);
...
...
@@ -1100,13 +1100,13 @@ once(type: SensorType.SENSOR_TYPE_ID_WEAR_DETECTION, callback: Callback<WearD
**系统能力**
：SystemCapability.Sensors.Sensor
-
参数：
| 参数名 | 类型 | 必填 | 说明
|
| -------- | -------- | -------- |
-------- |
| type |
[
SensorType
](
#sensortype
)
| 是
| 佩戴检测传感器类型为SENSOR_TYPE_ID_WEAR_DETECTION。 |
| callback | Callback
<
[WearDetectionResponse](#weardetectionresponse)
>
| 是
| 注册一次穿戴检测传感器的回调函数，上报的数据类型为WearDetectionResponse。 |
**参数：**
| 参数名 | 类型 | 必填 | 说明
|
| -------- | ---------------------------------------- | ---- | --------------------------------
-------- |
| type |
[
SensorType
](
#sensortype
)
| 是
| 佩戴检测传感器类型为SENSOR_TYPE_ID_WEAR_DETECTION。 |
| callback | Callback
<
[WearDetectionResponse](#weardetectionresponse)
>
| 是
| 注册一次穿戴检测传感器的回调函数，上报的数据类型为WearDetectionResponse。 |
-
示例：
**示例：**
```
sensor.once(sensor.SensorType.SENSOR_TYPE_ID_WEAR_DETECTION, function(data) {
console.info("Wear status: "+ data.value);
...
...
@@ -1124,14 +1124,14 @@ off(type: SensorType.SENSOR_TYPE_ID_ACCELEROMETER, callback?: Callback<Accele
**系统能力**
：SystemCapability.Sensors.Sensor
-
参数：
**参数：**
| 参数名
| 类型 | 必填 | 说明
|
| -------- | ----------------------------------------
-------------------- | ---- | --------------------
---------------------------------------- |
| type |
[
SensorType
](
#sensortype
)
| 是
| 要取消订阅的加速度传感器类型为SENSOR_TYPE_ID_ACCELEROMETER。 |
| callback | Callback
<
[AccelerometerResponse](#accelerometerresponse)
>
| 是 | 取消注册加速度传感器的回调函数，上报的数据类型为AccelerometerResponse。 |
| 参数名
| 类型 | 必填 | 说明
|
| -------- | ----------------------------------------
| ---- |
---------------------------------------- |
| type |
[
SensorType
](
#sensortype
)
| 是
| 要取消订阅的加速度传感器类型为SENSOR_TYPE_ID_ACCELEROMETER。 |
| callback | Callback
<
[AccelerometerResponse](#accelerometerresponse)
>
| 是
| 取消注册加速度传感器的回调函数，上报的数据类型为AccelerometerResponse。 |
-
示例：
**示例：**
```
function callback(data) {
...
...
@@ -1152,14 +1152,14 @@ off(type: SensorType.SENSOR_TYPE_ID_ACCELEROMETER_UNCALIBRATED, callback?: Callb
**系统能力**
：SystemCapability.Sensors.Sensor
-
参数：
**参数：**
| 参数名
| 类型 | 必填 | 说明
|
| -------- | ----------------------------------------
-------------------- | ---- | --------------------
---------------------------------------- |
| type |
[
SensorType
](
#sensortype
)
| 是
| 要取消订阅的未校准加速度计传感器类型为SENSOR_TYPE_ID_ACCELEROMETER_UNCALIBRATED。 |
| callback | Callback
<
[AccelerometerUncalibratedResponse](#accelerometeruncalibratedresponse)
>
| 是 | 取消注册未校准加速度计传感器的回调函数，上报的数据类型为AccelerometerUncalibratedResponse。 |
| 参数名
| 类型 | 必填 | 说明
|
| -------- | ----------------------------------------
| ---- |
---------------------------------------- |
| type |
[
SensorType
](
#sensortype
)
| 是
| 要取消订阅的未校准加速度计传感器类型为SENSOR_TYPE_ID_ACCELEROMETER_UNCALIBRATED。 |
| callback | Callback
<
[AccelerometerUncalibratedResponse](#accelerometeruncalibratedresponse)
>
| 是
| 取消注册未校准加速度计传感器的回调函数，上报的数据类型为AccelerometerUncalibratedResponse。 |
-
示例：
**示例：**
```
function callback(data) {
...
...
@@ -1181,14 +1181,14 @@ off(type: SensorType.SENSOR_TYPE_ID_AMBIENT_LIGHT, callback?: Callback<LightR
**系统能力**
：SystemCapability.Sensors.Sensor
-
参数：
**参数：**
| 参数名
| 类型 | 必填 | 说明
|
| -------- | ----------------------------------------
------- | ---- | --------------------
---------------------------------------- |
| type |
[
SensorType
](
#sensortype
)
| 是
| 要取消订阅的环境光传感器类型为SENSOR_TYPE_ID_AMBIENT_LIGHT。 |
| callback | Callback
<
[LightResponse](#lightresponse)
>
| 是
| 取消注册环境光传感器的回调函数，上报的数据类型为LightResponse。
|
| 参数名
| 类型 | 必填 | 说明
|
| -------- | ----------------------------------------
| ---- |
---------------------------------------- |
| type |
[
SensorType
](
#sensortype
)
| 是
| 要取消订阅的环境光传感器类型为SENSOR_TYPE_ID_AMBIENT_LIGHT。 |
| callback | Callback
<
[LightResponse](#lightresponse)
>
| 是
| 取消注册环境光传感器的回调函数，上报的数据类型为LightResponse。
|
-
示例：
**示例：**
```
function callback(data) {
...
...
@@ -1205,14 +1205,14 @@ off(type: SensorType.SENSOR_TYPE_ID_AMBIENT_TEMPERATURE, callback?: Callback<
**系统能力**
：SystemCapability.Sensors.Sensor
-
参数：
**参数：**
| 参数名
| 类型 | 必填 | 说明
|
| -------- | ----------------------------------------
-------------------- | ---- | --------------------
---------------------------------------- |
| type |
[
SensorType
](
#sensortype
)
| 是
| 要取消订阅的环境温度传感器类型为SENSOR_TYPE_ID_AMBIENT_TEMPERATURE。 |
| callback | Callback
<
[AmbientTemperatureResponse](#ambienttemperatureresponse)
>
| 是 | 取消注册环境温度传感器的回调函数，上报的数据类型为AmbientTemperatureResponse。 |
| 参数名
| 类型 | 必填 | 说明
|
| -------- | ----------------------------------------
| ---- |
---------------------------------------- |
| type |
[
SensorType
](
#sensortype
)
| 是
| 要取消订阅的环境温度传感器类型为SENSOR_TYPE_ID_AMBIENT_TEMPERATURE。 |
| callback | Callback
<
[AmbientTemperatureResponse](#ambienttemperatureresponse)
>
| 是
| 取消注册环境温度传感器的回调函数，上报的数据类型为AmbientTemperatureResponse。 |
-
示例：
**示例：**
```
function callback(data) {
...
...
@@ -1229,14 +1229,14 @@ off(type: SensorType.SENSOR_TYPE_ID_BAROMETER, callback?: Callback<BarometerR
**系统能力**
：SystemCapability.Sensors.Sensor
-
参数：
**参数：**
| 参数名
| 类型 | 必填 | 说明
|
| -------- | ----------------------------------------
--------------- | ---- | --------------------
---------------------------------------- |
| type |
[
SensorType
](
#sensortype
)
| 是 | 要取消订阅的气压计传感器类型为SENSOR_TYPE_ID_BAROMETER。
|
| callback | Callback
<
[BarometerResponse](#barometerresponse)
>
| 是 | 取消注册气压计传感器的回调函数，上报的数据类型为BarometerResponse。 |
| 参数名
| 类型 | 必填 | 说明
|
| -------- | ----------------------------------------
| ---- |
---------------------------------------- |
| type |
[
SensorType
](
#sensortype
)
| 是 | 要取消订阅的气压计传感器类型为SENSOR_TYPE_ID_BAROMETER。
|
| callback | Callback
<
[BarometerResponse](#barometerresponse)
>
| 是
| 取消注册气压计传感器的回调函数，上报的数据类型为BarometerResponse。 |
-
示例：
**示例：**
```
function callback(data) {
...
...
@@ -1253,14 +1253,14 @@ off(type: SensorType.SENSOR_TYPE_ID_GRAVITY, callback?: Callback<GravityRespo
**系统能力**
：SystemCapability.Sensors.Sensor
-
参数：
**参数：**
| 参数名
| 类型 | 必填 | 说明
|
| -------- | ----------------------------------------
----------- | ---- | --------------------
---------------------------------------- |
| type |
[
SensorType
](
#sensortype
)
| 是 | 要取消订阅的重力传感器类型为SENSOR_TYPE_ID_GRAVITY。
|
| callback | Callback
<
[GravityResponse](#gravityresponse)
>
| 是 | 取消注册注册重力传感器的回调函数，上报的数据类型为GravityResponse。 |
| 参数名
| 类型 | 必填 | 说明
|
| -------- | ----------------------------------------
| ---- |
---------------------------------------- |
| type |
[
SensorType
](
#sensortype
)
| 是 | 要取消订阅的重力传感器类型为SENSOR_TYPE_ID_GRAVITY。
|
| callback | Callback
<
[GravityResponse](#gravityresponse)
>
| 是
| 取消注册注册重力传感器的回调函数，上报的数据类型为GravityResponse。 |
-
示例：
**示例：**
```
function callback(data) {
...
...
@@ -1281,14 +1281,14 @@ off(type: SensorType.SENSOR_TYPE_ID_GYROSCOPE, callback?: Callback<GyroscopeR
**系统能力**
：SystemCapability.Sensors.Sensor
-
参数：
**参数：**
| 参数名
| 类型 | 必填 | 说明
|
| -------- | ----------------------------------------
--------------- | ---- | --------------------
---------------------------------------- |
| type |
[
SensorType
](
#sensortype
)
| 是 | 要取消订阅的陀螺仪传感器类型为SENSOR_TYPE_ID_GYROSCOPE。
|
| callback | Callback
<
[GyroscopeResponse](#gyroscoperesponse)
>
| 是 | 取消注册陀螺仪传感器的回调函数，上报的数据类型为GyroscopeResponse。 |
| 参数名
| 类型 | 必填 | 说明
|
| -------- | ----------------------------------------
| ---- |
---------------------------------------- |
| type |
[
SensorType
](
#sensortype
)
| 是 | 要取消订阅的陀螺仪传感器类型为SENSOR_TYPE_ID_GYROSCOPE。
|
| callback | Callback
<
[GyroscopeResponse](#gyroscoperesponse)
>
| 是
| 取消注册陀螺仪传感器的回调函数，上报的数据类型为GyroscopeResponse。 |
-
示例：
**示例：**
```
function callback(data) {
...
...
@@ -1309,14 +1309,14 @@ off(type: SensorType.SENSOR_TYPE_ID_GYROSCOPE_UNCALIBRATED, callback?: Callback&
**系统能力**
：SystemCapability.Sensors.Sensor
-
参数：
**参数：**
| 参数名
| 类型 | 必填 | 说明
|
| -------- | ----------------------------------------
-------------------- | ---- | --------------------
---------------------------------------- |
| type |
[
SensorType
](
#sensortype
)
| 是
| 要取消订阅的未校准陀螺仪传感器类型为SENSOR_TYPE_ID_GYROSCOPE_UNCALIBRATED。 |
| callback | Callback
<
[GyroscopeUncalibratedResponse](#gyroscopeuncalibratedresponse)
>
| 是 | 取消注册未校准陀螺仪传感器的回调函数，上报的数据类型为GyroscopeUncalibratedResponse。 |
| 参数名
| 类型 | 必填 | 说明
|
| -------- | ----------------------------------------
| ---- |
---------------------------------------- |
| type |
[
SensorType
](
#sensortype
)
| 是
| 要取消订阅的未校准陀螺仪传感器类型为SENSOR_TYPE_ID_GYROSCOPE_UNCALIBRATED。 |
| callback | Callback
<
[GyroscopeUncalibratedResponse](#gyroscopeuncalibratedresponse)
>
| 是
| 取消注册未校准陀螺仪传感器的回调函数，上报的数据类型为GyroscopeUncalibratedResponse。 |
-
示例：
**示例：**
```
function callback(data) {
...
...
@@ -1335,14 +1335,14 @@ off(type: SensorType.SENSOR_TYPE_ID_HALL, callback?: Callback<HallResponse>
**系统能力**
：SystemCapability.Sensors.Sensor
-
参数：
**参数：**
| 参数名
| 类型 | 必填 | 说明
|
| -------- | ----------------------------------------
----- | ---- | --------------------
---------------------------------------- |
| type |
[
SensorType
](
#sensortype
)
| 是 | 要取消订阅的霍尔传感器类型为SENSOR_TYPE_ID_HALL。
|
| callback | Callback
<
[HallResponse](#hallresponse)
>
| 是 | 取消注册霍尔传感器的回调函数，上报的数据类型为
HallResponse。 |
| 参数名
| 类型 | 必填 | 说明
|
| -------- | ----------------------------------------
| ---- |
---------------------------------------- |
| type |
[
SensorType
](
#sensortype
)
| 是 | 要取消订阅的霍尔传感器类型为SENSOR_TYPE_ID_HALL。
|
| callback | Callback
<
[HallResponse](#hallresponse)
>
| 是
| 取消注册霍尔传感器的回调函数，上报的数据类型为
HallResponse。 |
-
示例：
**示例：**
```
function callback(data) {
...
...
@@ -1361,14 +1361,14 @@ off(type: SensorType.SENSOR_TYPE_ID_HEART_RATE, callback?: Callback<HeartRate
**系统能力**
：SystemCapability.Sensors.Sensor
-
参数：
**参数：**
| 参数名
| 类型 | 必填 | 说明
|
| -------- | ----------------------------------------
--------------- | ---- | --------------------
---------------------------------------- |
| type |
[
SensorType
](
#sensortype
)[
SensorType
]
(#sensortype)
| 是 | 要取消订阅的心率传感器类型为SENSOR_TYPE_ID_HEART_RATE。
|
| callback | Callback
<
[HeartRateResponse](#heartrateresponse)
>
| 是 | 取消注册一次心率传感器的回调函数，上报的数据类型为HeartRateResponse。 |
| 参数名
| 类型 | 必填 | 说明
|
| -------- | ----------------------------------------
| ---- |
---------------------------------------- |
| type |
[
SensorType
](
#sensortype
)[
SensorType
]
(#sensortype)
| 是 | 要取消订阅的心率传感器类型为SENSOR_TYPE_ID_HEART_RATE。
|
| callback | Callback
<
[HeartRateResponse](#heartrateresponse)
>
| 是
| 取消注册一次心率传感器的回调函数，上报的数据类型为HeartRateResponse。 |
-
示例：
**示例：**
```
function callback(data) {
...
...
@@ -1387,14 +1387,14 @@ off(type: SensorType.SENSOR_TYPE_ID_HUMIDITY, callback?: Callback<HumidityRes
**系统能力**
：SystemCapability.Sensors.Sensor
-
参数：
**参数：**
| 参数名
| 类型 | 必填 | 说明
|
| -------- | ----------------------------------------
------------- | ---- | --------------------
---------------------------------------- |
| type |
[
SensorType
](
#sensortype
)
| 是 | 要取消订阅的湿度传感器类型为SENSOR_TYPE_ID_HUMIDITY。
|
| callback | Callback
<
[HumidityResponse](#humidityresponse)
>
| 是 | 取消注册湿度传感器的回调函数，上报的数据类型为HumidityResponse。 |
| 参数名
| 类型 | 必填 | 说明
|
| -------- | ----------------------------------------
| ---- |
---------------------------------------- |
| type |
[
SensorType
](
#sensortype
)
| 是 | 要取消订阅的湿度传感器类型为SENSOR_TYPE_ID_HUMIDITY。
|
| callback | Callback
<
[HumidityResponse](#humidityresponse)
>
| 是
| 取消注册湿度传感器的回调函数，上报的数据类型为HumidityResponse。 |
-
示例：
**示例：**
```
function callback(data) {
...
...
@@ -1413,14 +1413,14 @@ off(type: SensorType.SENSOR_TYPE_ID_LINEAR_ACCELERATION, callback?: Callback<
**系统能力**
：SystemCapability.Sensors.Sensor
-
参数：
**参数：**
| 参数名
| 类型 | 必填 | 说明
|
| -------- | ----------------------------------------
-------------------- | ---- | --------------------
---------------------------------------- |
| type |
[
SensorType
](
#sensortype
)
| 是
| 要取消订阅的线性加速度传感器类型为SENSOR_TYPE_ID_LINEAR_ACCELERATION。 |
| callback | Callback
<
[LinearAccelerometerResponse](#linearaccelerometerresponse)
>
| 是 | 取消注册性加速度传感器的回调函数，上报的数据类型为LinearAccelerometerResponse。 |
| 参数名
| 类型 | 必填 | 说明
|
| -------- | ----------------------------------------
| ---- |
---------------------------------------- |
| type |
[
SensorType
](
#sensortype
)
| 是
| 要取消订阅的线性加速度传感器类型为SENSOR_TYPE_ID_LINEAR_ACCELERATION。 |
| callback | Callback
<
[LinearAccelerometerResponse](#linearaccelerometerresponse)
>
| 是
| 取消注册性加速度传感器的回调函数，上报的数据类型为LinearAccelerometerResponse。 |
-
示例：
**示例：**
```
function callback(data) {
...
...
@@ -1441,14 +1441,14 @@ sensor.off(sensor.SensorType.SENSOR_TYPE_ID_LINEAR_ACCELERATION, callback);
**系统能力**
：SystemCapability.Sensors.Sensor
-
参数：
**参数：**
| 参数名
| 类型 | 必填 | 说明
|
| ---------------- | ----------------------------------------
-------------------- | ---- | --------------------
---------------------------------------- |
| type |
[
SensorType
](
#sensortype
)
| 是 | 要取消订阅的磁场传感器类型为SENSOR_TYPE_ID_MAGNETIC_FIELD。
|
| callbackcallback | Callback
<
[MagneticFieldResponse](#magneticfieldresponse)
>
| 是 | 取消注册磁场传感器的回调函数，上报的数据类型为MagneticFieldResponse。 |
| 参数名
| 类型 | 必填 | 说明
|
| ---------------- | ----------------------------------------
| ---- |
---------------------------------------- |
| type |
[
SensorType
](
#sensortype
)
| 是 | 要取消订阅的磁场传感器类型为SENSOR_TYPE_ID_MAGNETIC_FIELD。
|
| callbackcallback | Callback
<
[MagneticFieldResponse](#magneticfieldresponse)
>
| 是
| 取消注册磁场传感器的回调函数，上报的数据类型为MagneticFieldResponse。 |
-
示例：
**示例：**
```
function callback(data) {
...
...
@@ -1467,14 +1467,14 @@ sensor.off(sensor.SensorType.SENSOR_TYPE_ID_MAGNETIC_FIELD, callback);
**系统能力**
：SystemCapability.Sensors.Sensor
-
参数：
**参数：**
| 参数名
| 类型 | 必填 | 说明
|
| -------- | ----------------------------------------
-------------------- | ---- | --------------------
---------------------------------------- |
| type |
[
SensorType
](
#sensortype
)
| 是
| 要取消订阅的未校准磁场传感器类型为SENSOR_TYPE_ID_MAGNETIC_FIELD_UNCALIBRATED。 |
| callback | Callback
<
[MagneticFieldUncalibratedResponse](#magneticfielduncalibratedresponse)
>
| 是 | 取消注册未校准磁场传感器的回调函数，上报的数据类型为MagneticFieldUncalibratedResponse。 |
| 参数名
| 类型 | 必填 | 说明
|
| -------- | ----------------------------------------
| ---- |
---------------------------------------- |
| type |
[
SensorType
](
#sensortype
)
| 是
| 要取消订阅的未校准磁场传感器类型为SENSOR_TYPE_ID_MAGNETIC_FIELD_UNCALIBRATED。 |
| callback | Callback
<
[MagneticFieldUncalibratedResponse](#magneticfielduncalibratedresponse)
>
| 是
| 取消注册未校准磁场传感器的回调函数，上报的数据类型为MagneticFieldUncalibratedResponse。 |
-
示例：
**示例：**
```
function callback(data) {
...
...
@@ -1496,14 +1496,14 @@ sensor.off(sensor.SensorType.SENSOR_TYPE_ID_MAGNETIC_FIELD_UNCALIBRATED, callbac
**系统能力**
：SystemCapability.Sensors.Sensor
-
参数：
**参数：**
| 参数名
| 类型 | 必填 | 说明
|
| -------- | ----------------------------------------
------------------- | ---- | --------------------
---------------------------------------- |
| type |
[
SensorType
](
#sensortype
)
| 是 | 要取消订阅的方向传感器类型为SENSOR_TYPE_ID_ORIENTATION
|
| callback | Callback
<
[OrientationResponse](#orientationresponse)
>
| 是 | 取消注册方向传感器的回调函数，上报的数据类型为OrientationResponse。 |
| 参数名
| 类型 | 必填 | 说明
|
| -------- | ----------------------------------------
| ---- |
---------------------------------------- |
| type |
[
SensorType
](
#sensortype
)
| 是 | 要取消订阅的方向传感器类型为SENSOR_TYPE_ID_ORIENTATION
|
| callback | Callback
<
[OrientationResponse](#orientationresponse)
>
| 是
| 取消注册方向传感器的回调函数，上报的数据类型为OrientationResponse。 |
-
示例：
**示例：**
```
function callback(data) {
...
...
@@ -1522,14 +1522,14 @@ off(type: SensorType.SENSOR_TYPE_ID_PEDOMETER, callback?: Callback<PedometerR
**系统能力**
：SystemCapability.Sensors.Sensor
-
参数：
**参数：**
| 参数名
| 类型 | 必填 | 说明
|
| -------- | ----------------------------------------
--------------- | ---- | --------------------
---------------------------------------- |
| type |
[
SensorType
](
#sensortype
)
| 是 | 要取消订阅的计步传感器类型为SENSOR_TYPE_ID_PEDOMETER。
|
| callback | Callback
<
[PedometerResponse](#pedometerresponse)
>
| 是 | 取消注册计步传感器的回调函数，上报的数据类型为PedometerResponse。 |
| 参数名
| 类型 | 必填 | 说明
|
| -------- | ----------------------------------------
| ---- |
---------------------------------------- |
| type |
[
SensorType
](
#sensortype
)
| 是 | 要取消订阅的计步传感器类型为SENSOR_TYPE_ID_PEDOMETER。
|
| callback | Callback
<
[PedometerResponse](#pedometerresponse)
>
| 是
| 取消注册计步传感器的回调函数，上报的数据类型为PedometerResponse。 |
-
示例
;
**返回值：**
;
```
function callback(data) {
...
...
@@ -1548,14 +1548,14 @@ off(type: SensorType.SENSOR_TYPE_ID_PEDOMETER_DETECTION, callback?: Callback<
**系统能力**
：SystemCapability.Sensors.Sensor
-
参数：
**参数：**
| 参数名
| 类型 | 必填 | 说明
|
| -------- | ----------------------------------------
-------------------- | ---- | --------------------
---------------------------------------- |
| type |
[
SensorType
](
#sensortype
)
| 是
| 要取消订阅的计步检测传感器类型为SENSOR_TYPE_ID_PEDOMETER_DETECTION。 |
| callback | Callback
<
[PedometerDetectionResponse](#pedometerdetectionresponse)
>
| 是 | 取消注册计步检测传感器的回调函数，上报的数据类型为PedometerDetectionResponse。 |
| 参数名
| 类型 | 必填 | 说明
|
| -------- | ----------------------------------------
| ---- |
---------------------------------------- |
| type |
[
SensorType
](
#sensortype
)
| 是
| 要取消订阅的计步检测传感器类型为SENSOR_TYPE_ID_PEDOMETER_DETECTION。 |
| callback | Callback
<
[PedometerDetectionResponse](#pedometerdetectionresponse)
>
| 是
| 取消注册计步检测传感器的回调函数，上报的数据类型为PedometerDetectionResponse。 |
-
示例：
**示例：**
```
function callback(data) {
...
...
@@ -1572,14 +1572,14 @@ off(type: SensorType.SENSOR_TYPE_ID_PROXIMITY, callback?: Callback<ProximityR
**系统能力**
：SystemCapability.Sensors.Sensor
-
参数：
**参数：**
| 参数名
| 类型 | 必填 | 说明
|
| -------- | ----------------------------------------
--------------- | ---- | --------------------
---------------------------------------- |
| type |
[
SensorType
](
#sensortype
)
| 是 | 要取消订阅的接近光传感器类型为SENSOR_TYPE_ID_PROXIMITY。
|
| callback | Callback
<
[ProximityResponse](#proximityresponse)
>
| 是 | 取消注册接近光传感器的回调函数，上报的数据类型为ProximityResponse。 |
| 参数名
| 类型 | 必填 | 说明
|
| -------- | ----------------------------------------
| ---- |
---------------------------------------- |
| type |
[
SensorType
](
#sensortype
)
| 是 | 要取消订阅的接近光传感器类型为SENSOR_TYPE_ID_PROXIMITY。
|
| callback | Callback
<
[ProximityResponse](#proximityresponse)
>
| 是
| 取消注册接近光传感器的回调函数，上报的数据类型为ProximityResponse。 |
-
示例：
**示例：**
```
function callback(data) {
...
...
@@ -1596,14 +1596,14 @@ off(type: SensorType.SENSOR_TYPE_ID_ROTATION_VECTOR, callback?: Callback<Rota
**系统能力**
：SystemCapability.Sensors.Sensor
-
参数：
**参数：**
| 参数名
| 类型 | 必填 | 说明
|
| -------- | ----------------------------------------
-------------------- | ---- | --------------------
---------------------------------------- |
| type |
[
SensorType
](
#sensortype
)
| 是
| 要取消订阅的旋转矢量传感器类型为SENSOR_TYPE_ID_ROTATION_VECTOR。 |
| callback | Callback
<
[RotationVectorResponse](#rotationvectorresponse)
>
| 是 | 取消注册旋转矢量传感器的回调函数，上报的数据类型为RotationVectorResponse。 |
| 参数名
| 类型 | 必填 | 说明
|
| -------- | ----------------------------------------
| ---- |
---------------------------------------- |
| type |
[
SensorType
](
#sensortype
)
| 是
| 要取消订阅的旋转矢量传感器类型为SENSOR_TYPE_ID_ROTATION_VECTOR。 |
| callback | Callback
<
[RotationVectorResponse](#rotationvectorresponse)
>
| 是
| 取消注册旋转矢量传感器的回调函数，上报的数据类型为RotationVectorResponse。 |
-
示例：
**示例：**
```
function callback(data) {
...
...
@@ -1623,14 +1623,14 @@ off(type: SensorType.SENSOR_TYPE_ID_SIGNIFICANT_MOTION, callback?: Callback<S
**系统能力**
：SystemCapability.Sensors.Sensor
-
参数：
**参数：**
| 参数名
| 类型 | 必填 | 说明
|
| -------- | ----------------------------------------
-------------------- | ---- | --------------------
---------------------------------------- |
| type |
[
SensorType
](
#sensortype
)
| 是
| 要取消订阅的大幅动作传感器类型为SENSOR_TYPE_ID_SIGNIFICANT_MOTION。 |
| callback | Callback
<
[SignificantMotionResponse](#significantmotionresponse)
>
| 是 | 取消注册有效运动传感器的回调函数，上报的数据类型为SignificantMotionResponse。 |
| 参数名
| 类型 | 必填 | 说明
|
| -------- | ----------------------------------------
| ---- |
---------------------------------------- |
| type |
[
SensorType
](
#sensortype
)
| 是
| 要取消订阅的大幅动作传感器类型为SENSOR_TYPE_ID_SIGNIFICANT_MOTION。 |
| callback | Callback
<
[SignificantMotionResponse](#significantmotionresponse)
>
| 是
| 取消注册有效运动传感器的回调函数，上报的数据类型为SignificantMotionResponse。 |
-
示例：
**示例：**
```
function callback(data) {
...
...
@@ -1647,14 +1647,14 @@ off(type: SensorType.SENSOR_TYPE_ID_WEAR_DETECTION, callback?: Callback<WearD
**系统能力**
：SystemCapability.Sensors.Sensor
-
参数：
**参数：**
| 参数名
| 类型 | 必填 | 说明
|
| -------- | ----------------------------------------
-------------------- | ---- | --------------------
---------------------------------------- |
| type |
[
SensorType
](
#sensortype
)
| 是
| 要取消订阅的佩戴检测传感器类型为SENSOR_TYPE_ID_WEAR_DETECTION。 |
| callback | Callback
<
[WearDetectionResponse](#weardetectionresponse)
>
| 是 | 取消注册佩戴检测传感器的回调函数，上报的数据类型为WearDetectionResponse。 |
| 参数名
| 类型 | 必填 | 说明
|
| -------- | ----------------------------------------
| ---- |
---------------------------------------- |
| type |
[
SensorType
](
#sensortype
)
| 是
| 要取消订阅的佩戴检测传感器类型为SENSOR_TYPE_ID_WEAR_DETECTION。 |
| callback | Callback
<
[WearDetectionResponse](#weardetectionresponse)
>
| 是
| 取消注册佩戴检测传感器的回调函数，上报的数据类型为WearDetectionResponse。 |
-
示例：
**示例：**
```
function accCallback(data) {
...
...
@@ -1671,29 +1671,28 @@ transformCoordinateSystem(inRotationVector: Array<number>, coordinates: Co
**系统能力**
：SystemCapability.Sensors.Sensor
-
参数
**参数：**
| 参数名 | 类型 | 必填 | 说明
|
| ---------------- | ----------------------------------------- | ---- | -----------
----------- |
| inRotationVector | Array
<
number
>
| 是 | 表示旋转矩阵。
|
| coordinates |
[
CoordinatesOptions
](
#coordinatesoptions
)
| 是 | 表示坐标系方向。
|
| callback | AsyncCallback
<
Array
<
number
>>
| 是
| 返回转换后的旋转矩阵。 |
| 参数名 | 类型 | 必填 | 说明
|
| ---------------- | ---------------------------------------- | ---- |
----------- |
| inRotationVector | Array
<
number
>
| 是 | 表示旋转矩阵。
|
| coordinates |
[
CoordinatesOptions
](
#coordinatesoptions
)
| 是 | 表示坐标系方向。
|
| callback | AsyncCallback
<
Array
<
number
>>
| 是
| 返回转换后的旋转矩阵。 |
-
示例
```
sensor.transformCoordinateSystem([1, 0, 0, 0, 1, 0, 0, 0, 1], {'axisX':2, 'axisY':3}, function(err, data) {
if (err) {
console.error("Operation failed. Error code: " + err.code + ", message: " + err.message);
return;
}
console.info("Operation successed. Data obtained: " + data.x);
for (var i=0; i < data.length; i++) {
console.info("transformCoordinateSystem data[ " + i + "] = " + data[i]);
}
})
```
**示例：**
```
sensor.transformCoordinateSystem([1, 0, 0, 0, 1, 0, 0, 0, 1], {'axisX':2, 'axisY':3}, function(err, data) {
if (err) {
console.error("Operation failed. Error code: " + err.code + ", message: " + err.message);
return;
}
console.info("Operation successed. Data obtained: " + data.x);
for (var i=0; i < data.length; i++) {
console.info("transformCoordinateSystem data[ " + i + "] = " + data[i]);
}
})
```
## sensor.transformCoordinateSystem
transformCoordinateSystem(inRotationVector: Array
<
number
>
, coordinates: CoordinatesOptions): Promise
<
Array
<
number
>>
...
...
@@ -1702,35 +1701,32 @@ transformCoordinateSystem(inRotationVector: Array<number>, coordinates: Co
**系统能力**
：SystemCapability.Sensors.Sensor
-
参数
| 参数名 | 类型 | 必填 | 说明 |
| ---------------- | ----------------------------------------- | ---- | ---------------- |
| inRotationVector | Array
<
number
>
| 是 | 表示旋转矩阵。 |
| coordinates |
[
CoordinatesOptions
](
#coordinatesoptions
)
| 是 | 表示坐标系方向。 |
-
返回值
**参数：**
| 类型 | 说明 |
| ---------------------------------- | ---------------------- |
| Promise
<
Array
<
number
>>
| 返回转换后的旋转矩阵。 |
| 参数名 | 类型 | 必填 | 说明 |
| ---------------- | ---------------------------------------- | ---- | -------- |
| inRotationVector | Array
<
number
>
| 是 | 表示旋转矩阵。 |
| coordinates |
[
CoordinatesOptions
](
#coordinatesoptions
)
| 是 | 表示坐标系方向。 |
-
示例
**返回值：**
```
const promise = sensor.transformCoordinateSystem([1, 0, 0, 0, 1, 0, 0, 0, 1], {'axisX':2, 'axisY':3});
promise.then((data) => {
console.info("Operation successed.");
for (var i=0; i < data.length; i++) {
console.info("transformCoordinateSystem data[ " + i + "] = " + data[i]);
}
}).catch((err) => {
console.info("Operation failed");
})
```
| 类型 | 说明 |
| ---------------------------------- | ----------- |
| Promise
<
Array
<
number
>>
| 返回转换后的旋转矩阵。 |
**示例：**
```
const promise = sensor.transformCoordinateSystem([1, 0, 0, 0, 1, 0, 0, 0, 1], {'axisX':2, 'axisY':3});
promise.then((data) => {
console.info("Operation successed.");
for (var i=0; i < data.length; i++) {
console.info("transformCoordinateSystem data[ " + i + "] = " + data[i]);
}
}).catch((err) => {
console.info("Operation failed");
})
```
## sensor.getGeomagneticField
...
...
@@ -1740,27 +1736,25 @@ getGeomagneticField(locationOptions: LocationOptions, timeMillis: number, callba
**系统能力**
：SystemCapability.Sensors.Sensor
-
参数
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| locationOptions |
[
LocationOptions
](
#locationoptions
)
| 是 | 地理位置。 |
| timeMillis | number | 是 | 表示获取磁偏角的时间，单位为毫秒。 |
| callback | AsyncCallback
<
[GeomagneticResponse](#geomagneticresponse)
>
| 是 | 返回磁场信息。 |
-
示例
```
sensor.getGeomagneticField([80, 0, 0], {'timeMillis':1580486400000}, function(err, data) {
if (err) {
console.error('Operation failed. Error code: ' + err.code + '; message: ' + err.message);
return;
}
console.info('sensor_getGeomagneticField_promise x: ' + data.x + ',y: ' + data.y + ',z: ' +
data.z + ',geomagneticDip: ' + data.geomagneticDip + ',deflectionAngle: ' + data.deflectionAngle +
',levelIntensity: ' + data.levelIntensity + ',totalIntensity: ' + data.totalIntensity);
});
```
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| --------------- | ---------------------------------------- | ---- | ----------------- |
| locationOptions |
[
LocationOptions
](
#locationoptions
)
| 是 | 地理位置。 |
| timeMillis | number | 是 | 表示获取磁偏角的时间，单位为毫秒。 |
| callback | AsyncCallback
<
[GeomagneticResponse](#geomagneticresponse)
>
| 是 | 返回磁场信息。 |
**示例：**
```
sensor.getGeomagneticField([80, 0, 0], {'timeMillis':1580486400000}, function(err, data) {
if (err) {
console.error('Operation failed. Error code: ' + err.code + '; message: ' + err.message);
return;
}
console.info('sensor_getGeomagneticField_promise x: ' + data.x + ',y: ' + data.y + ',z: ' +
data.z + ',geomagneticDip: ' + data.geomagneticDip + ',deflectionAngle: ' + data.deflectionAngle +
',levelIntensity: ' + data.levelIntensity + ',totalIntensity: ' + data.totalIntensity);
});
```
## sensor.getGeomagneticField
getGeomagneticField(locationOptions: LocationOptions, timeMillis: number): Promise
<
GeomagneticResponse
>
...
...
@@ -1769,18 +1763,18 @@ getGeomagneticField(locationOptions: LocationOptions, timeMillis: number): Promi
**系统能力**
：SystemCapability.Sensors.Sensor
-
参数
| 参数名 | 类型 | 必填 | 说明
|
| -------- | -------- | -------- |
-------- |
| locationOptions |
[
LocationOptions
](
#locationoptions
)
| 是 | 地理位置。
|
| timeMillis | number | 是
| 表示获取磁偏角的时间，单位为毫秒。 |
**参数：**
| 参数名 | 类型 | 必填 | 说明
|
| --------------- | ----------------------------------- | ---- | ---------
-------- |
| locationOptions |
[
LocationOptions
](
#locationoptions
)
| 是 | 地理位置。
|
| timeMillis | number | 是
| 表示获取磁偏角的时间，单位为毫秒。 |
-
返回值
| 类型 | 说明
|
| -------- | -
------- |
| Promise
<
[GeomagneticResponse](#geomagneticresponse)
>
| 返回磁场信息。 |
**返回值：**
| 类型 | 说明
|
| ---------------------------------------- |
------- |
| Promise
<
[GeomagneticResponse](#geomagneticresponse)
>
| 返回磁场信息。 |
-
示例
**返回值：**
```
const promise = sensor.getGeomagneticField([80, 0, 0], {'timeMillis':1580486400000});
promise.then((data) => {
...
...
@@ -1800,15 +1794,15 @@ getAltitude(seaPressure: number, currentPressure: number, callback: AsyncCallbac
**系统能力**
：SystemCapability.Sensors.Sensor
-
参数
**参数：**
| 参数名 | 类型 | 必填 | 说明
|
| --------------- | --------------------------- | ---- | -----------------
-------------------- |
| seaPressure | number | 是 | 表示海平面气压值，单位为hPa。
|
| currentPressure | number | 是
| 表示设备所在高度的气压值，单位为hPa。 |
| callback | AsyncCallback
<
number
>
| 是
| 返回设备所在的海拔高度，单位为米。 |
| 参数名 | 类型 | 必填 | 说明
|
| --------------- | --------------------------- | ---- |
-------------------- |
| seaPressure | number | 是 | 表示海平面气压值，单位为hPa。
|
| currentPressure | number | 是
| 表示设备所在高度的气压值，单位为hPa。 |
| callback | AsyncCallback
<
number
>
| 是
| 返回设备所在的海拔高度，单位为米。 |
-
示例
**返回值：**
```
sensor.getAltitude(0, 200, function(err, data) {
...
...
@@ -1829,20 +1823,20 @@ getAltitude(seaPressure: number, currentPressure: number): Promise<number>
**系统能力**
：SystemCapability.Sensors.Sensor
-
参数
**参数：**
| 参数名 | 类型 | 必填 | 说明
|
| --------------- | ------ | ---- | -----------------
-------------------- |
| seaPressure | number | 是 | 表示海平面气压值，单位为hPa。
|
| currentPressure | number | 是
| 表示设备所在高度的气压值，单位为hPa。 |
| 参数名 | 类型 | 必填 | 说明
|
| --------------- | ------ | ---- |
-------------------- |
| seaPressure | number | 是 | 表示海平面气压值，单位为hPa。
|
| currentPressure | number | 是
| 表示设备所在高度的气压值，单位为hPa。 |
-
返回值
**返回值：**
| 类型 | 说明
|
| --------------------- | ------------------
------------------ |
| Promise
<
number
>
| 返回设备所在的海拔高度（单位：米）。 |
| 类型 | 说明
|
| --------------------- |
------------------ |
| Promise
<
number
>
| 返回设备所在的海拔高度（单位：米）。 |
-
示例
**返回值：**
```
const promise = sensor.getAltitude(0, 200);
...
...
@@ -1862,14 +1856,14 @@ getGeomagneticDip(inclinationMatrix: Array<number>, callback: AsyncCallbac
**系统能力**
：SystemCapability.Sensors.Sensor
-
参数
**参数：**
| 参数名 | 类型 | 必填 | 说明
|
| ----------------- | --------------------------- | ---- | --------------
-------------- |
| inclinationMatrix | Array
<
number
>
| 是 | 表示倾斜矩阵。
|
| callback | AsyncCallback
<
number
>
| 是
| 返回地磁倾斜角，单位为弧度。 |
| 参数名 | 类型 | 必填 | 说明
|
| ----------------- | --------------------------- | ---- |
-------------- |
| inclinationMatrix | Array
<
number
>
| 是 | 表示倾斜矩阵。
|
| callback | AsyncCallback
<
number
>
| 是
| 返回地磁倾斜角，单位为弧度。 |
-
示例
**返回值：**
```
sensor.getGeomagneticDip([1, 0, 0, 0, 1, 0, 0, 0, 1], function(err, data) {
...
...
@@ -1878,7 +1872,7 @@ getGeomagneticDip(inclinationMatrix: Array<number>, callback: AsyncCallbac
err.message);
return;
}
console.info(Successed to get getGeomagneticDip interface get data: " + data);
console.info(
"
Successed to get getGeomagneticDip interface get data: " + data);
})
```
...
...
@@ -1890,19 +1884,19 @@ getGeomagneticDip(inclinationMatrix: Array<number>): Promise<number>
**系统能力**
：SystemCapability.Sensors.Sensor
-
参数
**参数：**
| 参数名 | 类型 | 必填 | 说明
|
| ----------------- | ------------------- | ---- | -------
------- |
| inclinationMatrix | Array
<
number
>
| 是
| 表示倾斜矩阵。 |
| 参数名 | 类型 | 必填 | 说明
|
| ----------------- | ------------------- | ---- |
------- |
| inclinationMatrix | Array
<
number
>
| 是
| 表示倾斜矩阵。 |
-
返回值
**返回值：**
| 类型 | 说明
|
| --------------------- | --------------
-------------- |
| Promise
<
number
>
| 返回地磁倾斜角，单位为弧度。 |
| 类型 | 说明
|
| --------------------- |
-------------- |
| Promise
<
number
>
| 返回地磁倾斜角，单位为弧度。 |
-
示例
**返回值：**
```
const promise = sensor.getGeomagneticDip([1, 0, 0, 0, 1, 0, 0, 0, 1]);
...
...
@@ -1921,15 +1915,15 @@ getAngleModify(currentRotationMatrix: Array<number>, preRotationMatrix: Ar
**系统能力**
：SystemCapability.Sensors.Sensor
-
参数
**参数：**
| 参数名 | 类型 | 必填 | 说明
|
| --------------------- | ---------------------------------------- | ---- | ---------------
------------------ |
| currentRotationMatrix | Array
<
number
>
| 是 | 表示当前旋转矩阵。
|
| preRotationMatrix | Array
<
number
>
| 是 | 表示旋转矩阵。
|
| callback | AsyncCallback
<
Array
<
number
>>
| 是
| 返回z、x、y轴方向的旋转角度变化。 |
| 参数名 | 类型 | 必填 | 说明
|
| --------------------- | ---------------------------------------- | ---- |
------------------ |
| currentRotationMatrix | Array
<
number
>
| 是 | 表示当前旋转矩阵。
|
| preRotationMatrix | Array
<
number
>
| 是 | 表示旋转矩阵。
|
| callback | AsyncCallback
<
Array
<
number
>>
| 是
| 返回z、x、y轴方向的旋转角度变化。 |
-
示例
**返回值：**
```
sensor. getAngleModify([1,0,0,0,1,0,0,0,1], [1, 0, 0, 0, 0.87, -0.50, 0, 0.50, 0.87], function(err, data) {
...
...
@@ -1954,20 +1948,20 @@ getAngleModify(currentRotationMatrix: Array<number>, preRotationMatrix: Ar
**系统能力**
：SystemCapability.Sensors.Sensor
-
参数
**参数：**
| 参数名 | 类型 | 必填 | 说明
|
| --------------------- | ------------------- | ---- | ---------
--------- |
| currentRotationMatrix | Array
<
number
>
| 是
| 表示当前旋转矩阵。 |
| preRotationMatrix | Array
<
number
>
| 是 | 表示旋转矩阵。
|
| 参数名 | 类型 | 必填 | 说明
|
| --------------------- | ------------------- | ---- |
--------- |
| currentRotationMatrix | Array
<
number
>
| 是
| 表示当前旋转矩阵。 |
| preRotationMatrix | Array
<
number
>
| 是 | 表示旋转矩阵。
|
-
返回值
**返回值：**
| 类型 | 说明
|
| ---------------------------------- | ---------------
------------------ |
| Promise
<
Array
<
number
>>
| 返回z、x、y轴方向的旋转角度变化。 |
| 类型 | 说明
|
| ---------------------------------- |
------------------ |
| Promise
<
Array
<
number
>>
| 返回z、x、y轴方向的旋转角度变化。 |
-
示例
**返回值：**
```
const promise = sensor.getAngleModify([1,0,0,0,1,0,0,0,1], [1,0,0,0,0.87,-0.50,0,0.50,0.87]);
...
...
@@ -1990,14 +1984,14 @@ createRotationMatrix(rotationVector: Array<number>, callback: AsyncCallbac
**系统能力**
：SystemCapability.Sensors.Sensor
-
参数
**参数：**
| 参数名 | 类型 | 必填 | 说明
|
| -------------- | ---------------------------------------- | ---- | -------
------- |
| rotationVector | Array
<
number
>
| 是
| 表示旋转矢量。 |
| callback | AsyncCallback
<
Array
<
number
>>
| 是
| 返回旋转矩阵。 |
| 参数名 | 类型 | 必填 | 说明
|
| -------------- | ---------------------------------------- | ---- |
------- |
| rotationVector | Array
<
number
>
| 是
| 表示旋转矢量。 |
| callback | AsyncCallback
<
Array
<
number
>>
| 是
| 返回旋转矩阵。 |
-
示例
**返回值：**
```
sensor.createRotationMatrix([0.20046076, 0.21907, 0.73978853, 0.60376877], function(err, data) {
...
...
@@ -2022,19 +2016,19 @@ createRotationMatrix(rotationVector: Array<number>): Promise<Array<n
**系统能力**
：SystemCapability.Sensors.Sensor
-
参数
**参数：**
| 参数名 | 类型 | 必填 | 说明
|
| -------------- | ------------------- | ---- | -------
------- |
| rotationVector | Array
<
number
>
| 是
| 表示旋转矢量。 |
| 参数名 | 类型 | 必填 | 说明
|
| -------------- | ------------------- | ---- |
------- |
| rotationVector | Array
<
number
>
| 是
| 表示旋转矢量。 |
-
返回值
**返回值：**
| 类型 | 说明
|
| ---------------------------------- | -------
------- |
| Promise
<
Array
<
number
>>
| 返回旋转矩阵。 |
| 类型 | 说明
|
| ---------------------------------- |
------- |
| Promise
<
Array
<
number
>>
| 返回旋转矩阵。 |
-
示例
**返回值：**
```
const promise = sensor.createRotationMatrix([0.20046076, 0.21907, 0.73978853, 0.60376877]);
...
...
@@ -2057,14 +2051,14 @@ createQuaternion(rotationVector: Array<number>, callback: AsyncCallback<
**系统能力**
：SystemCapability.Sensors.Sensor
-
参数
**参数：**
| 参数名 | 类型 | 必填 | 说明
|
| -------------- | ---------------------------------------- | ---- | -------
------- |
| rotationVector | Array
<
number
>
| 是
| 表示旋转矢量。 |
| callback | AsyncCallback
<
Array
<
number
>>
| 是 | 返回四元数。
|
| 参数名 | 类型 | 必填 | 说明
|
| -------------- | ---------------------------------------- | ---- |
------- |
| rotationVector | Array
<
number
>
| 是
| 表示旋转矢量。 |
| callback | AsyncCallback
<
Array
<
number
>>
| 是 | 返回四元数。
|
-
示例
**返回值：**
```
sensor.createQuaternion([0.20046076, 0.21907, 0.73978853, 0.60376877], function(err, data) {
...
...
@@ -2089,19 +2083,19 @@ createQuaternion(rotationVector: Array<number>): Promise<Array<numbe
**系统能力**
：SystemCapability.Sensors.Sensor
-
参数
**参数：**
| 参数名 | 类型 | 必填 | 说明
|
| -------------- | ------------------- | ---- | -------
------- |
| rotationVector | Array
<
number
>
| 是
| 表示旋转矢量。 |
| 参数名 | 类型 | 必填 | 说明
|
| -------------- | ------------------- | ---- |
------- |
| rotationVector | Array
<
number
>
| 是
| 表示旋转矢量。 |
-
返回值
**返回值：**
| 类型 | 说明
|
| ---------------------------------- | ------
------ |
| Promise
<
Array
<
number
>>
| 返回四元数。 |
| 类型 | 说明
|
| ---------------------------------- |
------ |
| Promise
<
Array
<
number
>>
| 返回四元数。 |
-
示例
**返回值：**
```
const promise = sensor.createQuaternion([0.20046076, 0.21907, 0.73978853, 0.60376877]);
...
...
@@ -2124,14 +2118,14 @@ getDirection(rotationMatrix: Array<number>, callback: AsyncCallback<Arr
**系统能力**
：SystemCapability.Sensors.Sensor
-
参数
**参数：**
| 参数名 | 类型 | 必填 | 说明
|
| -------------- | ---------------------------------------- | ---- | ---------------
------------------ |
| rotationMatrix | Array
<
number
>
| 是 | 表示旋转矩阵。
|
| callback | AsyncCallback
<
Array
<
number
>>
| 是
| 返回围绕z、x、y轴方向的旋转角度。 |
| 参数名 | 类型 | 必填 | 说明
|
| -------------- | ---------------------------------------- | ---- |
------------------ |
| rotationMatrix | Array
<
number
>
| 是 | 表示旋转矩阵。
|
| callback | AsyncCallback
<
Array
<
number
>>
| 是
| 返回围绕z、x、y轴方向的旋转角度。 |
-
示例
**返回值：**
```
sensor.getDirection([1, 0, 0, 0, 1, 0, 0, 0, 1], function(err, data) {
...
...
@@ -2156,19 +2150,19 @@ getDirection(rotationMatrix: Array<number>): Promise<Array<number>
**系统能力**
：SystemCapability.Sensors.Sensor
-
参数
**参数：**
| 参数名 | 类型 | 必填 | 说明
|
| -------------- | ------------------- | ---- | -------
------- |
| rotationMatrix | Array
<
number
>
| 是
| 表示旋转矩阵。 |
| 参数名 | 类型 | 必填 | 说明
|
| -------------- | ------------------- | ---- |
------- |
| rotationMatrix | Array
<
number
>
| 是
| 表示旋转矩阵。 |
-
返回值
**返回值：**
| 类型 | 说明
|
| ---------------------------------- | ---------------
------------------ |
| Promise
<
Array
<
number
>>
| 返回围绕z、x、y轴方向的旋转角度。 |
| 类型 | 说明
|
| ---------------------------------- |
------------------ |
| Promise
<
Array
<
number
>>
| 返回围绕z、x、y轴方向的旋转角度。 |
-
示例
**返回值：**
```
const promise = sensor.getDirection([1, 0, 0, 0, 1, 0, 0, 0, 1]);
...
...
@@ -2191,15 +2185,15 @@ createRotationMatrix(gravity: Array<number>, geomagnetic: Array<number&
**系统能力**
：SystemCapability.Sensors.Sensor
-
参数
**参数：**
| 参数名 | 类型 | 必填 | 说明
|
| ----------- | ------------------------------------------------------------ | ---- | -------
------- |
| gravity | Array
<
number
>
| 是
| 表示重力向量。 |
| geomagnetic | Array
<
number
>
| 是
| 表示地磁矢量。 |
| callback | AsyncCallback
<
[RotationMatrixResponse](#rotationmatrixresponse)
>
| 是
| 返回旋转矩阵。 |
| 参数名 | 类型 | 必填 | 说明
|
| ----------- | ---------------------------------------- | ---- |
------- |
| gravity | Array
<
number
>
| 是
| 表示重力向量。 |
| geomagnetic | Array
<
number
>
| 是
| 表示地磁矢量。 |
| callback | AsyncCallback
<
[RotationMatrixResponse](#rotationmatrixresponse)
>
| 是
| 返回旋转矩阵。 |
-
示例
**返回值：**
```
sensor.createRotationMatrix([-0.27775216, 0.5351276, 9.788099], [210.87253, -78.6096, -111.44444], function(err, data) {
...
...
@@ -2224,20 +2218,20 @@ createRotationMatrix(gravity: Array<number>, geomagnetic: Array<number&
**系统能力**
：SystemCapability.Sensors.Sensor
-
参数
**参数：**
| 参数名 | 类型 | 必填 | 说明
|
| ----------- | ------------------- | ---- | -------
------- |
| gravity | Array
<
number
>
| 是
| 表示重力向量。 |
| geomagnetic | Array
<
number
>
| 是
| 表示地磁矢量。 |
| 参数名 | 类型 | 必填 | 说明
|
| ----------- | ------------------- | ---- |
------- |
| gravity | Array
<
number
>
| 是
| 表示重力向量。 |
| geomagnetic | Array
<
number
>
| 是
| 表示地磁矢量。 |
-
返回值
**返回值：**
| 类型 | 说明
|
| ------------------------------------------------------------ | -------
------- |
| Promise
<
[RotationMatrixResponse](#rotationmatrixresponse)
>
| 返回旋转矩阵。 |
| 类型 | 说明
|
| ---------------------------------------- |
------- |
| Promise
<
[RotationMatrixResponse](#rotationmatrixresponse)
>
| 返回旋转矩阵。 |
-
示例
**返回值：**
```
const promise = sensor.createRotationMatrix([-0.27775216, 0.5351276, 9.788099], [210.87253, -78.6096, -111.44444]);
...
...
@@ -2259,29 +2253,29 @@ createRotationMatrix(gravity: Array<number>, geomagnetic: Array<number&
**系统能力**
：以下各项对应的系统能力均为SystemCapability.Sensors.Sensor
| 名称
| 默认值 | 说明
|
| --------
| -------- |
-------- |
| SENSOR_TYPE_ID_ACCELEROMETER
| 1 | 加速度传感器。
|
| SENSOR_TYPE_ID_GYROSCOPE
| 2 | 陀螺仪传感器。
|
| SENSOR_TYPE_ID_AMBIENT_LIGHT
| 5 | 环境光传感器。
|
| SENSOR_TYPE_ID_MAGNETIC_FIELD
| 6 | 磁场传感器。
|
| SENSOR_TYPE_ID_BAROMETER
| 8 | 气压计传感器。
|
| SENSOR_TYPE_ID_HALL
| 10 | 霍尔传感器。
|
| SENSOR_TYPE_ID_PROXIMITY
| 12 | 接近光传感器。
|
| SENSOR_TYPE_ID_HUMIDITY
| 13 | 湿度传感器。
|
| SENSOR_TYPE_ID_ORIENTATION
| 256 | 方向传感器。
|
| SENSOR_TYPE_ID_GRAVITY
| 257 | 重力传感器。
|
| SENSOR_TYPE_ID_LINEAR_ACCELERATION
| 258 | 线性加速度传感器。
|
| SENSOR_TYPE_ID_ROTATION_VECTOR
| 259 | 旋转矢量传感器。
|
| SENSOR_TYPE_ID_AMBIENT_TEMPERATURE
| 260 | 环境温度传感器。
|
| SENSOR_TYPE_ID_MAGNETIC_FIELD_UNCALIBRATED | 261
| 未校准磁场传感器。
|
| SENSOR_TYPE_ID_GYROSCOPE_UNCALIBRATED
| 263 | 未校准陀螺仪传感器。
|
| SENSOR_TYPE_ID_SIGNIFICANT_MOTION
| 264 | 有效运动传感器。
|
| SENSOR_TYPE_ID_PEDOMETER_DETECTION
| 265 | 计步检测传感器。
|
| SENSOR_TYPE_ID_PEDOMETER
| 266 | 计步传感器。
|
| SENSOR_TYPE_ID_HEART_RATE
| 278 | 心率传感器。
|
| SENSOR_TYPE_ID_WEAR_DETECTION
| 280 | 佩戴检测传感器。
|
| SENSOR_TYPE_ID_ACCELEROMETER_UNCALIBRATED | 281 | 未校准加速度计传感器。 |
| 名称
| 默认值 | 说明
|
| --------
-------------------------------- | ---- | ---
-------- |
| SENSOR_TYPE_ID_ACCELEROMETER
| 1 | 加速度传感器。
|
| SENSOR_TYPE_ID_GYROSCOPE
| 2 | 陀螺仪传感器。
|
| SENSOR_TYPE_ID_AMBIENT_LIGHT
| 5 | 环境光传感器。
|
| SENSOR_TYPE_ID_MAGNETIC_FIELD
| 6 | 磁场传感器。
|
| SENSOR_TYPE_ID_BAROMETER
| 8 | 气压计传感器。
|
| SENSOR_TYPE_ID_HALL
| 10 | 霍尔传感器。
|
| SENSOR_TYPE_ID_PROXIMITY
| 12 | 接近光传感器。
|
| SENSOR_TYPE_ID_HUMIDITY
| 13 | 湿度传感器。
|
| SENSOR_TYPE_ID_ORIENTATION
| 256 | 方向传感器。
|
| SENSOR_TYPE_ID_GRAVITY
| 257 | 重力传感器。
|
| SENSOR_TYPE_ID_LINEAR_ACCELERATION
| 258 | 线性加速度传感器。
|
| SENSOR_TYPE_ID_ROTATION_VECTOR
| 259 | 旋转矢量传感器。
|
| SENSOR_TYPE_ID_AMBIENT_TEMPERATURE
| 260 | 环境温度传感器。
|
| SENSOR_TYPE_ID_MAGNETIC_FIELD_UNCALIBRATED | 261
| 未校准磁场传感器。
|
| SENSOR_TYPE_ID_GYROSCOPE_UNCALIBRATED
| 263 | 未校准陀螺仪传感器。
|
| SENSOR_TYPE_ID_SIGNIFICANT_MOTION
| 264 | 有效运动传感器。
|
| SENSOR_TYPE_ID_PEDOMETER_DETECTION
| 265 | 计步检测传感器。
|
| SENSOR_TYPE_ID_PEDOMETER
| 266 | 计步传感器。
|
| SENSOR_TYPE_ID_HEART_RATE
| 278 | 心率传感器。
|
| SENSOR_TYPE_ID_WEAR_DETECTION
| 280 | 佩戴检测传感器。
|
| SENSOR_TYPE_ID_ACCELEROMETER_UNCALIBRATED | 281
| 未校准加速度计传感器。 |
## Response
...
...
@@ -2290,9 +2284,9 @@ createRotationMatrix(gravity: Array<number>, geomagnetic: Array<number&
**系统能力**
：以下各项对应的系统能力均为SystemCapability.Sensors.Sensor
| 名称
| 参数类型 | 可读 | 可写 | 说明
|
| --------
| -------- | -------- | -------- |
-------- |
| timestamp | number | 是
| 是
| 传感器数据上报的时间戳。 |
| 名称
| 参数类型 | 可读 | 可写 | 说明
|
| --------
- | ------ | ---- | ---- | ----
-------- |
| timestamp | number | 是
| 是
| 传感器数据上报的时间戳。 |
## AccelerometerResponse
...
...
@@ -2302,11 +2296,11 @@ createRotationMatrix(gravity: Array<number>, geomagnetic: Array<number&
**系统能力**
：以下各项对应的系统能力均为SystemCapability.Sensors.Sensor
| 名称
| 参数类型 | 可读 | 可写 | 说明
|
| ----
---- | -------- | -------- | -------- |
-------- |
| x
| number | 是 | 是
| 施加在设备x轴的加速度，单位 : m/s2。 |
| y
| number | 是 | 是
| 施加在设备y轴的加速度，单位 : m/s2。 |
| z
| number | 是 | 是
| 施加在设备z轴的加速度，单位 : m/s2。 |
| 名称
| 参数类型 | 可读 | 可写 | 说明
|
| ----
| ------ | ---- | ---- | --------------
-------- |
| x
| number | 是 | 是
| 施加在设备x轴的加速度，单位 : m/s2。 |
| y
| number | 是 | 是
| 施加在设备y轴的加速度，单位 : m/s2。 |
| z
| number | 是 | 是
| 施加在设备z轴的加速度，单位 : m/s2。 |
## LinearAccelerometerResponse
...
...
@@ -2316,11 +2310,11 @@ createRotationMatrix(gravity: Array<number>, geomagnetic: Array<number&
**系统能力**
：以下各项对应的系统能力均为SystemCapability.Sensors.Sensor
| 名称
| 参数类型 | 可读 | 可写 | 说明
|
| ----
---- | -------- | -------- | -------- |
-------- |
| x
| number | 是 | 是
| 施加在设备x轴的线性加速度，单位 : m/s2。 |
| y
| number | 是 | 是
| 施加在设备y轴的线性加速度，单位 : m/s2。 |
| z
| number | 是 | 是
| 施加在设备z轴的线性加速度，单位 : m/s2。 |
| 名称
| 参数类型 | 可读 | 可写 | 说明
|
| ----
| ------ | ---- | ---- | ----------------
-------- |
| x
| number | 是 | 是
| 施加在设备x轴的线性加速度，单位 : m/s2。 |
| y
| number | 是 | 是
| 施加在设备y轴的线性加速度，单位 : m/s2。 |
| z
| number | 是 | 是
| 施加在设备z轴的线性加速度，单位 : m/s2。 |
## AccelerometerUncalibratedResponse
...
...
@@ -2330,14 +2324,14 @@ createRotationMatrix(gravity: Array<number>, geomagnetic: Array<number&
**系统能力**
：以下各项对应的系统能力均为SystemCapability.Sensors.Sensor
| 名称
| 参数类型 | 可读 | 可写 | 说明
|
| -----
--- | -------- | -------- | -------- |
-------- |
| x
| number | 是 | 是 | 施加在设备x轴未校准的加速度，单位 : m/s2。
|
| y
| number | 是 | 是 | 施加在设备y轴未校准的加速度，单位 : m/s2。
|
| z
| number | 是 | 是 | 施加在设备z轴未校准的加速度，单位 : m/s2。
|
| biasX | number | 是
| 是 | 施加在设备x轴未校准的加速度偏量，单位 : m/s2。
|
| biasY | number | 是
| 是
| 施加在设备上y轴未校准的加速度偏量，单位 : m/s2。 |
| biasZ | number | 是
| 是 | 施加在设备z轴未校准的加速度偏量，单位 : m/s2。
|
| 名称
| 参数类型 | 可读 | 可写 | 说明
|
| -----
| ------ | ---- | ---- | --------------------
-------- |
| x
| number | 是 | 是 | 施加在设备x轴未校准的加速度，单位 : m/s2。
|
| y
| number | 是 | 是 | 施加在设备y轴未校准的加速度，单位 : m/s2。
|
| z
| number | 是 | 是 | 施加在设备z轴未校准的加速度，单位 : m/s2。
|
| biasX | number | 是
| 是 | 施加在设备x轴未校准的加速度偏量，单位 : m/s2。
|
| biasY | number | 是
| 是
| 施加在设备上y轴未校准的加速度偏量，单位 : m/s2。 |
| biasZ | number | 是
| 是 | 施加在设备z轴未校准的加速度偏量，单位 : m/s2。
|
## GravityResponse
...
...
@@ -2347,11 +2341,11 @@ createRotationMatrix(gravity: Array<number>, geomagnetic: Array<number&
**系统能力**
：以下各项对应的系统能力均为SystemCapability.Sensors.Sensor
| 名称
| 参数类型 | 可读 | 可写 | 说明
|
| ----
---- | -------- | -------- | -------- |
-------- |
| x
| number | 是 | 是
| 施加在设备x轴的重力加速度，单位 : m/s2。 |
| y
| number | 是 | 是
| 施加在设备y轴的重力加速度，单位 : m/s2。 |
| z
| number | 是 | 是
| 施加在设备z轴的重力加速度，单位 : m/s2。 |
| 名称
| 参数类型 | 可读 | 可写 | 说明
|
| ----
| ------ | ---- | ---- | ----------------
-------- |
| x
| number | 是 | 是
| 施加在设备x轴的重力加速度，单位 : m/s2。 |
| y
| number | 是 | 是
| 施加在设备y轴的重力加速度，单位 : m/s2。 |
| z
| number | 是 | 是
| 施加在设备z轴的重力加速度，单位 : m/s2。 |
## OrientationResponse
...
...
@@ -2361,11 +2355,11 @@ createRotationMatrix(gravity: Array<number>, geomagnetic: Array<number&
**系统能力**
：以下各项对应的系统能力均为SystemCapability.Sensors.Sensor
| 名称
| 参数类型 | 可读 | 可写 | 说明
|
| -----
--- | -------- | -------- | -------- |
-------- |
| alpha | number | 是
| 是
| 设备围绕 Z 轴旋转一定角度，单位 : rad。 |
| beta
| number | 是 | 是 | 设备围绕 X轴旋转一定角度，单位 : rad。
|
| gamma | number | 是
| 是 | 设备围绕 Y轴旋转一定角度，单位 : rad。
|
| 名称
| 参数类型 | 可读 | 可写 | 说明
|
| -----
| ------ | ---- | ---- | ----------------
-------- |
| alpha | number | 是
| 是
| 设备围绕 Z 轴旋转一定角度，单位 : rad。 |
| beta
| number | 是 | 是 | 设备围绕 X轴旋转一定角度，单位 : rad。
|
| gamma | number | 是
| 是 | 设备围绕 Y轴旋转一定角度，单位 : rad。
|
## RotationVectorResponse
...
...
@@ -2375,12 +2369,12 @@ createRotationMatrix(gravity: Array<number>, geomagnetic: Array<number&
**系统能力**
：以下各项对应的系统能力均为SystemCapability.Sensors.Sensor
| 名称
| 参数类型 | 可读 | 可写 | 说明
|
| ----
---- | -------- | -------- | -------- |
-------- |
| x
| number | 是 | 是
| 旋转矢量x轴分量。 |
| y
| number | 是 | 是
| 旋转矢量y轴分量。 |
| z
| number | 是 | 是
| 旋转矢量z轴分量。 |
| w
| number | 是 | 是 | 标量。
|
| 名称
| 参数类型 | 可读 | 可写 | 说明
|
| ----
| ------ | ---- | ---- | -
-------- |
| x
| number | 是 | 是
| 旋转矢量x轴分量。 |
| y
| number | 是 | 是
| 旋转矢量y轴分量。 |
| z
| number | 是 | 是
| 旋转矢量z轴分量。 |
| w
| number | 是 | 是 | 标量。
|
## GyroscopeResponse
...
...
@@ -2390,11 +2384,11 @@ createRotationMatrix(gravity: Array<number>, geomagnetic: Array<number&
**系统能力**
：以下各项对应的系统能力均为SystemCapability.Sensors.Sensor
| 名称
| 参数类型 | 可读 | 可写 | 说明
|
| ----
---- | -------- | -------- | -------- |
-------- |
| x
| number | 是 | 是
| 设备x轴的旋转角速度，单位rad/s。 |
| y
| number | 是 | 是
| 设备y轴的旋转角速度，单位rad/s。 |
| z
| number | 是 | 是
| 设备z轴的旋转角速度，单位rad/s。 |
| 名称
| 参数类型 | 可读 | 可写 | 说明
|
| ----
| ------ | ---- | ---- | -----------
-------- |
| x
| number | 是 | 是
| 设备x轴的旋转角速度，单位rad/s。 |
| y
| number | 是 | 是
| 设备y轴的旋转角速度，单位rad/s。 |
| z
| number | 是 | 是
| 设备z轴的旋转角速度，单位rad/s。 |
## GyroscopeUncalibratedResponse
...
...
@@ -2404,14 +2398,14 @@ createRotationMatrix(gravity: Array<number>, geomagnetic: Array<number&
**系统能力**
：以下各项对应的系统能力均为SystemCapability.Sensors.Sensor
| 名称
| 参数类型 | 可读 | 可写 | 说明
|
| -----
--- | -------- | -------- | -------- |
-------- |
| x
| number | 是 | 是 | 设备x轴未校准的旋转角速度，单位rad/s。
|
| y
| number | 是 | 是 | 设备y轴未校准的旋转角速度，单位rad/s。
|
| z
| number | 是 | 是 | 设备z轴未校准的旋转角速度，单位rad/s。
|
| biasX | number | 是
| 是
| 设备x轴未校准的旋转角速度偏量，单位rad/s。 |
| biasY | number | 是
| 是
| 设备y轴未校准的旋转角速度偏量，单位rad/s。 |
| biasZ | number | 是
| 是
| 设备z轴未校准的旋转角速度偏量，单位rad/s。 |
| 名称
| 参数类型 | 可读 | 可写 | 说明
|
| -----
| ------ | ---- | ---- | ----------------
-------- |
| x
| number | 是 | 是 | 设备x轴未校准的旋转角速度，单位rad/s。
|
| y
| number | 是 | 是 | 设备y轴未校准的旋转角速度，单位rad/s。
|
| z
| number | 是 | 是 | 设备z轴未校准的旋转角速度，单位rad/s。
|
| biasX | number | 是
| 是
| 设备x轴未校准的旋转角速度偏量，单位rad/s。 |
| biasY | number | 是
| 是
| 设备y轴未校准的旋转角速度偏量，单位rad/s。 |
| biasZ | number | 是
| 是
| 设备z轴未校准的旋转角速度偏量，单位rad/s。 |
## SignificantMotionResponse
...
...
@@ -2421,9 +2415,9 @@ createRotationMatrix(gravity: Array<number>, geomagnetic: Array<number&
**系统能力**
：以下各项对应的系统能力均为SystemCapability.Sensors.Sensor
| 名称
| 参数类型 | 可读 | 可写 | 说明
|
| ------
-- | -------- | -------- | -------- |
-------- |
| scalar | number | 是
| 是
| 表示剧烈运动程度。测量三个物理轴（x、y
和
z）上，设备是否存在大幅度运动；如果取值为1则代表存在大幅度运动，取值为0则代表没有大幅度运动。 |
| 名称
| 参数类型 | 可读 | 可写 | 说明
|
| ------
| ------ | ---- | ---- | --------------------------------
-------- |
| scalar | number | 是
| 是
| 表示剧烈运动程度。测量三个物理轴（x、y
和
z）上，设备是否存在大幅度运动；如果取值为1则代表存在大幅度运动，取值为0则代表没有大幅度运动。 |
## ProximityResponse
...
...
@@ -2433,9 +2427,9 @@ createRotationMatrix(gravity: Array<number>, geomagnetic: Array<number&
**系统能力**
：以下各项对应的系统能力均为SystemCapability.Sensors.Sensor
| 名称
| 参数类型 | 可读 | 可写 | 说明
|
| -------- | ------
-- | -------- | -------- |
-------- |
| distance | number | 是
| 是
| 可见物体与设备显示器的接近程度。0表示接近，1表示远离。 |
| 名称
| 参数类型 | 可读 | 可写 | 说明
|
| -------- | ------
| ---- | ---- | --------------------
-------- |
| distance | number | 是
| 是
| 可见物体与设备显示器的接近程度。0表示接近，1表示远离。 |
## LightResponse
...
...
@@ -2445,9 +2439,9 @@ createRotationMatrix(gravity: Array<number>, geomagnetic: Array<number&
**系统能力**
：以下各项对应的系统能力均为SystemCapability.Sensors.Sensor
| 名称
| 参数类型 | 可读 | 可写 | 说明
|
| --------
| -------- | -------- | -------- |
-------- |
| intensity | number | 是
| 是
| 光强（单位：勒克斯）。 |
| 名称
| 参数类型 | 可读 | 可写 | 说明
|
| --------
- | ------ | ---- | ---- | ---
-------- |
| intensity | number | 是
| 是
| 光强（单位：勒克斯）。 |
## HallResponse
...
...
@@ -2457,9 +2451,9 @@ createRotationMatrix(gravity: Array<number>, geomagnetic: Array<number&
**系统能力**
：以下各项对应的系统能力均为SystemCapability.Sensors.Sensor
| 名称
| 参数类型 | 可读 | 可写 | 说明
|
| ------
-- | -------- | -------- | -------- |
-------- |
| status | number | 是
| 是
| 显示霍尔状态。测量设备周围是否存在磁力吸引，0表示有，1表示没有。 |
| 名称
| 参数类型 | 可读 | 可写 | 说明
|
| ------
| ------ | ---- | ---- | -------------------------
-------- |
| status | number | 是
| 是
| 显示霍尔状态。测量设备周围是否存在磁力吸引，0表示有，1表示没有。 |
## MagneticFieldResponse
...
...
@@ -2469,11 +2463,11 @@ createRotationMatrix(gravity: Array<number>, geomagnetic: Array<number&
**系统能力**
：以下各项对应的系统能力均为SystemCapability.Sensors.Sensor
| 名称
| 参数类型 | 可读 | 可写 | 说明
|
| ----
---- | -------- | -------- | -------- |
-------- |
| x
| number | 是 | 是 | x轴环境磁场强度，单位 : μT。
|
| y
| number | 是 | 是 | y轴环境磁场强度，单位 : μT。
|
| z
| number | 是 | 是
| z轴环境磁场强度，单位 : μT。。 |
| 名称
| 参数类型 | 可读 | 可写 | 说明
|
| ----
| ------ | ---- | ---- | ----------
-------- |
| x
| number | 是 | 是 | x轴环境磁场强度，单位 : μT。
|
| y
| number | 是 | 是 | y轴环境磁场强度，单位 : μT。
|
| z
| number | 是 | 是
| z轴环境磁场强度，单位 : μT。。 |
## MagneticFieldUncalibratedResponse
...
...
@@ -2483,14 +2477,14 @@ createRotationMatrix(gravity: Array<number>, geomagnetic: Array<number&
**系统能力**
：以下各项对应的系统能力均为SystemCapability.Sensors.Sensor
| 名称
| 参数类型 | 可读 | 可写 | 说明
|
| -----
--- | -------- | -------- | -------- |
-------- |
| x
| number | 是 | 是 | x轴未校准环境磁场强度，单位 : μT。
|
| y
| number | 是 | 是 | y轴未校准环境磁场强度，单位 : μT。
|
| z
| number | 是 | 是 | z轴未校准环境磁场强度，单位 : μT。
|
| biasX | number | 是
| 是
| x轴未校准环境磁场强度偏量，单位 : μT。 |
| biasY | number | 是
| 是
| y轴未校准环境磁场强度偏量，单位 : μT。 |
| biasZ | number | 是
| 是
| z轴未校准环境磁场强度偏量，单位 : μT。 |
| 名称
| 参数类型 | 可读 | 可写 | 说明
|
| -----
| ------ | ---- | ---- | --------------
-------- |
| x
| number | 是 | 是 | x轴未校准环境磁场强度，单位 : μT。
|
| y
| number | 是 | 是 | y轴未校准环境磁场强度，单位 : μT。
|
| z
| number | 是 | 是 | z轴未校准环境磁场强度，单位 : μT。
|
| biasX | number | 是
| 是
| x轴未校准环境磁场强度偏量，单位 : μT。 |
| biasY | number | 是
| 是
| y轴未校准环境磁场强度偏量，单位 : μT。 |
| biasZ | number | 是
| 是
| z轴未校准环境磁场强度偏量，单位 : μT。 |
## PedometerResponse
...
...
@@ -2500,9 +2494,9 @@ createRotationMatrix(gravity: Array<number>, geomagnetic: Array<number&
**系统能力**
：以下各项对应的系统能力均为SystemCapability.Sensors.Sensor
| 名称
| 参数类型 | 可读 | 可写 | 说明
|
| -----
--- | -------- | -------- | ----
---- | -------- |
| steps | number | 是
| 是
| 用户的行走步数。 |
| 名称
| 参数类型 | 可读 | 可写 | 说明
|
| -----
| ------ | ---- |
---- | -------- |
| steps | number | 是
| 是
| 用户的行走步数。 |
## HumidityResponse
...
...
@@ -2512,9 +2506,9 @@ createRotationMatrix(gravity: Array<number>, geomagnetic: Array<number&
**系统能力**
：以下各项对应的系统能力均为SystemCapability.Sensors.Sensor
| 名称
| 参数类型 | 可读 | 可写 | 说明
|
| -------- | ------
-- | -------- | -------- |
-------- |
| humidity | number | 是
| 是
| 湿度值。测量环境的相对湿度，以百分比
(%)
表示。 |
| 名称
| 参数类型 | 可读 | 可写 | 说明
|
| -------- | ------
| ---- | ---- | ----------------------------
-------- |
| humidity | number | 是
| 是
| 湿度值。测量环境的相对湿度，以百分比
(%)
表示。 |
## PedometerDetectionResponse
...
...
@@ -2524,9 +2518,9 @@ createRotationMatrix(gravity: Array<number>, geomagnetic: Array<number&
**系统能力**
：以下各项对应的系统能力均为SystemCapability.Sensors.Sensor
| 名称
| 参数类型 | 可读 | 可写 | 说明
|
| ------
-- | -------- | -------- | -------- |
-------- |
| scalar | number | 是
| 是
| 计步器检测。检测用户的计步动作，如果取值为1则代表用户产生了计步行走的动作，取值为0则代表用户没有发生运动。 |
| 名称
| 参数类型 | 可读 | 可写 | 说明
|
| ------
| ------ | ---- | ---- | --------------------------------
-------- |
| scalar | number | 是
| 是
| 计步器检测。检测用户的计步动作，如果取值为1则代表用户产生了计步行走的动作，取值为0则代表用户没有发生运动。 |
## AmbientTemperatureResponse
...
...
@@ -2536,9 +2530,9 @@ createRotationMatrix(gravity: Array<number>, geomagnetic: Array<number&
**系统能力**
：以下各项对应的系统能力均为SystemCapability.Sensors.Sensor
| 名称
| 参数类型 | 可读 | 可写 | 说明
|
| --------
| -------- | -------- | -------- |
-------- |
| temperature | number | 是
| 是
| 环境温度（单位：摄氏度）。 |
| 名称
| 参数类型 | 可读 | 可写 | 说明
|
| --------
--- | ------ | ---- | ---- | -----
-------- |
| temperature | number | 是
| 是
| 环境温度（单位：摄氏度）。 |
## BarometerResponse
...
...
@@ -2548,9 +2542,9 @@ createRotationMatrix(gravity: Array<number>, geomagnetic: Array<number&
**系统能力**
：以下各项对应的系统能力均为SystemCapability.Sensors.Sensor
| 名称
| 参数类型 | 可读 | 可写 | 说明
|
| -------- | ------
-- | -------- | -------- |
-------- |
| pressure | number | 是
| 是
| 压力值（单位：帕斯卡）。 |
| 名称
| 参数类型 | 可读 | 可写 | 说明
|
| -------- | ------
| ---- | ---- | ----
-------- |
| pressure | number | 是
| 是
| 压力值（单位：帕斯卡）。 |
## HeartRateResponse
...
...
@@ -2560,9 +2554,9 @@ createRotationMatrix(gravity: Array<number>, geomagnetic: Array<number&
**系统能力**
：以下各项对应的系统能力均为SystemCapability.Sensors.Sensor
| 名称
| 参数类型 | 可读 | 可写 | 说明
|
| --------
| -------- | -------- | -------- |
-------- |
| heartRate | number | 是
| 是
| 心率值。测量用户的心率数值，单位：bpm。 |
| 名称
| 参数类型 | 可读 | 可写 | 说明
|
| --------
- | ------ | ---- | ---- | -------------
-------- |
| heartRate | number | 是
| 是
| 心率值。测量用户的心率数值，单位：bpm。 |
## WearDetectionResponse
...
...
@@ -2572,9 +2566,9 @@ createRotationMatrix(gravity: Array<number>, geomagnetic: Array<number&
**系统能力**
：以下各项对应的系统能力均为SystemCapability.Sensors.Sensor
| 名称
| 参数类型 | 可读 | 可写 | 说明
|
| -----
--- | -------- | -------- | -------- |
-------- |
| value | number | 是
| 是
| 表示设备是否被穿戴（1表示已穿戴，0表示未穿戴）。 |
| 名称
| 参数类型 | 可读 | 可写 | 说明
|
| -----
| ------ | ---- | ---- | -----------------
-------- |
| value | number | 是
| 是
| 表示设备是否被穿戴（1表示已穿戴，0表示未穿戴）。 |
## Options
...
...
@@ -2583,8 +2577,8 @@ createRotationMatrix(gravity: Array<number>, geomagnetic: Array<number&
**系统能力**
：以下各项对应的系统能力均为SystemCapability.Sensors.Sensor
| 名称
| 参数类型 | 说明
|
| -------- | ------
-- |
-------- |
| 名称
| 参数类型 | 说明
|
| -------- | ------
| -------------------
-------- |
| interval | number | 表示传感器的上报频率，默认值为200000000ns。 |
## RotationMatrixResponse
...
...
@@ -2593,10 +2587,10 @@ createRotationMatrix(gravity: Array<number>, geomagnetic: Array<number&
**系统能力**
：以下各项对应的系统能力均为SystemCapability.Sensors.Sensor
| 名称
| 参数类型 | 可读 | 可写 | 说明
|
| ----------- | ------------------- | ---- | ---- | -----
-----
|
| rotation | Array
<
number
>
| 是
| 是
| 旋转矩阵。 |
| inclination | Array
<
number
>
| 是
| 是
| 倾斜矩阵。 |
| 名称
| 参数类型 | 可读 | 可写 | 说明
|
| ----------- | ------------------- | ---- | ---- | ----- |
| rotation | Array
<
number
>
| 是
| 是
| 旋转矩阵。 |
| inclination | Array
<
number
>
| 是
| 是
| 倾斜矩阵。 |
## CoordinatesOptions
...
...
@@ -2605,10 +2599,10 @@ createRotationMatrix(gravity: Array<number>, geomagnetic: Array<number&
**系统能力**
：以下各项对应的系统能力均为SystemCapability.Sensors.Sensor
| 名称
| 参数类型 | 可读 | 可写 | 说明
|
| ---- | ------
-- | ---- | ---- | -----
------ |
| x | number
| 是 | 是
| x坐标方向。 |
| y | number
| 是 | 是
| y坐标方向。 |
| 名称
| 参数类型 | 可读 | 可写 | 说明
|
| ---- | ------
| ---- | ---- |
------ |
| x | number
| 是 | 是
| x坐标方向。 |
| y | number
| 是 | 是
| y坐标方向。 |
## GeomagneticResponse
...
...
@@ -2617,15 +2611,15 @@ createRotationMatrix(gravity: Array<number>, geomagnetic: Array<number&
**系统能力**
：以下各项对应的系统能力均为SystemCapability.Sensors.Sensor
| 名称
| 参数类型 | 可读 | 可写 | 说明
|
| --------
| -------- | -------- | -------- |
-------- |
| x
| number | 是 | 是 | 地磁场的北分量。
|
| y
| number | 是 | 是 | 地磁场的东分量。
|
| z
| number | 是 | 是 | 地磁场的垂直分量。
|
| geomagneticDip
| number | 是 | 是 | 地磁倾角，即地球磁场线与水平面的夹角。
|
| deflectionAngle | number | 是
| 是
| 地磁偏角，即地磁北方向与正北方向在水平面上的角度。 |
| levelIntensity
| number | 是 | 是 | 地磁场的水平强度。
|
| totalIntensity
| number | 是 | 是 | 地磁场的总强度。
|
| 名称
| 参数类型 | 可读 | 可写 | 说明
|
| --------
------- | ------ | ---- | ---- | -----------------
-------- |
| x
| number | 是 | 是 | 地磁场的北分量。
|
| y
| number | 是 | 是 | 地磁场的东分量。
|
| z
| number | 是 | 是 | 地磁场的垂直分量。
|
| geomagneticDip
| number | 是 | 是 | 地磁倾角，即地球磁场线与水平面的夹角。
|
| deflectionAngle | number | 是
| 是
| 地磁偏角，即地磁北方向与正北方向在水平面上的角度。 |
| levelIntensity
| number | 是 | 是 | 地磁场的水平强度。
|
| totalIntensity
| number | 是 | 是 | 地磁场的总强度。
|
## LocationOptions
...
...
@@ -2633,8 +2627,8 @@ createRotationMatrix(gravity: Array<number>, geomagnetic: Array<number&
**系统能力**
：以下各项对应的系统能力均为SystemCapability.Sensors.Sensor
| 名称
| 参数类型 | 可读 | 可写 | 说明
|
| --------
| -------- | -------- | -------- | ---
----- |
| latitude
| number | 是 | 是 | 纬度。
|
| longitude | number | 是
| 是 | 经度。
|
| altitude
| number | 是 | 是
| 海拔高度。 |
| 名称
| 参数类型 | 可读 | 可写 | 说明
|
| --------
- | ------ | ---- | ---- |
----- |
| latitude
| number | 是 | 是 | 纬度。
|
| longitude | number | 是
| 是 | 经度。
|
| altitude
| number | 是 | 是
| 海拔高度。 |
zh-cn/application-dev/reference/apis/js-apis-update.md
浏览文件 @
52ae4725
...
...
@@ -30,15 +30,15 @@ getUpdater(upgradeFile: string, updateType?: UpdateTypes): Updater
**参数：**
| 参数名
| 类型 | 必填 | 说明
|
| ----------- | --------------------------- | ---- | ----
----
|
| upgradeFile | string | 是 | 升级文件 |
| updateType |
[
UpdateTypes
](
#updatetypes
)
| 是 | 升级类型 |
| 参数名
| 类型 | 必填 | 说明
|
| ----------- | --------------------------- | ---- | ---- |
| upgradeFile | string | 是
| 升级文件 |
| updateType |
[
UpdateTypes
](
#updatetypes
)
| 是
| 升级类型 |
**返回值：**
| 类型
| 说明
|
| ------------------- | ----
----
|
| 类型
| 说明
|
| ------------------- | ---- |
|
[
Updater
](
#updater
)
| 升级对象 |
**示例：**
...
...
@@ -61,16 +61,16 @@ getUpdaterForOther(upgradeFile: string, device: string, updateType?: UpdateTypes
**参数：**
| 参数名
| 类型 | 必填 | 说明
|
| ----------- | --------------------------- | ---- | -----
-----
|
| upgradeFile | string | 是
| 升级文件
|
| device | string | 是 | 待升级设备 |
| updateType |
[
UpdateTypes
](
#updatetypes
)
| 是
| 升级类型
|
| 参数名
| 类型 | 必填 | 说明
|
| ----------- | --------------------------- | ---- | ----- |
| upgradeFile | string | 是
| 升级文件
|
| device | string | 是
| 待升级设备 |
| updateType |
[
UpdateTypes
](
#updatetypes
)
| 是
| 升级类型
|
**返回值：**
| 类型
| 说明
|
| ------------------- | ----
----
|
| 类型
| 说明
|
| ------------------- | ---- |
|
[
Updater
](
#updater
)
| 升级对象 |
**示例：**
...
...
@@ -93,16 +93,16 @@ getUpdaterFromOther(upgradeFile: string, device: string, updateType?: UpdateType
**参数：**
| 参数名
| 类型 | 必填 | 说明
|
| ----------- | --------------------------- | ---- | -----
-----
|
| upgradeFile | string | 是
| 升级文件
|
| device | string | 是 | 待升级设备 |
| updateType |
[
UpdateTypes
](
#updatetypes
)
| 是
| 升级类型
|
| 参数名
| 类型 | 必填 | 说明
|
| ----------- | --------------------------- | ---- | ----- |
| upgradeFile | string | 是
| 升级文件
|
| device | string | 是
| 待升级设备 |
| updateType |
[
UpdateTypes
](
#updatetypes
)
| 是
| 升级类型
|
**返回值：**
| 类型
| 说明
|
| ------------------- | ----
----
|
| 类型
| 说明
|
| ------------------- | ---- |
|
[
Updater
](
#updater
)
| 升级对象 |
**示例：**
...
...
@@ -127,9 +127,9 @@ getNewVersionInfo(callback: AsyncCallback\<NewVersionInfo>): void
**参数：**
| 参数名
| 类型 | 必填 | 说明
|
| -------- | ----------------------------------------
-------- | ---- | ---------
--------- |
| callback | AsyncCallback
<
[
NewVersionInfo
](
#newversioninfo
)
>
| 否 | 回调返回新版本信息 |
| 参数名
| 类型 | 必填 | 说明
|
| -------- | ----------------------------------------
| ---- |
--------- |
| callback | AsyncCallback
<
[
NewVersionInfo
](
#newversioninfo
)
>
| 否
| 回调返回新版本信息 |
**示例：**
...
...
@@ -152,8 +152,8 @@ getNewVersionInfo(): Promise\<NewVersionInfo>
**返回值：**
| 类型
| 说明
|
| ----------------------------------------
--- | ---------
---------------- |
| 类型
| 说明
|
| ----------------------------------------
|
---------------- |
| Promise
\<
[
NewVersionInfo
](
#newversioninfo
)
> | Promise，用于异步获取结果 |
**示例：**
...
...
@@ -178,9 +178,9 @@ checkNewVersion(callback: AsyncCallback\<NewVersionInfo>): void
**参数：**
| 参数名
| 类型 | 必填 | 说明
|
| -------- | ----------------------------------------
--------- | ---- | ---------
--------- |
| callback | AsyncCallback
\<
[
NewVersionInfo
](
#newversioninfo
)
> | 否 | 回调返回新版本信息 |
| 参数名
| 类型 | 必填 | 说明
|
| -------- | ----------------------------------------
| ---- |
--------- |
| callback | AsyncCallback
\<
[
NewVersionInfo
](
#newversioninfo
)
> | 否
| 回调返回新版本信息 |
**示例：**
...
...
@@ -203,8 +203,8 @@ checkNewVersion(): Promise\<NewVersionInfo>
**返回值:**
| 类型
| 说明
|
| ----------------------------------------
--- | ---------
---------------- |
| 类型
| 说明
|
| ----------------------------------------
|
---------------- |
| Promise
\<
[
NewVersionInfo
](
#newversioninfo
)
> | Promise函数返回新版本信息 |
**示例:**
...
...
@@ -229,10 +229,10 @@ verifyUpdatePackage(upgradeFile: string, certsFile: string): void
**参数：**
| 参数名
| 类型 | 必填 | 说明
|
| ----------- | ------ | ---- | ---------
---------
|
| upgradeFile | string | 是 | 待校验的升级包路径 |
| certsFile | string | 是
| 证书路径
|
| 参数名
| 类型 | 必填 | 说明
|
| ----------- | ------ | ---- | --------- |
| upgradeFile | string | 是
| 待校验的升级包路径 |
| certsFile | string | 是
| 证书路径
|
**示例：**
...
...
@@ -253,8 +253,8 @@ rebootAndCleanUserData(): Promise\<number>
**返回值：**
| 类型
| 说明
|
| ---------------- | -------------------
------------
|
| 类型
| 说明
|
| ---------------- | ------------------- |
| Promise
\<
number> | Promise示例，用于异步获取结果。 |
**示例：**
...
...
@@ -277,9 +277,9 @@ rebootAndCleanUserData(callback: AsyncCallback\<number>): void
**参数：**
| 参数名
| 类型 | 必填 | 说明
|
| 参数名
| 类型 | 必填 | 说明
|
| -------- | -------- | ---- | ---------------------- |
| callback | Function | 是 | AsyncCallback
\<
number> |
| callback | Function | 是
| AsyncCallback
\<
number> |
**示例：**
...
...
@@ -299,8 +299,8 @@ applyNewVersion(): Promise\<number>
**返回值：**
| 类型
| 说明
|
| ---------------- | -------------------
------------
|
| 类型
| 说明
|
| ---------------- | ------------------- |
| Promise
\<
number> | Promise示例，用于异步获取结果。 |
**示例：**
...
...
@@ -323,9 +323,9 @@ applyNewVersion(callback: AsyncCallback\<number>): void
**参数：**
| 参数名
| 类型 | 必填 | 说明
|
| 参数名
| 类型 | 必填 | 说明
|
| -------- | -------- | ---- | ---------------------- |
| callback | Function | 是 | AsyncCallback
\<
number> |
| callback | Function | 是
| AsyncCallback
\<
number> |
**示例：**
...
...
@@ -356,7 +356,7 @@ updater.download();
### upgrade
up
dater.up
grade():void
upgrade():void
启动升级。
...
...
@@ -383,10 +383,10 @@ setUpdatePolicy(policy: UpdatePolicy, callback: AsyncCallback\<number>): void
**参数：**
| 参数名
| 类型 | 必填 | 说明
|
| -------- | ----------------------------- | ---- | ------
------
|
| policy |
[
UpdatePolicy
](
#updatepolicy
)
| 是 | 设置升级策略 |
| callback | AsyncCallback
\<
number> | 是 | 回调返回结果 |
| 参数名
| 类型 | 必填 | 说明
|
| -------- | ----------------------------- | ---- | ------ |
| policy |
[
UpdatePolicy
](
#updatepolicy
)
| 是
| 设置升级策略 |
| callback | AsyncCallback
\<
number> | 是
| 回调返回结果 |
**示例：**
...
...
@@ -414,14 +414,14 @@ setUpdatePolicy(policy: UpdatePolicy): Promise\<number>
**参数：**
| 参数名
| 类型 | 必填 | 说明
|
| ------ | ----------------------------- | ---- | ------
------
|
| policy |
[
UpdatePolicy
](
#updatepolicy
)
| 是 | 设置升级策略 |
| 参数名
| 类型 | 必填 | 说明
|
| ------ | ----------------------------- | ---- | ------ |
| policy |
[
UpdatePolicy
](
#updatepolicy
)
| 是
| 设置升级策略 |
**返回值：**
| 类型
| 说明
|
| ---------------- | ---------------
--------
|
| 类型
| 说明
|
| ---------------- | --------------- |
| Promise
\<
number> | Promise函数返回设置结果 |
**示例：**
...
...
@@ -451,9 +451,9 @@ getUpdatePolicy(callback: AsyncCallback\<UpdatePolicy>): void
**参数：**
| 参数名
| 类型 | 必填 | 说明
|
| -------- | ----------------------------------------
----- | ---- | ----------
---------- |
| callback | AsyncCallback
\<
[
UpdatePolicy
](
#updatepolicy
)
> | 否 | 回调返回升级策略信息 |
| 参数名
| 类型 | 必填 | 说明
|
| -------- | ----------------------------------------
| ---- |
---------- |
| callback | AsyncCallback
\<
[
UpdatePolicy
](
#updatepolicy
)
> | 否
| 回调返回升级策略信息 |
**示例：**
...
...
@@ -476,8 +476,8 @@ getUpdatePolicy(): Promise\<UpdatePolicy>
**返回值：**
| 类型
| 说明
|
| --------------------------------------- | -----------------
----------
|
| 类型
| 说明
|
| --------------------------------------- | ----------------- |
| Promise
\<
[
UpdatePolicy
](
#updatepolicy
)
> | Promise函数返回升级策略信息 |
**示例：**
...
...
@@ -498,10 +498,10 @@ update.getUpdatePolicy().then(value => {
**系统能力**
：以下各项对应的系统能力均为:SystemCapability.Update.UpdateService
| 参数名
| 说明
|
| -----
- | ---
----- |
| OTA
| OTA升级
|
| patch
| 补丁升级
|
| 参数名
| 说明
|
| -----
|
----- |
| OTA
| OTA升级
|
| patch
| 补丁升级
|
## PackageTypes
...
...
@@ -509,15 +509,15 @@ update.getUpdatePolicy().then(value => {
**系统能力**
：以下各项对应的系统能力均为:SystemCapability.Update.UpdateService
| 参数名
| 默认值 | 说明
|
| -------------------- | ----
-- | -------
------- |
| PACKAGE_TYPE_NORMAL | 1
| 通用升级包
|
| PACKAGE_TYPE_BASE | 2
| 基础升级包
|
| PACKAGE_TYPE_CUST | 3
| 定制升级包
|
| PACKAGE_TYPE_PRELOAD | 4
| 预装升级包
|
| PACKAGE_TYPE_COTA | 5
| 参数配置升级包 |
| PACKAGE_TYPE_VERSION | 6
| 版本升级包
|
| PACKAGE_TYPE_PATCH | 7
| 补丁包
|
| 参数名
| 默认值 | 说明
|
| -------------------- | ----
|
------- |
| PACKAGE_TYPE_NORMAL | 1
| 通用升级包
|
| PACKAGE_TYPE_BASE | 2
| 基础升级包
|
| PACKAGE_TYPE_CUST | 3
| 定制升级包
|
| PACKAGE_TYPE_PRELOAD | 4
| 预装升级包
|
| PACKAGE_TYPE_COTA | 5 | 参数配置升级包 |
| PACKAGE_TYPE_VERSION | 6
| 版本升级包
|
| PACKAGE_TYPE_PATCH | 7
| 补丁包
|
## InstallMode
...
...
@@ -525,11 +525,11 @@ update.getUpdatePolicy().then(value => {
**系统能力**
：以下各项对应的系统能力均为:SystemCapability.Update.UpdateService
| 参数名
| 默认值 | 说明
|
| ------------------- | ----
-- | ----
---- |
| INSTALL_MODE_NORMAL | 0
| 正常升级 |
| INSTALL_MODE_NIGHT | 1
| 夜间升级 |
| INSTALL_MODE_AUTO | 2
| 自动升级 |
| 参数名
| 默认值 | 说明
|
| ------------------- | ----
|
---- |
| INSTALL_MODE_NORMAL | 0 | 正常升级 |
| INSTALL_MODE_NIGHT | 1 | 夜间升级 |
| INSTALL_MODE_AUTO | 2 | 自动升级 |
## NewVersionStatus
...
...
@@ -537,12 +537,12 @@ update.getUpdatePolicy().then(value => {
**系统能力**
：以下各项对应的系统能力均为:SystemCapability.Update.UpdateService
| 参数名
| 默认值 | 说明
|
| ------------------- | ----
-- | --------
-------- |
| VERSION_STATUS_ERR | -1
| 检测版本时出错
|
| VERSION_STATUS_NEW | 0
| 检测到新版本
|
| VERSION_STATUS_NONE | 1
| 没有检测到新版本 |
| VERSION_STATUS_BUSY | 2
| 检测版本时忙
|
| 参数名
| 默认值 | 说明
|
| ------------------- | ----
|
-------- |
| VERSION_STATUS_ERR | -1
| 检测版本时出错
|
| VERSION_STATUS_NEW | 0
| 检测到新版本
|
| VERSION_STATUS_NONE | 1 | 没有检测到新版本 |
| VERSION_STATUS_BUSY | 2
| 检测版本时忙
|
## UpdatePolicy
...
...
@@ -550,11 +550,11 @@ update.getUpdatePolicy().then(value => {
**系统能力**
：以下各项对应的系统能力均为:SystemCapability.Update.UpdateService
| 名称
| 参数类型 | 必填 | 说明
|
| ------------------- | --------------------------- | ---- | -------
-------
|
| autoDownload | bool | 是
| 自动升级开关
|
| installMode |
[
InstallMode
](
#installmode
)
| 是
| 安装模式
|
| autoUpgradeInterval | Array
\<
number> | 是 | 自动升级时间段 |
| 名称
| 参数类型 | 必填 | 说明
|
| ------------------- | --------------------------- | ---- | ------- |
| autoDownload | bool | 是
| 自动升级开关
|
| installMode |
[
InstallMode
](
#installmode
)
| 是
| 安装模式
|
| autoUpgradeInterval | Array
\<
number> | 是
| 自动升级时间段 |
## NewVersionInfo
...
...
@@ -562,12 +562,12 @@ update.getUpdatePolicy().then(value => {
**系统能力**
：以下各项对应的系统能力均为:SystemCapability.Update.UpdateService
| 名称
| 参数类型 | 必填 | 说明
|
| --------------- | ----------------------------------------
--- | ---- | ----
---- |
| status |
[
NewVersionStatus
](
#newversionstatus
)
| 是
| 升级状态 |
| errMsg | string
| 是
| 错误信息 |
| checkResults | Array
<
[
CheckResult
](
#checkresult
)
>
| 是
| 检测结果 |
| descriptionInfo | Array
\<
[
DescriptionInfo
](
#descriptioninfo
)
> | 是 | 描述信息 |
| 名称
| 参数类型 | 必填 | 说明
|
| --------------- | ----------------------------------------
| ---- |
---- |
| status |
[
NewVersionStatus
](
#newversionstatus
)
| 是
| 升级状态 |
| errMsg | string
| 是
| 错误信息 |
| checkResults | Array
<
[
CheckResult
](
#checkresult
)
>
| 是
| 检测结果 |
| descriptionInfo | Array
\<
[
DescriptionInfo
](
#descriptioninfo
)
> | 是
| 描述信息 |
## CheckResult
...
...
@@ -575,14 +575,14 @@ update.getUpdatePolicy().then(value => {
**系统能力**
：以下各项对应的系统能力均为:SystemCapability.Update.UpdateService
| 名称
| 参数类型 | 必填 | 说明
|
| ------------- | ----------------------------- | ---- | ------
------
|
| versionName | string | 是
| 版本名称
|
| versionCode | number | 是
| 版本编码
|
| size | number | 是
| 版本大小
|
| verifyInfo | string | 是 | 版本校验信息 |
| packageType |
[
PackageTypes
](
#packagetypes
)
| 是
| 版本类型
|
| descriptionId | string | 是 | 版本描述信息 |
| 名称
| 参数类型 | 必填 | 说明
|
| ------------- | ----------------------------- | ---- | ------ |
| versionName | string | 是
| 版本名称
|
| versionCode | number | 是
| 版本编码
|
| size | number | 是
| 版本大小
|
| verifyInfo | string | 是
| 版本校验信息 |
| packageType |
[
PackageTypes
](
#packagetypes
)
| 是
| 版本类型
|
| descriptionId | string | 是
| 版本描述信息 |
## DescriptionInfo
...
...
@@ -590,7 +590,7 @@ update.getUpdatePolicy().then(value => {
**系统能力**
：以下各项对应的系统能力均为:SystemCapability.Update.UpdateService
| 名称 | 参数类型 | 必填 | 说明 |
| ------------- | -------- | ---- | ----------------- |
| descriptionId | string | 是 | 版本versionId信息 |
| content | string | 是 | 版本changelog信息 |
\ No newline at end of file
| 名称 | 参数类型 | 必填 | 说明 |
| ------------- | ------ | ---- | ------------- |
| descriptionId | string | 是 | 版本versionId信息 |
| content | string | 是 | 版本changelog信息 |
\ No newline at end of file
zh-cn/application-dev/reference/apis/js-apis-vibrator.md
浏览文件 @
52ae4725
...
...
@@ -22,18 +22,18 @@ vibrate(duration: number): Promise<void>
**系统能力**
：SystemCapability.Sensors.MiscDevice
-
参数：
| 参数名 | 类型 | 必填 | 说明
|
| -------- | -------- | -------- |
-------- |
| duration | number | 是
| 指示马达振动的持续时间。 |
**参数：**
| 参数名 | 类型 | 必填 | 说明
|
| -------- | ------ | ---- | ----
-------- |
| duration | number | 是
| 指示马达振动的持续时间。 |
-
返回值：
| 类型 | 说明
|
| -------- |
-------- |
| Promise
<
void
>
| 指示触发振动是否成功。 |
**返回值：**
| 类型 | 说明
|
| ------------------- | ---
-------- |
| Promise
<
void
>
| 指示触发振动是否成功。 |
-
示例：
**示例：**
```
vibrator.vibrate(1000).then(()=>{
console.log("Promise returned to indicate a successful vibration.");
...
...
@@ -53,13 +53,13 @@ vibrate(duration: number, callback?: AsyncCallback<void>): void
**系统能力**
：SystemCapability.Sensors.MiscDevice
-
参数：
| 参数名 | 类型 | 必填 | 说明
|
| -------- | -------- | -------- |
-------- |
| duration | number | 是 | 指示马达振动的持续时间。
|
| callback | AsyncCallback
<
void
>
| 否
| 马达执行振动的回调函数，指示触发振动是否成功。 |
**参数：**
| 参数名 | 类型 | 必填 | 说明
|
| -------- | ------------------------- | ---- | ---------------
-------- |
| duration | number | 是 | 指示马达振动的持续时间。
|
| callback | AsyncCallback
<
void
>
| 否
| 马达执行振动的回调函数，指示触发振动是否成功。 |
-
示例：
**示例：**
```
vibrator.vibrate(1000,function(error){
if(error){
...
...
@@ -81,17 +81,17 @@ vibrate(effectId: EffectId): Promise<void>
**系统能力**
：SystemCapability.Sensors.MiscDevice
-
参数：
| 参数名 | 类型 | 必填 | 说明
|
| -------- | -------- | -------- |
-------- |
| effectId |
[
EffectId
](
#effectid
)
| 是
| 指示马达振动效果的字符串。 |
**参数：**
| 参数名 | 类型 | 必填 | 说明
|
| -------- | --------------------- | ---- | -----
-------- |
| effectId |
[
EffectId
](
#effectid
)
| 是
| 指示马达振动效果的字符串。 |
-
返回值：
| 类型 | 说明
|
| -------- |
-------- |
| Promise
<
void
>
| 指示触发振动是否成功。 |
**返回值：**
| 类型 | 说明
|
| ------------------- | ---
-------- |
| Promise
<
void
>
| 指示触发振动是否成功。 |
-
示例：
**示例：**
```
vibrator.vibrate(vibrator.EffectId.EFFECT_CLOCK_TIMER).then(()=>{
console.log("Promise returned to indicate a successful vibration.");
...
...
@@ -111,13 +111,13 @@ vibrate(effectId: EffectId, callback?: AsyncCallback<void>): void
**系统能力**
：SystemCapability.Sensors.MiscDevice
-
参数：
| 参数名 | 类型 | 必填 | 说明
|
| -------- | -------- | -------- |
-------- |
| effectId |
[
EffectId
](
#effectid
)
| 是 | 指示马达振动效果的字符串。
|
| callback | AsyncCallback
<
void
>
| 否
| 马达执行振动的回调函数，指示触发振动是否成功。 |
**参数：**
| 参数名 | 类型 | 必填 | 说明
|
| -------- | ------------------------- | ---- | ---------------
-------- |
| effectId |
[
EffectId
](
#effectid
)
| 是 | 指示马达振动效果的字符串。
|
| callback | AsyncCallback
<
void
>
| 否
| 马达执行振动的回调函数，指示触发振动是否成功。 |
-
示例：
**示例：**
```
vibrator.vibrate(vibrator.EffectId.EFFECT_CLOCK_TIMER, function(error){
if(error){
...
...
@@ -139,17 +139,17 @@ stop(stopMode: VibratorStopMode): Promise<void>
**系统能力**
：SystemCapability.Sensors.MiscDevice
-
参数：
| 参数名 | 类型 | 必填 | 说明
|
| -------- | -------- | -------- |
-------- |
| stopMode |
[
VibratorStopMode
](
#vibratorstopmode
)
| 是
| 指示马达要停止指定的振动模式。 |
**参数：**
| 参数名 | 类型 | 必填 | 说明
|
| -------- | ------------------------------------- | ---- | -------
-------- |
| stopMode |
[
VibratorStopMode
](
#vibratorstopmode
)
| 是
| 指示马达要停止指定的振动模式。 |
-
返回值：
| 类型 | 说明
|
| -------- |
-------- |
| Promise
<
void
>
| 指示停止振动是否成功。 |
**返回值：**
| 类型 | 说明
|
| ------------------- | ---
-------- |
| Promise
<
void
>
| 指示停止振动是否成功。 |
-
示例：
**示例：**
```
vibrator.stop(vibrator.VibratorStopMode.VIBRATOR_STOP_MODE_PRESET).then(()=>{
console.log("Promise returned to indicate a successful vibration.");
...
...
@@ -169,13 +169,13 @@ stop(stopMode: VibratorStopMode, callback?: AsyncCallback<void>): void;
**系统能力**
：SystemCapability.Sensors.MiscDevice
-
参数：
| 参数名 | 类型 | 必填 | 说明
|
| -------- | -------- | -------- |
-------- |
| stopMode |
[
VibratorStopMode
](
#vibratorstopmode
)
| 是 | 指示马达要停止指定的振动模式。
|
| callback | AsyncCallback
<
void
>
| 否
| 马达停止振动的回调函数，指示停止振动是否成功。 |
**参数：**
| 参数名 | 类型 | 必填 | 说明
|
| -------- | ------------------------------------- | ---- | ---------------
-------- |
| stopMode |
[
VibratorStopMode
](
#vibratorstopmode
)
| 是 | 指示马达要停止指定的振动模式。
|
| callback | AsyncCallback
<
void
>
| 否
| 马达停止振动的回调函数，指示停止振动是否成功。 |
-
示例：
**示例：**
```
vibrator.stop(vibrator.VibratorStopMode.VIBRATOR_STOP_MODE_PRESET, function(error){
if(error){
...
...
@@ -193,8 +193,8 @@ stop(stopMode: VibratorStopMode, callback?: AsyncCallback<void>): void;
**系统能力**
：以下各项对应的系统能力均为SystemCapability.Sensors.MiscDevice
| 名称
| 默认值 | 说明
|
| --------
| -------- |
-------- |
| 名称
| 默认值 | 说明
|
| --------
---------- | -------------------- | -------
-------- |
| EFFECT_CLOCK_TIMER | "haptic.clock.timer" | 调整定时器时振动器的振动效果。 |
...
...
@@ -204,7 +204,7 @@ stop(stopMode: VibratorStopMode, callback?: AsyncCallback<void>): void;
**系统能力**
：以下各项对应的系统能力均为SystemCapability.Sensors.MiscDevice
| 名称
| 默认值 | 说明
|
| --------
| -------- |
-------- |
| VIBRATOR_STOP_MODE_TIME
| "time"
| 停止模式为duration模式的振动。即触发振动时参数类型为number，参数本身为指示振动持续时间的触发方式。 |
| 名称
| 默认值 | 说明
|
| --------
----------------- | -------- | --------------------------------
-------- |
| VIBRATOR_STOP_MODE_TIME
| "time"
| 停止模式为duration模式的振动。即触发振动时参数类型为number，参数本身为指示振动持续时间的触发方式。 |
| VIBRATOR_STOP_MODE_PRESET | "preset" | 停止模式为预置EffectId的振动。即触发振动时参数类型为EffectId，参数本身为指示马达振动效果的字符串的触发方式。 |
zh-cn/application-dev/reference/apis/js-apis-workScheduler.md
浏览文件 @
52ae4725
...
...
@@ -19,14 +19,14 @@ startWork(work: WorkInfo): boolean
**参数**
：
| 参数名
| 类型 | 必填 | 说明
|
| ----
---- | -------- | -------- |
-------- |
| work |
[
WorkInfo
](
#workinfo
)
| 是 | 指示要添加到执行队列的工作。 |
| 参数名
| 类型 | 必填 | 说明
|
| ----
| --------------------- | ---- | ------
-------- |
| work |
[
WorkInfo
](
#workinfo
)
| 是
| 指示要添加到执行队列的工作。 |
**返回值**
：
| 类型
| 说明
|
| -------
- |
-------- |
| 类型
| 说明
|
| -------
| ------------------------
-------- |
| boolean | 如果工作成功添加到执行队列，则返回true，否则返回false。 |
**示例**
：
...
...
@@ -54,15 +54,15 @@ stopWork(work: WorkInfo, needCancel?: boolean): boolean
**参数**
：
| 参数名
| 类型 | 必填 | 说明
|
| --------
| -------- | -------- |
-------- |
| work
|
[
WorkInfo
](
#workinfo
)
| 是 | 指示要停止的工作。
|
|
needCancel|boolean| 是| 是否需要取消的工作。
|
| 参数名
| 类型 | 必填 | 说明
|
| --------
-- | --------------------- | ---- | --
-------- |
| work
|
[
WorkInfo
](
#workinfo
)
| 是 | 指示要停止的工作。
|
|
needCancel | boolean | 是 | 是否需要取消的工作。
|
**返回值**
：
| 类型
| 说明
|
| -------
- |
-------- |
| 类型
| 说明
|
| -------
| ---------------
-------- |
| boolean | 如果成功，则返回true，否则返回false。 |
**示例**
：
...
...
@@ -90,10 +90,10 @@ getWorkStatus(workId: number, callback : AsyncCallback\<WorkInfo>): void
**参数**
：
| 参数名
| 类型 | 必填 | 说明
|
| -------- | --------
| -------- |
-------- |
| workId
| number | 是 | work的id。
|
|
callback|AsyncCallback
\<
[
WorkInfo
](
#workinfo
)
>| 是| 指定的callback回调方法。如果指定的工作Id有效，则返回从WorkSchedulerService获取的有效工作状态；否则返回null。
|
| 参数名
| 类型 | 必填 | 说明
|
| -------- | --------
----------------------------- | ---- | --------------------------------
-------- |
| workId
| number | 是 | work的id。
|
|
callback | AsyncCallback
\<
[
WorkInfo
](
#workinfo
)
> | 是 | 指定的callback回调方法。如果指定的工作Id有效，则返回从WorkSchedulerService获取的有效工作状态；否则返回null。
|
**示例**
：
...
...
@@ -110,7 +110,7 @@ getWorkStatus(workId: number, callback : AsyncCallback\<WorkInfo>): void
```
## workScheduler.getWorkStatus
getWorkStatus(workI
D
: number): Promise
\<
WorkInfo>
getWorkStatus(workI
d
: number): Promise
\<
WorkInfo>
获取工作的最新状态，使用Promise形式返回。
...
...
@@ -118,14 +118,14 @@ getWorkStatus(workID: number): Promise\<WorkInfo>
**参数**
：
| 参数名
| 类型 | 必填 | 说明
|
| ------
-- | -------- | ----
---- | -------- |
| workId | number | 是 | work的id。 |
| 参数名
| 类型 | 必填 | 说明
|
| ------
| ------ |
---- | -------- |
| workId | number | 是
| work的id。 |
**返回值**
：
| 类型
| 说明
|
| --------
|
-------- |
| 类型
| 说明
|
| --------
----------------------- | --------------------------------
-------- |
| Promise
\<
[
WorkInfo
](
#workinfo
)
> | 指定的Promise回调方法。如果指定的工作ID有效，则返回从WorkSchedulerService获取的有效工作状态；否则返回null。 |
**示例**
：
...
...
@@ -149,14 +149,14 @@ obtainAllWorks(callback : AsyncCallback\<void>): Array\<WorkInfo>
**参数**
：
| 参数名
| 类型 | 必填 | 说明
|
| -------- | --------
| -------- |
-------- |
|
callback|AsyncCallback
\<
void>| 是| 指定的callback回调方法。返回与应用程序关联的所有工作。
|
| 参数名
| 类型 | 必填 | 说明
|
| -------- | --------
------------ | ---- | -----------------------
-------- |
|
callback | AsyncCallback
\<
void> | 是 | 指定的callback回调方法。返回与应用程序关联的所有工作。
|
**返回值**
：
| 类型
| 说明
|
| --------
|
-------- |
| 类型
| 说明
|
| --------
--------------------- | -------
-------- |
| Array
\<
[
WorkInfo
](
#workinfo
)
> | 返回与应用程序关联的所有工作。 |
**示例**
：
...
...
@@ -180,9 +180,9 @@ obtainAllWorks(): Promise<Array\<WorkInfo>>
**返回值**
：
| 类型
| 说明
|
| --------
|
-------- |
| Promise
<Array
\<[
WorkInfo
](
#workinfo
)
>
> |
指定的Promise回调方法。返回与应用程序关联的所有工作。
|
| 类型
| 说明
|
| --------
------------------------------ | ----------------------
-------- |
| Promise
<Array
\<[
WorkInfo
](
#workinfo
)
>
> |
指定的Promise回调方法。返回与应用程序关联的所有工作。
|
**示例**
：
...
...
@@ -217,15 +217,15 @@ isLastWorkTimeOut(workId: number, callback : AsyncCallback\<void>): boolean
**参数**
：
| 参数名
| 类型 | 必填 | 说明
|
| -------- | --------
| -------- |
-------- |
| workId
| number | 是 | work的id。
|
|
callback|AsyncCallback
\<
void>| 是| 指定的callback回调方法。如果指定工作的最后一次执行是超时操作，则返回true；否则返回false。
|
| 参数名
| 类型 | 必填 | 说明
|
| -------- | --------
------------ | ---- | --------------------------------
-------- |
| workId
| number | 是 | work的id。
|
|
callback | AsyncCallback
\<
void> | 是 | 指定的callback回调方法。如果指定工作的最后一次执行是超时操作，则返回true；否则返回false。
|
**返回值**
：
| 类型
| 说明
|
| -------
- |
-------- |
| 类型
| 说明
|
| -------
| --------------------------------
-------- |
| boolean | 指定的callback回调方法。如果指定工作的最后一次执行是超时操作，则返回true；否则返回false。 |
**示例**
：
...
...
@@ -249,15 +249,15 @@ isLastWorkTimeOut(workId: number): Promise\<boolean>
**参数**
：
| 参数名
| 类型 | 必填 | 说明
|
| ------
-- | -------- | ----
---- | -------- |
| workId | number | 是 | work的id。 |
| 参数名
| 类型 | 必填 | 说明
|
| ------
| ------ |
---- | -------- |
| workId | number | 是
| work的id。 |
**返回值**
：
| 类型
| 说明
|
| --------
|
-------- |
| Promise
\<
boolean> | 指定的Promise回调方法。如果指定工作的最后一次执行是超时操作，则返回true；否则返回false。|
| 类型
| 说明
|
| --------
--------- | --------------------------------
-------- |
| Promise
\<
boolean> | 指定的Promise回调方法。如果指定工作的最后一次执行是超时操作，则返回true；否则返回false。
|
**示例**
：
...
...
@@ -276,57 +276,57 @@ isLastWorkTimeOut(workId: number): Promise\<boolean>
**系统能力**
：以下各项对应的系统能力均为SystemCapability.ResourceSchedule.WorkScheduler
| 参数名
| 类型 | 必填 | 说明
|
| --------
| -------- | -------- |
-------- |
|
workId |number |是 |当前工作的ID
|
|
bundleName |string |是| 延迟任务包名
|
|
abilityName | string| 是| 延迟任务回调通知的组件名（必填）
|
|
networkType |
[
NetworkType
](
#networktype
)
| 否| 网络类型
|
|
isCharging | boolean| 否|是否充电
|
|
chargerType |
[
ChargingType
](
#chargingtype
)
| 否|充电类型
|
|
batteryLevel | number| 否|电量
|
|
batteryStatus|
[
BatteryStatus
](
#batterystatus
)
| 否|电池状态
|
|
storageRequest|
[
StorageRequest
](
#storagerequest
)
| 否|存储状态
|
|
isRepeat|boolean|否|是否循环任务
|
|
repeatCycleTime |number|否|循环间隔
|
|
repeatCount |number|否|循环次数
|
| 参数名
| 类型 | 必填 | 说明
|
| --------
------- | --------------------------------- | ---- | --------
-------- |
|
workId | number | 是 | 当前工作的ID
|
|
bundleName | string | 是 | 延迟任务包名
|
|
abilityName | string | 是 | 延迟任务回调通知的组件名（必填）
|
|
networkType |
[
NetworkType
](
#networktype
)
| 否 | 网络类型
|
|
isCharging | boolean | 否 | 是否充电
|
|
chargerType |
[
ChargingType
](
#chargingtype
)
| 否 | 充电类型
|
|
batteryLevel | number | 否 | 电量
|
|
batteryStatus |
[
BatteryStatus
](
#batterystatus
)
| 否 | 电池状态
|
|
storageRequest |
[
StorageRequest
](
#storagerequest
)
| 否 | 存储状态
|
|
isRepeat | boolean | 否 | 是否循环任务
|
|
repeatCycleTime | number | 否 | 循环间隔
|
|
repeatCount | number | 否 | 循环次数
|
## NetworkType
触发工作的网络类型。
**系统能力**
：以下各项对应的系统能力均为SystemCapability.ResourceSchedule.WorkScheduler
|名称 |默认值 |说明
|
| -------- | -------- |
-------- |
|NETWORK_TYPE_ANY |0 |表示这个触发条件是任何类型的网络连接。
|
|NETWORK_TYPE_MOBILE |1| 表示这个触发条件是Mobile网络连接。
|
|NETWORK_TYPE_WIFI |2 |表示这个触发条件是Wifi类型的网络连接。
|
|NETWORK_TYPE_BLUETOOTH |3 |表示这个触发条件是Bluetooth网络连接。
|
|NETWORK_TYPE_WIFI_P2P |4 |表示这个触发条件是Wifi P2P网络连接。
|
|NETWORK_TYPE_ETHERNET |5 |表示这个触发条件是有线网络连接。
|
| 名称 | 默认值 | 说明
|
| ---------------------- | ---- | ---------------
-------- |
| NETWORK_TYPE_ANY | 0 | 表示这个触发条件是任何类型的网络连接。
|
| NETWORK_TYPE_MOBILE | 1 | 表示这个触发条件是Mobile网络连接。
|
| NETWORK_TYPE_WIFI | 2 | 表示这个触发条件是Wifi类型的网络连接。
|
| NETWORK_TYPE_BLUETOOTH | 3 | 表示这个触发条件是Bluetooth网络连接。
|
| NETWORK_TYPE_WIFI_P2P | 4 | 表示这个触发条件是Wifi P2P网络连接。
|
| NETWORK_TYPE_ETHERNET | 5 | 表示这个触发条件是有线网络连接。
|
## ChargingType
触发工作的充电类型。
**系统能力**
：以下各项对应的系统能力均为SystemCapability.ResourceSchedule.WorkScheduler
|名称 |默认值 |说明
|
| -------- | -------- |
-------- |
|CHARGING_PLUGGED_ANY |0| 表示这个触发条件是任何类型的充电器连接。
|
|CHARGING_PLUGGED_AC |1 |表示这个触发条件是直流充电器连接。
|
|CHARGING_PLUGGED_USB |2 |表示这个触发条件是USB充连接。
|
|CHARGING_PLUGGED_WIRELESS |3| 表示这个触发条件是无线充电器连接。
|
| 名称 | 默认值 | 说明
|
| ------------------------- | ---- | ------------
-------- |
| CHARGING_PLUGGED_ANY | 0 | 表示这个触发条件是任何类型的充电器连接。
|
| CHARGING_PLUGGED_AC | 1 | 表示这个触发条件是直流充电器连接。
|
| CHARGING_PLUGGED_USB | 2 | 表示这个触发条件是USB充连接。
|
| CHARGING_PLUGGED_WIRELESS | 3 | 表示这个触发条件是无线充电器连接。
|
## BatteryStatus
触发工作的电池状态。
**系统能力**
：以下各项对应的系统能力均为SystemCapability.ResourceSchedule.WorkScheduler
|名称 |默认值 |说明
|
| -------- | -------- |
-------- |
|BATTERY_STATUS_LOW |0 |表示这个触发条件是低电告警。
|
|BATTERY_STATUS_OKAY |1| 表示这个触发条件是从低电恢复到正常电量。
|
|BATTERY_STATUS_LOW_OR_OKAY |2 |表示这个触发条件是从低电恢复到正常电量或者低电告警。
|
| 名称 | 默认值 | 说明
|
| -------------------------- | ---- | ------------------
-------- |
| BATTERY_STATUS_LOW | 0 | 表示这个触发条件是低电告警。
|
| BATTERY_STATUS_OKAY | 1 | 表示这个触发条件是从低电恢复到正常电量。
|
| BATTERY_STATUS_LOW_OR_OKAY | 2 | 表示这个触发条件是从低电恢复到正常电量或者低电告警。
|
## StorageRequest
触发工作的存储状态。
...
...
编辑
预览
Markdown
is supported
0%
请重试
或
添加新附件
.
添加附件
取消
You are about to add
0
people
to the discussion. Proceed with caution.
先完成此消息的编辑！
取消
想要评论请
注册
或
登录
