未验证 提交 52ae4725 编写于 作者: O openharmony_ci 提交者: Gitee

!2326 一致性问题修改

Merge pull request !2326 from LiAn/master
...@@ -46,12 +46,12 @@ stat(path: string): Promise<Stat> ...@@ -46,12 +46,12 @@ stat(path: string): Promise<Stat>
- 参数: - 参数:
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | | ---- | ------ | ---- | ----------- |
| path | string | 是 | 待获取文件的绝对路径。 | | path | string | 是 | 待获取文件的绝对路径。 |
- 返回值: - 返回值:
| 类型 | 说明 | | 类型 | 说明 |
| -------- | -------- | | ---------------------------- | ---------- |
| Promise<[Stat](#stat)> | 表示文件的具体信息。 | | Promise<[Stat](#stat)> | 表示文件的具体信息。 |
- 示例: - 示例:
...@@ -74,7 +74,7 @@ stat(path:string, callback:AsyncCallback<Stat>): void ...@@ -74,7 +74,7 @@ stat(path:string, callback:AsyncCallback<Stat>): void
- 参数: - 参数:
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | | -------- | ---------------------------------- | ---- | --------------- |
| path | string | 是 | 待获取文件的绝对路径。 | | path | string | 是 | 待获取文件的绝对路径。 |
| callback | AsyncCallback<[Stat](#stat)> | 是 | 异步获取文件的信息之后的回调。 | | callback | AsyncCallback<[Stat](#stat)> | 是 | 异步获取文件的信息之后的回调。 |
...@@ -96,13 +96,13 @@ statSync(path:string): Stat ...@@ -96,13 +96,13 @@ statSync(path:string): Stat
- 参数: - 参数:
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | | ---- | ------ | ---- | ----------- |
| path | string | 是 | 待获取文件的绝对路径。 | | path | string | 是 | 待获取文件的绝对路径。 |
- 返回值: - 返回值:
| 类型 | 说明 | | 类型 | 说明 |
| -------- | -------- | | ------------- | ---------- |
| [Stat](#stat) | 表示文件的具体信息。 | | [Stat](#stat) | 表示文件的具体信息。 |
- 示例: - 示例:
...@@ -122,12 +122,12 @@ opendir(path: string): Promise<Dir> ...@@ -122,12 +122,12 @@ opendir(path: string): Promise<Dir>
- 参数: - 参数:
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | | ---- | ------ | ---- | ------------- |
| path | string | 是 | 待打开文件目录的绝对路径。 | | path | string | 是 | 待打开文件目录的绝对路径。 |
- 返回值: - 返回值:
| 类型 | 说明 | | 类型 | 说明 |
| -------- | -------- | | -------------------------- | -------- |
| Promise<[Dir](#dir)> | 返回Dir对象。 | | Promise<[Dir](#dir)> | 返回Dir对象。 |
- 示例: - 示例:
...@@ -150,7 +150,7 @@ opendir(path: string, callback: AsyncCallback<Dir>): void ...@@ -150,7 +150,7 @@ opendir(path: string, callback: AsyncCallback<Dir>): void
- 参数: - 参数:
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | | -------- | -------------------------------- | ---- | -------------- |
| path | string | 是 | 待打开文件目录的绝对路径。 | | path | string | 是 | 待打开文件目录的绝对路径。 |
| callback | AsyncCallback<[Dir](#dir)> | 是 | 异步打开文件目录之后的回调。 | | callback | AsyncCallback<[Dir](#dir)> | 是 | 异步打开文件目录之后的回调。 |
...@@ -174,12 +174,12 @@ opendirSync(path: string): Dir ...@@ -174,12 +174,12 @@ opendirSync(path: string): Dir
- 参数: - 参数:
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | | ---- | ------ | ---- | ------------- |
| path | string | 是 | 待打开文件目录的绝对路径。 | | path | string | 是 | 待打开文件目录的绝对路径。 |
- 返回值: - 返回值:
| 类型 | 说明 | | 类型 | 说明 |
| -------- | -------- | | ----------- | -------- |
| [Dir](#dir) | 返回Dir对象。 | | [Dir](#dir) | 返回Dir对象。 |
- 示例: - 示例:
...@@ -200,13 +200,13 @@ access(path: string, mode?: number): Promise<void> ...@@ -200,13 +200,13 @@ access(path: string, mode?: number): Promise<void>
- 参数:. - 参数:.
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | | ---- | ------ | ---- | ---------------------------------------- |
| path | string | 是 | 待访问文件的绝对路径。 | | path | string | 是 | 待访问文件的绝对路径。 |
| mode | number | 否 | 访问文件时的选项,可给定如下选项,以按位或的方式使用多个选项,默认给定0。<br/>确认当前进程是否具有对应权限:<br/>-&nbsp;0:确认文件是否存在。<br/>-&nbsp;1:确认当前进程是否具有可执行权限。<br/>-&nbsp;2:确认当前进程是否具有写权限。<br/>-&nbsp;4:确认当前进程是否具有读权限。 | | mode | number | 否 | 访问文件时的选项,可给定如下选项,以按位或的方式使用多个选项,默认给定0。<br/>确认当前进程是否具有对应权限:<br/>-&nbsp;0:确认文件是否存在。<br/>-&nbsp;1:确认当前进程是否具有可执行权限。<br/>-&nbsp;2:确认当前进程是否具有写权限。<br/>-&nbsp;4:确认当前进程是否具有读权限。 |
- 返回值: - 返回值:
| 类型 | 说明 | | 类型 | 说明 |
| -------- | -------- | | ------------------- | ---------------------------- |
| Promise&lt;void&gt; | Promise实例,用于异步获取结果。本调用将返回空值。 | | Promise&lt;void&gt; | Promise实例,用于异步获取结果。本调用将返回空值。 |
- 示例: - 示例:
...@@ -229,7 +229,7 @@ access(path: string, mode: number, callback: AsyncCallback&lt;void&gt;): void ...@@ -229,7 +229,7 @@ access(path: string, mode: number, callback: AsyncCallback&lt;void&gt;): void
- 参数: - 参数:
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | | -------- | ------------------------- | ---- | ---------------------------------------- |
| path | string | 是 | 待访问文件的绝对路径。 | | path | string | 是 | 待访问文件的绝对路径。 |
| mode | number | 否 | 访问文件时的选项,可给定如下选项,以按位或的方式使用多个选项,默认给定0。<br/>确认当前进程是否具有对应权限:<br/>-&nbsp;0:确认文件是否存在。<br/>-&nbsp;1:确认当前进程是否具有可执行权限。<br/>-&nbsp;2:确认当前进程是否具有写权限。<br/>-&nbsp;4:确认当前进程是否具有读权限。 | | mode | number | 否 | 访问文件时的选项,可给定如下选项,以按位或的方式使用多个选项,默认给定0。<br/>确认当前进程是否具有对应权限:<br/>-&nbsp;0:确认文件是否存在。<br/>-&nbsp;1:确认当前进程是否具有可执行权限。<br/>-&nbsp;2:确认当前进程是否具有写权限。<br/>-&nbsp;4:确认当前进程是否具有读权限。 |
| callback | AsyncCallback&lt;void&gt; | 是 | 异步检查当前进程是否可访问某文件之后的回调。 | | callback | AsyncCallback&lt;void&gt; | 是 | 异步检查当前进程是否可访问某文件之后的回调。 |
...@@ -252,7 +252,7 @@ accessSync(path: string, mode?: number): void ...@@ -252,7 +252,7 @@ accessSync(path: string, mode?: number): void
- 参数: - 参数:
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | | ---- | ------ | ---- | ---------------------------------------- |
| path | string | 是 | 待访问文件的绝对路径。 | | path | string | 是 | 待访问文件的绝对路径。 |
| mode | number | 否 | 访问文件时的选项,可给定如下选项,以按位或的方式使用多个选项,默认给定0。<br/>确认当前进程是否具有对应权限:<br/>-&nbsp;0:确认文件是否存在。<br/>-&nbsp;1:确认当前进程是否具有可执行权限。<br/>-&nbsp;2:确认当前进程是否具有写权限。<br/>-&nbsp;4:确认当前进程是否具有读权限。 | | mode | number | 否 | 访问文件时的选项,可给定如下选项,以按位或的方式使用多个选项,默认给定0。<br/>确认当前进程是否具有对应权限:<br/>-&nbsp;0:确认文件是否存在。<br/>-&nbsp;1:确认当前进程是否具有可执行权限。<br/>-&nbsp;2:确认当前进程是否具有写权限。<br/>-&nbsp;4:确认当前进程是否具有读权限。 |
...@@ -276,12 +276,12 @@ close(fd: number):Promise&lt;void&gt; ...@@ -276,12 +276,12 @@ close(fd: number):Promise&lt;void&gt;
- 参数: - 参数:
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | | ---- | ------ | ---- | ------------ |
| fd | number | 是 | 待关闭文件的文件描述符。 | | fd | number | 是 | 待关闭文件的文件描述符。 |
- 返回值: - 返回值:
| 类型 | 说明 | | 类型 | 说明 |
| -------- | -------- | | ------------------- | ---------------------------- |
| Promise&lt;void&gt; | Promise实例,用于异步获取结果。本调用将返回空值。 | | Promise&lt;void&gt; | Promise实例,用于异步获取结果。本调用将返回空值。 |
- 示例: - 示例:
...@@ -305,7 +305,7 @@ close(fd: number, callback:AsyncCallback&lt;void&gt;): void ...@@ -305,7 +305,7 @@ close(fd: number, callback:AsyncCallback&lt;void&gt;): void
- 参数: - 参数:
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | | -------- | ------------------------- | ---- | ------------ |
| fd | number | 是 | 待关闭文件的文件描述符。 | | fd | number | 是 | 待关闭文件的文件描述符。 |
| callback | AsyncCallback&lt;void&gt; | 是 | 异步关闭文件之后的回调。 | | callback | AsyncCallback&lt;void&gt; | 是 | 异步关闭文件之后的回调。 |
...@@ -328,7 +328,7 @@ closeSync(fd: number): void ...@@ -328,7 +328,7 @@ closeSync(fd: number): void
- 参数: - 参数:
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | | ---- | ------ | ---- | ------------ |
| fd | number | 是 | 待关闭文件的文件描述符。 | | fd | number | 是 | 待关闭文件的文件描述符。 |
- 示例: - 示例:
...@@ -347,7 +347,7 @@ close(): Promise&lt;void&gt; ...@@ -347,7 +347,7 @@ close(): Promise&lt;void&gt;
- 返回值: - 返回值:
| 类型 | 说明 | | 类型 | 说明 |
| -------- | -------- | | ------------------- | ---------------------------- |
| Promise&lt;void&gt; | Promise实例,用于异步获取结果。本调用将返回空值。 | | Promise&lt;void&gt; | Promise实例,用于异步获取结果。本调用将返回空值。 |
- 示例: - 示例:
...@@ -370,7 +370,7 @@ close(callback: AsyncCallback&lt;void&gt;): void ...@@ -370,7 +370,7 @@ close(callback: AsyncCallback&lt;void&gt;): void
- 参数: - 参数:
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | | -------- | ------------------------- | ---- | ------------- |
| callback | AsyncCallback&lt;void&gt; | 是 | 异步关闭文件流之后的回调。 | | callback | AsyncCallback&lt;void&gt; | 是 | 异步关闭文件流之后的回调。 |
- 示例: - 示例:
...@@ -391,14 +391,14 @@ copyFile(src:string | number, dest:string | number, mode?:number):Promise&lt;voi ...@@ -391,14 +391,14 @@ copyFile(src:string | number, dest:string | number, mode?:number):Promise&lt;voi
- 参数: - 参数:
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | | ---- | -------------------------- | ---- | ---------------------------------------- |
| src | string&nbsp;\|&nbsp;number | 是 | 待复制文件的路径或待复制文件的描述符。 | | src | string&nbsp;\|&nbsp;number | 是 | 待复制文件的路径或待复制文件的描述符。 |
| dest | string&nbsp;\|&nbsp;number | 是 | 目标文件路径或目标文件描述符。 | | dest | string&nbsp;\|&nbsp;number | 是 | 目标文件路径或目标文件描述符。 |
| mode | number | 否 | mode提供覆盖文件的选项,当前仅支持0,且默认为0。<br/>0:完全覆盖目标文件,未覆盖部分将被裁切掉。 | | mode | number | 否 | mode提供覆盖文件的选项,当前仅支持0,且默认为0。<br/>0:完全覆盖目标文件,未覆盖部分将被裁切掉。 |
- 返回值: - 返回值:
| 类型 | 说明 | | 类型 | 说明 |
| -------- | -------- | | ------------------- | ---------------------------- |
| Promise&lt;void&gt; | Promise实例,用于异步获取结果。本调用将返回空值。 | | Promise&lt;void&gt; | Promise实例,用于异步获取结果。本调用将返回空值。 |
- 示例: - 示例:
...@@ -421,7 +421,7 @@ copyFile(src: string | number, dest: string | number, mode: number, callback: As ...@@ -421,7 +421,7 @@ copyFile(src: string | number, dest: string | number, mode: number, callback: As
- 参数: - 参数:
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | | -------- | -------------------------- | ---- | ---------------------------------------- |
| src | string&nbsp;\|&nbsp;number | 是 | 待复制文件的路径或待复制文件的描述符。 | | src | string&nbsp;\|&nbsp;number | 是 | 待复制文件的路径或待复制文件的描述符。 |
| dest | string&nbsp;\|&nbsp;number | 是 | 目标文件路径或目标文件描述符。 | | dest | string&nbsp;\|&nbsp;number | 是 | 目标文件路径或目标文件描述符。 |
| mode | number | 否 | mode提供覆盖文件的选项,当前仅支持0,且默认为0。<br/>0:完全覆盖目标文件,未覆盖部分将被裁切掉。 | | mode | number | 否 | mode提供覆盖文件的选项,当前仅支持0,且默认为0。<br/>0:完全覆盖目标文件,未覆盖部分将被裁切掉。 |
...@@ -445,7 +445,7 @@ copyFileSync(src: string | number, dest: string | number, mode?: number): void ...@@ -445,7 +445,7 @@ copyFileSync(src: string | number, dest: string | number, mode?: number): void
- 参数: - 参数:
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | | ---- | -------------------------- | ---- | ---------------------------------------- |
| src | string&nbsp;\|&nbsp;number | 是 | 待复制文件的路径或待复制文件的描述符。 | | src | string&nbsp;\|&nbsp;number | 是 | 待复制文件的路径或待复制文件的描述符。 |
| dest | string&nbsp;\|&nbsp;number | 是 | 目标文件路径或目标文件描述符。 | | dest | string&nbsp;\|&nbsp;number | 是 | 目标文件路径或目标文件描述符。 |
| mode | number | 否 | mode提供覆盖文件的选项,当前仅支持0,且默认为0。<br/>0:完全覆盖目标文件,未覆盖部分将被裁切掉。 | | mode | number | 否 | mode提供覆盖文件的选项,当前仅支持0,且默认为0。<br/>0:完全覆盖目标文件,未覆盖部分将被裁切掉。 |
...@@ -466,13 +466,13 @@ mkdir(path:string, mode?: number): Promise&lt;void&gt; ...@@ -466,13 +466,13 @@ mkdir(path:string, mode?: number): Promise&lt;void&gt;
- 参数: - 参数:
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | | ---- | ------ | ---- | ---------------------------------------- |
| path | string | 是 | 待创建目录的绝对路径。 | | path | string | 是 | 待创建目录的绝对路径。 |
| mode | number | 否 | 创建目录的权限,可给定如下权限,以按位或的方式追加权限,默认给定0o775。<br/>-&nbsp;0o775:所有者具有读、写及可执行权限,其余用户具有读及可执行权限。<br/>-&nbsp;0o700:所有者具有读、写及可执行权限。<br/>-&nbsp;0o400:所有者具有读权限。<br/>-&nbsp;0o200:所有者具有写权限。<br/>-&nbsp;0o100:所有者具有可执行权限。<br/>-&nbsp;0o070:所有用户组具有读、写及可执行权限。<br/>-&nbsp;0o040:所有用户组具有读权限。<br/>-&nbsp;0o020:所有用户组具有写权限。<br/>-&nbsp;0o010:所有用户组具有可执行权限。<br/>-&nbsp;0o007:其余用户具有读、写及可执行权限。<br/>-&nbsp;0o004:其余用户具有读权限。<br/>-&nbsp;0o002:其余用户具有写权限。<br/>-&nbsp;0o001:其余用户具有可执行权限。 | | mode | number | 否 | 创建目录的权限,可给定如下权限,以按位或的方式追加权限,默认给定0o775。<br/>-&nbsp;0o775:所有者具有读、写及可执行权限,其余用户具有读及可执行权限。<br/>-&nbsp;0o700:所有者具有读、写及可执行权限。<br/>-&nbsp;0o400:所有者具有读权限。<br/>-&nbsp;0o200:所有者具有写权限。<br/>-&nbsp;0o100:所有者具有可执行权限。<br/>-&nbsp;0o070:所有用户组具有读、写及可执行权限。<br/>-&nbsp;0o040:所有用户组具有读权限。<br/>-&nbsp;0o020:所有用户组具有写权限。<br/>-&nbsp;0o010:所有用户组具有可执行权限。<br/>-&nbsp;0o007:其余用户具有读、写及可执行权限。<br/>-&nbsp;0o004:其余用户具有读权限。<br/>-&nbsp;0o002:其余用户具有写权限。<br/>-&nbsp;0o001:其余用户具有可执行权限。 |
- 返回值: - 返回值:
| 类型 | 说明 | | 类型 | 说明 |
| -------- | -------- | | ------------------- | ---------------------------- |
| Promise&lt;void&gt; | Promise实例,用于异步获取结果。本调用将返回空值。 | | Promise&lt;void&gt; | Promise实例,用于异步获取结果。本调用将返回空值。 |
- 示例: - 示例:
...@@ -495,7 +495,7 @@ mkdir(path: string, mode: number, callback: AsyncCallback&lt;void&gt;): void ...@@ -495,7 +495,7 @@ mkdir(path: string, mode: number, callback: AsyncCallback&lt;void&gt;): void
- 参数: - 参数:
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | | -------- | ------------------------- | ---- | ---------------------------------------- |
| path | string | 是 | 待创建目录的绝对路径。 | | path | string | 是 | 待创建目录的绝对路径。 |
| mode | number | 否 | 创建目录的权限,可给定如下权限,以按位或的方式追加权限,默认给定0o775。<br/>-&nbsp;0o775:所有者具有读、写及可执行权限,其余用户具有读及可执行权限。<br/>-&nbsp;0o700:所有者具有读、写及可执行权限。<br/>-&nbsp;0o400:所有者具有读权限。<br/>-&nbsp;0o200:所有者具有写权限。<br/>-&nbsp;0o100:所有者具有可执行权限。<br/>-&nbsp;0o070:所有用户组具有读、写及可执行权限。<br/>-&nbsp;0o040:所有用户组具有读权限。<br/>-&nbsp;0o020:所有用户组具有写权限。<br/>-&nbsp;0o010:所有用户组具有可执行权限。<br/>-&nbsp;0o007:其余用户具有读、写及可执行权限。<br/>-&nbsp;0o004:其余用户具有读权限。<br/>-&nbsp;0o002:其余用户具有写权限。<br/>-&nbsp;0o001:其余用户具有可执行权限。 | | mode | number | 否 | 创建目录的权限,可给定如下权限,以按位或的方式追加权限,默认给定0o775。<br/>-&nbsp;0o775:所有者具有读、写及可执行权限,其余用户具有读及可执行权限。<br/>-&nbsp;0o700:所有者具有读、写及可执行权限。<br/>-&nbsp;0o400:所有者具有读权限。<br/>-&nbsp;0o200:所有者具有写权限。<br/>-&nbsp;0o100:所有者具有可执行权限。<br/>-&nbsp;0o070:所有用户组具有读、写及可执行权限。<br/>-&nbsp;0o040:所有用户组具有读权限。<br/>-&nbsp;0o020:所有用户组具有写权限。<br/>-&nbsp;0o010:所有用户组具有可执行权限。<br/>-&nbsp;0o007:其余用户具有读、写及可执行权限。<br/>-&nbsp;0o004:其余用户具有读权限。<br/>-&nbsp;0o002:其余用户具有写权限。<br/>-&nbsp;0o001:其余用户具有可执行权限。 |
| callback | AsyncCallback&lt;void&gt; | 是 | 异步创建目录操作完成之后的回调。 | | callback | AsyncCallback&lt;void&gt; | 是 | 异步创建目录操作完成之后的回调。 |
...@@ -520,7 +520,7 @@ mkdirSync(path: string, mode?: number): void ...@@ -520,7 +520,7 @@ mkdirSync(path: string, mode?: number): void
- 参数: - 参数:
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | | ---- | ------ | ---- | ---------------------------------------- |
| path | string | 是 | 待创建目录的绝对路径。 | | path | string | 是 | 待创建目录的绝对路径。 |
| mode | number | 否 | 创建目录的权限,可给定如下权限,以按位或的方式追加权限,默认给定0o775。<br/>-&nbsp;0o775:所有者具有读、写及可执行权限,其余用户具有读及可执行权限。<br/>-&nbsp;0o700:所有者具有读、写及可执行权限。<br/>-&nbsp;0o400:所有者具有读权限。<br/>-&nbsp;0o200:所有者具有写权限。<br/>-&nbsp;0o100:所有者具有可执行权限。<br/>-&nbsp;0o070:所有用户组具有读、写及可执行权限。<br/>-&nbsp;0o040:所有用户组具有读权限。<br/>-&nbsp;0o020:所有用户组具有写权限。<br/>-&nbsp;0o010:所有用户组具有可执行权限。<br/>-&nbsp;0o007:其余用户具有读、写及可执行权限。<br/>-&nbsp;0o004:其余用户具有读权限。<br/>-&nbsp;0o002:其余用户具有写权限。<br/>-&nbsp;0o001:其余用户具有可执行权限。 | | mode | number | 否 | 创建目录的权限,可给定如下权限,以按位或的方式追加权限,默认给定0o775。<br/>-&nbsp;0o775:所有者具有读、写及可执行权限,其余用户具有读及可执行权限。<br/>-&nbsp;0o700:所有者具有读、写及可执行权限。<br/>-&nbsp;0o400:所有者具有读权限。<br/>-&nbsp;0o200:所有者具有写权限。<br/>-&nbsp;0o100:所有者具有可执行权限。<br/>-&nbsp;0o070:所有用户组具有读、写及可执行权限。<br/>-&nbsp;0o040:所有用户组具有读权限。<br/>-&nbsp;0o020:所有用户组具有写权限。<br/>-&nbsp;0o010:所有用户组具有可执行权限。<br/>-&nbsp;0o007:其余用户具有读、写及可执行权限。<br/>-&nbsp;0o004:其余用户具有读权限。<br/>-&nbsp;0o002:其余用户具有写权限。<br/>-&nbsp;0o001:其余用户具有可执行权限。 |
...@@ -540,14 +540,14 @@ open(path: string, flags?: number, mode?: number): Promise&lt;number&gt; ...@@ -540,14 +540,14 @@ open(path: string, flags?: number, mode?: number): Promise&lt;number&gt;
- 参数: - 参数:
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | | ----- | ------ | ---- | ---------------------------------------- |
| path | string | 是 | 待打开文件的绝对路径。 | | path | string | 是 | 待打开文件的绝对路径。 |
| flags | number | 否 | 打开文件的选项,必须指定如下选项中的一个,默认以只读方式打开:<br/>-&nbsp;0o0:只读打开。<br/>-&nbsp;0o1:只写打开。<br/>-&nbsp;0o2:读写打开。<br/>同时,也可给定如下选项,以按位或的方式追加,默认不给定任何额外选项:<br/>-&nbsp;0o100:若文件不存在,则创建文件。使用该选项时必须指定第三个参数&nbsp;mode。<br/>-&nbsp;0o200:如果追加了0o100选项,且文件已经存在,则出错。<br/>-&nbsp;0o1000:如果文件存在且以只写或读写的方式打开文件,则将其长度裁剪为零。<br/>-&nbsp;0o2000:以追加方式打开,后续写将追加到文件末尾。<br/>-&nbsp;0o4000:如果path指向FIFO、块特殊文件或字符特殊文件,则本次打开及后续&nbsp;IO&nbsp;进行非阻塞操作。<br/>-&nbsp;0o200000:如果path指向目录,则出错。<br/>-&nbsp;0o400000:如果path指向符号链接,则出错。<br/>-&nbsp;0o4010000:以同步IO的方式打开文件。 | | flags | number | 否 | 打开文件的选项,必须指定如下选项中的一个,默认以只读方式打开:<br/>-&nbsp;0o0:只读打开。<br/>-&nbsp;0o1:只写打开。<br/>-&nbsp;0o2:读写打开。<br/>同时,也可给定如下选项,以按位或的方式追加,默认不给定任何额外选项:<br/>-&nbsp;0o100:若文件不存在,则创建文件。使用该选项时必须指定第三个参数&nbsp;mode。<br/>-&nbsp;0o200:如果追加了0o100选项,且文件已经存在,则出错。<br/>-&nbsp;0o1000:如果文件存在且以只写或读写的方式打开文件,则将其长度裁剪为零。<br/>-&nbsp;0o2000:以追加方式打开,后续写将追加到文件末尾。<br/>-&nbsp;0o4000:如果path指向FIFO、块特殊文件或字符特殊文件,则本次打开及后续&nbsp;IO&nbsp;进行非阻塞操作。<br/>-&nbsp;0o200000:如果path指向目录,则出错。<br/>-&nbsp;0o400000:如果path指向符号链接,则出错。<br/>-&nbsp;0o4010000:以同步IO的方式打开文件。 |
| mode | number | 否 | 若创建文件,则指定文件的权限,可给定如下权限,以按位或的方式追加权限,默认给定0o666。<br/>-&nbsp;0o666:所有者具有读、写权限,所有用户组具有读、写权限,其余用户具有读、写权限。<br/>-&nbsp;0o700:所有者具有读、写及可执行权限。<br/>-&nbsp;0o400:所有者具有读权限。<br/>-&nbsp;0o200:所有者具有写权限。<br/>-&nbsp;0o100:所有者具有可执行权限。<br/>-&nbsp;0o070:所有用户组具有读、写及可执行权限。<br/>-&nbsp;0o040:所有用户组具有读权限。<br/>-&nbsp;0o020:所有用户组具有写权限。<br/>-&nbsp;0o010:所有用户组具有可执行权限。<br/>-&nbsp;0o007:其余用户具有读、写及可执行权限。<br/>-&nbsp;0o004:其余用户具有读权限。<br/>-&nbsp;0o002:其余用户具有写权限。<br/>-&nbsp;0o001:其余用户具有可执行权限。 | | mode | number | 否 | 若创建文件,则指定文件的权限,可给定如下权限,以按位或的方式追加权限,默认给定0o666。<br/>-&nbsp;0o666:所有者具有读、写权限,所有用户组具有读、写权限,其余用户具有读、写权限。<br/>-&nbsp;0o700:所有者具有读、写及可执行权限。<br/>-&nbsp;0o400:所有者具有读权限。<br/>-&nbsp;0o200:所有者具有写权限。<br/>-&nbsp;0o100:所有者具有可执行权限。<br/>-&nbsp;0o070:所有用户组具有读、写及可执行权限。<br/>-&nbsp;0o040:所有用户组具有读权限。<br/>-&nbsp;0o020:所有用户组具有写权限。<br/>-&nbsp;0o010:所有用户组具有可执行权限。<br/>-&nbsp;0o007:其余用户具有读、写及可执行权限。<br/>-&nbsp;0o004:其余用户具有读权限。<br/>-&nbsp;0o002:其余用户具有写权限。<br/>-&nbsp;0o001:其余用户具有可执行权限。 |
- 返回值: - 返回值:
| 类型 | 说明 | | 类型 | 说明 |
| -------- | -------- | | --------------------- | ----------- |
| Promise&lt;number&gt; | 打开文件的文件描述符。 | | Promise&lt;number&gt; | 打开文件的文件描述符。 |
- 示例: - 示例:
...@@ -570,7 +570,7 @@ open(path: string, flags: number, mode: number, callback: AsyncCallback&lt;numbe ...@@ -570,7 +570,7 @@ open(path: string, flags: number, mode: number, callback: AsyncCallback&lt;numbe
- 参数: - 参数:
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | | -------- | ------------------------------- | ---- | ---------------------------------------- |
| path | string | 是 | 待打开文件的绝对路径。 | | path | string | 是 | 待打开文件的绝对路径。 |
| flags | number | 是 | 打开文件的选项,必须指定如下选项中的一个,默认以只读方式打开:<br/>-&nbsp;0o0:只读打开。<br/>-&nbsp;0o1:只写打开。<br/>-&nbsp;0o2:读写打开。<br/>同时,也可给定如下选项,以按位或的方式追加,默认不给定任何额外选项:<br/>-&nbsp;0o100:若文件不存在,则创建文件。使用该选项时必须指定第三个参数&nbsp;mode。<br/>-&nbsp;0o200:如果追加了0o100选项,且文件已经存在,则出错。<br/>-&nbsp;0o1000:如果文件存在且以只写或读写的方式打开文件,则将其长度裁剪为零。<br/>-&nbsp;0o2000:以追加方式打开,后续写将追加到文件末尾。<br/>-&nbsp;0o4000:如果path指向FIFO、块特殊文件或字符特殊文件,则本次打开及后续&nbsp;IO&nbsp;进行非阻塞操作。<br/>-&nbsp;0o200000:如果path指向目录,则出错。<br/>-&nbsp;0o400000:如果path指向符号链接,则出错。<br/>-&nbsp;0o4010000:以同步IO的方式打开文件。 | | flags | number | 是 | 打开文件的选项,必须指定如下选项中的一个,默认以只读方式打开:<br/>-&nbsp;0o0:只读打开。<br/>-&nbsp;0o1:只写打开。<br/>-&nbsp;0o2:读写打开。<br/>同时,也可给定如下选项,以按位或的方式追加,默认不给定任何额外选项:<br/>-&nbsp;0o100:若文件不存在,则创建文件。使用该选项时必须指定第三个参数&nbsp;mode。<br/>-&nbsp;0o200:如果追加了0o100选项,且文件已经存在,则出错。<br/>-&nbsp;0o1000:如果文件存在且以只写或读写的方式打开文件,则将其长度裁剪为零。<br/>-&nbsp;0o2000:以追加方式打开,后续写将追加到文件末尾。<br/>-&nbsp;0o4000:如果path指向FIFO、块特殊文件或字符特殊文件,则本次打开及后续&nbsp;IO&nbsp;进行非阻塞操作。<br/>-&nbsp;0o200000:如果path指向目录,则出错。<br/>-&nbsp;0o400000:如果path指向符号链接,则出错。<br/>-&nbsp;0o4010000:以同步IO的方式打开文件。 |
| mode | number | 是 | 若创建文件,则指定文件的权限,可给定如下权限,以按位或的方式追加权限,默认给定0o666。<br/>-&nbsp;0o666:所有者具有读、写权限,所有用户组具有读、写权限,其余用户具有读、写权限。<br/>-&nbsp;0o700:所有者具有读、写及可执行权限。<br/>-&nbsp;0o400:所有者具有读权限。<br/>-&nbsp;0o200:所有者具有写权限。<br/>-&nbsp;0o100:所有者具有可执行权限。<br/>-&nbsp;0o070:所有用户组具有读、写及可执行权限。<br/>-&nbsp;0o040:所有用户组具有读权限。<br/>-&nbsp;0o020:所有用户组具有写权限。<br/>-&nbsp;0o010:所有用户组具有可执行权限。<br/>-&nbsp;0o007:其余用户具有读、写及可执行权限。<br/>-&nbsp;0o004:其余用户具有读权限。<br/>-&nbsp;0o002:其余用户具有写权限。<br/>-&nbsp;0o001:其余用户具有可执行权限。 | | mode | number | 是 | 若创建文件,则指定文件的权限,可给定如下权限,以按位或的方式追加权限,默认给定0o666。<br/>-&nbsp;0o666:所有者具有读、写权限,所有用户组具有读、写权限,其余用户具有读、写权限。<br/>-&nbsp;0o700:所有者具有读、写及可执行权限。<br/>-&nbsp;0o400:所有者具有读权限。<br/>-&nbsp;0o200:所有者具有写权限。<br/>-&nbsp;0o100:所有者具有可执行权限。<br/>-&nbsp;0o070:所有用户组具有读、写及可执行权限。<br/>-&nbsp;0o040:所有用户组具有读权限。<br/>-&nbsp;0o020:所有用户组具有写权限。<br/>-&nbsp;0o010:所有用户组具有可执行权限。<br/>-&nbsp;0o007:其余用户具有读、写及可执行权限。<br/>-&nbsp;0o004:其余用户具有读权限。<br/>-&nbsp;0o002:其余用户具有写权限。<br/>-&nbsp;0o001:其余用户具有可执行权限。 |
...@@ -594,14 +594,14 @@ openSync(path:string, flags?:number, mode?:number): number ...@@ -594,14 +594,14 @@ openSync(path:string, flags?:number, mode?:number): number
- 参数: - 参数:
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | | ----- | ------ | ---- | ---------------------------------------- |
| path | string | 是 | 待打开文件的绝对路径。 | | path | string | 是 | 待打开文件的绝对路径。 |
| flags | number | 否 | 打开文件的选项,必须指定如下选项中的一个,默认以只读方式打开:<br/>-&nbsp;0o0:只读打开。<br/>-&nbsp;0o1:只写打开。<br/>-&nbsp;0o2:读写打开。<br/>同时,也可给定如下选项,以按位或的方式追加,默认不给定任何额外选项:<br/>-&nbsp;0o100:若文件不存在,则创建文件。使用该选项时必须指定第三个参数&nbsp;mode。<br/>-&nbsp;0o200:如果追加了0o100选项,且文件已经存在,则出错。<br/>-&nbsp;0o1000:如果文件存在且以只写或读写的方式打开文件,则将其长度裁剪为零。<br/>-&nbsp;0o2000:以追加方式打开,后续写将追加到文件末尾。<br/>-&nbsp;0o4000:如果path指向FIFO、块特殊文件或字符特殊文件,则本次打开及后续&nbsp;IO&nbsp;进行非阻塞操作。<br/>-&nbsp;0o200000:如果path指向目录,则出错。<br/>-&nbsp;0o400000:如果path指向符号链接,则出错。<br/>-&nbsp;0o4010000:以同步IO的方式打开文件。 | | flags | number | 否 | 打开文件的选项,必须指定如下选项中的一个,默认以只读方式打开:<br/>-&nbsp;0o0:只读打开。<br/>-&nbsp;0o1:只写打开。<br/>-&nbsp;0o2:读写打开。<br/>同时,也可给定如下选项,以按位或的方式追加,默认不给定任何额外选项:<br/>-&nbsp;0o100:若文件不存在,则创建文件。使用该选项时必须指定第三个参数&nbsp;mode。<br/>-&nbsp;0o200:如果追加了0o100选项,且文件已经存在,则出错。<br/>-&nbsp;0o1000:如果文件存在且以只写或读写的方式打开文件,则将其长度裁剪为零。<br/>-&nbsp;0o2000:以追加方式打开,后续写将追加到文件末尾。<br/>-&nbsp;0o4000:如果path指向FIFO、块特殊文件或字符特殊文件,则本次打开及后续&nbsp;IO&nbsp;进行非阻塞操作。<br/>-&nbsp;0o200000:如果path指向目录,则出错。<br/>-&nbsp;0o400000:如果path指向符号链接,则出错。<br/>-&nbsp;0o4010000:以同步IO的方式打开文件。 |
| mode | number | 否 | 若创建文件,则指定文件的权限,可给定如下权限,以按位或的方式追加权限,默认给定0o666。<br/>-&nbsp;0o666:所有者具有读、写权限,所有用户组具有读、写权限,其余用户具有读、写权限。<br/>-&nbsp;0o700:所有者具有读、写及可执行权限。<br/>-&nbsp;0o400:所有者具有读权限。<br/>-&nbsp;0o200:所有者具有写权限。<br/>-&nbsp;0o100:所有者具有可执行权限。<br/>-&nbsp;0o070:所有用户组具有读、写及可执行权限。<br/>-&nbsp;0o040:所有用户组具有读权限。<br/>-&nbsp;0o020:所有用户组具有写权限。<br/>-&nbsp;0o010:所有用户组具有可执行权限。<br/>-&nbsp;0o007:其余用户具有读、写及可执行权限。<br/>-&nbsp;0o004:其余用户具有读权限。<br/>-&nbsp;0o002:其余用户具有写权限。<br/>-&nbsp;0o001:其余用户具有可执行权限。<br/>创建出的文件权限受umask影响,umask随进程启动确定,其修改当前不开放。 | | mode | number | 否 | 若创建文件,则指定文件的权限,可给定如下权限,以按位或的方式追加权限,默认给定0o666。<br/>-&nbsp;0o666:所有者具有读、写权限,所有用户组具有读、写权限,其余用户具有读、写权限。<br/>-&nbsp;0o700:所有者具有读、写及可执行权限。<br/>-&nbsp;0o400:所有者具有读权限。<br/>-&nbsp;0o200:所有者具有写权限。<br/>-&nbsp;0o100:所有者具有可执行权限。<br/>-&nbsp;0o070:所有用户组具有读、写及可执行权限。<br/>-&nbsp;0o040:所有用户组具有读权限。<br/>-&nbsp;0o020:所有用户组具有写权限。<br/>-&nbsp;0o010:所有用户组具有可执行权限。<br/>-&nbsp;0o007:其余用户具有读、写及可执行权限。<br/>-&nbsp;0o004:其余用户具有读权限。<br/>-&nbsp;0o002:其余用户具有写权限。<br/>-&nbsp;0o001:其余用户具有可执行权限。<br/>创建出的文件权限受umask影响,umask随进程启动确定,其修改当前不开放。 |
- 返回值: - 返回值:
| 类型 | 说明 | | 类型 | 说明 |
| -------- | -------- | | ------ | ----------- |
| number | 打开文件的文件描述符。 | | number | 打开文件的文件描述符。 |
- 示例: - 示例:
...@@ -624,14 +624,14 @@ read(fd: number, buffer: ArrayBuffer, options?: { ...@@ -624,14 +624,14 @@ read(fd: number, buffer: ArrayBuffer, options?: {
- 参数: - 参数:
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | | ------- | ----------- | ---- | ---------------------------------------- |
| fd | number | 是 | 待读取文件的文件描述符。 | | fd | number | 是 | 待读取文件的文件描述符。 |
| buffer | ArrayBuffer | 是 | 用于保存读取到的文件数据的缓冲区。 | | buffer | ArrayBuffer | 是 | 用于保存读取到的文件数据的缓冲区。 |
| options | Object | 否 | 支持如下选项:<br/>-&nbsp;offset,number类型,表示将数据读取到缓冲区的位置,即相对于缓冲区首地址的偏移。可选,默认为0。<br/>-&nbsp;length,number类型,表示期望读取数据的长度。可选,默认缓冲区长度减去偏移长度。<br/>-&nbsp;position,number类型,表示期望读取文件的位置。可选,默认从当前位置开始读。 | | options | Object | 否 | 支持如下选项:<br/>-&nbsp;offset,number类型,表示将数据读取到缓冲区的位置,即相对于缓冲区首地址的偏移。可选,默认为0。<br/>-&nbsp;length,number类型,表示期望读取数据的长度。可选,默认缓冲区长度减去偏移长度。<br/>-&nbsp;position,number类型,表示期望读取文件的位置。可选,默认从当前位置开始读。 |
- 返回值: - 返回值:
| 类型 | 说明 | | 类型 | 说明 |
| -------- | -------- | | ---------------------------------- | ------ |
| Promise&lt;[ReadOut](#readout)&gt; | 读取的结果。 | | Promise&lt;[ReadOut](#readout)&gt; | 读取的结果。 |
- 示例: - 示例:
...@@ -660,7 +660,7 @@ read(fd: number, buffer: ArrayBuffer, options: { ...@@ -660,7 +660,7 @@ read(fd: number, buffer: ArrayBuffer, options: {
- 参数: - 参数:
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | | -------- | ---------------------------------------- | ---- | ---------------------------------------- |
| fd | number | 是 | 待读取文件的文件描述符。 | | fd | number | 是 | 待读取文件的文件描述符。 |
| buffer | ArrayBuffer | 是 | 用于保存读取到的文件数据的缓冲区。 | | buffer | ArrayBuffer | 是 | 用于保存读取到的文件数据的缓冲区。 |
| options | Object | 否 | 支持如下选项:<br/>-&nbsp;offset,number类型,表示将数据读取到缓冲区的位置,即相对于缓冲区首地址的偏移。可选,默认为0。<br/>-&nbsp;length,number类型,表示期望读取数据的长度。可选,默认缓冲区长度减去偏移长度。<br/>-&nbsp;position,number类型,表示期望读取文件的位置。可选,默认从当前位置开始读。 | | options | Object | 否 | 支持如下选项:<br/>-&nbsp;offset,number类型,表示将数据读取到缓冲区的位置,即相对于缓冲区首地址的偏移。可选,默认为0。<br/>-&nbsp;length,number类型,表示期望读取数据的长度。可选,默认缓冲区长度减去偏移长度。<br/>-&nbsp;position,number类型,表示期望读取文件的位置。可选,默认从当前位置开始读。 |
...@@ -692,14 +692,14 @@ readSync(fd: number, buffer: ArrayBuffer, options?: { ...@@ -692,14 +692,14 @@ readSync(fd: number, buffer: ArrayBuffer, options?: {
- 参数: - 参数:
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | | ------- | ----------- | ---- | ---------------------------------------- |
| fd | number | 是 | 待读取文件的文件描述符。 | | fd | number | 是 | 待读取文件的文件描述符。 |
| buffer | ArrayBuffer | 是 | 用于保存读取到的文件数据的缓冲区。 | | buffer | ArrayBuffer | 是 | 用于保存读取到的文件数据的缓冲区。 |
| options | Object | 否 | 支持如下选项:<br/>-&nbsp;offset,number类型,表示将数据读取到缓冲区的位置,即相对于缓冲区首地址的偏移。可选,默认为0。<br/>-&nbsp;length,number类型,表示期望读取数据的长度。可选,默认缓冲区长度减去偏移长度。<br/>-&nbsp;position,number类型,表示期望读取文件的位置。可选,默认从当前位置开始读。 | | options | Object | 否 | 支持如下选项:<br/>-&nbsp;offset,number类型,表示将数据读取到缓冲区的位置,即相对于缓冲区首地址的偏移。可选,默认为0。<br/>-&nbsp;length,number类型,表示期望读取数据的长度。可选,默认缓冲区长度减去偏移长度。<br/>-&nbsp;position,number类型,表示期望读取文件的位置。可选,默认从当前位置开始读。 |
- 返回值: - 返回值:
| 类型 | 说明 | | 类型 | 说明 |
| -------- | -------- | | ------ | -------- |
| number | 实际读取的长度。 | | number | 实际读取的长度。 |
- 示例: - 示例:
...@@ -720,12 +720,12 @@ rmdir(path: string): Promise&lt;void&gt; ...@@ -720,12 +720,12 @@ rmdir(path: string): Promise&lt;void&gt;
- 参数: - 参数:
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | | ---- | ------ | ---- | ----------- |
| path | string | 是 | 待删除目录的绝对路径。 | | path | string | 是 | 待删除目录的绝对路径。 |
- 返回值: - 返回值:
| 类型 | 说明 | | 类型 | 说明 |
| -------- | -------- | | ------------------- | ---------------------------- |
| Promise&lt;void&gt; | Promise实例,用于异步获取结果。本调用将返回空值。 | | Promise&lt;void&gt; | Promise实例,用于异步获取结果。本调用将返回空值。 |
- 示例: - 示例:
...@@ -748,7 +748,7 @@ rmdir(path: string, callback:AsyncCallback&lt;void&gt;): void ...@@ -748,7 +748,7 @@ rmdir(path: string, callback:AsyncCallback&lt;void&gt;): void
- 参数: - 参数:
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | | -------- | ------------------------- | ---- | ------------ |
| path | string | 是 | 待删除目录的绝对路径。 | | path | string | 是 | 待删除目录的绝对路径。 |
| callback | AsyncCallback&lt;void&gt; | 是 | 异步删除目录之后的回调。 | | callback | AsyncCallback&lt;void&gt; | 是 | 异步删除目录之后的回调。 |
...@@ -770,7 +770,7 @@ rmdirSync(path: string): void ...@@ -770,7 +770,7 @@ rmdirSync(path: string): void
- 参数: - 参数:
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | | ---- | ------ | ---- | ----------- |
| path | string | 是 | 待删除目录的绝对路径。 | | path | string | 是 | 待删除目录的绝对路径。 |
- 示例: - 示例:
...@@ -789,12 +789,12 @@ unlink(path:string): Promise&lt;void&gt; ...@@ -789,12 +789,12 @@ unlink(path:string): Promise&lt;void&gt;
- 参数: - 参数:
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | | ---- | ------ | ---- | ----------- |
| path | string | 是 | 待删除文件的绝对路径。 | | path | string | 是 | 待删除文件的绝对路径。 |
- 返回值: - 返回值:
| 类型 | 说明 | | 类型 | 说明 |
| -------- | -------- | | ------------------- | ---------------------------- |
| Promise&lt;void&gt; | Promise实例,用于异步获取结果。本调用将返回空值。 | | Promise&lt;void&gt; | Promise实例,用于异步获取结果。本调用将返回空值。 |
- 示例: - 示例:
...@@ -817,7 +817,7 @@ unlink(path:string, callback:AsyncCallback&lt;void&gt;): void ...@@ -817,7 +817,7 @@ unlink(path:string, callback:AsyncCallback&lt;void&gt;): void
- 参数: - 参数:
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | | -------- | ------------------------- | ---- | ------------ |
| path | string | 是 | 待删除文件的绝对路径。 | | path | string | 是 | 待删除文件的绝对路径。 |
| callback | AsyncCallback&lt;void&gt; | 是 | 异步删除文件之后的回调。 | | callback | AsyncCallback&lt;void&gt; | 是 | 异步删除文件之后的回调。 |
...@@ -841,7 +841,7 @@ unlinkSync(path: string): void ...@@ -841,7 +841,7 @@ unlinkSync(path: string): void
- 参数: - 参数:
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | | ---- | ------ | ---- | ----------- |
| path | string | 是 | 待删除文件的绝对路径。 | | path | string | 是 | 待删除文件的绝对路径。 |
- 示例: - 示例:
...@@ -865,14 +865,14 @@ write(fd: number, buffer: ArrayBuffer | string, options?: { ...@@ -865,14 +865,14 @@ write(fd: number, buffer: ArrayBuffer | string, options?: {
- 参数: - 参数:
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | | ------- | ------------------------------- | ---- | ---------------------------------------- |
| fd | number | 是 | 待写入文件的文件描述符。 | | fd | number | 是 | 待写入文件的文件描述符。 |
| buffer | ArrayBuffer&nbsp;\|&nbsp;string | 是 | 待写入文件的数据,可来自缓冲区或字符串。 | | buffer | ArrayBuffer&nbsp;\|&nbsp;string | 是 | 待写入文件的数据,可来自缓冲区或字符串。 |
| options | Object | 否 | 支持如下选项:<br/>-&nbsp;offset,number类型,表示期望写入数据的位置相对于数据首地址的偏移。可选,默认为0。<br/>-&nbsp;length,number类型,表示期望写入数据的长度。可选,默认缓冲区长度减去偏移长度。<br/>-&nbsp;position,number类型,表示期望写入文件的位置。可选,默认从当前位置开始写。<br/>-&nbsp;encoding,string类型,当数据是string类型时有效,表示数据的编码方式,默认&nbsp;'utf-8'。仅支持&nbsp;'utf-8'。 | | options | Object | 否 | 支持如下选项:<br/>-&nbsp;offset,number类型,表示期望写入数据的位置相对于数据首地址的偏移。可选,默认为0。<br/>-&nbsp;length,number类型,表示期望写入数据的长度。可选,默认缓冲区长度减去偏移长度。<br/>-&nbsp;position,number类型,表示期望写入文件的位置。可选,默认从当前位置开始写。<br/>-&nbsp;encoding,string类型,当数据是string类型时有效,表示数据的编码方式,默认&nbsp;'utf-8'。仅支持&nbsp;'utf-8'。 |
- 返回值: - 返回值:
| 类型 | 说明 | | 类型 | 说明 |
| -------- | -------- | | --------------------- | -------- |
| Promise&lt;number&gt; | 实际写入的长度。 | | Promise&lt;number&gt; | 实际写入的长度。 |
- 示例: - 示例:
...@@ -901,7 +901,7 @@ write(fd: number, buffer: ArrayBuffer | string, options: { ...@@ -901,7 +901,7 @@ write(fd: number, buffer: ArrayBuffer | string, options: {
- 参数: - 参数:
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | | -------- | ------------------------------- | ---- | ---------------------------------------- |
| fd | number | 是 | 待写入文件的文件描述符。 | | fd | number | 是 | 待写入文件的文件描述符。 |
| buffer | ArrayBuffer&nbsp;\|&nbsp;string | 是 | 待写入文件的数据,可来自缓冲区或字符串。 | | buffer | ArrayBuffer&nbsp;\|&nbsp;string | 是 | 待写入文件的数据,可来自缓冲区或字符串。 |
| options | Object | 否 | 支持如下选项:<br/>-&nbsp;offset,number类型,表示期望写入数据的位置相对于数据首地址的偏移。可选,默认为0。<br/>-&nbsp;length,number类型,表示期望写入数据的长度。可选,默认缓冲区长度减去偏移长度。<br/>-&nbsp;position,number类型,表示期望写入文件的位置。可选,默认从当前位置开始写。<br/>-&nbsp;encoding,string类型,当数据是string类型时有效,表示数据的编码方式,默认&nbsp;'utf-8'。仅支持&nbsp;'utf-8'。 | | options | Object | 否 | 支持如下选项:<br/>-&nbsp;offset,number类型,表示期望写入数据的位置相对于数据首地址的偏移。可选,默认为0。<br/>-&nbsp;length,number类型,表示期望写入数据的长度。可选,默认缓冲区长度减去偏移长度。<br/>-&nbsp;position,number类型,表示期望写入文件的位置。可选,默认从当前位置开始写。<br/>-&nbsp;encoding,string类型,当数据是string类型时有效,表示数据的编码方式,默认&nbsp;'utf-8'。仅支持&nbsp;'utf-8'。 |
...@@ -933,14 +933,14 @@ writeSync(fd: number, buffer: ArrayBuffer | string, options?: { ...@@ -933,14 +933,14 @@ writeSync(fd: number, buffer: ArrayBuffer | string, options?: {
- 参数: - 参数:
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | | ------- | ------------------------------- | ---- | ---------------------------------------- |
| fd | number | 是 | 待写入文件的文件描述符。 | | fd | number | 是 | 待写入文件的文件描述符。 |
| buffer | ArrayBuffer&nbsp;\|&nbsp;string | 是 | 待写入文件的数据,可来自缓冲区或字符串。 | | buffer | ArrayBuffer&nbsp;\|&nbsp;string | 是 | 待写入文件的数据,可来自缓冲区或字符串。 |
| options | Object | 否 | 支持如下选项:<br/>-&nbsp;offset,number类型,表示期望写入数据的位置相对于数据首地址的偏移。可选,默认为0。<br/>-&nbsp;length,number类型,表示期望写入数据的长度。可选,默认缓冲区长度减去偏移长度。<br/>-&nbsp;position,number类型,表示期望写入文件的位置。可选,默认从当前位置开始写。<br/>-&nbsp;encoding,string类型,当数据是string类型时有效,表示数据的编码方式,默认&nbsp;'utf-8'。仅支持&nbsp;'utf-8'。 | | options | Object | 否 | 支持如下选项:<br/>-&nbsp;offset,number类型,表示期望写入数据的位置相对于数据首地址的偏移。可选,默认为0。<br/>-&nbsp;length,number类型,表示期望写入数据的长度。可选,默认缓冲区长度减去偏移长度。<br/>-&nbsp;position,number类型,表示期望写入文件的位置。可选,默认从当前位置开始写。<br/>-&nbsp;encoding,string类型,当数据是string类型时有效,表示数据的编码方式,默认&nbsp;'utf-8'。仅支持&nbsp;'utf-8'。 |
- 返回值: - 返回值:
| 类型 | 说明 | | 类型 | 说明 |
| -------- | -------- | | ------ | -------- |
| number | 实际写入的长度。 | | number | 实际写入的长度。 |
- 示例: - 示例:
...@@ -960,13 +960,13 @@ hash(path: string, algorithm: string): Promise&lt;string&gt; ...@@ -960,13 +960,13 @@ hash(path: string, algorithm: string): Promise&lt;string&gt;
- 参数: - 参数:
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | | --------- | ------ | ---- | ---------------------------------------- |
| path | string | 是 | 待计算哈希值文件的绝对路径。 | | path | string | 是 | 待计算哈希值文件的绝对路径。 |
| algorithm | string | 是 | 哈希计算采用的算法。可选&nbsp;"md5"、"sha1"&nbsp;&nbsp;"sha256"。建议采用安全强度更高的&nbsp;"sha256"。 | | algorithm | string | 是 | 哈希计算采用的算法。可选&nbsp;"md5"、"sha1"&nbsp;&nbsp;"sha256"。建议采用安全强度更高的&nbsp;"sha256"。 |
- 返回值: - 返回值:
| 类型 | 说明 | | 类型 | 说明 |
| -------- | -------- | | --------------------- | -------------------------- |
| Promise&lt;string&gt; | 文件的哈希值。表示为十六进制数字串,所有字母均大写。 | | Promise&lt;string&gt; | 文件的哈希值。表示为十六进制数字串,所有字母均大写。 |
- 示例: - 示例:
...@@ -989,7 +989,7 @@ hash(path: string, algorithm: string, callback: AsyncCallback&lt;string&gt;): vo ...@@ -989,7 +989,7 @@ hash(path: string, algorithm: string, callback: AsyncCallback&lt;string&gt;): vo
- 参数: - 参数:
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | | --------- | --------------------------- | ---- | ---------------------------------------- |
| path | string | 是 | 待计算哈希值文件的绝对路径。 | | path | string | 是 | 待计算哈希值文件的绝对路径。 |
| algorithm | string | 是 | 哈希计算采用的算法。可选&nbsp;"md5"、"sha1"&nbsp;&nbsp;"sha256"。建议采用安全强度更高的&nbsp;"sha256"。 | | algorithm | string | 是 | 哈希计算采用的算法。可选&nbsp;"md5"、"sha1"&nbsp;&nbsp;"sha256"。建议采用安全强度更高的&nbsp;"sha256"。 |
| callback | AsyncCallback&lt;string&gt; | 是 | 异步计算文件哈希操之后的回调函数(其中给定文件哈希值表示为十六进制数字串,所有字母均大写)。 | | callback | AsyncCallback&lt;string&gt; | 是 | 异步计算文件哈希操之后的回调函数(其中给定文件哈希值表示为十六进制数字串,所有字母均大写)。 |
...@@ -1014,13 +1014,13 @@ chmod(path: string, mode: number):Promise&lt;void&gt; ...@@ -1014,13 +1014,13 @@ chmod(path: string, mode: number):Promise&lt;void&gt;
- 参数: - 参数:
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | | ---- | ------ | ---- | ---------------------------------------- |
| path | string | 是 | 待改变文件权限的绝对路径。 | | path | string | 是 | 待改变文件权限的绝对路径。 |
| mode | number | 是 | 改变文件权限,可给定如下权限,以按位或的方式追加权限。<br/>-&nbsp;0o700:所有者具有读、写及可执行权限。<br/>-&nbsp;0o400:所有者具有读权限。<br/>-&nbsp;0o200:所有者具有写权限。<br/>-&nbsp;0o100:所有者具有可执行权限。<br/>-&nbsp;0o070:所有用户组具有读、写及可执行权限。<br/>-&nbsp;0o040:所有用户组具有读权限。<br/>-&nbsp;0o020:所有用户组具有写权限。<br/>-&nbsp;0o010:所有用户组具有可执行权限。<br/>-&nbsp;0o007:其余用户具有读、写及可执行权限。<br/>-&nbsp;0o004:其余用户具有读权限。<br/>-&nbsp;0o002:其余用户具有写权限。<br/>-&nbsp;0o001:其余用户具有可执行权限。 | | mode | number | 是 | 改变文件权限,可给定如下权限,以按位或的方式追加权限。<br/>-&nbsp;0o700:所有者具有读、写及可执行权限。<br/>-&nbsp;0o400:所有者具有读权限。<br/>-&nbsp;0o200:所有者具有写权限。<br/>-&nbsp;0o100:所有者具有可执行权限。<br/>-&nbsp;0o070:所有用户组具有读、写及可执行权限。<br/>-&nbsp;0o040:所有用户组具有读权限。<br/>-&nbsp;0o020:所有用户组具有写权限。<br/>-&nbsp;0o010:所有用户组具有可执行权限。<br/>-&nbsp;0o007:其余用户具有读、写及可执行权限。<br/>-&nbsp;0o004:其余用户具有读权限。<br/>-&nbsp;0o002:其余用户具有写权限。<br/>-&nbsp;0o001:其余用户具有可执行权限。 |
- 返回值: - 返回值:
| 类型 | 说明 | | 类型 | 说明 |
| -------- | -------- | | ------------------- | ---------------------------- |
| Promise&lt;void&gt; | Promise实例,用于异步获取结果。本调用将返回空值。 | | Promise&lt;void&gt; | Promise实例,用于异步获取结果。本调用将返回空值。 |
- 示例: - 示例:
...@@ -1043,7 +1043,7 @@ chmod(path: string, mode: number, callback: AsyncCallback&lt;void&gt;): void ...@@ -1043,7 +1043,7 @@ chmod(path: string, mode: number, callback: AsyncCallback&lt;void&gt;): void
- 参数: - 参数:
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | | -------- | ------------------------- | ---- | ---------------------------------------- |
| path | string | 是 | 待改变文件权限的绝对路径。 | | path | string | 是 | 待改变文件权限的绝对路径。 |
| mode | number | 是 | 改变文件权限,可给定如下权限,以按位或的方式追加权限。<br/>-&nbsp;0o700:所有者具有读、写及可执行权限。<br/>-&nbsp;0o400:所有者具有读权限。<br/>-&nbsp;0o200:所有者具有写权限。<br/>-&nbsp;0o100:所有者具有可执行权限。<br/>-&nbsp;0o070:所有用户组具有读、写及可执行权限。<br/>-&nbsp;0o040:所有用户组具有读权限。<br/>-&nbsp;0o020:所有用户组具有写权限。<br/>-&nbsp;0o010:所有用户组具有可执行权限。<br/>-&nbsp;0o007:其余用户具有读、写及可执行权限。<br/>-&nbsp;0o004:其余用户具有读权限。<br/>-&nbsp;0o002:其余用户具有写权限。<br/>-&nbsp;0o001:其余用户具有可执行权限。 | | mode | number | 是 | 改变文件权限,可给定如下权限,以按位或的方式追加权限。<br/>-&nbsp;0o700:所有者具有读、写及可执行权限。<br/>-&nbsp;0o400:所有者具有读权限。<br/>-&nbsp;0o200:所有者具有写权限。<br/>-&nbsp;0o100:所有者具有可执行权限。<br/>-&nbsp;0o070:所有用户组具有读、写及可执行权限。<br/>-&nbsp;0o040:所有用户组具有读权限。<br/>-&nbsp;0o020:所有用户组具有写权限。<br/>-&nbsp;0o010:所有用户组具有可执行权限。<br/>-&nbsp;0o007:其余用户具有读、写及可执行权限。<br/>-&nbsp;0o004:其余用户具有读权限。<br/>-&nbsp;0o002:其余用户具有写权限。<br/>-&nbsp;0o001:其余用户具有可执行权限。 |
| callback | AsyncCallback&lt;void&gt; | 是 | 异步改变文件权限之后的回调。 | | callback | AsyncCallback&lt;void&gt; | 是 | 异步改变文件权限之后的回调。 |
...@@ -1066,7 +1066,7 @@ chmodSync(path: string, mode: number): void ...@@ -1066,7 +1066,7 @@ chmodSync(path: string, mode: number): void
- 参数: - 参数:
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | | ---- | ------ | ---- | ---------------------------------------- |
| path | string | 是 | 待改变文件权限的绝对路径。 | | path | string | 是 | 待改变文件权限的绝对路径。 |
| mode | number | 是 | 改变文件权限,可给定如下权限,以按位或的方式追加权限。<br/>-&nbsp;0o700:所有者具有读、写及可执行权限。<br/>-&nbsp;0o400:所有者具有读权限。<br/>-&nbsp;0o200:所有者具有写权限。<br/>-&nbsp;0o100:所有者具有可执行权限。<br/>-&nbsp;0o070:所有用户组具有读、写及可执行权限。<br/>-&nbsp;0o040:所有用户组具有读权限。<br/>-&nbsp;0o020:所有用户组具有写权限。<br/>-&nbsp;0o010:所有用户组具有可执行权限。<br/>-&nbsp;0o007:其余用户具有读、写及可执行权限。<br/>-&nbsp;0o004:其余用户具有读权限。<br/>-&nbsp;0o002:其余用户具有写权限。<br/>-&nbsp;0o001:其余用户具有可执行权限。 | | mode | number | 是 | 改变文件权限,可给定如下权限,以按位或的方式追加权限。<br/>-&nbsp;0o700:所有者具有读、写及可执行权限。<br/>-&nbsp;0o400:所有者具有读权限。<br/>-&nbsp;0o200:所有者具有写权限。<br/>-&nbsp;0o100:所有者具有可执行权限。<br/>-&nbsp;0o070:所有用户组具有读、写及可执行权限。<br/>-&nbsp;0o040:所有用户组具有读权限。<br/>-&nbsp;0o020:所有用户组具有写权限。<br/>-&nbsp;0o010:所有用户组具有可执行权限。<br/>-&nbsp;0o007:其余用户具有读、写及可执行权限。<br/>-&nbsp;0o004:其余用户具有读权限。<br/>-&nbsp;0o002:其余用户具有写权限。<br/>-&nbsp;0o001:其余用户具有可执行权限。 |
...@@ -1086,12 +1086,12 @@ fstat(fd: number): Promise&lt;Stat&gt; ...@@ -1086,12 +1086,12 @@ fstat(fd: number): Promise&lt;Stat&gt;
- 参数: - 参数:
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | | ---- | ------ | ---- | ------------ |
| fd | number | 是 | 待获取文件的文件描述符。 | | fd | number | 是 | 待获取文件的文件描述符。 |
- 返回值: - 返回值:
| 类型 | 说明 | | 类型 | 说明 |
| -------- | -------- | | ---------------------------- | ---------- |
| Promise&lt;[Stat](#stat)&gt; | 表示文件的具体信息。 | | Promise&lt;[Stat](#stat)&gt; | 表示文件的具体信息。 |
- 示例: - 示例:
...@@ -1114,7 +1114,7 @@ fstat(fd: number, callback: AsyncCallback&lt;Stat&gt;): void ...@@ -1114,7 +1114,7 @@ fstat(fd: number, callback: AsyncCallback&lt;Stat&gt;): void
- 参数: - 参数:
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | | -------- | ---------------------------------- | ---- | ---------------- |
| fd | number | 是 | 待获取文件的文件描述符。 | | fd | number | 是 | 待获取文件的文件描述符。 |
| callback | AsyncCallback&lt;[Stat](#stat)&gt; | 是 | 异步获取文件状态信息之后的回调。 | | callback | AsyncCallback&lt;[Stat](#stat)&gt; | 是 | 异步获取文件状态信息之后的回调。 |
...@@ -1137,12 +1137,12 @@ fstatSync(fd: number): Stat ...@@ -1137,12 +1137,12 @@ fstatSync(fd: number): Stat
- 参数: - 参数:
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | | ---- | ------ | ---- | ------------ |
| fd | number | 是 | 待获取文件的文件描述符。 | | fd | number | 是 | 待获取文件的文件描述符。 |
- 返回值: - 返回值:
| 类型 | 说明 | | 类型 | 说明 |
| -------- | -------- | | ------------- | ---------- |
| [Stat](#stat) | 表示文件的具体信息。 | | [Stat](#stat) | 表示文件的具体信息。 |
- 示例: - 示例:
...@@ -1162,13 +1162,13 @@ ftruncate(fd: number, len?: number): Promise&lt;void&gt; ...@@ -1162,13 +1162,13 @@ ftruncate(fd: number, len?: number): Promise&lt;void&gt;
- 参数: - 参数:
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | | ---- | ------ | ---- | ---------------- |
| fd | number | 是 | 待截断文件的文件描述符。 | | fd | number | 是 | 待截断文件的文件描述符。 |
| len | number | 是 | 文件截断后的长度,以字节为单位。 | | len | number | 是 | 文件截断后的长度,以字节为单位。 |
- 返回值: - 返回值:
| 类型 | 说明 | | 类型 | 说明 |
| -------- | -------- | | ------------------- | ---------------------------- |
| Promise&lt;void&gt; | Promise实例,用于异步获取结果。本调用将返回空值。 | | Promise&lt;void&gt; | Promise实例,用于异步获取结果。本调用将返回空值。 |
- 示例: - 示例:
...@@ -1192,7 +1192,7 @@ ftruncate(fd: number, len: number, callback:AsyncCallback&lt;void&gt;): void ...@@ -1192,7 +1192,7 @@ ftruncate(fd: number, len: number, callback:AsyncCallback&lt;void&gt;): void
- 参数: - 参数:
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | | -------- | ------------------------- | ---- | ---------------- |
| fd | number | 是 | 待截断文件的文件描述符。 | | fd | number | 是 | 待截断文件的文件描述符。 |
| len | number | 是 | 文件截断后的长度,以字节为单位。 | | len | number | 是 | 文件截断后的长度,以字节为单位。 |
| callback | AsyncCallback&lt;void&gt; | 是 | 异步截断文件的信息之后的回调。 | | callback | AsyncCallback&lt;void&gt; | 是 | 异步截断文件的信息之后的回调。 |
...@@ -1215,7 +1215,7 @@ ftruncateSync(fd: number, len?: number): void ...@@ -1215,7 +1215,7 @@ ftruncateSync(fd: number, len?: number): void
- 参数: - 参数:
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | | ---- | ------ | ---- | ---------------- |
| fd | number | 是 | 待截断文件的文件描述符。 | | fd | number | 是 | 待截断文件的文件描述符。 |
| len | number | 否 | 文件截断后的长度,以字节为单位。 | | len | number | 否 | 文件截断后的长度,以字节为单位。 |
...@@ -1235,13 +1235,13 @@ truncate(path: string, len?: number): Promise&lt;void&gt; ...@@ -1235,13 +1235,13 @@ truncate(path: string, len?: number): Promise&lt;void&gt;
- 参数: - 参数:
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | | ---- | ------ | ---- | ---------------- |
| path | string | 是 | 待截断文件的绝对路径。 | | path | string | 是 | 待截断文件的绝对路径。 |
| len | number | 是 | 文件截断后的长度,以字节为单位。 | | len | number | 是 | 文件截断后的长度,以字节为单位。 |
- 返回值: - 返回值:
| 类型 | 说明 | | 类型 | 说明 |
| -------- | -------- | | ------------------- | ---------------------------- |
| Promise&lt;void&gt; | Promise实例,用于异步获取结果。本调用将返回空值。 | | Promise&lt;void&gt; | Promise实例,用于异步获取结果。本调用将返回空值。 |
- 示例: - 示例:
...@@ -1264,7 +1264,7 @@ truncate(path: string, len: number, callback:AsyncCallback&lt;void&gt;): void ...@@ -1264,7 +1264,7 @@ truncate(path: string, len: number, callback:AsyncCallback&lt;void&gt;): void
- 参数: - 参数:
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | | -------- | ------------------------- | ---- | ---------------- |
| path | string | 是 | 待截断文件的绝对路径。 | | path | string | 是 | 待截断文件的绝对路径。 |
| len | number | 是 | 文件截断后的长度,以字节为单位。 | | len | number | 是 | 文件截断后的长度,以字节为单位。 |
| callback | AsyncCallback&lt;void&gt; | 是 | 异步截断文件的信息之后的回调。 | | callback | AsyncCallback&lt;void&gt; | 是 | 异步截断文件的信息之后的回调。 |
...@@ -1287,7 +1287,7 @@ truncateSync(path: string, len?: number): void ...@@ -1287,7 +1287,7 @@ truncateSync(path: string, len?: number): void
- 参数: - 参数:
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | | ---- | ------ | ---- | ---------------- |
| path | string | 是 | 待截断文件的绝对路径。 | | path | string | 是 | 待截断文件的绝对路径。 |
| len | number | 否 | 文件截断后的长度,以字节为单位。 | | len | number | 否 | 文件截断后的长度,以字节为单位。 |
...@@ -1311,13 +1311,13 @@ readText(filePath: string, options?: { ...@@ -1311,13 +1311,13 @@ readText(filePath: string, options?: {
- 参数: - 参数:
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | | -------- | ------ | ---- | ---------------------------------------- |
| filePath | string | 是 | 待读取文件的绝对路径。 | | filePath | string | 是 | 待读取文件的绝对路径。 |
| options | Object | 否 | 支持如下选项:<br/>-&nbsp;position,number类型,表示期望读取文件的位置。可选,默认从当前位置开始读取。<br/>-&nbsp;length,number类型,表示期望读取数据的长度。可选,默认缓冲区长度减去偏移长度。<br/>-&nbsp;encoding,string类型,当数据是&nbsp;string&nbsp;类型时有效,表示数据的编码方式,默认&nbsp;'utf-8',仅支持&nbsp;'utf-8'。 | | options | Object | 否 | 支持如下选项:<br/>-&nbsp;position,number类型,表示期望读取文件的位置。可选,默认从当前位置开始读取。<br/>-&nbsp;length,number类型,表示期望读取数据的长度。可选,默认缓冲区长度减去偏移长度。<br/>-&nbsp;encoding,string类型,当数据是&nbsp;string&nbsp;类型时有效,表示数据的编码方式,默认&nbsp;'utf-8',仅支持&nbsp;'utf-8'。 |
- 返回值: - 返回值:
| 类型 | 说明 | | 类型 | 说明 |
| -------- | -------- | | --------------------- | ---------- |
| Promise&lt;string&gt; | 返回读取文件的内容。 | | Promise&lt;string&gt; | 返回读取文件的内容。 |
- 示例: - 示例:
...@@ -1344,7 +1344,7 @@ readText(filePath: string, options: { ...@@ -1344,7 +1344,7 @@ readText(filePath: string, options: {
- 参数: - 参数:
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | | -------- | --------------------------- | ---- | ---------------------------------------- |
| filePath | string | 是 | 待读取文件的绝对路径。 | | filePath | string | 是 | 待读取文件的绝对路径。 |
| options | Object | 否 | 支持如下选项:<br/>-&nbsp;position,number类型,表示期望读取文件的位置。可选,默认从当前位置开始读取。<br/>-&nbsp;length,number类型,表示期望读取数据的长度。可选,默认缓冲区长度减去偏移长度。<br/>-&nbsp;encoding,string类型,当数据是&nbsp;string&nbsp;类型时有效,表示数据的编码方式,默认&nbsp;'utf-8',仅支持&nbsp;'utf-8'。 | | options | Object | 否 | 支持如下选项:<br/>-&nbsp;position,number类型,表示期望读取文件的位置。可选,默认从当前位置开始读取。<br/>-&nbsp;length,number类型,表示期望读取数据的长度。可选,默认缓冲区长度减去偏移长度。<br/>-&nbsp;encoding,string类型,当数据是&nbsp;string&nbsp;类型时有效,表示数据的编码方式,默认&nbsp;'utf-8',仅支持&nbsp;'utf-8'。 |
| callback | AsyncCallback&lt;string&gt; | 是 | 异步通过文本方式读取文件之后的回调。 | | callback | AsyncCallback&lt;string&gt; | 是 | 异步通过文本方式读取文件之后的回调。 |
...@@ -1371,13 +1371,13 @@ readTextSync(filePath: string, options?: { ...@@ -1371,13 +1371,13 @@ readTextSync(filePath: string, options?: {
- 参数: - 参数:
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | | -------- | ------ | ---- | ---------------------------------------- |
| filePath | string | 是 | 待读取文件的绝对路径。 | | filePath | string | 是 | 待读取文件的绝对路径。 |
| options | Object | 否 | 支持如下选项:<br/>-&nbsp;position,number类型,表示期望读取文件的位置。可选,默认从当前位置开始读取。<br/>-&nbsp;length,number类型,表示期望读取数据的长度。可选,默认缓冲区长度减去偏移长度。<br/>-&nbsp;encoding,string类型,当数据是&nbsp;string&nbsp;类型时有效,表示数据的编码方式,默认&nbsp;'utf-8',仅支持&nbsp;'utf-8'。 | | options | Object | 否 | 支持如下选项:<br/>-&nbsp;position,number类型,表示期望读取文件的位置。可选,默认从当前位置开始读取。<br/>-&nbsp;length,number类型,表示期望读取数据的长度。可选,默认缓冲区长度减去偏移长度。<br/>-&nbsp;encoding,string类型,当数据是&nbsp;string&nbsp;类型时有效,表示数据的编码方式,默认&nbsp;'utf-8',仅支持&nbsp;'utf-8'。 |
- 返回值: - 返回值:
| 类型 | 说明 | | 类型 | 说明 |
| -------- | -------- | | --------------------- | ---------- |
| Promise&lt;string&gt; | 返回读取文件的内容。 | | Promise&lt;string&gt; | 返回读取文件的内容。 |
- 示例: - 示例:
...@@ -1396,12 +1396,12 @@ lstat(path: string): Promise&lt;Stat&gt; ...@@ -1396,12 +1396,12 @@ lstat(path: string): Promise&lt;Stat&gt;
- 参数: - 参数:
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | | ---- | ------ | ---- | ----------------- |
| path | string | 是 | 目标文件的绝对路径,指向链接状态。 | | path | string | 是 | 目标文件的绝对路径,指向链接状态。 |
- 返回值: - 返回值:
| 类型 | 说明 | | 类型 | 说明 |
| -------- | -------- | | ---------------------------- | ---------- |
| Promise&lt;[Stat](#stat)&gt; | 表示文件的具体信息。 | | Promise&lt;[Stat](#stat)&gt; | 表示文件的具体信息。 |
- 示例: - 示例:
...@@ -1424,7 +1424,7 @@ lstat(path:string, callback:AsyncCallback&lt;Stat&gt;): void ...@@ -1424,7 +1424,7 @@ lstat(path:string, callback:AsyncCallback&lt;Stat&gt;): void
- 参数: - 参数:
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | | -------- | ---------------------------------- | ---- | ----------------- |
| path | string | 是 | 目标文件的绝对路径,指向链接状态。 | | path | string | 是 | 目标文件的绝对路径,指向链接状态。 |
| callback | AsyncCallback&lt;[Stat](#stat)&gt; | 是 | 异步获取链接状态信息之后的回调。 | | callback | AsyncCallback&lt;[Stat](#stat)&gt; | 是 | 异步获取链接状态信息之后的回调。 |
...@@ -1446,12 +1446,12 @@ lstatSync(path:string): Stat ...@@ -1446,12 +1446,12 @@ lstatSync(path:string): Stat
- 参数: - 参数:
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | | ---- | ------ | ---- | ----------------- |
| path | string | 是 | 目标文件的绝对路径,指向链接状态。 | | path | string | 是 | 目标文件的绝对路径,指向链接状态。 |
- 返回值: - 返回值:
| 类型 | 说明 | | 类型 | 说明 |
| -------- | -------- | | ------------- | ---------- |
| [Stat](#stat) | 表示文件的具体信息。 | | [Stat](#stat) | 表示文件的具体信息。 |
- 示例: - 示例:
...@@ -1474,13 +1474,13 @@ read(buffer: ArrayBuffer, options?: { ...@@ -1474,13 +1474,13 @@ read(buffer: ArrayBuffer, options?: {
- 参数: - 参数:
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | | ------- | ----------- | ---- | ---------------------------------------- |
| buffer | ArrayBuffer | 是 | 用于保存读取到的文件数据的缓冲区。 | | buffer | ArrayBuffer | 是 | 用于保存读取到的文件数据的缓冲区。 |
| options | Object | 否 | 支持如下选项:<br/>-&nbsp;offset,number类型,表示将数据读取到缓冲区的位置,即相对于缓冲区首地址的偏移。可选,默认为0。<br/>-&nbsp;length,number类型,表示期望读取数据的长度。可选,默认缓冲区长度减去偏移长度。 | | options | Object | 否 | 支持如下选项:<br/>-&nbsp;offset,number类型,表示将数据读取到缓冲区的位置,即相对于缓冲区首地址的偏移。可选,默认为0。<br/>-&nbsp;length,number类型,表示期望读取数据的长度。可选,默认缓冲区长度减去偏移长度。 |
- 返回值: - 返回值:
| 类型 | 说明 | | 类型 | 说明 |
| -------- | -------- | | ---------------------------------- | ------ |
| Promise&lt;[ReadOut](#readout)&gt; | 读取的结果。 | | Promise&lt;[ReadOut](#readout)&gt; | 读取的结果。 |
- 示例: - 示例:
...@@ -1507,7 +1507,7 @@ read(buffer: ArrayBuffer, options: { ...@@ -1507,7 +1507,7 @@ read(buffer: ArrayBuffer, options: {
- 参数: - 参数:
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | | -------- | ---------------------------------------- | ---- | ---------------------------------------- |
| buffer | ArrayBuffer | 是 | 用于保存读取到的文件数据的缓冲区。 | | buffer | ArrayBuffer | 是 | 用于保存读取到的文件数据的缓冲区。 |
| options | Object | 否 | 支持如下选项:<br/>-&nbsp;offset,number类型,表示将数据读取到缓冲区的位置,即相对于缓冲区首地址的偏移。可选,默认为0。<br/>-&nbsp;length,number类型,表示期望读取数据的长度。可选,默认缓冲区长度减去偏移长度。 | | options | Object | 否 | 支持如下选项:<br/>-&nbsp;offset,number类型,表示将数据读取到缓冲区的位置,即相对于缓冲区首地址的偏移。可选,默认为0。<br/>-&nbsp;length,number类型,表示期望读取数据的长度。可选,默认缓冲区长度减去偏移长度。 |
| callback | AsyncCallback&lt;[ReadOut](#readout)&gt; | 是 | 异步从文件读取数据之后的回调。 | | callback | AsyncCallback&lt;[ReadOut](#readout)&gt; | 是 | 异步从文件读取数据之后的回调。 |
...@@ -1533,13 +1533,13 @@ rename(oldPath: string, newPath: string): Promise&lt;void&gt; ...@@ -1533,13 +1533,13 @@ rename(oldPath: string, newPath: string): Promise&lt;void&gt;
- 参数: - 参数:
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | | ------- | ------ | ---- | ------------ |
| oldPath | string | 是 | 目标文件的当前绝对路径。 | | oldPath | string | 是 | 目标文件的当前绝对路径。 |
| Newpath | String | 是 | 目标文件的新绝对路径。 | | Newpath | String | 是 | 目标文件的新绝对路径。 |
- 返回值: - 返回值:
| 类型 | 说明 | | 类型 | 说明 |
| -------- | -------- | | ------------------- | ---------------------------- |
| Promise&lt;void&gt; | Promise实例,用于异步获取结果。本调用将返回空值。 | | Promise&lt;void&gt; | Promise实例,用于异步获取结果。本调用将返回空值。 |
- 示例: - 示例:
...@@ -1562,7 +1562,7 @@ rename(oldPath: string, newPath: string, callback: AsyncCallback&lt;void&gt;): v ...@@ -1562,7 +1562,7 @@ rename(oldPath: string, newPath: string, callback: AsyncCallback&lt;void&gt;): v
- 参数: - 参数:
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | | -------- | ------------------------- | ---- | ------------- |
| oldpath | string | 是 | 目标文件的当前绝对路径。 | | oldpath | string | 是 | 目标文件的当前绝对路径。 |
| Newpath | String | 是 | 目标文件的新绝对路径。 | | Newpath | String | 是 | 目标文件的新绝对路径。 |
| Callback | AsyncCallback&lt;void&gt; | 是 | 异步重命名文件之后的回调。 | | Callback | AsyncCallback&lt;void&gt; | 是 | 异步重命名文件之后的回调。 |
...@@ -1584,7 +1584,7 @@ renameSync(oldPath: string, newPath: string): void ...@@ -1584,7 +1584,7 @@ renameSync(oldPath: string, newPath: string): void
- 参数: - 参数:
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | | ------- | ------ | ---- | ------------ |
| oldPath | string | 是 | 目标文件的当前绝对路径。 | | oldPath | string | 是 | 目标文件的当前绝对路径。 |
| Newpath | String | 是 | 目标文件的新绝对路径。 | | Newpath | String | 是 | 目标文件的新绝对路径。 |
...@@ -1604,12 +1604,12 @@ fsync(fd: number): Promise&lt;void&gt; ...@@ -1604,12 +1604,12 @@ fsync(fd: number): Promise&lt;void&gt;
- 参数: - 参数:
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | | ---- | ------ | ---- | ------------ |
| fd | number | 是 | 待同步文件的文件描述符。 | | fd | number | 是 | 待同步文件的文件描述符。 |
- 返回值: - 返回值:
| 类型 | 说明 | | 类型 | 说明 |
| -------- | -------- | | ------------------- | ---------------------------- |
| Promise&lt;void&gt; | Promise实例,用于异步获取结果。本调用将返回空值。 | | Promise&lt;void&gt; | Promise实例,用于异步获取结果。本调用将返回空值。 |
- 示例: - 示例:
...@@ -1632,7 +1632,7 @@ fsync(fd: number, callback: AsyncCallback&lt;void&gt;): void ...@@ -1632,7 +1632,7 @@ fsync(fd: number, callback: AsyncCallback&lt;void&gt;): void
- 参数: - 参数:
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | | -------- | ------------------------- | ---- | --------------- |
| fd | number | 是 | 待同步文件的文件描述符。 | | fd | number | 是 | 待同步文件的文件描述符。 |
| Callback | AsyncCallback&lt;void&gt; | 是 | 异步将文件数据同步之后的回调。 | | Callback | AsyncCallback&lt;void&gt; | 是 | 异步将文件数据同步之后的回调。 |
...@@ -1654,7 +1654,7 @@ fsyncSync(fd: number): void ...@@ -1654,7 +1654,7 @@ fsyncSync(fd: number): void
- 参数: - 参数:
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | | ---- | ------ | ---- | ------------ |
| fd | number | 是 | 待同步文件的文件描述符。 | | fd | number | 是 | 待同步文件的文件描述符。 |
- 示例: - 示例:
...@@ -1673,12 +1673,12 @@ fdatasync(fd: number): Promise&lt;void&gt; ...@@ -1673,12 +1673,12 @@ fdatasync(fd: number): Promise&lt;void&gt;
- 参数: - 参数:
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | | ---- | ------ | ---- | ------------ |
| fd | number | 是 | 待同步文件的文件描述符。 | | fd | number | 是 | 待同步文件的文件描述符。 |
- 返回值: - 返回值:
| 类型 | 说明 | | 类型 | 说明 |
| -------- | -------- | | ------------------- | ---------------------------- |
| Promise&lt;void&gt; | Promise实例,用于异步获取结果,本调用将返回空值。 | | Promise&lt;void&gt; | Promise实例,用于异步获取结果,本调用将返回空值。 |
- 示例: - 示例:
...@@ -1701,7 +1701,7 @@ fdatasync(fd: number, callback:AsyncCallback&lt;void&gt;): void ...@@ -1701,7 +1701,7 @@ fdatasync(fd: number, callback:AsyncCallback&lt;void&gt;): void
- 参数: - 参数:
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | | -------- | ------------------------------- | ---- | ----------------- |
| fd | number | 是 | 待同步文件的文件描述符。 | | fd | number | 是 | 待同步文件的文件描述符。 |
| callback | AsyncCallback&nbsp;&lt;void&gt; | 是 | 异步将文件内容数据同步之后的回调。 | | callback | AsyncCallback&nbsp;&lt;void&gt; | 是 | 异步将文件内容数据同步之后的回调。 |
...@@ -1723,7 +1723,7 @@ fdatasyncSync(fd: number): void ...@@ -1723,7 +1723,7 @@ fdatasyncSync(fd: number): void
- 参数: - 参数:
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | | ---- | ------ | ---- | ------------ |
| fd | number | 是 | 待同步文件的文件描述符。 | | fd | number | 是 | 待同步文件的文件描述符。 |
- 示例: - 示例:
...@@ -1742,13 +1742,13 @@ symlink(target: string, srcPath: string): Promise&lt;void&gt; ...@@ -1742,13 +1742,13 @@ symlink(target: string, srcPath: string): Promise&lt;void&gt;
- 参数: - 参数:
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | | ------- | ------ | ---- | ------------ |
| target | string | 是 | 目标文件的绝对路径。 | | target | string | 是 | 目标文件的绝对路径。 |
| srcPath | string | 是 | 符号链接文件的绝对路径。 | | srcPath | string | 是 | 符号链接文件的绝对路径。 |
- 返回值: - 返回值:
| 类型 | 说明 | | 类型 | 说明 |
| -------- | -------- | | ------------------- | ---------------------------- |
| Promise&lt;void&gt; | Promise实例,用于异步获取结果,本调用将返回空值。 | | Promise&lt;void&gt; | Promise实例,用于异步获取结果,本调用将返回空值。 |
- 示例: - 示例:
...@@ -1771,7 +1771,7 @@ symlink(target: string, srcPath: string, callback: AsyncCallback&lt;void&gt;): v ...@@ -1771,7 +1771,7 @@ symlink(target: string, srcPath: string, callback: AsyncCallback&lt;void&gt;): v
- 参数: - 参数:
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | | -------- | ------------------------- | ---- | ---------------- |
| target | string | 是 | 目标文件的绝对路径。 | | target | string | 是 | 目标文件的绝对路径。 |
| srcPath | string | 是 | 符号链接文件的绝对路径。 | | srcPath | string | 是 | 符号链接文件的绝对路径。 |
| callback | AsyncCallback&lt;void&gt; | 是 | 异步创建符号链接信息之后的回调。 | | callback | AsyncCallback&lt;void&gt; | 是 | 异步创建符号链接信息之后的回调。 |
...@@ -1794,7 +1794,7 @@ symlinkSync(target: string, srcPath: string): void ...@@ -1794,7 +1794,7 @@ symlinkSync(target: string, srcPath: string): void
- 参数: - 参数:
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | | ------- | ------ | ---- | ------------ |
| target | string | 是 | 目标文件的绝对路径。 | | target | string | 是 | 目标文件的绝对路径。 |
| srcPath | string | 是 | 符号链接文件的绝对路径。 | | srcPath | string | 是 | 符号链接文件的绝对路径。 |
...@@ -1814,14 +1814,14 @@ chown(path: string, uid: number, gid: number): Promise&lt;void&gt; ...@@ -1814,14 +1814,14 @@ chown(path: string, uid: number, gid: number): Promise&lt;void&gt;
- 参数: - 参数:
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | | ---- | ------ | ---- | --------------- |
| path | string | 是 | 待改变文件的绝对路径。 | | path | string | 是 | 待改变文件的绝对路径。 |
| uid | number | 是 | 新的UID(UserID)。 | | uid | number | 是 | 新的UID(UserID)。 |
| gid | number | 是 | 新的GID(GroupID)。 | | gid | number | 是 | 新的GID(GroupID)。 |
- 返回值: - 返回值:
| 类型 | 说明 | | 类型 | 说明 |
| -------- | -------- | | ------------------- | ---------------------------- |
| Promise&lt;void&gt; | Promise实例,用于异步获取结果,本调用将返回空值。 | | Promise&lt;void&gt; | Promise实例,用于异步获取结果,本调用将返回空值。 |
- 示例: - 示例:
...@@ -1845,7 +1845,7 @@ chown(path: string, uid: number, gid: number, callback: AsyncCallback&lt;void&gt ...@@ -1845,7 +1845,7 @@ chown(path: string, uid: number, gid: number, callback: AsyncCallback&lt;void&gt
- 参数: - 参数:
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | | -------- | ------------------------- | ---- | --------------- |
| path | string | 是 | 待改变文件的绝对路径。 | | path | string | 是 | 待改变文件的绝对路径。 |
| uid | number | 是 | 新的UID。 | | uid | number | 是 | 新的UID。 |
| gid | number | 是 | 新的GID。 | | gid | number | 是 | 新的GID。 |
...@@ -1870,7 +1870,7 @@ chownSync(path: string, uid: number, gid: number): void ...@@ -1870,7 +1870,7 @@ chownSync(path: string, uid: number, gid: number): void
- 参数: - 参数:
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | | ---- | ------ | ---- | ----------- |
| path | string | 是 | 待改变文件的绝对路径。 | | path | string | 是 | 待改变文件的绝对路径。 |
| uid | number | 是 | 新的UID。 | | uid | number | 是 | 新的UID。 |
| gid | number | 是 | 新的GID。 | | gid | number | 是 | 新的GID。 |
...@@ -1892,12 +1892,12 @@ mkdtemp(prefix: string): Promise&lt;string&gt; ...@@ -1892,12 +1892,12 @@ mkdtemp(prefix: string): Promise&lt;string&gt;
- 参数: - 参数:
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | | ------ | ------ | ---- | --------------------------- |
| prefix | string | 是 | 用随机产生的字符串替换以“XXXXXX”结尾目录路径。 | | prefix | string | 是 | 用随机产生的字符串替换以“XXXXXX”结尾目录路径。 |
- 返回值: - 返回值:
| 参数名 | 说明 | | 参数名 | 说明 |
| -------- | -------- | | --------------------- | ---------- |
| Promise&lt;string&gt; | 生成的唯一目录路径。 | | Promise&lt;string&gt; | 生成的唯一目录路径。 |
- 示例: - 示例:
...@@ -1920,7 +1920,7 @@ mkdtemp(prefix: string, callback: AsyncCallback&lt;string&gt;): void ...@@ -1920,7 +1920,7 @@ mkdtemp(prefix: string, callback: AsyncCallback&lt;string&gt;): void
- 参数: - 参数:
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | | -------- | --------------------------- | ---- | --------------------------- |
| prefix | string | 是 | 用随机产生的字符串替换以“XXXXXX”结尾目录路径。 | | prefix | string | 是 | 用随机产生的字符串替换以“XXXXXX”结尾目录路径。 |
| callback | AsyncCallback&lt;string&gt; | 是 | 异步创建临时目录之后的回调。 | | callback | AsyncCallback&lt;string&gt; | 是 | 异步创建临时目录之后的回调。 |
...@@ -1942,12 +1942,12 @@ mkdtempSync(prefix: string): string ...@@ -1942,12 +1942,12 @@ mkdtempSync(prefix: string): string
- 参数: - 参数:
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | | ------ | ------ | ---- | --------------------------- |
| prefix | string | 是 | 用随机产生的字符串替换以“XXXXXX”结尾目录路径。 | | prefix | string | 是 | 用随机产生的字符串替换以“XXXXXX”结尾目录路径。 |
- 返回值: - 返回值:
| 参数名 | 说明 | | 参数名 | 说明 |
| -------- | -------- | | ------ | ---------- |
| string | 产生的唯一目录路径。 | | string | 产生的唯一目录路径。 |
- 示例: - 示例:
...@@ -1966,13 +1966,13 @@ fchmod(fd: number, mode: number): Promise&lt;void&gt; ...@@ -1966,13 +1966,13 @@ fchmod(fd: number, mode: number): Promise&lt;void&gt;
- 参数: - 参数:
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | | ---- | ------ | ---- | ---------------------------------------- |
| fd | number | 是 | 待改变文件的文件描述符。 | | fd | number | 是 | 待改变文件的文件描述符。 |
| mode | number | 是 | 若创建文件,则指定文件的权限,可给定如下权限,以按位或的方式追加权限。<br/>-&nbsp;0o700:所有者具有读、写及可执行权限。<br/>-&nbsp;0o400:所有者具有读权限。<br/>-&nbsp;0o200:所有者具有写权限。<br/>-&nbsp;0o100:所有者具有可执行权限。<br/>-&nbsp;0o070:所有用户组具有读、写及可执行权限。<br/>-&nbsp;0o040:所有用户组具有读权限。<br/>-&nbsp;0o020:所有用户组具有写权限。<br/>-&nbsp;0o010:所有用户组具有可执行权限。<br/>-&nbsp;0o007:其余用户具有读、写及可执行权限。<br/>-&nbsp;0o004:其余用户具有读权限。<br/>-&nbsp;0o002:其余用户具有写权限。<br/>-&nbsp;0o001:其余用户具有可执行权限。 | | mode | number | 是 | 若创建文件,则指定文件的权限,可给定如下权限,以按位或的方式追加权限。<br/>-&nbsp;0o700:所有者具有读、写及可执行权限。<br/>-&nbsp;0o400:所有者具有读权限。<br/>-&nbsp;0o200:所有者具有写权限。<br/>-&nbsp;0o100:所有者具有可执行权限。<br/>-&nbsp;0o070:所有用户组具有读、写及可执行权限。<br/>-&nbsp;0o040:所有用户组具有读权限。<br/>-&nbsp;0o020:所有用户组具有写权限。<br/>-&nbsp;0o010:所有用户组具有可执行权限。<br/>-&nbsp;0o007:其余用户具有读、写及可执行权限。<br/>-&nbsp;0o004:其余用户具有读权限。<br/>-&nbsp;0o002:其余用户具有写权限。<br/>-&nbsp;0o001:其余用户具有可执行权限。 |
- 返回值: - 返回值:
| 参数名 | 说明 | | 参数名 | 说明 |
| -------- | -------- | | ------------------- | ---------------------------- |
| Promise&lt;void&gt; | Promise实例,用于异步获取结果,本调用将返回空值。 | | Promise&lt;void&gt; | Promise实例,用于异步获取结果,本调用将返回空值。 |
- 示例: - 示例:
...@@ -1995,7 +1995,7 @@ fchmod(fd: number, mode: number, callback: AsyncCallback&lt;void&gt;): void ...@@ -1995,7 +1995,7 @@ fchmod(fd: number, mode: number, callback: AsyncCallback&lt;void&gt;): void
- 参数: - 参数:
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | | -------- | ------------------------------- | ---- | ---------------------------------------- |
| fd | number | 是 | 待改变文件的文件描述符。 | | fd | number | 是 | 待改变文件的文件描述符。 |
| mode | number | 是 | 若创建文件,则指定文件的权限,可给定如下权限,以按位或的方式追加权限。<br/>-&nbsp;0o700:所有者具有读、写及可执行权限。<br/>-&nbsp;0o400:所有者具有读权限。<br/>-&nbsp;0o200:所有者具有写权限。<br/>-&nbsp;0o100:所有者具有可执行权限。<br/>-&nbsp;0o070:所有用户组具有读、写及可执行权限。<br/>-&nbsp;0o040:所有用户组具有读权限。<br/>-&nbsp;0o020:所有用户组具有写权限。<br/>-&nbsp;0o010:所有用户组具有可执行权限。<br/>-&nbsp;0o007:其余用户具有读、写及可执行权限。<br/>-&nbsp;0o004:其余用户具有读权限。<br/>-&nbsp;0o002:其余用户具有写权限。<br/>-&nbsp;0o001:其余用户具有可执行权限。 | | mode | number | 是 | 若创建文件,则指定文件的权限,可给定如下权限,以按位或的方式追加权限。<br/>-&nbsp;0o700:所有者具有读、写及可执行权限。<br/>-&nbsp;0o400:所有者具有读权限。<br/>-&nbsp;0o200:所有者具有写权限。<br/>-&nbsp;0o100:所有者具有可执行权限。<br/>-&nbsp;0o070:所有用户组具有读、写及可执行权限。<br/>-&nbsp;0o040:所有用户组具有读权限。<br/>-&nbsp;0o020:所有用户组具有写权限。<br/>-&nbsp;0o010:所有用户组具有可执行权限。<br/>-&nbsp;0o007:其余用户具有读、写及可执行权限。<br/>-&nbsp;0o004:其余用户具有读权限。<br/>-&nbsp;0o002:其余用户具有写权限。<br/>-&nbsp;0o001:其余用户具有可执行权限。 |
| callback | AsyncCallback&nbsp;&lt;void&gt; | 是 | 异步改变文件权限之后的回调。 | | callback | AsyncCallback&nbsp;&lt;void&gt; | 是 | 异步改变文件权限之后的回调。 |
...@@ -2018,7 +2018,7 @@ fchmodSync(fd: number, mode: number): void ...@@ -2018,7 +2018,7 @@ fchmodSync(fd: number, mode: number): void
- 参数: - 参数:
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | | ---- | ------ | ---- | ---------------------------------------- |
| fd | number | 是 | 待改变文件的文件描述符。 | | fd | number | 是 | 待改变文件的文件描述符。 |
| mode | number | 是 | 若创建文件,则指定文件的权限,可给定如下权限,以按位或的方式追加权限。<br/>-&nbsp;0o700:所有者具有读、写及可执行权限。<br/>-&nbsp;0o400:所有者具有读权限。<br/>-&nbsp;0o200:所有者具有写权限。<br/>-&nbsp;0o100:所有者具有可执行权限。<br/>-&nbsp;0o070:所有用户组具有读、写及可执行权限。<br/>-&nbsp;0o040:所有用户组具有读权限。<br/>-&nbsp;0o020:所有用户组具有写权限。<br/>-&nbsp;0o010:所有用户组具有可执行权限。<br/>-&nbsp;0o007:其余用户具有读、写及可执行权限。<br/>-&nbsp;0o004:其余用户具有读权限。<br/>-&nbsp;0o002:其余用户具有写权限。<br/>-&nbsp;0o001:其余用户具有可执行权限。 | | mode | number | 是 | 若创建文件,则指定文件的权限,可给定如下权限,以按位或的方式追加权限。<br/>-&nbsp;0o700:所有者具有读、写及可执行权限。<br/>-&nbsp;0o400:所有者具有读权限。<br/>-&nbsp;0o200:所有者具有写权限。<br/>-&nbsp;0o100:所有者具有可执行权限。<br/>-&nbsp;0o070:所有用户组具有读、写及可执行权限。<br/>-&nbsp;0o040:所有用户组具有读权限。<br/>-&nbsp;0o020:所有用户组具有写权限。<br/>-&nbsp;0o010:所有用户组具有可执行权限。<br/>-&nbsp;0o007:其余用户具有读、写及可执行权限。<br/>-&nbsp;0o004:其余用户具有读权限。<br/>-&nbsp;0o002:其余用户具有写权限。<br/>-&nbsp;0o001:其余用户具有可执行权限。 |
...@@ -2038,13 +2038,13 @@ createStream(path: string, mode: string): Promise&lt;Stream&gt; ...@@ -2038,13 +2038,13 @@ createStream(path: string, mode: string): Promise&lt;Stream&gt;
- 参数: - 参数:
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | | ---- | ------ | ---- | ---------------------------------------- |
| path | string | 是 | 待打开文件的绝对路径。 | | path | string | 是 | 待打开文件的绝对路径。 |
| mode | string | 是 | -&nbsp;r:打开只读文件,该文件必须存在。<br/>-&nbsp;r+:打开可读写的文件,该文件必须存在。<br/>-&nbsp;w:打开只写文件,若文件存在则文件长度清0,即该文件内容会消失。若文件不存在则建立该文件。<br/>-&nbsp;w+:打开可读写文件,若文件存在则文件长度清0,即该文件内容会消失。若文件不存在则建立该文件。<br/>-&nbsp;a:以附加的方式打开只写文件。若文件不存在,则会建立该文件,如果文件存在,写入的数据会被加到文件尾,即文件原先的内容会被保留。<br/>-&nbsp;a+:以附加方式打开可读写的文件。若文件不存在,则会建立该文件,如果文件存在,写入的数据会被加到文件尾后,即文件原先的内容会被保留。 | | mode | string | 是 | -&nbsp;r:打开只读文件,该文件必须存在。<br/>-&nbsp;r+:打开可读写的文件,该文件必须存在。<br/>-&nbsp;w:打开只写文件,若文件存在则文件长度清0,即该文件内容会消失。若文件不存在则建立该文件。<br/>-&nbsp;w+:打开可读写文件,若文件存在则文件长度清0,即该文件内容会消失。若文件不存在则建立该文件。<br/>-&nbsp;a:以附加的方式打开只写文件。若文件不存在,则会建立该文件,如果文件存在,写入的数据会被加到文件尾,即文件原先的内容会被保留。<br/>-&nbsp;a+:以附加方式打开可读写的文件。若文件不存在,则会建立该文件,如果文件存在,写入的数据会被加到文件尾后,即文件原先的内容会被保留。 |
- 返回值: - 返回值:
| 类型 | 说明 | | 类型 | 说明 |
| -------- | -------- | | --------------------------------- | --------- |
| Promise&lt;[Stream](#stream7)&gt; | 返回文件流的结果。 | | Promise&lt;[Stream](#stream7)&gt; | 返回文件流的结果。 |
- 示例: - 示例:
...@@ -2067,7 +2067,7 @@ createStream(path: string, mode: string, callback: AsyncCallback&lt;Stream&gt;): ...@@ -2067,7 +2067,7 @@ createStream(path: string, mode: string, callback: AsyncCallback&lt;Stream&gt;):
- 参数: - 参数:
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | | -------- | --------------------------------------- | ---- | ---------------------------------------- |
| path | string | 是 | 待打开文件的绝对路径。 | | path | string | 是 | 待打开文件的绝对路径。 |
| mode | string | 是 | -&nbsp;r:打开只读文件,该文件必须存在。<br/>-&nbsp;r+:打开可读写的文件,该文件必须存在。<br/>-&nbsp;w:打开只写文件,若文件存在则文件长度清0,即该文件内容会消失。若文件不存在则建立该文件。<br/>-&nbsp;w+:打开可读写文件,若文件存在则文件长度清0,即该文件内容会消失。若文件不存在则建立该文件。<br/>-&nbsp;a:以附加的方式打开只写文件。若文件不存在,则会建立该文件,如果文件存在,写入的数据会被加到文件尾,即文件原先的内容会被保留。<br/>-&nbsp;a+:以附加方式打开可读写的文件。若文件不存在,则会建立该文件,如果文件存在,写入的数据会被加到文件尾后,即文件原先的内容会被保留。 | | mode | string | 是 | -&nbsp;r:打开只读文件,该文件必须存在。<br/>-&nbsp;r+:打开可读写的文件,该文件必须存在。<br/>-&nbsp;w:打开只写文件,若文件存在则文件长度清0,即该文件内容会消失。若文件不存在则建立该文件。<br/>-&nbsp;w+:打开可读写文件,若文件存在则文件长度清0,即该文件内容会消失。若文件不存在则建立该文件。<br/>-&nbsp;a:以附加的方式打开只写文件。若文件不存在,则会建立该文件,如果文件存在,写入的数据会被加到文件尾,即文件原先的内容会被保留。<br/>-&nbsp;a+:以附加方式打开可读写的文件。若文件不存在,则会建立该文件,如果文件存在,写入的数据会被加到文件尾后,即文件原先的内容会被保留。 |
| callback | AsyncCallback&lt;[Stream](#stream7)&gt; | 是 | 异步打开文件流之后的回调。 | | callback | AsyncCallback&lt;[Stream](#stream7)&gt; | 是 | 异步打开文件流之后的回调。 |
...@@ -2090,13 +2090,13 @@ createStreamSync(path: string, mode: string): Stream ...@@ -2090,13 +2090,13 @@ createStreamSync(path: string, mode: string): Stream
- 参数: - 参数:
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | | ---- | ------ | ---- | ---------------------------------------- |
| path | string | 是 | 待打开文件的绝对路径。 | | path | string | 是 | 待打开文件的绝对路径。 |
| mode | string | 是 | -&nbsp;r:打开只读文件,该文件必须存在。<br/>-&nbsp;r+:打开可读写的文件,该文件必须存在。<br/>-&nbsp;w:打开只写文件,若文件存在则文件长度清0,即该文件内容会消失。若文件不存在则建立该文件。<br/>-&nbsp;w+:打开可读写文件,若文件存在则文件长度清0,即该文件内容会消失。若文件不存在则建立该文件。<br/>-&nbsp;a:以附加的方式打开只写文件。若文件不存在,则会建立该文件,如果文件存在,写入的数据会被加到文件尾,即文件原先的内容会被保留。<br/>-&nbsp;a+:以附加方式打开可读写的文件。若文件不存在,则会建立该文件,如果文件存在,写入的数据会被加到文件尾后,即文件原先的内容会被保留。 | | mode | string | 是 | -&nbsp;r:打开只读文件,该文件必须存在。<br/>-&nbsp;r+:打开可读写的文件,该文件必须存在。<br/>-&nbsp;w:打开只写文件,若文件存在则文件长度清0,即该文件内容会消失。若文件不存在则建立该文件。<br/>-&nbsp;w+:打开可读写文件,若文件存在则文件长度清0,即该文件内容会消失。若文件不存在则建立该文件。<br/>-&nbsp;a:以附加的方式打开只写文件。若文件不存在,则会建立该文件,如果文件存在,写入的数据会被加到文件尾,即文件原先的内容会被保留。<br/>-&nbsp;a+:以附加方式打开可读写的文件。若文件不存在,则会建立该文件,如果文件存在,写入的数据会被加到文件尾后,即文件原先的内容会被保留。 |
- 返回值: - 返回值:
| 参数名 | 说明 | | 参数名 | 说明 |
| -------- | -------- | | ------------------ | --------- |
| [Stream](#stream7) | 返回文件流的结果。 | | [Stream](#stream7) | 返回文件流的结果。 |
- 示例: - 示例:
...@@ -2115,13 +2115,13 @@ fdopenStream(fd: number, mode: string): Promise&lt;Stream&gt; ...@@ -2115,13 +2115,13 @@ fdopenStream(fd: number, mode: string): Promise&lt;Stream&gt;
- 参数: - 参数:
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | | ---- | ------ | ---- | ---------------------------------------- |
| fd | number | 是 | 待打开文件的文件描述符。 | | fd | number | 是 | 待打开文件的文件描述符。 |
| mode | string | 是 | -&nbsp;r:打开只读文件,该文件必须存在。<br/>-&nbsp;r+:打开可读写的文件,该文件必须存在。<br/>-&nbsp;w:打开只写文件,若文件存在则文件长度清0,即该文件内容会消失。若文件不存在则建立该文件。<br/>-&nbsp;w+:打开可读写文件,若文件存在则文件长度清0,即该文件内容会消失。若文件不存在则建立该文件。<br/>-&nbsp;a:以附加的方式打开只写文件。若文件不存在,则会建立该文件,如果文件存在,写入的数据会被加到文件尾,即文件原先的内容会被保留。<br/>-&nbsp;a+:以附加方式打开可读写的文件。若文件不存在,则会建立该文件,如果文件存在,写入的数据会被加到文件尾后,即文件原先的内容会被保留。 | | mode | string | 是 | -&nbsp;r:打开只读文件,该文件必须存在。<br/>-&nbsp;r+:打开可读写的文件,该文件必须存在。<br/>-&nbsp;w:打开只写文件,若文件存在则文件长度清0,即该文件内容会消失。若文件不存在则建立该文件。<br/>-&nbsp;w+:打开可读写文件,若文件存在则文件长度清0,即该文件内容会消失。若文件不存在则建立该文件。<br/>-&nbsp;a:以附加的方式打开只写文件。若文件不存在,则会建立该文件,如果文件存在,写入的数据会被加到文件尾,即文件原先的内容会被保留。<br/>-&nbsp;a+:以附加方式打开可读写的文件。若文件不存在,则会建立该文件,如果文件存在,写入的数据会被加到文件尾后,即文件原先的内容会被保留。 |
- 返回值: - 返回值:
| 参数名 | 说明 | | 参数名 | 说明 |
| -------- | -------- | | --------------------------------- | --------- |
| Promise&lt;[Stream](#stream7)&gt; | 返回文件流的结果。 | | Promise&lt;[Stream](#stream7)&gt; | 返回文件流的结果。 |
- 示例: - 示例:
...@@ -2144,7 +2144,7 @@ fdopenStream(fd: number, mode: string, callback: AsyncCallback&lt;Stream&gt;): v ...@@ -2144,7 +2144,7 @@ fdopenStream(fd: number, mode: string, callback: AsyncCallback&lt;Stream&gt;): v
- 参数: - 参数:
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | | -------- | ---------------------------------------- | ---- | ---------------------------------------- |
| fd | number | 是 | 待打开文件的文件描述符。 | | fd | number | 是 | 待打开文件的文件描述符。 |
| mode | string | 是 | -&nbsp;r:打开只读文件,该文件必须存在。<br/>-&nbsp;r+:打开可读写的文件,该文件必须存在。<br/>-&nbsp;w:打开只写文件,若文件存在则文件长度清0,即该文件内容会消失。若文件不存在则建立该文件。<br/>-&nbsp;w+:打开可读写文件,若文件存在则文件长度清0,即该文件内容会消失。若文件不存在则建立该文件。<br/>-&nbsp;a:以附加的方式打开只写文件。若文件不存在,则会建立该文件,如果文件存在,写入的数据会被加到文件尾,即文件原先的内容会被保留。<br/>-&nbsp;a+:以附加方式打开可读写的文件。若文件不存在,则会建立该文件,如果文件存在,写入的数据会被加到文件尾后,即文件原先的内容会被保留。 | | mode | string | 是 | -&nbsp;r:打开只读文件,该文件必须存在。<br/>-&nbsp;r+:打开可读写的文件,该文件必须存在。<br/>-&nbsp;w:打开只写文件,若文件存在则文件长度清0,即该文件内容会消失。若文件不存在则建立该文件。<br/>-&nbsp;w+:打开可读写文件,若文件存在则文件长度清0,即该文件内容会消失。若文件不存在则建立该文件。<br/>-&nbsp;a:以附加的方式打开只写文件。若文件不存在,则会建立该文件,如果文件存在,写入的数据会被加到文件尾,即文件原先的内容会被保留。<br/>-&nbsp;a+:以附加方式打开可读写的文件。若文件不存在,则会建立该文件,如果文件存在,写入的数据会被加到文件尾后,即文件原先的内容会被保留。 |
| callback | AsyncCallback&nbsp;&lt;[Stream](#stream7)&gt; | 是 | 异步打开文件流之后的回调。 | | callback | AsyncCallback&nbsp;&lt;[Stream](#stream7)&gt; | 是 | 异步打开文件流之后的回调。 |
...@@ -2167,13 +2167,13 @@ fdopenStreamSync(fd: number, mode: string): Stream ...@@ -2167,13 +2167,13 @@ fdopenStreamSync(fd: number, mode: string): Stream
- 参数: - 参数:
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | | ---- | ------ | ---- | ---------------------------------------- |
| fd | number | 是 | 待打开文件的文件描述符。 | | fd | number | 是 | 待打开文件的文件描述符。 |
| mode | string | 是 | -&nbsp;r:打开只读文件,该文件必须存在。<br/>-&nbsp;r+:打开可读写的文件,该文件必须存在。<br/>-&nbsp;w:打开只写文件,若文件存在则文件长度清0,即该文件内容会消失。若文件不存在则建立该文件。<br/>-&nbsp;w+:打开可读写文件,若文件存在则文件长度清0,即该文件内容会消失。若文件不存在则建立该文件。<br/>-&nbsp;a:以附加的方式打开只写文件。若文件不存在,则会建立该文件,如果文件存在,写入的数据会被加到文件尾,即文件原先的内容会被保留。<br/>-&nbsp;a+:以附加方式打开可读写的文件。若文件不存在,则会建立该文件,如果文件存在,写入的数据会被加到文件尾后,即文件原先的内容会被保留。 | | mode | string | 是 | -&nbsp;r:打开只读文件,该文件必须存在。<br/>-&nbsp;r+:打开可读写的文件,该文件必须存在。<br/>-&nbsp;w:打开只写文件,若文件存在则文件长度清0,即该文件内容会消失。若文件不存在则建立该文件。<br/>-&nbsp;w+:打开可读写文件,若文件存在则文件长度清0,即该文件内容会消失。若文件不存在则建立该文件。<br/>-&nbsp;a:以附加的方式打开只写文件。若文件不存在,则会建立该文件,如果文件存在,写入的数据会被加到文件尾,即文件原先的内容会被保留。<br/>-&nbsp;a+:以附加方式打开可读写的文件。若文件不存在,则会建立该文件,如果文件存在,写入的数据会被加到文件尾后,即文件原先的内容会被保留。 |
- 返回值: - 返回值:
| 参数名 | 说明 | | 参数名 | 说明 |
| -------- | -------- | | ------------------ | --------- |
| [Stream](#stream7) | 返回文件流的结果。 | | [Stream](#stream7) | 返回文件流的结果。 |
- 示例: - 示例:
...@@ -2192,14 +2192,14 @@ fchown(fd: number, uid: number, gid: number): Promise&lt;void&gt; ...@@ -2192,14 +2192,14 @@ fchown(fd: number, uid: number, gid: number): Promise&lt;void&gt;
- 参数: - 参数:
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | | ---- | ------ | ---- | ------------ |
| fd | number | 是 | 待改变文件的文件描述符。 | | fd | number | 是 | 待改变文件的文件描述符。 |
| uid | number | 是 | 文件所有者的UID。 | | uid | number | 是 | 文件所有者的UID。 |
| gid | number | 是 | 文件所有组的GID。 | | gid | number | 是 | 文件所有组的GID。 |
- 返回值: - 返回值:
| 类型 | 说明 | | 类型 | 说明 |
| -------- | -------- | | ------------------- | ---------------------------- |
| Promise&lt;void&gt; | Promise实例,用于异步获取结果。本调用将返回空值。 | | Promise&lt;void&gt; | Promise实例,用于异步获取结果。本调用将返回空值。 |
- 示例: - 示例:
...@@ -2223,7 +2223,7 @@ fchown(fd: number, uid: number, gid: number, callback: AsyncCallback&lt;void&gt; ...@@ -2223,7 +2223,7 @@ fchown(fd: number, uid: number, gid: number, callback: AsyncCallback&lt;void&gt;
- 参数: - 参数:
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | | -------- | ------------------------- | ---- | --------------- |
| fd | number | 是 | 待改变文件的文件描述符。 | | fd | number | 是 | 待改变文件的文件描述符。 |
| uid | number | 是 | 文件所有者的UID。 | | uid | number | 是 | 文件所有者的UID。 |
| gid | number | 是 | 文件所有组的GID。 | | gid | number | 是 | 文件所有组的GID。 |
...@@ -2248,7 +2248,7 @@ fchownSync(fd: number, uid: number, gid: number): void ...@@ -2248,7 +2248,7 @@ fchownSync(fd: number, uid: number, gid: number): void
- 参数: - 参数:
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | | ---- | ------ | ---- | ------------ |
| fd | number | 是 | 待改变文件的文件描述符。 | | fd | number | 是 | 待改变文件的文件描述符。 |
| uid | number | 是 | 文件所有者的UID。 | | uid | number | 是 | 文件所有者的UID。 |
| gid | number | 是 | 文件所有组的GID。 | | gid | number | 是 | 文件所有组的GID。 |
...@@ -2270,14 +2270,14 @@ lchown(path: string, uid: number, gid: number): Promise&lt;void&gt; ...@@ -2270,14 +2270,14 @@ lchown(path: string, uid: number, gid: number): Promise&lt;void&gt;
- 参数: - 参数:
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | | ---- | ------ | ---- | ----------- |
| path | string | 是 | 待打开文件的绝对路径。 | | path | string | 是 | 待打开文件的绝对路径。 |
| uid | number | 是 | 新的UID。 | | uid | number | 是 | 新的UID。 |
| gid | number | 是 | 新的GID。 | | gid | number | 是 | 新的GID。 |
- 返回值: - 返回值:
| 类型 | 说明 | | 类型 | 说明 |
| -------- | -------- | | ------------------- | ---------------------------- |
| Promise&lt;void&gt; | Promise实例,用于异步获取结果。本调用将返回空值。 | | Promise&lt;void&gt; | Promise实例,用于异步获取结果。本调用将返回空值。 |
- 示例: - 示例:
...@@ -2301,7 +2301,7 @@ lchown(path: string, uid: number, gid: number, callback: AsyncCallback&lt;void&g ...@@ -2301,7 +2301,7 @@ lchown(path: string, uid: number, gid: number, callback: AsyncCallback&lt;void&g
- 参数: - 参数:
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | | -------- | ------------------------- | ---- | --------------- |
| path | string | 是 | 待打开文件的绝对路径。 | | path | string | 是 | 待打开文件的绝对路径。 |
| uid | number | 是 | 新的UID。 | | uid | number | 是 | 新的UID。 |
| gid | number | 是 | 新的GID。 | | gid | number | 是 | 新的GID。 |
...@@ -2326,7 +2326,7 @@ lchownSync(path: string, uid: number, gid: number): void ...@@ -2326,7 +2326,7 @@ lchownSync(path: string, uid: number, gid: number): void
- 参数: - 参数:
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | | ---- | ------ | ---- | ----------- |
| path | string | 是 | 待打开文件的绝对路径。 | | path | string | 是 | 待打开文件的绝对路径。 |
| uid | number | 是 | 新的UID。 | | uid | number | 是 | 新的UID。 |
| gid | number | 是 | 新的GID。 | | gid | number | 是 | 新的GID。 |
...@@ -2348,14 +2348,14 @@ createWatcher(filename: string, events: number, callback: AsyncCallback&lt;numbe ...@@ -2348,14 +2348,14 @@ createWatcher(filename: string, events: number, callback: AsyncCallback&lt;numbe
- 参数: - 参数:
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | | -------- | --------------------------------- | ---- | ---------------------------------------- |
| filename | string | 是 | 待监视文件的绝对路径。 | | filename | string | 是 | 待监视文件的绝对路径。 |
| events | Number | 是 | -&nbsp;1:&nbsp;监听文件或者目录是否发生重命名。<br/>-&nbsp;2:监听文件或者目录内容的是否修改。<br/>-&nbsp;3:两者都有。 | | events | Number | 是 | -&nbsp;1:&nbsp;监听文件或者目录是否发生重命名。<br/>-&nbsp;2:监听文件或者目录内容的是否修改。<br/>-&nbsp;3:两者都有。 |
| callback | AsyncCallback&lt;number&nbsp;&gt; | 是 | 每发生变化一次,调用一次此函数。 | | callback | AsyncCallback&lt;number&nbsp;&gt; | 是 | 每发生变化一次,调用一次此函数。 |
- 返回值: - 返回值:
| 参数名 | 说明 | | 参数名 | 说明 |
| -------- | -------- | | -------------------- | ---------- |
| [Watcher](#watcher7) | 文件变化监听的实例。 | | [Watcher](#watcher7) | 文件变化监听的实例。 |
- 示例: - 示例:
...@@ -2373,7 +2373,7 @@ createWatcher(filename: string, events: number, callback: AsyncCallback&lt;numbe ...@@ -2373,7 +2373,7 @@ createWatcher(filename: string, events: number, callback: AsyncCallback&lt;numbe
**系统能力**:以下各项对应的系统能力均为SystemCapability.FileManagement.File.FileIO。 **系统能力**:以下各项对应的系统能力均为SystemCapability.FileManagement.File.FileIO。
| 名称 | 参数类型 | 可读 | 可写 | 说明 | | 名称 | 参数类型 | 可读 | 可写 | 说明 |
| -------- | -------- | -------- | -------- | -------- | | --------- | ---------- | ---- | ---- | ----------------- |
| bytesRead | number | 是 | 是 | 实际读取长度。 | | bytesRead | number | 是 | 是 | 实际读取长度。 |
| offset | number | 是 | 是 | 读取数据相对于缓冲区首地址的偏移。 | | offset | number | 是 | 是 | 读取数据相对于缓冲区首地址的偏移。 |
| buffer | ArrayBufer | 是 | 是 | 保存读取数据的缓冲区。 | | buffer | ArrayBufer | 是 | 是 | 保存读取数据的缓冲区。 |
...@@ -2388,7 +2388,7 @@ createWatcher(filename: string, events: number, callback: AsyncCallback&lt;numbe ...@@ -2388,7 +2388,7 @@ createWatcher(filename: string, events: number, callback: AsyncCallback&lt;numbe
### 属性 ### 属性
| 名称 | 参数类型 | 可读 | 可写 | 说明 | | 名称 | 参数类型 | 可读 | 可写 | 说明 |
| -------- | -------- | -------- | -------- | -------- | | ------ | ------ | ---- | ---- | ---------------------------------------- |
| dev | number | 是 | 否 | 标识包含该文件的主设备号。 | | dev | number | 是 | 否 | 标识包含该文件的主设备号。 |
| ino | number | 是 | 否 | 标识该文件。通常同设备上的不同文件的INO不同。 | | ino | number | 是 | 否 | 标识该文件。通常同设备上的不同文件的INO不同。 |
| mode | number | 是 | 否 | 表示文件类型及权限,其首&nbsp;4&nbsp;位表示文件类型,后&nbsp;12&nbsp;位表示权限。各特征位的含义如下:<br/>-&nbsp;0o170000:可用于获取文件类型的掩码。<br/>-&nbsp;0o140000:文件是套接字。<br/>-&nbsp;0o120000:文件是符号链接。<br/>-&nbsp;0o100000:文件是一般文件。<br/>-&nbsp;0o060000:文件属于块设备。<br/>-&nbsp;0o040000:文件是目录。<br/>-&nbsp;0o020000:文件是字符设备。<br/>-&nbsp;0o010000:文件是具名管道,即FIFO。<br/>-&nbsp;0o0700:可用于获取用户权限的掩码。<br/>-&nbsp;0o0400:用户读,对于普通文件,所有者可读取文件;对于目录,所有者可读取目录项。<br/>-&nbsp;0o0200:用户写,对于普通文件,所有者可写入文件;对于目录,所有者可创建/删除目录项。<br/>-&nbsp;0o0100:用户执行,对于普通文件,所有者可执行文件;对于目录,所有者可在目录中搜索给定路径名。<br/>-&nbsp;0o0070:可用于获取用户组权限的掩码。<br/>-&nbsp;0o0040:用户组读,对于普通文件,所有用户组可读取文件;对于目录,所有用户组可读取目录项。<br/>-&nbsp;0o0020:用户组写,对于普通文件,所有用户组可写入文件;对于目录,所有用户组可创建/删除目录项。<br/>-&nbsp;0o0010:用户组执行,对于普通文件,所有用户组可执行文件;对于目录,所有用户组是否可在目录中搜索给定路径名。<br/>-&nbsp;0o0007:可用于获取其他用户权限的掩码。<br/>-&nbsp;0o0004:其他读,对于普通文件,其余用户可读取文件;对于目录,其他用户组可读取目录项。<br/>-&nbsp;0o0002:其他写,对于普通文件,其余用户可写入文件;对于目录,其他用户组可创建/删除目录项。<br/>-&nbsp;0o0001:其他执行,对于普通文件,其余用户可执行文件;对于目录,其他用户组可在目录中搜索给定路径名。 | | mode | number | 是 | 否 | 表示文件类型及权限,其首&nbsp;4&nbsp;位表示文件类型,后&nbsp;12&nbsp;位表示权限。各特征位的含义如下:<br/>-&nbsp;0o170000:可用于获取文件类型的掩码。<br/>-&nbsp;0o140000:文件是套接字。<br/>-&nbsp;0o120000:文件是符号链接。<br/>-&nbsp;0o100000:文件是一般文件。<br/>-&nbsp;0o060000:文件属于块设备。<br/>-&nbsp;0o040000:文件是目录。<br/>-&nbsp;0o020000:文件是字符设备。<br/>-&nbsp;0o010000:文件是具名管道,即FIFO。<br/>-&nbsp;0o0700:可用于获取用户权限的掩码。<br/>-&nbsp;0o0400:用户读,对于普通文件,所有者可读取文件;对于目录,所有者可读取目录项。<br/>-&nbsp;0o0200:用户写,对于普通文件,所有者可写入文件;对于目录,所有者可创建/删除目录项。<br/>-&nbsp;0o0100:用户执行,对于普通文件,所有者可执行文件;对于目录,所有者可在目录中搜索给定路径名。<br/>-&nbsp;0o0070:可用于获取用户组权限的掩码。<br/>-&nbsp;0o0040:用户组读,对于普通文件,所有用户组可读取文件;对于目录,所有用户组可读取目录项。<br/>-&nbsp;0o0020:用户组写,对于普通文件,所有用户组可写入文件;对于目录,所有用户组可创建/删除目录项。<br/>-&nbsp;0o0010:用户组执行,对于普通文件,所有用户组可执行文件;对于目录,所有用户组是否可在目录中搜索给定路径名。<br/>-&nbsp;0o0007:可用于获取其他用户权限的掩码。<br/>-&nbsp;0o0004:其他读,对于普通文件,其余用户可读取文件;对于目录,其他用户组可读取目录项。<br/>-&nbsp;0o0002:其他写,对于普通文件,其余用户可写入文件;对于目录,其他用户组可创建/删除目录项。<br/>-&nbsp;0o0001:其他执行,对于普通文件,其余用户可执行文件;对于目录,其他用户组可在目录中搜索给定路径名。 |
...@@ -2413,7 +2413,7 @@ isBlockDevice(): boolean ...@@ -2413,7 +2413,7 @@ isBlockDevice(): boolean
- 返回值: - 返回值:
| 类型 | 说明 | | 类型 | 说明 |
| -------- | -------- | | ------- | ---------------- |
| boolean | 表示当前目录项是否是块特殊设备。 | | boolean | 表示当前目录项是否是块特殊设备。 |
- 示例: - 示例:
...@@ -2432,7 +2432,7 @@ isCharacterDevice(): boolean ...@@ -2432,7 +2432,7 @@ isCharacterDevice(): boolean
- 返回值: - 返回值:
| 类型 | 说明 | | 类型 | 说明 |
| -------- | -------- | | ------- | ----------------- |
| boolean | 表示当前目录项是否是字符特殊设备。 | | boolean | 表示当前目录项是否是字符特殊设备。 |
- 示例: - 示例:
...@@ -2451,7 +2451,7 @@ isDirectory(): boolean ...@@ -2451,7 +2451,7 @@ isDirectory(): boolean
- 返回值: - 返回值:
| 类型 | 说明 | | 类型 | 说明 |
| -------- | -------- | | ------- | ------------- |
| boolean | 表示当前目录项是否是目录。 | | boolean | 表示当前目录项是否是目录。 |
- 示例: - 示例:
...@@ -2470,7 +2470,7 @@ isFIFO(): boolean ...@@ -2470,7 +2470,7 @@ isFIFO(): boolean
- 返回值: - 返回值:
| 类型 | 说明 | | 类型 | 说明 |
| -------- | -------- | | ------- | --------------------- |
| boolean | 表示当前目录项是否是&nbsp;FIFO。 | | boolean | 表示当前目录项是否是&nbsp;FIFO。 |
- 示例: - 示例:
...@@ -2489,7 +2489,7 @@ isFile(): boolean ...@@ -2489,7 +2489,7 @@ isFile(): boolean
- 返回值: - 返回值:
| 类型 | 说明 | | 类型 | 说明 |
| -------- | -------- | | ------- | --------------- |
| boolean | 表示当前目录项是否是普通文件。 | | boolean | 表示当前目录项是否是普通文件。 |
- 示例: - 示例:
...@@ -2508,7 +2508,7 @@ isSocket(): boolean ...@@ -2508,7 +2508,7 @@ isSocket(): boolean
- 返回值: - 返回值:
| 类型 | 说明 | | 类型 | 说明 |
| -------- | -------- | | ------- | -------------- |
| boolean | 表示当前目录项是否是套接字。 | | boolean | 表示当前目录项是否是套接字。 |
- 示例: - 示例:
...@@ -2527,7 +2527,7 @@ isSymbolicLink(): boolean ...@@ -2527,7 +2527,7 @@ isSymbolicLink(): boolean
- 返回值: - 返回值:
| 类型 | 说明 | | 类型 | 说明 |
| -------- | -------- | | ------- | --------------- |
| boolean | 表示当前目录项是否是符号链接。 | | boolean | 表示当前目录项是否是符号链接。 |
- 示例: - 示例:
...@@ -2565,7 +2565,7 @@ stop(callback: AsyncCallback&lt;void&gt;): void ...@@ -2565,7 +2565,7 @@ stop(callback: AsyncCallback&lt;void&gt;): void
- 参数: - 参数:
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | | -------- | ------------------------- | ---- | ---------------------- |
| callback | AsyncCallback&lt;void&gt; | 是 | 以异步方法关闭watcher监听之后的回调。 | | callback | AsyncCallback&lt;void&gt; | 是 | 以异步方法关闭watcher监听之后的回调。 |
- 示例: - 示例:
...@@ -2591,7 +2591,7 @@ close(): Promise&lt;void&gt; ...@@ -2591,7 +2591,7 @@ close(): Promise&lt;void&gt;
- 返回值: - 返回值:
| 类型 | 说明 | | 类型 | 说明 |
| -------- | -------- | | ------------------- | ------------- |
| Promise&lt;void&gt; | 表示异步关闭文件流的结果。 | | Promise&lt;void&gt; | 表示异步关闭文件流的结果。 |
- 示例: - 示例:
...@@ -2615,7 +2615,7 @@ close(callback: AsyncCallback&lt;void&gt;): void ...@@ -2615,7 +2615,7 @@ close(callback: AsyncCallback&lt;void&gt;): void
- 参数: - 参数:
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | | -------- | ------------------------- | ---- | ------------- |
| callback | AsyncCallback&lt;void&gt; | 是 | 异步关闭文件流之后的回调。 | | callback | AsyncCallback&lt;void&gt; | 是 | 异步关闭文件流之后的回调。 |
- 示例: - 示例:
...@@ -2652,7 +2652,7 @@ flush(): Promise&lt;void&gt; ...@@ -2652,7 +2652,7 @@ flush(): Promise&lt;void&gt;
- 返回值: - 返回值:
| 类型 | 说明 | | 类型 | 说明 |
| -------- | -------- | | ------------------- | ------------- |
| Promise&lt;void&gt; | 表示异步刷新文件流的结果。 | | Promise&lt;void&gt; | 表示异步刷新文件流的结果。 |
- 示例: - 示例:
...@@ -2676,7 +2676,7 @@ flush(callback: AsyncCallback&lt;void&gt;): void ...@@ -2676,7 +2676,7 @@ flush(callback: AsyncCallback&lt;void&gt;): void
- 参数: - 参数:
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | | -------- | ------------------------- | ---- | -------------- |
| callback | AsyncCallback&lt;void&gt; | 是 | 异步刷新文件流后的回调函数。 | | callback | AsyncCallback&lt;void&gt; | 是 | 异步刷新文件流后的回调函数。 |
- 示例: - 示例:
...@@ -2718,13 +2718,13 @@ write(buffer: ArrayBuffer | string, options?: { ...@@ -2718,13 +2718,13 @@ write(buffer: ArrayBuffer | string, options?: {
- 参数: - 参数:
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | | ------- | ------------------------------- | ---- | ---------------------------------------- |
| buffer | ArrayBuffer&nbsp;\|&nbsp;string | 是 | 待写入文件的数据,可来自缓冲区或字符串。 | | buffer | ArrayBuffer&nbsp;\|&nbsp;string | 是 | 待写入文件的数据,可来自缓冲区或字符串。 |
| options | Object | 否 | 支持如下选项:<br/>-&nbsp;offset,number类型,表示期望写入数据的位置相对于数据首地址的偏移。可选,默认为0。<br/>-&nbsp;length,number类型,表示期望写入数据的长度。可选,默认缓冲区长度减去偏移长度。<br/>-&nbsp;position,number类型,表示期望写入文件的位置。可选,默认从当前位置开始写。<br/>-&nbsp;encoding,string类型,当数据是string类型时有效,表示数据的编码方式,默认&nbsp;'utf-8'。仅支持&nbsp;'utf-8'。 | | options | Object | 否 | 支持如下选项:<br/>-&nbsp;offset,number类型,表示期望写入数据的位置相对于数据首地址的偏移。可选,默认为0。<br/>-&nbsp;length,number类型,表示期望写入数据的长度。可选,默认缓冲区长度减去偏移长度。<br/>-&nbsp;position,number类型,表示期望写入文件的位置。可选,默认从当前位置开始写。<br/>-&nbsp;encoding,string类型,当数据是string类型时有效,表示数据的编码方式,默认&nbsp;'utf-8'。仅支持&nbsp;'utf-8'。 |
- 返回值: - 返回值:
| 类型 | 说明 | | 类型 | 说明 |
| -------- | -------- | | --------------------- | -------- |
| Promise&lt;number&gt; | 实际写入的长度。 | | Promise&lt;number&gt; | 实际写入的长度。 |
- 示例: - 示例:
...@@ -2753,7 +2753,7 @@ write(buffer: ArrayBuffer | string, options: { ...@@ -2753,7 +2753,7 @@ write(buffer: ArrayBuffer | string, options: {
- 参数: - 参数:
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | | -------- | ------------------------------- | ---- | ---------------------------------------- |
| buffer | ArrayBuffer&nbsp;\|&nbsp;string | 是 | 待写入文件的数据,可来自缓冲区或字符串。 | | buffer | ArrayBuffer&nbsp;\|&nbsp;string | 是 | 待写入文件的数据,可来自缓冲区或字符串。 |
| options | Object | 否 | 支持如下选项:<br/>-&nbsp;offset,number类型,表示期望写入数据的位置相对于数据首地址的偏移。可选,默认为0。<br/>-&nbsp;length,number类型,表示期望写入数据的长度。可选,默认缓冲区长度减去偏移长度。<br/>-&nbsp;position,number类型,表示期望写入文件的位置。可选,默认从当前位置开始写。<br/>-&nbsp;encoding,string类型,当数据是string类型时有效,表示数据的编码方式,默认&nbsp;'utf-8'。仅支持&nbsp;'utf-8'。 | | options | Object | 否 | 支持如下选项:<br/>-&nbsp;offset,number类型,表示期望写入数据的位置相对于数据首地址的偏移。可选,默认为0。<br/>-&nbsp;length,number类型,表示期望写入数据的长度。可选,默认缓冲区长度减去偏移长度。<br/>-&nbsp;position,number类型,表示期望写入文件的位置。可选,默认从当前位置开始写。<br/>-&nbsp;encoding,string类型,当数据是string类型时有效,表示数据的编码方式,默认&nbsp;'utf-8'。仅支持&nbsp;'utf-8'。 |
| callback | AsyncCallback&lt;number&gt; | 是 | 异步写入完成后执行的回调函数。 | | callback | AsyncCallback&lt;number&gt; | 是 | 异步写入完成后执行的回调函数。 |
...@@ -2785,13 +2785,13 @@ writeSync(buffer: ArrayBuffer | string, options?: { ...@@ -2785,13 +2785,13 @@ writeSync(buffer: ArrayBuffer | string, options?: {
- 参数: - 参数:
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | | ------- | ------------------------------- | ---- | ---------------------------------------- |
| buffer | ArrayBuffer&nbsp;\|&nbsp;string | 是 | 待写入文件的数据,可来自缓冲区或字符串。 | | buffer | ArrayBuffer&nbsp;\|&nbsp;string | 是 | 待写入文件的数据,可来自缓冲区或字符串。 |
| options | Object | 否 | 支持如下选项:<br/>-&nbsp;offset,number类型,表示期望写入数据的位置相对于数据首地址的偏移。可选,默认为0。<br/>-&nbsp;length,number类型,表示期望写入数据的长度。可选,默认缓冲区长度减去偏移长度。<br/>-&nbsp;position,number类型,表示期望写入文件的位置。可选,默认从当前位置开始写。<br/>-&nbsp;encoding,string类型,当数据是string类型时有效,表示数据的编码方式,默认&nbsp;'utf-8'。仅支持&nbsp;'utf-8'。 | | options | Object | 否 | 支持如下选项:<br/>-&nbsp;offset,number类型,表示期望写入数据的位置相对于数据首地址的偏移。可选,默认为0。<br/>-&nbsp;length,number类型,表示期望写入数据的长度。可选,默认缓冲区长度减去偏移长度。<br/>-&nbsp;position,number类型,表示期望写入文件的位置。可选,默认从当前位置开始写。<br/>-&nbsp;encoding,string类型,当数据是string类型时有效,表示数据的编码方式,默认&nbsp;'utf-8'。仅支持&nbsp;'utf-8'。 |
- 返回值: - 返回值:
| 类型 | 说明 | | 类型 | 说明 |
| -------- | -------- | | ------ | -------- |
| number | 实际写入的长度。 | | number | 实际写入的长度。 |
- 示例: - 示例:
...@@ -2815,13 +2815,13 @@ read(buffer: ArrayBuffer, options?: { ...@@ -2815,13 +2815,13 @@ read(buffer: ArrayBuffer, options?: {
- 参数: - 参数:
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | | ------- | ----------- | ---- | ---------------------------------------- |
| buffer | ArrayBuffer | 是 | 用于读取文件的缓冲区。 | | buffer | ArrayBuffer | 是 | 用于读取文件的缓冲区。 |
| options | Object | 否 | 支持如下选项:<br/>-&nbsp;offset,number类型,表示将数据读取到缓冲区的位置,即相对于缓冲区首地址的偏移。可选,默认为0。<br/>-&nbsp;length,number类型,表示期望读取数据的长度。可选,默认缓冲区长度减去偏移长度。<br/>-&nbsp;position,number类型,表示期望读取文件的位置。可选,默认从当前位置开始读。 | | options | Object | 否 | 支持如下选项:<br/>-&nbsp;offset,number类型,表示将数据读取到缓冲区的位置,即相对于缓冲区首地址的偏移。可选,默认为0。<br/>-&nbsp;length,number类型,表示期望读取数据的长度。可选,默认缓冲区长度减去偏移长度。<br/>-&nbsp;position,number类型,表示期望读取文件的位置。可选,默认从当前位置开始读。 |
- 返回值: - 返回值:
| 类型 | 说明 | | 类型 | 说明 |
| -------- | -------- | | ---------------------------------- | ------ |
| Promise&lt;[ReadOut](#readout)&gt; | 读取的结果。 | | Promise&lt;[ReadOut](#readout)&gt; | 读取的结果。 |
- 示例: - 示例:
...@@ -2849,7 +2849,7 @@ read(buffer: ArrayBuffer, options: { ...@@ -2849,7 +2849,7 @@ read(buffer: ArrayBuffer, options: {
- 参数: - 参数:
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | | -------- | ---------------------------------------- | ---- | ---------------------------------------- |
| buffer | ArrayBuffer | 是 | 用于读取文件的缓冲区。 | | buffer | ArrayBuffer | 是 | 用于读取文件的缓冲区。 |
| options | Object | 否 | 支持如下选项:<br/>-&nbsp;offset,number类型,表示将数据读取到缓冲区的位置,即相对于缓冲区首地址的偏移。可选,默认为0。<br/>-&nbsp;length,number类型,表示期望读取数据的长度。可选,默认缓冲区长度减去偏移长度。<br/>-&nbsp;position,number类型,表示期望读取文件的位置。可选,默认从当前位置开始读。 | | options | Object | 否 | 支持如下选项:<br/>-&nbsp;offset,number类型,表示将数据读取到缓冲区的位置,即相对于缓冲区首地址的偏移。可选,默认为0。<br/>-&nbsp;length,number类型,表示期望读取数据的长度。可选,默认缓冲区长度减去偏移长度。<br/>-&nbsp;position,number类型,表示期望读取文件的位置。可选,默认从当前位置开始读。 |
| callback | AsyncCallback&lt;[ReadOut](#readout)&gt; | 是 | 异步从流文件读取数据之后的回调。 | | callback | AsyncCallback&lt;[ReadOut](#readout)&gt; | 是 | 异步从流文件读取数据之后的回调。 |
...@@ -2879,13 +2879,13 @@ readSync(buffer: ArrayBuffer, options?: { ...@@ -2879,13 +2879,13 @@ readSync(buffer: ArrayBuffer, options?: {
- 参数: - 参数:
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | | ------- | ----------- | ---- | ---------------------------------------- |
| buffer | ArrayBuffer | 是 | 用于读取文件的缓冲区。 | | buffer | ArrayBuffer | 是 | 用于读取文件的缓冲区。 |
| options | Object | 否 | 支持如下选项:<br/>-&nbsp;offset,number类型,表示将数据读取到缓冲区的位置,即相对于缓冲区首地址的偏移。可选,默认为0。<br/>-&nbsp;length,number类型,表示期望读取数据的长度。可选,默认缓冲区长度减去偏移长度。<br/>-&nbsp;position,number类型,表示期望读取文件的位置。可选,默认从当前位置开始读。 | | options | Object | 否 | 支持如下选项:<br/>-&nbsp;offset,number类型,表示将数据读取到缓冲区的位置,即相对于缓冲区首地址的偏移。可选,默认为0。<br/>-&nbsp;length,number类型,表示期望读取数据的长度。可选,默认缓冲区长度减去偏移长度。<br/>-&nbsp;position,number类型,表示期望读取文件的位置。可选,默认从当前位置开始读。 |
- 返回值: - 返回值:
| 类型 | 说明 | | 类型 | 说明 |
| -------- | -------- | | ------ | -------- |
| number | 实际读取的长度。 | | number | 实际读取的长度。 |
- 示例: - 示例:
...@@ -2910,7 +2910,7 @@ read(): Promise&lt;Dirent&gt; ...@@ -2910,7 +2910,7 @@ read(): Promise&lt;Dirent&gt;
- 返回值: - 返回值:
| 类型 | 说明 | | 类型 | 说明 |
| -------- | -------- | | -------------------------------- | ------------- |
| Promise&lt;[Dirent](#dirent)&gt; | 表示异步读取目录项的结果。 | | Promise&lt;[Dirent](#dirent)&gt; | 表示异步读取目录项的结果。 |
- 示例: - 示例:
...@@ -2934,7 +2934,7 @@ read(callback: AsyncCallback&lt;Dirent&gt;): void ...@@ -2934,7 +2934,7 @@ read(callback: AsyncCallback&lt;Dirent&gt;): void
- 参数: - 参数:
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | | -------- | -------------------------------------- | ---- | ---------------- |
| callback | AsyncCallback&lt;[Dirent](#dirent)&gt; | 是 | 异步读取下一个目录项之后的回调。 | | callback | AsyncCallback&lt;[Dirent](#dirent)&gt; | 是 | 异步读取下一个目录项之后的回调。 |
- 示例: - 示例:
...@@ -2959,7 +2959,7 @@ readSync(): Dirent ...@@ -2959,7 +2959,7 @@ readSync(): Dirent
- 返回值: - 返回值:
| 类型 | 说明 | | 类型 | 说明 |
| -------- | -------- | | ----------------- | -------- |
| [Dirent](#dirent) | 表示一个目录项。 | | [Dirent](#dirent) | 表示一个目录项。 |
- 示例: - 示例:
...@@ -2993,7 +2993,7 @@ closeSync(): void ...@@ -2993,7 +2993,7 @@ closeSync(): void
### 属性 ### 属性
| 名称 | 参数类型 | 可读 | 可写 | 说明 | | 名称 | 参数类型 | 可读 | 可写 | 说明 |
| -------- | -------- | -------- | -------- | -------- | | ---- | ------ | ---- | ---- | ------- |
| name | string | 是 | 否 | 目录项的名称。 | | name | string | 是 | 否 | 目录项的名称。 |
...@@ -3007,7 +3007,7 @@ isBlockDevice(): boolean ...@@ -3007,7 +3007,7 @@ isBlockDevice(): boolean
- 返回值: - 返回值:
| 类型 | 说明 | | 类型 | 说明 |
| -------- | -------- | | ------- | ---------------- |
| boolean | 表示当前目录项是否是块特殊设备。 | | boolean | 表示当前目录项是否是块特殊设备。 |
- 示例: - 示例:
...@@ -3027,7 +3027,7 @@ isCharacterDevice(): boolean ...@@ -3027,7 +3027,7 @@ isCharacterDevice(): boolean
- 返回值: - 返回值:
| 类型 | 说明 | | 类型 | 说明 |
| -------- | -------- | | ------- | ----------------- |
| boolean | 表示当前目录项是否是字符特殊设备。 | | boolean | 表示当前目录项是否是字符特殊设备。 |
- 示例: - 示例:
...@@ -3047,7 +3047,7 @@ isDirectory(): boolean ...@@ -3047,7 +3047,7 @@ isDirectory(): boolean
- 返回值: - 返回值:
| 类型 | 说明 | | 类型 | 说明 |
| -------- | -------- | | ------- | ------------- |
| boolean | 表示当前目录项是否是目录。 | | boolean | 表示当前目录项是否是目录。 |
- 示例: - 示例:
...@@ -3067,7 +3067,7 @@ isFIFO(): boolean ...@@ -3067,7 +3067,7 @@ isFIFO(): boolean
- 返回值: - 返回值:
| 类型 | 说明 | | 类型 | 说明 |
| -------- | -------- | | ------- | --------------- |
| boolean | 表示当前目录项是否是FIFO。 | | boolean | 表示当前目录项是否是FIFO。 |
- 示例: - 示例:
...@@ -3087,7 +3087,7 @@ isFile(): boolean ...@@ -3087,7 +3087,7 @@ isFile(): boolean
- 返回值: - 返回值:
| 类型 | 说明 | | 类型 | 说明 |
| -------- | -------- | | ------- | --------------- |
| boolean | 表示当前目录项是否是普通文件。 | | boolean | 表示当前目录项是否是普通文件。 |
- 示例: - 示例:
...@@ -3107,7 +3107,7 @@ isSocket(): boolean ...@@ -3107,7 +3107,7 @@ isSocket(): boolean
- 返回值: - 返回值:
| 类型 | 说明 | | 类型 | 说明 |
| -------- | -------- | | ------- | -------------- |
| boolean | 表示当前目录项是否是套接字。 | | boolean | 表示当前目录项是否是套接字。 |
- 示例: - 示例:
...@@ -3127,7 +3127,7 @@ isSymbolicLink(): boolean ...@@ -3127,7 +3127,7 @@ isSymbolicLink(): boolean
- 返回值: - 返回值:
| 类型 | 说明 | | 类型 | 说明 |
| -------- | -------- | | ------- | --------------- |
| boolean | 表示当前目录项是否是符号链接。 | | boolean | 表示当前目录项是否是符号链接。 |
- 示例: - 示例:
......
...@@ -21,19 +21,19 @@ getDisplayLanguage(language: string, locale: string, sentenceCase?: boolean): st ...@@ -21,19 +21,19 @@ getDisplayLanguage(language: string, locale: string, sentenceCase?: boolean): st
**系统能力**:SystemCapability.Global.I18n **系统能力**:SystemCapability.Global.I18n
- 参数: **参数:**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | | ------------ | ------- | ---- | ---------------- |
| language | string | 是 | 指定语言。 | | language | string | 是 | 指定语言。 |
| locale | string | 是 | 显示指定语言的区域ID。 | | locale | string | 是 | 显示指定语言的区域ID。 |
| sentenceCase | boolean | 否 | 本地化显示文本是否要首字母大写。 | | sentenceCase | boolean | 否 | 本地化显示文本是否要首字母大写。 |
- 返回值: **返回值:**
| 类型 | 说明 | | 类型 | 说明 |
| -------- | -------- | | ------ | ------------- |
| string | 指定语言的本地化显示文本。 | | string | 指定语言的本地化显示文本。 |
- 示例: **示例:**
``` ```
i18n.getDisplayLanguage("zh", "en-GB", true); i18n.getDisplayLanguage("zh", "en-GB", true);
i18n.getDisplayLanguage("zh", "en-GB"); i18n.getDisplayLanguage("zh", "en-GB");
...@@ -48,19 +48,19 @@ getDisplayCountry(country: string, locale: string, sentenceCase?: boolean): stri ...@@ -48,19 +48,19 @@ getDisplayCountry(country: string, locale: string, sentenceCase?: boolean): stri
**系统能力**:SystemCapability.Global.I18n **系统能力**:SystemCapability.Global.I18n
- 参数: **参数:**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | | ------------ | ------- | ---- | ---------------- |
| country | string | 是 | 指定国家。 | | country | string | 是 | 指定国家。 |
| locale | string | 是 | 显示指定国家的区域ID。 | | locale | string | 是 | 显示指定国家的区域ID。 |
| sentenceCase | boolean | 否 | 本地化显示文本是否要首字母大写。 | | sentenceCase | boolean | 否 | 本地化显示文本是否要首字母大写。 |
- 返回值: **返回值:**
| 类型 | 说明 | | 类型 | 说明 |
| -------- | -------- | | ------ | ------------- |
| string | 指定国家的本地化显示文本。 | | string | 指定国家的本地化显示文本。 |
- 示例: **示例:**
``` ```
i18n.getDisplayCountry("zh-CN", "en-GB", true); i18n.getDisplayCountry("zh-CN", "en-GB", true);
i18n.getDisplayCountry("zh-CN", "en-GB"); i18n.getDisplayCountry("zh-CN", "en-GB");
...@@ -75,17 +75,17 @@ isRTL(locale: string): boolean ...@@ -75,17 +75,17 @@ isRTL(locale: string): boolean
**系统能力**:SystemCapability.Global.I18n **系统能力**: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("zh-CN");// 中文不是RTL语言,返回false
i18n.isRTL("ar-EG");// 阿语是RTL语言,返回true i18n.isRTL("ar-EG");// 阿语是RTL语言,返回true
...@@ -100,12 +100,12 @@ getSystemLanguage(): string ...@@ -100,12 +100,12 @@ getSystemLanguage(): string
**系统能力**:SystemCapability.Global.I18n **系统能力**:SystemCapability.Global.I18n
- 返回值: **返回值:**
| 类型 | 说明 | | 类型 | 说明 |
| -------- | -------- | | ------ | ------- |
| string | 系统语言ID。 | | string | 系统语言ID。 |
- 示例: **示例:**
``` ```
i18n.getSystemLanguage(); i18n.getSystemLanguage();
``` ```
...@@ -119,17 +119,17 @@ setSystemLanguage(language: string): boolean ...@@ -119,17 +119,17 @@ setSystemLanguage(language: string): boolean
**系统能力**:SystemCapability.Global.I18n **系统能力**:SystemCapability.Global.I18n
- 参数: **参数:**
| 参数名 | 类型 | 说明 | | 参数名 | 类型 | 说明 |
| -------- | -------- | -------- | | -------- | ------ | ----- |
| language | string | 语言ID。 | | language | string | 语言ID。 |
- 返回值: **返回值:**
| 类型 | 说明 | | 类型 | 说明 |
| -------- | -------- | | ------- | ------------------------------------- |
| boolean | 返回true,表示系统语言设置成功;返回false,表示系统语言设置失败。 | | boolean | 返回true,表示系统语言设置成功;返回false,表示系统语言设置失败。 |
- 示例: **示例:**
``` ```
i18n.setSystemLanguage('zh'); i18n.setSystemLanguage('zh');
``` ```
...@@ -137,18 +137,18 @@ setSystemLanguage(language: string): boolean ...@@ -137,18 +137,18 @@ setSystemLanguage(language: string): boolean
## i18n.getSystemLanguages ## i18n.getSystemLanguages
getSystemLanguages(): Array<string> getSystemLanguages(): Array&lt;string&gt;
获取系统支持的语言列表。 获取系统支持的语言列表。
**系统能力**:SystemCapability.Global.I18n **系统能力**:SystemCapability.Global.I18n
- 返回值: **返回值:**
| 类型 | 说明 | | 类型 | 说明 |
| -------- | -------- | | ------------------- | ------------ |
| Array<string> | 系统支持的语言ID列表。 | | Array&lt;string&gt; | 系统支持的语言ID列表。 |
- 示例: **示例:**
``` ```
i18n.getSystemLanguages(); i18n.getSystemLanguages();
``` ```
...@@ -156,23 +156,23 @@ getSystemLanguages(): Array<string> ...@@ -156,23 +156,23 @@ getSystemLanguages(): Array<string>
## i18n.getSystemCountries ## i18n.getSystemCountries
getSystemCountries(language: string): Array<string> getSystemCountries(language: string): Array&lt;string&gt;
获取针对输入语言系统支持的区域列表。 获取针对输入语言系统支持的区域列表。
**系统能力**:SystemCapability.Global.I18n **系统能力**:SystemCapability.Global.I18n
- 参数: **参数:**
| 参数名 | 类型 | 说明 | | 参数名 | 类型 | 说明 |
| -------- | -------- | -------- | | -------- | ------ | ----- |
| language | string | 语言ID。 | | language | string | 语言ID。 |
- 返回值: **返回值:**
| 类型 | 说明 | | 类型 | 说明 |
| -------- | -------- | | ------------------- | ------------ |
| Array<string> | 系统支持的区域ID列表。 | | Array&lt;string&gt; | 系统支持的区域ID列表。 |
- 示例: **示例:**
``` ```
i18n.getSystemCountries('zh'); i18n.getSystemCountries('zh');
``` ```
...@@ -186,12 +186,12 @@ getSystemRegion(): string ...@@ -186,12 +186,12 @@ getSystemRegion(): string
**系统能力**:SystemCapability.Global.I18n **系统能力**:SystemCapability.Global.I18n
- 返回值: **返回值:**
| 类型 | 说明 | | 类型 | 说明 |
| -------- | -------- | | ------ | ------- |
| string | 系统地区ID。 | | string | 系统地区ID。 |
- 示例: **示例:**
``` ```
i18n.getSystemRegion(); i18n.getSystemRegion();
``` ```
...@@ -205,17 +205,17 @@ setSystemRegion(region: string): boolean ...@@ -205,17 +205,17 @@ setSystemRegion(region: string): boolean
**系统能力**:SystemCapability.Global.I18n **系统能力**:SystemCapability.Global.I18n
- 参数: **参数:**
| 参数名 | 类型 | 说明 | | 参数名 | 类型 | 说明 |
| -------- | -------- | -------- | | ------ | ------ | ----- |
| region | string | 地区ID。 | | region | string | 地区ID。 |
- 返回值: **返回值:**
| 类型 | 说明 | | 类型 | 说明 |
| -------- | -------- | | ------- | ------------------------------------- |
| boolean | 返回true,表示系统区域设置成功;返回false,表示系统区域设置失败。 | | boolean | 返回true,表示系统区域设置成功;返回false,表示系统区域设置失败。 |
- 示例: **示例:**
``` ```
i18n.setSystemRegion(); i18n.setSystemRegion();
``` ```
...@@ -229,12 +229,12 @@ getSystemLocale(): string ...@@ -229,12 +229,12 @@ getSystemLocale(): string
**系统能力**:SystemCapability.Global.I18n **系统能力**:SystemCapability.Global.I18n
- 返回值: **返回值:**
| 类型 | 说明 | | 类型 | 说明 |
| -------- | -------- | | ------ | ------- |
| string | 系统区域ID。 | | string | 系统区域ID。 |
- 示例: **示例:**
``` ```
i18n.getSystemLocale(); i18n.getSystemLocale();
``` ```
...@@ -248,17 +248,17 @@ setSystemLocale(locale: string): boolean ...@@ -248,17 +248,17 @@ setSystemLocale(locale: string): boolean
**系统能力**:SystemCapability.Global.I18n **系统能力**: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'); i18n.setSystemLocale('zh-CN');
``` ```
...@@ -272,18 +272,18 @@ isSuggested(language: string, region?: string): boolean ...@@ -272,18 +272,18 @@ isSuggested(language: string, region?: string): boolean
**系统能力**:SystemCapability.Global.I18n **系统能力**:SystemCapability.Global.I18n
- 参数: **参数:**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | | -------- | ------ | ---- | ------------- |
| language | string | 是 | 合法的语言ID,例如zh。 | | language | string | 是 | 合法的语言ID,例如zh。 |
| region | string | 否 | 合法的地区ID,例如CN | | region | string | 否 | 合法的地区ID,例如CN |
- 返回值: **返回值:**
| 类型 | 说明 | | 类型 | 说明 |
| -------- | -------- | | ------- | ---------------------------------------- |
| boolean | 返回true,表示当前语言和地区匹配;返回false,表示当前语言和地区不匹配。 | | boolean | 返回true,表示当前语言和地区匹配;返回false,表示当前语言和地区不匹配。 |
- 示例: **示例:**
``` ```
i18n.isSuggested('zh', 'CN'); i18n.isSuggested('zh', 'CN');
``` ```
...@@ -297,18 +297,18 @@ getCalendar(locale: string, type? : string): Calendar ...@@ -297,18 +297,18 @@ getCalendar(locale: string, type? : string): Calendar
**系统能力**:SystemCapability.Global.I18n **系统能力**:SystemCapability.Global.I18n
- 参数: **参数:**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | | ------ | ------ | ---- | ---------------------------------------- |
| locale | string | 是 | 合法的locale值,例如zh-Hans-CN。 | | locale | string | 是 | 合法的locale值,例如zh-Hans-CN。 |
| type | string | 否 | 合法的日历类型,目前合法的类型有buddhist,&nbsp;chinese,&nbsp;coptic,&nbsp;ethiopic,&nbsp;hebrew,&nbsp;gregory,&nbsp;indian,&nbsp;islamic_civil,&nbsp;islamic_tbla,&nbsp;islamic_umalqura,&nbsp;japanese,&nbsp;persian。当type没有给出时,采用区域默认的日历类型。 | | type | string | 否 | 合法的日历类型,目前合法的类型有buddhist,&nbsp;chinese,&nbsp;coptic,&nbsp;ethiopic,&nbsp;hebrew,&nbsp;gregory,&nbsp;indian,&nbsp;islamic_civil,&nbsp;islamic_tbla,&nbsp;islamic_umalqura,&nbsp;japanese,&nbsp;persian。当type没有给出时,采用区域默认的日历类型。 |
- 返回值: **返回值:**
| 类型 | 说明 | | 类型 | 说明 |
| -------- | -------- | | ---------------------- | ----- |
| [Calendar](#calendar8) | 日历对象。 | | [Calendar](#calendar8) | 日历对象。 |
- 示例: **示例:**
``` ```
i18n.getCalendar("zh-Hans", "gregory"); i18n.getCalendar("zh-Hans", "gregory");
``` ```
...@@ -325,12 +325,12 @@ setTime(date: Date): void ...@@ -325,12 +325,12 @@ setTime(date: Date): void
**系统能力**:SystemCapability.Global.I18n **系统能力**:SystemCapability.Global.I18n
- 参数: **参数:**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | | ---- | ---- | ---- | ----------------- |
| date | Date | 是 | 将要设置的日历对象的内部时间日期。 | | date | Date | 是 | 将要设置的日历对象的内部时间日期。 |
- 示例: **示例:**
``` ```
var calendar = I18n.getCalendar("en-US", "gregory"); var calendar = I18n.getCalendar("en-US", "gregory");
var date = new Date(2021, 10, 7, 8, 0, 0, 0); var date = new Date(2021, 10, 7, 8, 0, 0, 0);
...@@ -346,12 +346,12 @@ setTime(time: number): void ...@@ -346,12 +346,12 @@ setTime(time: number): void
**系统能力**:SystemCapability.Global.I18n **系统能力**:SystemCapability.Global.I18n
- 参数: **参数:**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | | ---- | ------ | ---- | ---------------------------------------- |
| time | number | 是 | time为从1970.1.1&nbsp;00:00:00&nbsp;GMT逝去的毫秒数。 | | time | number | 是 | time为从1970.1.1&nbsp;00:00:00&nbsp;GMT逝去的毫秒数。 |
- 示例: **示例:**
``` ```
var calendar = I18n.getCalendar("en-US", "gregory"); var calendar = I18n.getCalendar("en-US", "gregory");
calendar.setTime(10540800000); calendar.setTime(10540800000);
...@@ -366,17 +366,17 @@ set(year: number, month: number, date:number, hour?: number, minute?: number, se ...@@ -366,17 +366,17 @@ set(year: number, month: number, date:number, hour?: number, minute?: number, se
**系统能力**:SystemCapability.Global.I18n **系统能力**:SystemCapability.Global.I18n
- 参数: **参数:**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | | ------ | ------ | ---- | ------ |
| year | number | 是 | 设置的年。 | | year | number | 是 | 设置的年。 |
| month | number | 是 | 设置的月。 | | month | number | 是 | 设置的月。 |
| date | number | 是 | 设置的日。 | | date | number | 是 | 设置的日。 |
| hour | number | 否 | 设置的小时。 | | hour | number | 否 | 设置的小时。 |
| minute | number | 否 | 设置的分钟。 | | minute | number | 否 | 设置的分钟。 |
| second | number | 否 | 设置的秒。 | | second | number | 否 | 设置的秒。 |
- 示例: **示例:**
``` ```
var calendar = i18n.getCalendar("zh-Hans"); var calendar = i18n.getCalendar("zh-Hans");
calendar.setTime(2021, 10, 1, 8, 0, 0); // set time to 2021.10.1 08:00:00 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 ...@@ -391,12 +391,12 @@ setTimeZone(timezone: string): void
**系统能力**:SystemCapability.Global.I18n **系统能力**:SystemCapability.Global.I18n
- 参数: **参数:**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | | -------- | ------ | ---- | ------------------------- |
| timezone | string | 是 | 设置的时区id,如“Asia/Shanghai”。 | | timezone | string | 是 | 设置的时区id,如“Asia/Shanghai”。 |
- 示例: **示例:**
``` ```
var calendar = i18n.getCalendar("zh-Hans"); var calendar = i18n.getCalendar("zh-Hans");
calendar.setTimeZone("Asia/Shanghai"); calendar.setTimeZone("Asia/Shanghai");
...@@ -411,12 +411,12 @@ getTimeZone(): string ...@@ -411,12 +411,12 @@ getTimeZone(): string
**系统能力**:SystemCapability.Global.I18n **系统能力**:SystemCapability.Global.I18n
- 返回值: **返回值:**
| 类型 | 说明 | | 类型 | 说明 |
| -------- | -------- | | ------ | ---------- |
| string | 日历对象的时区id。 | | string | 日历对象的时区id。 |
- 示例: **示例:**
``` ```
var calendar = i18n.getCalendar("zh-Hans"); var calendar = i18n.getCalendar("zh-Hans");
calendar.setTimeZone("Asia/Shanghai"); calendar.setTimeZone("Asia/Shanghai");
...@@ -432,12 +432,12 @@ getFirstDayOfWeek(): number ...@@ -432,12 +432,12 @@ getFirstDayOfWeek(): number
**系统能力**:SystemCapability.Global.I18n **系统能力**:SystemCapability.Global.I18n
- 返回值: **返回值:**
| 类型 | 说明 | | 类型 | 说明 |
| -------- | -------- | | ------ | --------------------- |
| number | 获取一周的起始日,1代表周日,7代表周六。 | | number | 获取一周的起始日,1代表周日,7代表周六。 |
- 示例: **示例:**
``` ```
var calendar = I18n.getCalendar("en-US", "gregory"); var calendar = I18n.getCalendar("en-US", "gregory");
calendar.getFirstDayOfWeek(); calendar.getFirstDayOfWeek();
...@@ -452,12 +452,12 @@ setFirstDayOfWeek(value: number): void ...@@ -452,12 +452,12 @@ setFirstDayOfWeek(value: number): void
**系统能力**:SystemCapability.Global.I18n **系统能力**:SystemCapability.Global.I18n
- 参数: **参数:**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | | ----- | ------ | ---- | --------------------- |
| value | number | 否 | 设置一周的起始日,1代表周日,7代表周六。 | | value | number | 否 | 设置一周的起始日,1代表周日,7代表周六。 |
- 示例: **示例:**
``` ```
var calendar = i18n.getCalendar("zh-Hans"); var calendar = i18n.getCalendar("zh-Hans");
calendar.setFirstDayOfWeek(0); calendar.setFirstDayOfWeek(0);
...@@ -472,12 +472,12 @@ getMinimalDaysInFirstWeek(): number ...@@ -472,12 +472,12 @@ getMinimalDaysInFirstWeek(): number
**系统能力**:SystemCapability.Global.I18n **系统能力**:SystemCapability.Global.I18n
- 返回值: **返回值:**
| 类型 | 说明 | | 类型 | 说明 |
| -------- | -------- | | ------ | ------------ |
| number | 一年中第一周的最小天数。 | | number | 一年中第一周的最小天数。 |
- 示例: **示例:**
``` ```
var calendar = i18n.getCalendar("zh-Hans"); var calendar = i18n.getCalendar("zh-Hans");
calendar.getMinimalDaysInFirstWeek(); calendar.getMinimalDaysInFirstWeek();
...@@ -492,12 +492,12 @@ setMinimalDaysInFirstWeek(value: number): void ...@@ -492,12 +492,12 @@ setMinimalDaysInFirstWeek(value: number): void
**系统能力**:SystemCapability.Global.I18n **系统能力**:SystemCapability.Global.I18n
- 参数: **参数:**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | | ----- | ------ | ---- | ------------ |
| value | number | 否 | 一年中第一周的最小天数。 | | value | number | 否 | 一年中第一周的最小天数。 |
- 示例: **示例:**
``` ```
var calendar = i18n.getCalendar("zh-Hans"); var calendar = i18n.getCalendar("zh-Hans");
calendar.setMinimalDaysInFirstWeek(3); calendar.setMinimalDaysInFirstWeek(3);
...@@ -512,17 +512,17 @@ get(field: string): number ...@@ -512,17 +512,17 @@ get(field: string): number
**系统能力**:SystemCapability.Global.I18n **系统能力**:SystemCapability.Global.I18n
- 参数: **参数:**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | | ----- | ------ | ---- | ---------------------------------------- |
| field | string | 是 | 通过field来获取日历对象相应的值。目前支持的field值有&nbsp;era,&nbsp;year,&nbsp;month,&nbsp;week_of_year,&nbsp;week_of_month,&nbsp;date,&nbsp;day_of_year,&nbsp;day_of_week,&nbsp;day_of_week_in_month,&nbsp;hour,&nbsp;hour_of_day,&nbsp;minute,&nbsp;second,&nbsp;millisecond,&nbsp;zone_offset,&nbsp;dst_offset,&nbsp;year_woy,&nbsp;dow_local,&nbsp;extended_year,&nbsp;julian_day,&nbsp;milliseconds_in_day,&nbsp;is_leap_month。 | | field | string | 是 | 通过field来获取日历对象相应的值。目前支持的field值有&nbsp;era,&nbsp;year,&nbsp;month,&nbsp;week_of_year,&nbsp;week_of_month,&nbsp;date,&nbsp;day_of_year,&nbsp;day_of_week,&nbsp;day_of_week_in_month,&nbsp;hour,&nbsp;hour_of_day,&nbsp;minute,&nbsp;second,&nbsp;millisecond,&nbsp;zone_offset,&nbsp;dst_offset,&nbsp;year_woy,&nbsp;dow_local,&nbsp;extended_year,&nbsp;julian_day,&nbsp;milliseconds_in_day,&nbsp;is_leap_month。 |
- 返回值: **返回值:**
| 类型 | 说明 | | 类型 | 说明 |
| -------- | -------- | | ------ | ---------------------------------------- |
| number | 与field相关联的值,如当前Calendar对象的内部日期的年份为1990,get("year")返回1990。 | | number | 与field相关联的值,如当前Calendar对象的内部日期的年份为1990,get("year")返回1990。 |
- 示例: **示例:**
``` ```
var calendar = i18n.getCalendar("zh-Hans"); var calendar = i18n.getCalendar("zh-Hans");
calendar.setTime(2021, 10, 1, 8, 0, 0); // set time to 2021.10.1 08:00:00 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 ...@@ -538,17 +538,17 @@ getDisplayName(locale: string): string
**系统能力**:SystemCapability.Global.I18n **系统能力**:SystemCapability.Global.I18n
- 参数: **参数:**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | | ------ | ------ | ---- | ---------------------------------------- |
| locale | string | 是 | locale指定获取哪个区域下该calendar的名字,如buddhist在en-US上显示的名称为“Buddhist&nbsp;Calendar”。 | | locale | string | 是 | locale指定获取哪个区域下该calendar的名字,如buddhist在en-US上显示的名称为“Buddhist&nbsp;Calendar”。 |
- 返回值: **返回值:**
| 类型 | 说明 | | 类型 | 说明 |
| -------- | -------- | | ------ | ------------------- |
| string | 日历在locale所指示的区域的名字。 | | string | 日历在locale所指示的区域的名字。 |
- 示例: **示例:**
``` ```
var calendar = i18n.getCalendar("en-US", "buddhist"); var calendar = i18n.getCalendar("en-US", "buddhist");
calendar.getDisplayName("zh"); // 佛历 calendar.getDisplayName("zh"); // 佛历
...@@ -563,17 +563,17 @@ isWeekend(date?: Date): boolean ...@@ -563,17 +563,17 @@ isWeekend(date?: Date): boolean
**系统能力**:SystemCapability.Global.I18n **系统能力**:SystemCapability.Global.I18n
- 参数: **参数:**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | | ---- | ---- | ---- | ---------------------------------------- |
| date | Date | 否 | 判断日期在日历中是否是周末。如果date没有给出,判断calendar当前日期是否为周末。 | | date | Date | 否 | 判断日期在日历中是否是周末。如果date没有给出,判断calendar当前日期是否为周末。 |
- 返回值: **返回值:**
| 类型 | 说明 | | 类型 | 说明 |
| -------- | -------- | | ------- | ----------------------------------- |
| boolean | 当所判断的日期为周末时,返回&nbsp;true,否则返回false。 | | boolean | 当所判断的日期为周末时,返回&nbsp;true,否则返回false。 |
- 示例: **示例:**
``` ```
var calendar = i18n.getCalendar("zh-Hans"); var calendar = i18n.getCalendar("zh-Hans");
calendar.setTime(2021, 11, 11, 8, 0, 0); // set time to 2021.11.11 08:00:00 calendar.setTime(2021, 11, 11, 8, 0, 0); // set time to 2021.11.11 08:00:00
...@@ -596,11 +596,11 @@ constructor(country: string, options?: PhoneNumberFormatOptions) ...@@ -596,11 +596,11 @@ constructor(country: string, options?: PhoneNumberFormatOptions)
参数: 参数:
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | | ------- | ---------------------------------------- | ---- | ---------------- |
| country | string | 是 | 表示电话号码所属国家或地区代码。 | | country | string | 是 | 表示电话号码所属国家或地区代码。 |
| options | [PhoneNumberFormatOptions](#phonenumberformatoptions8) | 否 | 电话号码格式化对象的相关选项。 | | options | [PhoneNumberFormatOptions](#phonenumberformatoptions8) | 否 | 电话号码格式化对象的相关选项。 |
- 示例: **示例:**
``` ```
var phoneNumberFormat= new i18n.PhoneNumberFormat("CN", {"type": "E164"}); var phoneNumberFormat= new i18n.PhoneNumberFormat("CN", {"type": "E164"});
``` ```
...@@ -614,17 +614,17 @@ isValidNumber(number: string): boolean ...@@ -614,17 +614,17 @@ isValidNumber(number: string): boolean
**系统能力**:SystemCapability.Global.I18n **系统能力**:SystemCapability.Global.I18n
- 参数: **参数:**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | | ------ | ------ | ---- | --------- |
| number | string | 是 | 待判断的电话号码。 | | number | string | 是 | 待判断的电话号码。 |
- 返回值: **返回值:**
| 类型 | 说明 | | 类型 | 说明 |
| -------- | -------- | | ------- | ------------------------------------- |
| boolean | 返回true表示电话号码的格式正确,返回false表示电话号码的格式错误。 | | boolean | 返回true表示电话号码的格式正确,返回false表示电话号码的格式错误。 |
- 示例: **示例:**
``` ```
var phonenumberfmt = new i18n.PhoneNumberFormat("CN"); var phonenumberfmt = new i18n.PhoneNumberFormat("CN");
phonenumberfmt.isValidNumber("15812312312"); phonenumberfmt.isValidNumber("15812312312");
...@@ -639,17 +639,17 @@ format(number: string): string ...@@ -639,17 +639,17 @@ format(number: string): string
**系统能力**:SystemCapability.Global.I18n **系统能力**:SystemCapability.Global.I18n
- 参数: **参数:**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | | ------ | ------ | ---- | ---------- |
| number | string | 是 | 待格式化的电话号码。 | | number | string | 是 | 待格式化的电话号码。 |
- 返回值: **返回值:**
| 类型 | 说明 | | 类型 | 说明 |
| -------- | -------- | | ------ | ---------- |
| string | 格式化后的电话号码。 | | string | 格式化后的电话号码。 |
- 示例: **示例:**
``` ```
var phonenumberfmt = new i18n.PhoneNumberFormat("CN"); var phonenumberfmt = new i18n.PhoneNumberFormat("CN");
phonenumberfmt.format("15812312312"); phonenumberfmt.format("15812312312");
...@@ -663,7 +663,7 @@ format(number: string): string ...@@ -663,7 +663,7 @@ format(number: string): string
**系统能力**:以下各项对应的系统能力均为SystemCapability.Global.I18n **系统能力**:以下各项对应的系统能力均为SystemCapability.Global.I18n
| 名称 | 参数类型 | 可读 | 可写 | 说明 | | 名称 | 参数类型 | 可读 | 可写 | 说明 |
| -------- | -------- | -------- | -------- | -------- | | ---- | ------ | ---- | ---- | ---------------------------------------- |
| type | string | 是 | 是 | 表示对电话号码格式化的类型,取值范围:"E164",&nbsp;"INTERNATIONAL",&nbsp;"NATIONAL",&nbsp;"RFC3966"。 | | type | string | 是 | 是 | 表示对电话号码格式化的类型,取值范围:"E164",&nbsp;"INTERNATIONAL",&nbsp;"NATIONAL",&nbsp;"RFC3966"。 |
...@@ -674,7 +674,7 @@ format(number: string): string ...@@ -674,7 +674,7 @@ format(number: string): string
**系统能力**:以下各项对应的系统能力均为SystemCapability.Global.I18n **系统能力**:以下各项对应的系统能力均为SystemCapability.Global.I18n
| 名称 | 参数类型 | 可读 | 可写 | 说明 | | 名称 | 参数类型 | 可读 | 可写 | 说明 |
| -------- | -------- | -------- | -------- | -------- | | ------------- | ------ | ---- | ---- | ---------------------------------------- |
| unit | string | 是 | 是 | 单位的名称,如:"meter",&nbsp;"inch",&nbsp;"cup"等。 | | unit | string | 是 | 是 | 单位的名称,如:"meter",&nbsp;"inch",&nbsp;"cup"等。 |
| measureSystem | string | 是 | 是 | 单位的度量体系,取值包括:"SI",&nbsp;"US",&nbsp;"UK"。 | | measureSystem | string | 是 | 是 | 单位的度量体系,取值包括:"SI",&nbsp;"US",&nbsp;"UK"。 |
...@@ -690,21 +690,21 @@ unitConvert(fromUnit: UnitInfo, toUnit: UnitInfo, value: number, locale: string, ...@@ -690,21 +690,21 @@ unitConvert(fromUnit: UnitInfo, toUnit: UnitInfo, value: number, locale: string,
**系统能力**:SystemCapability.Global.I18n **系统能力**:SystemCapability.Global.I18n
- 参数: **参数:**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | | -------- | ---------------------- | ---- | ---------------------------------------- |
| fromUnit | [UnitInfo](#unitinfo8) | 是 | 要被转换的单位。 | | fromUnit | [UnitInfo](#unitinfo8) | 是 | 要被转换的单位。 |
| toUnit | [UnitInfo](#unitinfo8) | 是 | 要转换为的单位。 | | toUnit | [UnitInfo](#unitinfo8) | 是 | 要转换为的单位。 |
| value | number | 是 | 要被转换的单位的数量值。 | | value | number | 是 | 要被转换的单位的数量值。 |
| locale | string | 是 | 格式化时使用的区域参数,如:zh-Hans-CN。 | | locale | string | 是 | 格式化时使用的区域参数,如:zh-Hans-CN。 |
| style | string | 否 | 格式化使用的风格,取值包括:"long",&nbsp;"short",&nbsp;"medium"。 | | style | string | 否 | 格式化使用的风格,取值包括:"long",&nbsp;"short",&nbsp;"medium"。 |
- 返回值: **返回值:**
| 类型 | 说明 | | 类型 | 说明 |
| -------- | -------- | | ------ | ----------------------- |
| string | 按照toUnit的单位格式化后,得到的字符串。 | | string | 按照toUnit的单位格式化后,得到的字符串。 |
- 示例: **示例:**
``` ```
I18n.Util.unitConvert({unit: "cup", measureSystem: "US"}, {unit: "liter", measureSystem: "SI"}, 1000, "en-US", "long"); I18n.Util.unitConvert({unit: "cup", measureSystem: "US"}, {unit: "liter", measureSystem: "SI"}, 1000, "en-US", "long");
``` ```
...@@ -718,17 +718,17 @@ getInstance(locale?:string): IndexUtil ...@@ -718,17 +718,17 @@ getInstance(locale?:string): IndexUtil
**系统能力**:SystemCapability.Global.I18n **系统能力**:SystemCapability.Global.I18n
- 参数: **参数:**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | | ------ | ------ | ---- | ---------------------------- |
| locale | string | 否 | 包含区域设置信息的字符串,包括语言以及可选的脚本和区域。 | | locale | string | 否 | 包含区域设置信息的字符串,包括语言以及可选的脚本和区域。 |
- 返回值: **返回值:**
| 类型 | 说明 | | 类型 | 说明 |
| -------- | -------- | | ------------------------ | --------------------- |
| [IndexUtil](#indexutil8) | locale对应的IndexUtil对象。 | | [IndexUtil](#indexutil8) | locale对应的IndexUtil对象。 |
- 示例: **示例:**
``` ```
var indexUtil= i18n.IndexUtil.getInstance("zh-CN"); var indexUtil= i18n.IndexUtil.getInstance("zh-CN");
``` ```
...@@ -745,12 +745,12 @@ getIndexList(): Array&lt;string&gt; ...@@ -745,12 +745,12 @@ getIndexList(): Array&lt;string&gt;
**系统能力**:SystemCapability.Global.I18n **系统能力**:SystemCapability.Global.I18n
- 返回值: **返回值:**
| 类型 | 说明 | | 类型 | 说明 |
| -------- | -------- | | ------------------- | ------------------ |
| Array&lt;string&gt; | 返回当前locale对应的索引列表。 | | Array&lt;string&gt; | 返回当前locale对应的索引列表。 |
- 示例: **示例:**
``` ```
var indexUtil = i18n.getInstance("zh-CN"); var indexUtil = i18n.getInstance("zh-CN");
var indexList = indexUtil.getIndexList(); var indexList = indexUtil.getIndexList();
...@@ -765,12 +765,12 @@ addLocale(locale: string): void ...@@ -765,12 +765,12 @@ addLocale(locale: string): void
**系统能力**:SystemCapability.Global.I18n **系统能力**:SystemCapability.Global.I18n
- 参数: **参数:**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | | ------ | ------ | ---- | ---------------------------- |
| locale | string | 是 | 包含区域设置信息的字符串,包括语言以及可选的脚本和区域。 | | locale | string | 是 | 包含区域设置信息的字符串,包括语言以及可选的脚本和区域。 |
- 示例: **示例:**
``` ```
var indexUtil = i18n.getInstance("zh-CN"); var indexUtil = i18n.getInstance("zh-CN");
indexUtil.addLocale("en-US"); indexUtil.addLocale("en-US");
...@@ -785,17 +785,17 @@ getIndex(text: string): string ...@@ -785,17 +785,17 @@ getIndex(text: string): string
**系统能力**:SystemCapability.Global.I18n **系统能力**:SystemCapability.Global.I18n
- 参数: **参数:**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | | ---- | ------ | ---- | ------------ |
| text | string | 是 | 待计算索引值的输入文本。 | | text | string | 是 | 待计算索引值的输入文本。 |
- 返回值: **返回值:**
| 类型 | 说明 | | 类型 | 说明 |
| -------- | -------- | | ------ | ----------- |
| string | 输入文本对应的索引值。 | | string | 输入文本对应的索引值。 |
- 示例: **示例:**
``` ```
var indexUtil= i18n.getInstance("zh-CN"); var indexUtil= i18n.getInstance("zh-CN");
indexUtil.getIndex("hi"); // 返回h indexUtil.getIndex("hi"); // 返回h
...@@ -813,17 +813,17 @@ isDigit(char: string): boolean ...@@ -813,17 +813,17 @@ isDigit(char: string): boolean
**系统能力**:SystemCapability.Global.I18n **系统能力**:SystemCapability.Global.I18n
- 参数: **参数:**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | | ---- | ------ | ---- | ----- |
| char | string | 是 | 输入字符。 | | char | string | 是 | 输入字符。 |
- 返回值: **返回值:**
| 类型 | 说明 | | 类型 | 说明 |
| -------- | -------- | | ------- | ------------------------------------ |
| boolean | 返回true表示输入的字符是数字,返回false表示输入的字符不是数字。 | | boolean | 返回true表示输入的字符是数字,返回false表示输入的字符不是数字。 |
- 示例: **示例:**
``` ```
var isdigit = Character.isDigit("1"); // 返回true var isdigit = Character.isDigit("1"); // 返回true
``` ```
...@@ -837,17 +837,17 @@ isSpaceChar(char: string): boolean ...@@ -837,17 +837,17 @@ isSpaceChar(char: string): boolean
**系统能力**:SystemCapability.Global.I18n **系统能力**:SystemCapability.Global.I18n
- 参数: **参数:**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | | ---- | ------ | ---- | ----- |
| char | string | 是 | 输入字符。 | | char | string | 是 | 输入字符。 |
- 返回值: **返回值:**
| 类型 | 说明 | | 类型 | 说明 |
| -------- | -------- | | ------- | -------------------------------------- |
| boolean | 返回true表示输入的字符是空格符,返回false表示输入的字符不是空格符。 | | boolean | 返回true表示输入的字符是空格符,返回false表示输入的字符不是空格符。 |
- 示例: **示例:**
``` ```
var isspacechar = Character.isSpaceChar("a"); // 返回false var isspacechar = Character.isSpaceChar("a"); // 返回false
``` ```
...@@ -861,17 +861,17 @@ isWhitespace(char: string): boolean ...@@ -861,17 +861,17 @@ isWhitespace(char: string): boolean
**系统能力**:SystemCapability.Global.I18n **系统能力**:SystemCapability.Global.I18n
- 参数: **参数:**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | | ---- | ------ | ---- | ----- |
| char | string | 是 | 输入字符。 | | char | string | 是 | 输入字符。 |
- 返回值: **返回值:**
| 类型 | 说明 | | 类型 | 说明 |
| -------- | -------- | | ------- | -------------------------------------- |
| boolean | 返回true表示输入的字符是空白符,返回false表示输入的字符不是空白符。 | | boolean | 返回true表示输入的字符是空白符,返回false表示输入的字符不是空白符。 |
- 示例: **示例:**
``` ```
var iswhitespace = Character.isWhitespace("a"); // 返回false var iswhitespace = Character.isWhitespace("a"); // 返回false
``` ```
...@@ -885,17 +885,17 @@ isRTL(char: string): boolean ...@@ -885,17 +885,17 @@ isRTL(char: string): boolean
**系统能力**:SystemCapability.Global.I18n **系统能力**:SystemCapability.Global.I18n
- 参数: **参数:**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | | ---- | ------ | ---- | ----- |
| char | string | 是 | 输入字符。 | | char | string | 是 | 输入字符。 |
- 返回值: **返回值:**
| 类型 | 说明 | | 类型 | 说明 |
| -------- | -------- | | ------- | ---------------------------------------- |
| boolean | 返回true表示输入的字符是从右到左语言的字符,返回false表示输入的字符不是从右到左语言的字符。 | | boolean | 返回true表示输入的字符是从右到左语言的字符,返回false表示输入的字符不是从右到左语言的字符。 |
- 示例: **示例:**
``` ```
var isrtl = Character.isRTL("a"); // 返回false var isrtl = Character.isRTL("a"); // 返回false
``` ```
...@@ -909,17 +909,17 @@ isIdeograph(char: string): boolean ...@@ -909,17 +909,17 @@ isIdeograph(char: string): boolean
**系统能力**:SystemCapability.Global.I18n **系统能力**:SystemCapability.Global.I18n
- 参数: **参数:**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | | ---- | ------ | ---- | ----- |
| char | string | 是 | 输入字符。 | | char | string | 是 | 输入字符。 |
- 返回值: **返回值:**
| 类型 | 说明 | | 类型 | 说明 |
| -------- | -------- | | ------- | ---------------------------------------- |
| boolean | 返回true表示输入的字符是表意文字,返回false表示输入的字符不是表意文字。 | | boolean | 返回true表示输入的字符是表意文字,返回false表示输入的字符不是表意文字。 |
- 示例: **示例:**
``` ```
var isideograph = Character.isIdeograph("a"); // 返回false var isideograph = Character.isIdeograph("a"); // 返回false
``` ```
...@@ -933,17 +933,17 @@ isLetter(char: string): boolean ...@@ -933,17 +933,17 @@ isLetter(char: string): boolean
**系统能力**:SystemCapability.Global.I18n **系统能力**:SystemCapability.Global.I18n
- 参数: **参数:**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | | ---- | ------ | ---- | ----- |
| char | string | 是 | 输入字符。 | | char | string | 是 | 输入字符。 |
- 返回值: **返回值:**
| 类型 | 说明 | | 类型 | 说明 |
| -------- | -------- | | ------- | ------------------------------------ |
| boolean | 返回true表示输入的字符是字母,返回false表示输入的字符不是字母。 | | boolean | 返回true表示输入的字符是字母,返回false表示输入的字符不是字母。 |
- 示例: **示例:**
``` ```
var isletter = Character.isLetter("a"); // 返回true var isletter = Character.isLetter("a"); // 返回true
``` ```
...@@ -957,17 +957,17 @@ isLowerCase(char: string): boolean ...@@ -957,17 +957,17 @@ isLowerCase(char: string): boolean
**系统能力**:SystemCapability.Global.I18n **系统能力**:SystemCapability.Global.I18n
- 参数: **参数:**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | | ---- | ------ | ---- | ----- |
| char | string | 是 | 输入字符。 | | char | string | 是 | 输入字符。 |
- 返回值: **返回值:**
| 类型 | 说明 | | 类型 | 说明 |
| -------- | -------- | | ------- | ---------------------------------------- |
| boolean | 返回true表示输入的字符是小写字母,返回false表示输入的字符不是小写字母。 | | boolean | 返回true表示输入的字符是小写字母,返回false表示输入的字符不是小写字母。 |
- 示例: **示例:**
``` ```
var islowercase = Character.isLowerCase("a"); // 返回true var islowercase = Character.isLowerCase("a"); // 返回true
``` ```
...@@ -981,17 +981,17 @@ isUpperCase(char: string): boolean ...@@ -981,17 +981,17 @@ isUpperCase(char: string): boolean
**系统能力**:SystemCapability.Global.I18n **系统能力**:SystemCapability.Global.I18n
- 参数: **参数:**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | | ---- | ------ | ---- | ----- |
| char | string | 是 | 输入字符。 | | char | string | 是 | 输入字符。 |
- 返回值: **返回值:**
| 类型 | 说明 | | 类型 | 说明 |
| -------- | -------- | | ------- | ---------------------------------------- |
| boolean | 返回true表示输入的字符是大写字母,返回false表示输入的字符不是大写字母。 | | boolean | 返回true表示输入的字符是大写字母,返回false表示输入的字符不是大写字母。 |
- 示例: **示例:**
``` ```
var isuppercase = Character.isUpperCase("a"); // 返回false var isuppercase = Character.isUpperCase("a"); // 返回false
``` ```
...@@ -1005,17 +1005,17 @@ getType(char: string): string ...@@ -1005,17 +1005,17 @@ getType(char: string): string
**系统能力**:SystemCapability.Global.I18n **系统能力**:SystemCapability.Global.I18n
- 参数: **参数:**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | | ---- | ------ | ---- | ----- |
| char | string | 是 | 输入字符。 | | char | string | 是 | 输入字符。 |
- 返回值: **返回值:**
| 类型 | 说明 | | 类型 | 说明 |
| -------- | -------- | | ------ | ----------- |
| string | 输入字符的一般类别值。 | | string | 输入字符的一般类别值。 |
- 示例: **示例:**
``` ```
var type = Character.getType("a"); var type = Character.getType("a");
``` ```
...@@ -1029,17 +1029,17 @@ getLineInstance(locale: string): BreakIterator ...@@ -1029,17 +1029,17 @@ getLineInstance(locale: string): BreakIterator
**系统能力**:SystemCapability.Global.I18n **系统能力**: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"); i18n.getLineInstance("en");
``` ```
...@@ -1056,12 +1056,12 @@ setLineBreakText(text: string): void ...@@ -1056,12 +1056,12 @@ setLineBreakText(text: string): void
**系统能力**:SystemCapability.Global.I18n **系统能力**:SystemCapability.Global.I18n
- 参数: **参数:**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | | ---- | ------ | ---- | ----------------------- |
| text | string | 是 | 指定BreakIterator进行断句的文本。 | | text | string | 是 | 指定BreakIterator进行断句的文本。 |
- 示例: **示例:**
``` ```
iterator = I18n.getLineInstance("en"); iterator = I18n.getLineInstance("en");
iterator.setLineBreakText("Apple is my favorite fruit."); iterator.setLineBreakText("Apple is my favorite fruit.");
...@@ -1076,12 +1076,12 @@ getLineBreakText(): string ...@@ -1076,12 +1076,12 @@ getLineBreakText(): string
**系统能力**:SystemCapability.Global.I18n **系统能力**:SystemCapability.Global.I18n
- 返回值: **返回值:**
| 类型 | 说明 | | 类型 | 说明 |
| -------- | -------- | | ------ | ---------------------- |
| string | BreakIterator对象正在处理的文本 | | string | BreakIterator对象正在处理的文本 |
- 示例: **示例:**
``` ```
iterator = I18n.getLineInstance("en"); iterator = I18n.getLineInstance("en");
iterator.setLineBreakText("Apple is my favorite fruit."); iterator.setLineBreakText("Apple is my favorite fruit.");
...@@ -1097,12 +1097,12 @@ current(): number ...@@ -1097,12 +1097,12 @@ current(): number
**系统能力**:SystemCapability.Global.I18n **系统能力**:SystemCapability.Global.I18n
- 返回值: **返回值:**
| 类型 | 说明 | | 类型 | 说明 |
| -------- | -------- | | ------ | --------------------------- |
| number | BreakIterator在当前所处理的文本中的位置。 | | number | BreakIterator在当前所处理的文本中的位置。 |
- 示例: **示例:**
``` ```
iterator = I18n.getLineInstance("en"); iterator = I18n.getLineInstance("en");
iterator.setLineBreakText("Apple is my favorite fruit."); iterator.setLineBreakText("Apple is my favorite fruit.");
...@@ -1118,12 +1118,12 @@ first(): number ...@@ -1118,12 +1118,12 @@ first(): number
**系统能力**:SystemCapability.Global.I18n **系统能力**:SystemCapability.Global.I18n
- 返回值: **返回值:**
| 类型 | 说明 | | 类型 | 说明 |
| -------- | -------- | | ------ | ----------------- |
| number | 被处理文本的第一个分割点的偏移量。 | | number | 被处理文本的第一个分割点的偏移量。 |
- 示例: **示例:**
``` ```
iterator = I18n.getLineInstance("en"); iterator = I18n.getLineInstance("en");
iterator.setLineBreakText("Apple is my favorite fruit."); iterator.setLineBreakText("Apple is my favorite fruit.");
...@@ -1139,12 +1139,12 @@ last(): number ...@@ -1139,12 +1139,12 @@ last(): number
**系统能力**:SystemCapability.Global.I18n **系统能力**:SystemCapability.Global.I18n
- 返回值: **返回值:**
| 类型 | 说明 | | 类型 | 说明 |
| -------- | -------- | | ------ | ------------------ |
| number | 被处理的文本的最后一个分割点的偏移量 | | number | 被处理的文本的最后一个分割点的偏移量 |
- 示例: **示例:**
``` ```
iterator = I18n.getLineInstance("en"); iterator = I18n.getLineInstance("en");
iterator.setLineBreakText("Apple is my favorite fruit."); iterator.setLineBreakText("Apple is my favorite fruit.");
...@@ -1160,17 +1160,17 @@ next(index?: number): number ...@@ -1160,17 +1160,17 @@ next(index?: number): number
**系统能力**:SystemCapability.Global.I18n **系统能力**: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 = I18n.getLineInstance("en");
iterator.setLineBreakText("Apple is my favorite fruit."); iterator.setLineBreakText("Apple is my favorite fruit.");
...@@ -1188,12 +1188,12 @@ previous(): number ...@@ -1188,12 +1188,12 @@ previous(): number
**系统能力**:SystemCapability.Global.I18n **系统能力**:SystemCapability.Global.I18n
- 返回值: **返回值:**
| 类型 | 说明 | | 类型 | 说明 |
| -------- | -------- | | ------ | ---------------------------------------- |
| number | 返回移动到前一个分割点后,当前[BreakIterator](#breakiterator8)在文本中的位置。若移动index个分割点后超出了所处理的文本的长度范围,返回-1。 | | number | 返回移动到前一个分割点后,当前[BreakIterator](#breakiterator8)在文本中的位置。若移动index个分割点后超出了所处理的文本的长度范围,返回-1。 |
- 示例: **示例:**
``` ```
iterator = I18n.getLineInstance("en"); iterator = I18n.getLineInstance("en");
iterator.setLineBreakText("Apple is my favorite fruit."); iterator.setLineBreakText("Apple is my favorite fruit.");
...@@ -1211,17 +1211,17 @@ following(offset: number): number ...@@ -1211,17 +1211,17 @@ following(offset: number): number
**系统能力**:SystemCapability.Global.I18n **系统能力**: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 = I18n.getLineInstance("en");
iterator.setLineBreakText("Apple is my favorite fruit."); iterator.setLineBreakText("Apple is my favorite fruit.");
...@@ -1239,17 +1239,17 @@ isBoundary(offset: number): boolean ...@@ -1239,17 +1239,17 @@ isBoundary(offset: number): boolean
**系统能力**:SystemCapability.Global.I18n **系统能力**:SystemCapability.Global.I18n
- 参数: **参数:**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | | ------ | ------ | ---- | ----------- |
| offset | number | 是 | 指定需要进行判断的位置 | | offset | number | 是 | 指定需要进行判断的位置 |
- 返回值: **返回值:**
| 类型 | 说明 | | 类型 | 说明 |
| -------- | -------- | | ------- | ------------------------------- |
| boolean | 如果是一个分割点返回true,&nbsp;否则返回false。 | | boolean | 如果是一个分割点返回true,&nbsp;否则返回false。 |
- 示例: **示例:**
``` ```
iterator = I18n.getLineInstance("en"); iterator = I18n.getLineInstance("en");
iterator.setLineBreakText("Apple is my favorite fruit."); iterator.setLineBreakText("Apple is my favorite fruit.");
...@@ -1266,12 +1266,12 @@ is24HourClock(): boolean ...@@ -1266,12 +1266,12 @@ is24HourClock(): boolean
**系统能力**:SystemCapability.Global.I18n **系统能力**:SystemCapability.Global.I18n
- 返回值: **返回值:**
| 类型 | 说明 | | 类型 | 说明 |
| -------- | -------- | | ------- | ---------------------------------------- |
| boolean | 返回true,表示系统24小时开关开启;返回false,表示系统24小时开关关闭。 | | boolean | 返回true,表示系统24小时开关开启;返回false,表示系统24小时开关关闭。 |
- 示例: **示例:**
``` ```
var is24HourClock = i18n.is24HourClock(); var is24HourClock = i18n.is24HourClock();
``` ```
...@@ -1285,17 +1285,17 @@ set24HourClock(option: boolean): boolean ...@@ -1285,17 +1285,17 @@ set24HourClock(option: boolean): boolean
**系统能力**:SystemCapability.Global.I18n **系统能力**:SystemCapability.Global.I18n
- 参数: **参数:**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | | ------ | ------- | ---- | ---------------------------------------- |
| option | boolean | 是 | option为true,表示开启系统24小时制开关;返回false,表示关闭系统24小时开关。 | | option | boolean | 是 | option为true,表示开启系统24小时制开关;返回false,表示关闭系统24小时开关。 |
- 返回值: **返回值:**
| 类型 | 说明 | | 类型 | 说明 |
| -------- | -------- | | ------- | ----------------------------- |
| boolean | 返回true,表示修改成功;返回false,表示修改失败。 | | boolean | 返回true,表示修改成功;返回false,表示修改失败。 |
- 示例: **示例:**
``` ```
// 将系统时间设置为24小时制 // 将系统时间设置为24小时制
var success = I18n.set24HourClock(true); var success = I18n.set24HourClock(true);
...@@ -1310,18 +1310,18 @@ addPreferredLanguage(language: string, index?: number): boolean ...@@ -1310,18 +1310,18 @@ addPreferredLanguage(language: string, index?: number): boolean
**系统能力**:SystemCapability.Global.I18n **系统能力**:SystemCapability.Global.I18n
- 参数: **参数:**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | | -------- | ------ | ---- | ---------- |
| language | string | 是 | 待添加的偏好语言。 | | language | string | 是 | 待添加的偏好语言。 |
| index | number | 否 | 偏好语言的添加位置。 | | index | number | 否 | 偏好语言的添加位置。 |
- 返回值: **返回值:**
| 类型 | 说明 | | 类型 | 说明 |
| -------- | -------- | | ------- | ----------------------------- |
| boolean | 返回true,表示添加成功;返回false,表示添加失败。 | | boolean | 返回true,表示添加成功;返回false,表示添加失败。 |
- 示例: **示例:**
``` ```
// 将语言zh-CN添加到系统偏好语言列表中 // 将语言zh-CN添加到系统偏好语言列表中
var language = 'zh-CN'; var language = 'zh-CN';
...@@ -1338,17 +1338,17 @@ removePreferredLanguage(index: number): boolean ...@@ -1338,17 +1338,17 @@ removePreferredLanguage(index: number): boolean
**系统能力**:SystemCapability.Global.I18n **系统能力**:SystemCapability.Global.I18n
- 参数: **参数:**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | | ----- | ------ | ---- | --------------------- |
| index | number | 是 | 待删除偏好语言在系统偏好语言列表中的位置。 | | index | number | 是 | 待删除偏好语言在系统偏好语言列表中的位置。 |
- 返回值: **返回值:**
| 类型 | 说明 | | 类型 | 说明 |
| -------- | -------- | | ------- | ----------------------------- |
| boolean | 返回true,表示删除成功;返回false,表示删除失败。 | | boolean | 返回true,表示删除成功;返回false,表示删除失败。 |
- 示例: **示例:**
``` ```
// 删除系统偏好语言列表中的第一个偏好语言 // 删除系统偏好语言列表中的第一个偏好语言
var index = 0; var index = 0;
...@@ -1358,18 +1358,18 @@ removePreferredLanguage(index: number): boolean ...@@ -1358,18 +1358,18 @@ removePreferredLanguage(index: number): boolean
## i18n.getPreferredLanguageList<sup>8+</sup> ## i18n.getPreferredLanguageList<sup>8+</sup>
getPreferredLanguageList(): Array<string> getPreferredLanguageList(): Array&lt;string&gt;
获取系统偏好语言列表。 获取系统偏好语言列表。
**系统能力**:SystemCapability.Global.I18n **系统能力**:SystemCapability.Global.I18n
- 返回值: **返回值:**
| 类型 | 说明 | | 类型 | 说明 |
| -------- | -------- | | ------------------- | --------- |
| Array<string> | 系统偏好语言列表。 | | Array&lt;string&gt; | 系统偏好语言列表。 |
- 示例: **示例:**
``` ```
var preferredLanguageList = i18n.getPreferredLanguageList(); var preferredLanguageList = i18n.getPreferredLanguageList();
``` ```
...@@ -1383,12 +1383,12 @@ getFirstPreferredLanguage(): string ...@@ -1383,12 +1383,12 @@ getFirstPreferredLanguage(): string
**系统能力**:SystemCapability.Global.I18n **系统能力**:SystemCapability.Global.I18n
- 返回值: **返回值:**
| 类型 | 说明 | | 类型 | 说明 |
| -------- | -------- | | ------ | -------------- |
| string | 偏好语言列表中的第一个语言。 | | string | 偏好语言列表中的第一个语言。 |
- 示例: **示例:**
``` ```
var firstPreferredLanguage = i18n.getFirstPreferredLanguage(); var firstPreferredLanguage = i18n.getFirstPreferredLanguage();
``` ```
...@@ -1402,17 +1402,17 @@ getTimeZone(zoneID?: string): TimeZone ...@@ -1402,17 +1402,17 @@ getTimeZone(zoneID?: string): TimeZone
**系统能力**:SystemCapability.Global.I18n **系统能力**:SystemCapability.Global.I18n
- 参数: **参数:**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | | ------ | ------ | ---- | ----- |
| zondID | string | 否 | 时区ID。 | | zondID | string | 否 | 时区ID。 |
- 返回值: **返回值:**
| 类型 | 说明 | | 类型 | 说明 |
| -------- | -------- | | -------- | ------------ |
| TimeZone | 时区ID对应的时区对象。 | | TimeZone | 时区ID对应的时区对象。 |
- 示例: **示例:**
``` ```
var timezone = i18n.getTimeZone(); var timezone = i18n.getTimeZone();
``` ```
...@@ -1429,12 +1429,12 @@ getID(): string ...@@ -1429,12 +1429,12 @@ getID(): string
**系统能力**:SystemCapability.Global.I18n **系统能力**:SystemCapability.Global.I18n
- 返回值: **返回值:**
| 类型 | 说明 | | 类型 | 说明 |
| -------- | -------- | | ------ | ------------ |
| string | 时区对象对应的时区ID。 | | string | 时区对象对应的时区ID。 |
- 示例: **示例:**
``` ```
var timezone = i18n.getTimeZone(); var timezone = i18n.getTimeZone();
timezone.getID(); timezone.getID();
...@@ -1449,18 +1449,18 @@ getDisplayName(locale?: string, isDST?: boolean): string ...@@ -1449,18 +1449,18 @@ getDisplayName(locale?: string, isDST?: boolean): string
**系统能力**:SystemCapability.Global.I18n **系统能力**:SystemCapability.Global.I18n
- 参数: **参数:**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | | ------ | ------- | ---- | -------------------- |
| locale | string | 否 | 区域ID。 | | locale | string | 否 | 区域ID。 |
| isDST | boolean | 否 | 表示获取时区对象的表示时是否考虑夏令时。 | | isDST | boolean | 否 | 表示获取时区对象的表示时是否考虑夏令时。 |
- 返回值: **返回值:**
| 类型 | 说明 | | 类型 | 说明 |
| -------- | -------- | | ------ | ------------- |
| string | 时区对象在指定区域的表示。 | | string | 时区对象在指定区域的表示。 |
- 示例: **示例:**
``` ```
var timezone = i18n.getTimeZone(); var timezone = i18n.getTimeZone();
timezone.getDisplayName("zh-CN", false); timezone.getDisplayName("zh-CN", false);
...@@ -1475,12 +1475,12 @@ getRawOffset(): number ...@@ -1475,12 +1475,12 @@ getRawOffset(): number
**系统能力**:SystemCapability.Global.I18n **系统能力**:SystemCapability.Global.I18n
- 返回值: **返回值:**
| 类型 | 说明 | | 类型 | 说明 |
| -------- | -------- | | ------ | ------------------- |
| number | 时区对象表示的时区与UTC时区的偏差。 | | number | 时区对象表示的时区与UTC时区的偏差。 |
- 示例: **示例:**
``` ```
var timezone = i18n.getTimeZone(); var timezone = i18n.getTimeZone();
timezone.getRawOffset(); timezone.getRawOffset();
...@@ -1495,12 +1495,12 @@ getOffset(date?: number): number ...@@ -1495,12 +1495,12 @@ getOffset(date?: number): number
**系统能力**:SystemCapability.Global.I18n **系统能力**:SystemCapability.Global.I18n
- 返回值: **返回值:**
| 类型 | 说明 | | 类型 | 说明 |
| -------- | -------- | | ------ | ----------------------- |
| number | 某一时刻时区对象表示的时区与UTC时区的偏差。 | | number | 某一时刻时区对象表示的时区与UTC时区的偏差。 |
- 示例: **示例:**
``` ```
var timezone = i18n.getTimeZone(); var timezone = i18n.getTimeZone();
timezone.getOffset(1234567890); timezone.getOffset(1234567890);
......
...@@ -21,7 +21,7 @@ import Intl from '@ohos.intl'; ...@@ -21,7 +21,7 @@ import Intl from '@ohos.intl';
**系统能力**:以下各项对应的系统能力均为SystemCapability.Global.I18n **系统能力**:以下各项对应的系统能力均为SystemCapability.Global.I18n
| 名称 | 参数类型 | 可读 | 可写 | 说明 | | 名称 | 参数类型 | 可读 | 可写 | 说明 |
| -------- | -------- | -------- | -------- | -------- | | --------------- | ------- | ---- | ---- | ---------------------------------------- |
| language | string | 是 | 否 | 与区域设置关联的语,&nbsp;如:zh。 | | language | string | 是 | 否 | 与区域设置关联的语,&nbsp;如:zh。 |
| script | string | 是 | 否 | 语言的书写方式,如:Hans。 | | script | string | 是 | 否 | 语言的书写方式,如:Hans。 |
| region | string | 是 | 否 | 与区域设置相关的地区,如:CN。 | | region | string | 是 | 否 | 与区域设置相关的地区,如:CN。 |
...@@ -42,7 +42,7 @@ constructor() ...@@ -42,7 +42,7 @@ constructor()
**系统能力**:SystemCapability.Global.I18n **系统能力**:SystemCapability.Global.I18n
- 示例: **示例:**
``` ```
var locale = new Intl.Locale(); var locale = new Intl.Locale();
``` ```
...@@ -56,13 +56,13 @@ constructor(locale: string, options?: LocaleOptions) ...@@ -56,13 +56,13 @@ constructor(locale: string, options?: LocaleOptions)
**系统能力**:SystemCapability.Global.I18n **系统能力**:SystemCapability.Global.I18n
- 参数: **参数:**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | | ------- | ------------- | ---- | ---------------------------- |
| locale | string | 是 | 包含区域设置信息的字符串,包括语言以及可选的脚本和区域。 | | locale | string | 是 | 包含区域设置信息的字符串,包括语言以及可选的脚本和区域。 |
| options | LocaleOptions | 否 | 用于创建区域对象的选项。 | | options | LocaleOptions | 否 | 用于创建区域对象的选项。 |
- 示例: **示例:**
``` ```
var locale = new Intl.Locale("zh-CN"); var locale = new Intl.Locale("zh-CN");
``` ```
...@@ -76,12 +76,12 @@ toString(): string ...@@ -76,12 +76,12 @@ toString(): string
**系统能力**:SystemCapability.Global.I18n **系统能力**:SystemCapability.Global.I18n
- 返回值: **返回值:**
| 类型 | 说明 | | 类型 | 说明 |
| -------- | -------- | | ------ | ----------- |
| string | 字符串形式的区域信息。 | | string | 字符串形式的区域信息。 |
- 示例: **示例:**
``` ```
var locale = new Intl.Locale("zh-CN"); var locale = new Intl.Locale("zh-CN");
locale.toString(); locale.toString();
...@@ -96,12 +96,12 @@ maximize(): Locale ...@@ -96,12 +96,12 @@ maximize(): Locale
**系统能力**:SystemCapability.Global.I18n **系统能力**:SystemCapability.Global.I18n
- 返回值: **返回值:**
| 类型 | 说明 | | 类型 | 说明 |
| -------- | -------- | | ----------------- | ---------- |
| [Locale](#locale) | 最大化后的区域对象。 | | [Locale](#locale) | 最大化后的区域对象。 |
- 示例: **示例:**
``` ```
var locale = new Intl.Locale("zh-CN"); var locale = new Intl.Locale("zh-CN");
locale.maximize(); locale.maximize();
...@@ -116,12 +116,12 @@ minimize(): Locale ...@@ -116,12 +116,12 @@ minimize(): Locale
**系统能力**:SystemCapability.Global.I18n **系统能力**:SystemCapability.Global.I18n
- 返回值: **返回值:**
| 类型 | 说明 | | 类型 | 说明 |
| -------- | -------- | | ----------------- | ---------- |
| [Locale](#locale) | 最小化后的区域对象。 | | [Locale](#locale) | 最小化后的区域对象。 |
- 示例: **示例:**
``` ```
var locale = new Intl.Locale("zh-CN"); var locale = new Intl.Locale("zh-CN");
locale.minimize(); locale.minimize();
...@@ -135,7 +135,7 @@ minimize(): Locale ...@@ -135,7 +135,7 @@ minimize(): Locale
**系统能力**:以下各项对应的系统能力均为SystemCapability.Global.I18n **系统能力**:以下各项对应的系统能力均为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"。 | | 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"。 | | collation | string | 是 | 是 | 排序参数,取值包括:"big5han", "compat", "dict", "direct", "ducet", "emoji", "eor", "gb2312", "phonebk", "phonetic", "pinyin", "reformed ", "search", "searchjl", "standard", "stroke", "trad", "unihan", "zhuyin"。 |
| hourCycle | string | 是 | 是 | 时制格式,取值包括:"h11",&nbsp;"h12",&nbsp;"h23",&nbsp;"h24"。 | | hourCycle | string | 是 | 是 | 时制格式,取值包括:"h11",&nbsp;"h12",&nbsp;"h23",&nbsp;"h24"。 |
...@@ -155,7 +155,7 @@ constructor() ...@@ -155,7 +155,7 @@ constructor()
**系统能力**:SystemCapability.Global.I18n **系统能力**:SystemCapability.Global.I18n
- 示例: **示例:**
``` ```
var datefmt= new Intl.DateTimeFormat(); var datefmt= new Intl.DateTimeFormat();
``` ```
...@@ -163,25 +163,25 @@ constructor() ...@@ -163,25 +163,25 @@ constructor()
### constructor ### constructor
constructor(locale: string | Array<string>, options?: DateTimeOptions) constructor(locale: string | Array&lt;string&gt;, options?: DateTimeOptions)
创建时间日期格式化对象。 创建时间日期格式化对象。
**系统能力**:SystemCapability.Global.I18n **系统能力**:SystemCapability.Global.I18n
- 参数: **参数:**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | | ------- | ----------------------------------- | ---- | ---------------------------- |
| locale | string \| Array<string> | 是 | 包含区域设置信息的字符串,包括语言以及可选的脚本和区域。 | | locale | string \| Array&lt;string&gt; | 是 | 包含区域设置信息的字符串,包括语言以及可选的脚本和区域。 |
| options | [DateTimeOptions](#datetimeoptions) | 否 | 用于创建时间日期格式化的选项。 | | options | [DateTimeOptions](#datetimeoptions) | 否 | 用于创建时间日期格式化的选项。 |
- 示例: **示例:**
``` ```
var datefmt= new Intl.DateTimeFormat("zh-CN", { dateStyle: 'full', timeStyle: 'medium' }); var datefmt= new Intl.DateTimeFormat("zh-CN", { dateStyle: 'full', timeStyle: 'medium' });
``` ```
- 示例: **示例:**
``` ```
var datefmt= new Intl.DateTimeFormat(["ban", "zh"], { dateStyle: 'full', timeStyle: 'medium' }); var datefmt= new Intl.DateTimeFormat(["ban", "zh"], { dateStyle: 'full', timeStyle: 'medium' });
``` ```
...@@ -195,17 +195,17 @@ format(date: Date): string ...@@ -195,17 +195,17 @@ format(date: Date): string
**系统能力**:SystemCapability.Global.I18n **系统能力**:SystemCapability.Global.I18n
- 参数: **参数:**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | | ---- | ---- | ---- | ------- |
| date | Date | 是 | 时间日期对象。 | | date | Date | 是 | 时间日期对象。 |
- 返回值: **返回值:**
| 类型 | 说明 | | 类型 | 说明 |
| -------- | -------- | | ------ | ------------ |
| string | 格式化后的时间日期字符串 | | string | 格式化后的时间日期字符串 |
- 示例: **示例:**
``` ```
var date = new Date(2021, 11, 17, 3, 24, 0); var date = new Date(2021, 11, 17, 3, 24, 0);
var datefmt = new Intl.DateTimeFormat("en-GB"); var datefmt = new Intl.DateTimeFormat("en-GB");
...@@ -221,18 +221,18 @@ formatRange(startDate: Date, endDate: Date): string ...@@ -221,18 +221,18 @@ formatRange(startDate: Date, endDate: Date): string
**系统能力**:SystemCapability.Global.I18n **系统能力**:SystemCapability.Global.I18n
- 参数: **参数:**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | | --------- | ---- | ---- | -------- |
| startDate | Date | 是 | 起始的时间日期。 | | startDate | Date | 是 | 起始的时间日期。 |
| endDate | Date | 是 | 结束的时间日期。 | | endDate | Date | 是 | 结束的时间日期。 |
- 返回值: **返回值:**
| 类型 | 说明 | | 类型 | 说明 |
| -------- | -------- | | ------ | -------------- |
| string | 格式化后的时间日期段字符串。 | | string | 格式化后的时间日期段字符串。 |
- 示例: **示例:**
``` ```
var startDate = new Date(2021, 11, 17, 3, 24, 0); var startDate = new Date(2021, 11, 17, 3, 24, 0);
var endDate = new Date(2021, 11, 18, 3, 24, 0); var endDate = new Date(2021, 11, 18, 3, 24, 0);
...@@ -249,12 +249,12 @@ resolvedOptions(): DateTimeOptions ...@@ -249,12 +249,12 @@ resolvedOptions(): DateTimeOptions
**系统能力**:SystemCapability.Global.I18n **系统能力**:SystemCapability.Global.I18n
- 返回值: **返回值:**
| 类型 | 说明 | | 类型 | 说明 |
| -------- | -------- | | ----------------------------------- | ----------------------------- |
| [DateTimeOptions](#datetimeoptions) | DateTimeFormat&nbsp;对象的格式化选项。 | | [DateTimeOptions](#datetimeoptions) | DateTimeFormat&nbsp;对象的格式化选项。 |
- 示例: **示例:**
``` ```
var datefmt = new Intl.DateTimeFormat("en-GB"); var datefmt = new Intl.DateTimeFormat("en-GB");
datefmt.resolvedOptions(); datefmt.resolvedOptions();
...@@ -268,7 +268,7 @@ resolvedOptions(): DateTimeOptions ...@@ -268,7 +268,7 @@ resolvedOptions(): DateTimeOptions
**系统能力**:以下各项对应的系统能力均为SystemCapability.Global.I18n **系统能力**:以下各项对应的系统能力均为SystemCapability.Global.I18n
| 名称 | 参数类型 | 可读 | 可写 | 说明 | | 名称 | 参数类型 | 可读 | 可写 | 说明 |
| -------- | -------- | -------- | -------- | -------- | | --------------- | ------- | ---- | ---- | ---------------------------------------- |
| locale | string | 是 | 否 | 区域参数,&nbsp;如:zh-Hans-CN。 | | locale | string | 是 | 否 | 区域参数,&nbsp;如:zh-Hans-CN。 |
| dateStyle | string | 是 | 是 | 日期显示格式,取值包括:"long",&nbsp;"short",&nbsp;"medium",&nbsp;"full"。 | | dateStyle | string | 是 | 是 | 日期显示格式,取值包括:"long",&nbsp;"short",&nbsp;"medium",&nbsp;"full"。 |
| timeStyle | string | 是 | 是 | 时间显示格式,取值包括:"long",&nbsp;"short",&nbsp;"medium",&nbsp;"full"。 | | timeStyle | string | 是 | 是 | 时间显示格式,取值包括:"long",&nbsp;"short",&nbsp;"medium",&nbsp;"full"。 |
...@@ -301,7 +301,7 @@ constructor() ...@@ -301,7 +301,7 @@ constructor()
**系统能力**:SystemCapability.Global.I18n **系统能力**:SystemCapability.Global.I18n
- 示例: **示例:**
``` ```
var numfmt = new Intl.NumberFormat(); var numfmt = new Intl.NumberFormat();
``` ```
...@@ -309,7 +309,7 @@ constructor() ...@@ -309,7 +309,7 @@ constructor()
### constructor ### constructor
constructor(locale: string | Array<string>, options?: NumberOptions) constructor(locale: string | Array&lt;string&gt;, options?: NumberOptions)
创建数字格式化对象。 创建数字格式化对象。
...@@ -317,11 +317,11 @@ constructor(locale: string | Array<string>, options?: NumberOptions) ...@@ -317,11 +317,11 @@ constructor(locale: string | Array<string>, options?: NumberOptions)
参数: 参数:
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | | ------- | ------------------------------- | ---- | ---------------------------- |
| locale | string \| Array<string> | 是 | 包含区域设置信息的字符串,包括语言以及可选的脚本和区域。 | | locale | string \| Array&lt;string&gt; | 是 | 包含区域设置信息的字符串,包括语言以及可选的脚本和区域。 |
| options | [NumberOptions](#numberoptions) | 否 | 用于创建数字格式化的选项。 | | options | [NumberOptions](#numberoptions) | 否 | 用于创建数字格式化的选项。 |
- 示例: **示例:**
``` ```
var numfmt = new Intl.NumberFormat("en-GB", {style:'decimal', notation:"scientific"}); var numfmt = new Intl.NumberFormat("en-GB", {style:'decimal', notation:"scientific"});
``` ```
...@@ -335,18 +335,18 @@ format(number: number): string; ...@@ -335,18 +335,18 @@ format(number: number): string;
**系统能力**:SystemCapability.Global.I18n **系统能力**:SystemCapability.Global.I18n
- 参数: **参数:**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | | ------ | ------ | ---- | ---- |
| number | number | 是 | 数字对象 | | number | number | 是 | 数字对象 |
- 返回值: **返回值:**
| 类型 | 说明 | | 类型 | 说明 |
| -------- | -------- | | ------ | ---------- |
| string | 格式化后的数字字符串 | | string | 格式化后的数字字符串 |
- 示例: **示例:**
``` ```
var numfmt = new Intl.NumberFormat(["en-GB", "zh"], {style:'decimal', notation:"scientific"}); var numfmt = new Intl.NumberFormat(["en-GB", "zh"], {style:'decimal', notation:"scientific"});
numfmt.format(1223); numfmt.format(1223);
...@@ -361,13 +361,13 @@ resolvedOptions(): NumberOptions ...@@ -361,13 +361,13 @@ resolvedOptions(): NumberOptions
**系统能力**:SystemCapability.Global.I18n **系统能力**:SystemCapability.Global.I18n
- 返回值: **返回值:**
| 类型 | 说明 | | 类型 | 说明 |
| -------- | -------- | | ------------------------------- | --------------------------- |
| [NumberOptions](#numberoptions) | NumberFormat&nbsp;对象的格式化选项。 | | [NumberOptions](#numberoptions) | NumberFormat&nbsp;对象的格式化选项。 |
- 示例: **示例:**
``` ```
var numfmt = new Intl.NumberFormat(["en-GB", "zh"], {style:'decimal', notation:"scientific"}); var numfmt = new Intl.NumberFormat(["en-GB", "zh"], {style:'decimal', notation:"scientific"});
numfmt.resolvedOptions(); numfmt.resolvedOptions();
...@@ -381,7 +381,7 @@ resolvedOptions(): NumberOptions ...@@ -381,7 +381,7 @@ resolvedOptions(): NumberOptions
**系统能力**:以下各项对应的系统能力均为SystemCapability.Global.I18n **系统能力**:以下各项对应的系统能力均为SystemCapability.Global.I18n
| 名称 | 参数类型 | 可读 | 可写 | 说明 | | 名称 | 参数类型 | 可读 | 可写 | 说明 |
| -------- | -------- | -------- | -------- | -------- | | ------------------------ | ------- | ---- | ---- | ---------------------------------------- |
| locale | string | 是 | 否 | 区域参数,&nbsp;如:"zh-Hans-CN"。 | | locale | string | 是 | 否 | 区域参数,&nbsp;如:"zh-Hans-CN"。 |
| currency | string | 是 | 是 | 货币单位,&nbsp;如:"EUR","CNY","USD"等。 | | currency | string | 是 | 是 | 货币单位,&nbsp;如:"EUR","CNY","USD"等。 |
| currencySign | string | 是 | 是 | 货币单位的符号显示,取值包括:&nbsp;"symbol","narrowSymbol","code","name"&nbsp;。 | | currencySign | string | 是 | 是 | 货币单位的符号显示,取值包括:&nbsp;"symbol","narrowSymbol","code","name"&nbsp;。 |
...@@ -414,7 +414,7 @@ constructor() ...@@ -414,7 +414,7 @@ constructor()
**系统能力**:SystemCapability.Global.I18n **系统能力**:SystemCapability.Global.I18n
- 示例: **示例:**
``` ```
var collator = new Intl.Collator(); var collator = new Intl.Collator();
``` ```
...@@ -422,20 +422,20 @@ constructor() ...@@ -422,20 +422,20 @@ constructor()
### constructor<sup>8+</sup> ### constructor<sup>8+</sup>
constructor(locale: string | Array<string>, options?: CollatorOptions) constructor(locale: string | Array&lt;string&gt;, options?: CollatorOptions)
创建排序对象。 创建排序对象。
**系统能力**:SystemCapability.Global.I18n **系统能力**:SystemCapability.Global.I18n
- 参数: **参数:**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | | ------- | ----------------------------------- | ---- | ---------------------------- |
| locale | string \| Array<string> | 是 | 包含区域设置信息的字符串,包括语言以及可选的脚本和区域。 | | locale | string \| Array&lt;string&gt; | 是 | 包含区域设置信息的字符串,包括语言以及可选的脚本和区域。 |
| options | [CollatorOptions](#collatoroptions) | 否 | 用于创建排序对象的选项。 | | options | [CollatorOptions](#collatoroptions) | 否 | 用于创建排序对象的选项。 |
- 示例: **示例:**
``` ```
var collator = new Intl.Collator("zh-CN", {localeMatcher: "lookup", usage: "sort"}); var collator = new Intl.Collator("zh-CN", {localeMatcher: "lookup", usage: "sort"});
``` ```
...@@ -449,18 +449,18 @@ compare(first: string, second: string): number ...@@ -449,18 +449,18 @@ compare(first: string, second: string): number
**系统能力**:SystemCapability.Global.I18n **系统能力**:SystemCapability.Global.I18n
- 参数: **参数:**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | | ------ | ------ | ---- | ------------ |
| first | string | 是 | 进行比较第一个字符串。 | | first | string | 是 | 进行比较第一个字符串。 |
| second | 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"); var collator = new Intl.Collator("zh-Hans");
collator.compare("first", "second"); collator.compare("first", "second");
...@@ -475,12 +475,12 @@ resolvedOptions(): CollatorOptions ...@@ -475,12 +475,12 @@ resolvedOptions(): CollatorOptions
**系统能力**:SystemCapability.Global.I18n **系统能力**:SystemCapability.Global.I18n
- 返回值: **返回值:**
| 类型 | 说明 | | 类型 | 说明 |
| -------- | -------- | | ----------------------------------- | ----------------- |
| [CollatorOptions](#collatoroptions) | 返回的Collator对象的属性。 | | [CollatorOptions](#collatoroptions) | 返回的Collator对象的属性。 |
- 示例: **示例:**
``` ```
var collator = new Intl.Collator("zh-Hans"); var collator = new Intl.Collator("zh-Hans");
var options = collator.resolvedOptions(); var options = collator.resolvedOptions();
...@@ -494,7 +494,7 @@ resolvedOptions(): CollatorOptions ...@@ -494,7 +494,7 @@ resolvedOptions(): CollatorOptions
**系统能力**:以下各项对应的系统能力均为SystemCapability.Global.I18n **系统能力**:以下各项对应的系统能力均为SystemCapability.Global.I18n
| 名称 | 参数类型 | 可读 | 可写 | 说明 | | 名称 | 参数类型 | 可读 | 可写 | 说明 |
| -------- | -------- | -------- | -------- | -------- | | ----------------- | ------- | ---- | ---- | ---------------------------------------- |
| localeMatcher | string | 是 | 是 | locale匹配算法,取值范围:"best&nbsp;fit",&nbsp;"lookup"。 | | localeMatcher | string | 是 | 是 | locale匹配算法,取值范围:"best&nbsp;fit",&nbsp;"lookup"。 |
| usage | string | 是 | 是 | 比较的用途,取值范围:"sort",&nbsp;"search"。 | | usage | string | 是 | 是 | 比较的用途,取值范围:"sort",&nbsp;"search"。 |
| sensitivity | string | 是 | 是 | 表示字符串中的哪些差异会导致非零结果值,取值范围:"base",&nbsp;"accent",&nbsp;"case",&nbsp;"variant"。 | | sensitivity | string | 是 | 是 | 表示字符串中的哪些差异会导致非零结果值,取值范围:"base",&nbsp;"accent",&nbsp;"case",&nbsp;"variant"。 |
...@@ -515,7 +515,7 @@ constructor() ...@@ -515,7 +515,7 @@ constructor()
**系统能力**:SystemCapability.Global.I18n **系统能力**:SystemCapability.Global.I18n
- 示例: **示例:**
``` ```
var pluralRules = new Intl.PluralRules(); var pluralRules = new Intl.PluralRules();
``` ```
...@@ -523,7 +523,7 @@ constructor() ...@@ -523,7 +523,7 @@ constructor()
### constructor<sup>8+</sup> ### constructor<sup>8+</sup>
constructor(locale: string | Array<string>, options?: PluralRulesOptions) constructor(locale: string | Array&lt;string&gt;, options?: PluralRulesOptions)
创建PluralRules对象。 创建PluralRules对象。
...@@ -531,11 +531,11 @@ constructor(locale: string | Array<string>, options?: PluralRulesOptions) ...@@ -531,11 +531,11 @@ constructor(locale: string | Array<string>, options?: PluralRulesOptions)
参数: 参数:
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | | ------- | ---------------------------------------- | ---- | ---------------------------- |
| locale | string \| Array<string> | 是 | 包含区域设置信息的字符串,包括语言以及可选的脚本和区域。 | | locale | string \| Array&lt;string&gt; | 是 | 包含区域设置信息的字符串,包括语言以及可选的脚本和区域。 |
| options | [PluralRulesOptions](#pluralrulesoptions) | 否 | 用于创建单复数对象的选项。 | | options | [PluralRulesOptions](#pluralrulesoptions) | 否 | 用于创建单复数对象的选项。 |
- 示例: **示例:**
``` ```
var pluralRules= new Intl.PluraRules("zh-CN", {"localeMatcher": "lookup", "type": "cardinal"}); var pluralRules= new Intl.PluraRules("zh-CN", {"localeMatcher": "lookup", "type": "cardinal"});
``` ```
...@@ -549,17 +549,17 @@ select(n: number): string ...@@ -549,17 +549,17 @@ select(n: number): string
**系统能力**:SystemCapability.Global.I18n **系统能力**:SystemCapability.Global.I18n
- 参数: **参数:**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | | ---- | ------ | ---- | ------------ |
| n | number | 是 | 待获取单复数类别的数字。 | | n | number | 是 | 待获取单复数类别的数字。 |
- 返回值: **返回值:**
| 类型 | 说明 | | 类型 | 说明 |
| -------- | -------- | | ------ | ---------------------------------------- |
| string | 单复数类别,取值包括:"zero","one","two",&nbsp;"few",&nbsp;"many",&nbsp;"others"。 | | string | 单复数类别,取值包括:"zero","one","two",&nbsp;"few",&nbsp;"many",&nbsp;"others"。 |
- 示例: **示例:**
``` ```
var pluralRules = new Intl.PluralRules("zh-Hans"); var pluralRules = new Intl.PluralRules("zh-Hans");
pluralRules.select(1); pluralRules.select(1);
...@@ -573,7 +573,7 @@ select(n: number): string ...@@ -573,7 +573,7 @@ select(n: number): string
**系统能力**:以下各项对应的系统能力均为SystemCapability.Global.I18n **系统能力**:以下各项对应的系统能力均为SystemCapability.Global.I18n
| 名称 | 参数类型 | 可读 | 可写 | 说明 | | 名称 | 参数类型 | 可读 | 可写 | 说明 |
| -------- | -------- | -------- | -------- | -------- | | ------------------------ | ------ | ---- | ---- | ---------------------------------------- |
| localeMatcher | string | 是 | 是 | locale匹配算法,取值包括:"best&nbsp;fit",&nbsp;"lookup"。 | | localeMatcher | string | 是 | 是 | locale匹配算法,取值包括:"best&nbsp;fit",&nbsp;"lookup"。 |
| type | string | 是 | 是 | 排序的类型,取值包括:"cardinal",&nbsp;"ordinal"。 | | type | string | 是 | 是 | 排序的类型,取值包括:"cardinal",&nbsp;"ordinal"。 |
| minimumIntegerDigits | number | 是 | 是 | 表示要使用的最小整数位数,取值范围:1~21。 | | minimumIntegerDigits | number | 是 | 是 | 表示要使用的最小整数位数,取值范围:1~21。 |
...@@ -594,7 +594,7 @@ constructor() ...@@ -594,7 +594,7 @@ constructor()
**系统能力**:SystemCapability.Global.I18n **系统能力**:SystemCapability.Global.I18n
- 示例: **示例:**
``` ```
var relativetimefmt = new Intl.RelativeTimeFormat(); var relativetimefmt = new Intl.RelativeTimeFormat();
``` ```
...@@ -602,7 +602,7 @@ constructor() ...@@ -602,7 +602,7 @@ constructor()
### constructor<sup>8+</sup> ### constructor<sup>8+</sup>
constructor(locale: string | Array<string>, options?: RelativeTimeFormatInputOptions) constructor(locale: string | Array&lt;string&gt;, options?: RelativeTimeFormatInputOptions)
创建相对时间格式化对象。 创建相对时间格式化对象。
...@@ -610,11 +610,11 @@ constructor(locale: string | Array<string>, options?: RelativeTimeFormatInputOpt ...@@ -610,11 +610,11 @@ constructor(locale: string | Array<string>, options?: RelativeTimeFormatInputOpt
参数: 参数:
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | | ------- | ---------------------------------------- | ---- | ---------------------------- |
| locale | string \| Array<string> | 是 | 包含区域设置信息的字符串,包括语言以及可选的脚本和区域。 | | locale | string \| Array&lt;string&gt; | 是 | 包含区域设置信息的字符串,包括语言以及可选的脚本和区域。 |
| options | [RelativeTimeFormatInputOptions](#relativetimeformatinputoptions) | 否 | 用于创建相对时间格式化对象的选项。 | | options | [RelativeTimeFormatInputOptions](#relativetimeformatinputoptions) | 否 | 用于创建相对时间格式化对象的选项。 |
- 示例: **示例:**
``` ```
var relativeTimeFormat = new Intl.RelativeTimeFormat("zh-CN", {"localeMatcher": "lookup", "numeric": "always", "style": "long"}); var relativeTimeFormat = new Intl.RelativeTimeFormat("zh-CN", {"localeMatcher": "lookup", "numeric": "always", "style": "long"});
``` ```
...@@ -628,18 +628,18 @@ format(value: number, unit: string): string ...@@ -628,18 +628,18 @@ format(value: number, unit: string): string
**系统能力**:SystemCapability.Global.I18n **系统能力**:SystemCapability.Global.I18n
- 参数: **参数:**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | | ----- | ------ | ---- | ---------------------------------------- |
| value | number | 是 | 相对时间格式化的数值。 | | value | number | 是 | 相对时间格式化的数值。 |
| unit | string | 是 | 相对时间格式化的单位,取值包括:"year",&nbsp;"quarter",&nbsp;"month",&nbsp;"week",&nbsp;"day",&nbsp;"hour",&nbsp;"minute",&nbsp;"second"。 | | unit | string | 是 | 相对时间格式化的单位,取值包括:"year",&nbsp;"quarter",&nbsp;"month",&nbsp;"week",&nbsp;"day",&nbsp;"hour",&nbsp;"minute",&nbsp;"second"。 |
- 返回值: **返回值:**
| 类型 | 说明 | | 类型 | 说明 |
| -------- | -------- | | ------ | ---------- |
| string | 格式化后的相对时间。 | | string | 格式化后的相对时间。 |
- 示例: **示例:**
``` ```
var relativetimefmt = new Intl.RelativeTimeFormat("zh-CN"); var relativetimefmt = new Intl.RelativeTimeFormat("zh-CN");
relativetimefmt.format(3, "quarter") relativetimefmt.format(3, "quarter")
...@@ -648,24 +648,24 @@ format(value: number, unit: string): string ...@@ -648,24 +648,24 @@ format(value: number, unit: string): string
### formatToParts<sup>8+</sup> ### formatToParts<sup>8+</sup>
formatToParts(value: number, unit: string): Array<object> formatToParts(value: number, unit: string): Array&lt;object&gt;
返回一个对象数组,表示可用于自定义区域设置格式的相对时间格式。 返回一个对象数组,表示可用于自定义区域设置格式的相对时间格式。
**系统能力**:SystemCapability.Global.I18n **系统能力**:SystemCapability.Global.I18n
- 参数: **参数:**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | | ----- | ------ | ---- | ---------------------------------------- |
| value | number | 是 | 相对时间格式化的数值。 | | value | number | 是 | 相对时间格式化的数值。 |
| unit | string | 是 | 相对时间格式化的单位,取值包括:"year",&nbsp;"quarter",&nbsp;"month",&nbsp;"week",&nbsp;"day",&nbsp;"hour",&nbsp;"minute",&nbsp;"second"。 | | unit | string | 是 | 相对时间格式化的单位,取值包括:"year",&nbsp;"quarter",&nbsp;"month",&nbsp;"week",&nbsp;"day",&nbsp;"hour",&nbsp;"minute",&nbsp;"second"。 |
- 返回值: **返回值:**
| 类型 | 说明 | | 类型 | 说明 |
| -------- | -------- | | ------------------- | --------------------------- |
| Array<object> | 返回可用于自定义区域设置格式的相对时间格式的对象数组。 | | Array&lt;object&gt; | 返回可用于自定义区域设置格式的相对时间格式的对象数组。 |
- 示例: **示例:**
``` ```
var relativetimefmt = new Intl.RelativeTimeFormat("en", {"numeric": "auto"}); var relativetimefmt = new Intl.RelativeTimeFormat("en", {"numeric": "auto"});
var parts = relativetimefmt.format(10, "seconds"); var parts = relativetimefmt.format(10, "seconds");
...@@ -680,12 +680,12 @@ resolvedOptions(): RelativeTimeFormatResolvedOptions ...@@ -680,12 +680,12 @@ resolvedOptions(): RelativeTimeFormatResolvedOptions
**系统能力**:SystemCapability.Global.I18n **系统能力**:SystemCapability.Global.I18n
- 返回值: **返回值:**
| 类型 | 说明 | | 类型 | 说明 |
| -------- | -------- | | ---------------------------------------- | --------------------------------- |
| [RelativeTimeFormatResolvedOptions](#relativetimeformatresolvedoptions) | RelativeTimeFormat&nbsp;对象的格式化选项。 | | [RelativeTimeFormatResolvedOptions](#relativetimeformatresolvedoptions) | RelativeTimeFormat&nbsp;对象的格式化选项。 |
- 示例: **示例:**
``` ```
var relativetimefmt= new Intl.RelativeTimeFormat("en-GB"); var relativetimefmt= new Intl.RelativeTimeFormat("en-GB");
relativetimefmt.resolvedOptions(); relativetimefmt.resolvedOptions();
...@@ -699,7 +699,7 @@ resolvedOptions(): RelativeTimeFormatResolvedOptions ...@@ -699,7 +699,7 @@ resolvedOptions(): RelativeTimeFormatResolvedOptions
**系统能力**:以下各项对应的系统能力均为SystemCapability.Global.I18n **系统能力**:以下各项对应的系统能力均为SystemCapability.Global.I18n
| 名称 | 参数类型 | 可读 | 可写 | 说明 | | 名称 | 参数类型 | 可读 | 可写 | 说明 |
| -------- | -------- | -------- | -------- | -------- | | ------------- | ------ | ---- | ---- | ---------------------------------------- |
| localeMatcher | string | 是 | 是 | locale匹配算法,取值包括:"best&nbsp;fit",&nbsp;"lookup"。 | | localeMatcher | string | 是 | 是 | locale匹配算法,取值包括:"best&nbsp;fit",&nbsp;"lookup"。 |
| numeric | string | 是 | 是 | 输出消息的格式,取值包括:"always",&nbsp;"auto"。 | | numeric | string | 是 | 是 | 输出消息的格式,取值包括:"always",&nbsp;"auto"。 |
| style | string | 是 | 是 | 国际化消息的长度,取值包括:"long",&nbsp;"short",&nbsp;"narrow"。 | | style | string | 是 | 是 | 国际化消息的长度,取值包括:"long",&nbsp;"short",&nbsp;"narrow"。 |
...@@ -712,7 +712,7 @@ resolvedOptions(): RelativeTimeFormatResolvedOptions ...@@ -712,7 +712,7 @@ resolvedOptions(): RelativeTimeFormatResolvedOptions
**系统能力**:以下各项对应的系统能力均为SystemCapability.Global.I18n **系统能力**:以下各项对应的系统能力均为SystemCapability.Global.I18n
| 名称 | 参数类型 | 可读 | 可写 | 说明 | | 名称 | 参数类型 | 可读 | 可写 | 说明 |
| -------- | -------- | -------- | -------- | -------- | | --------------- | ------ | ---- | ---- | ---------------------------------------- |
| locale | string | 是 | 是 | 包含区域设置信息的字符串,包括语言以及可选的脚本和区域。 | | locale | string | 是 | 是 | 包含区域设置信息的字符串,包括语言以及可选的脚本和区域。 |
| numeric | string | 是 | 是 | 输出消息的格式,取值包括:"always",&nbsp;"auto"。 | | numeric | string | 是 | 是 | 输出消息的格式,取值包括:"always",&nbsp;"auto"。 |
| style | string | 是 | 是 | 国际化消息的长度,取值包括:"long",&nbsp;"short",&nbsp;"narrow"。 | | style | string | 是 | 是 | 国际化消息的长度,取值包括:"long",&nbsp;"short",&nbsp;"narrow"。 |
......
# 资源管理 资源管理
> ![icon-note.gif](public_sys-resources/icon-note.gif) **说明:** > ![icon-note.gif](public_sys-resources/icon-note.gif) **说明:**
> 本模块首批接口从API version 6开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。 > 本模块首批接口从API version 6开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。
...@@ -18,12 +18,12 @@ getResourceManager(callback: AsyncCallback&lt;ResourceManager&gt;): void ...@@ -18,12 +18,12 @@ getResourceManager(callback: AsyncCallback&lt;ResourceManager&gt;): void
**系统能力**:SystemCapability.Global.ResourceManager **系统能力**:SystemCapability.Global.ResourceManager
- 参数: **参数:**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | | -------- | ---------------------------------------- | ---- | ----------------------------- |
| callback | AsyncCallback&lt;[ResourceManager](#resourcemanager)&gt; | 是 | callback方式返回ResourceManager对象 | | callback | AsyncCallback&lt;[ResourceManager](#resourcemanager)&gt; | 是 | callback方式返回ResourceManager对象 |
- 示例: **示例:**
``` ```
resourceManager.getResourceManager((error, mgr) => { resourceManager.getResourceManager((error, mgr) => {
if (error != null) { if (error != null) {
...@@ -49,13 +49,13 @@ getResourceManager(bundleName: string, callback: AsyncCallback&lt;ResourceManage ...@@ -49,13 +49,13 @@ getResourceManager(bundleName: string, callback: AsyncCallback&lt;ResourceManage
**系统能力**:SystemCapability.Global.ResourceManager **系统能力**:SystemCapability.Global.ResourceManager
- 参数: **参数:**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | | ---------- | ---------------------------------------- | ---- | ----------------------------- |
| bundleName | string | 是 | 指定应用的Bundle名称 | | bundleName | string | 是 | 指定应用的Bundle名称 |
| callback | AsyncCallback&lt;[ResourceManager](#resourcemanager)&gt; | 是 | callback方式返回ResourceManager对象 | | callback | AsyncCallback&lt;[ResourceManager](#resourcemanager)&gt; | 是 | callback方式返回ResourceManager对象 |
- 示例: **示例:**
``` ```
resourceManager.getResourceManager("com.example.myapplication", (error, mgr) => { resourceManager.getResourceManager("com.example.myapplication", (error, mgr) => {
}); });
...@@ -70,12 +70,12 @@ getResourceManager(): Promise&lt;ResourceManager&gt; ...@@ -70,12 +70,12 @@ getResourceManager(): Promise&lt;ResourceManager&gt;
**系统能力**:SystemCapability.Global.ResourceManager **系统能力**:SystemCapability.Global.ResourceManager
- 返回值: **返回值:**
| 类型 | 说明 | | 类型 | 说明 |
| -------- | -------- | | ---------------------------------------- | ----------------- |
| Promise&lt;[ResourceManager](#resourcemanager)&gt; | Promise方式返回资源管理对象 | | Promise&lt;[ResourceManager](#resourcemanager)&gt; | Promise方式返回资源管理对象 |
- 示例: **示例:**
``` ```
resourceManager.getResourceManager().then(mgr => { resourceManager.getResourceManager().then(mgr => {
mgr.getString(0x1000000, (error, value) => { mgr.getString(0x1000000, (error, value) => {
...@@ -99,17 +99,17 @@ getResourceManager(bundleName: string): Promise&lt;ResourceManager&gt; ...@@ -99,17 +99,17 @@ getResourceManager(bundleName: string): Promise&lt;ResourceManager&gt;
**系统能力**:SystemCapability.Global.ResourceManager **系统能力**:SystemCapability.Global.ResourceManager
- 参数: **参数:**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | | ---------- | ------ | ---- | ------------- |
| bundleName | string | 是 | 指定应用的Bundle名称 | | bundleName | string | 是 | 指定应用的Bundle名称 |
- 返回值: **返回值:**
| 类型 | 说明 | | 类型 | 说明 |
| -------- | -------- | | ---------------------------------------- | ------------------ |
| Promise&lt;[ResourceManager](#resourcemanager)&gt; | Promise方式返回的资源管理对象 | | Promise&lt;[ResourceManager](#resourcemanager)&gt; | Promise方式返回的资源管理对象 |
- 示例: **示例:**
``` ```
resourceManager.getResourceManager("com.example.myapplication").then(mgr => { resourceManager.getResourceManager("com.example.myapplication").then(mgr => {
...@@ -123,69 +123,79 @@ getResourceManager(bundleName: string): Promise&lt;ResourceManager&gt; ...@@ -123,69 +123,79 @@ getResourceManager(bundleName: string): Promise&lt;ResourceManager&gt;
用于表示设备屏幕方向。 用于表示设备屏幕方向。
**系统能力**:以下各项对应的系统能力均为SystemCapability.Global.ResourceManager
| 名称 | 默认值 | 说明 | | 名称 | 默认值 | 说明 |
| -------- | -------- | -------- | | -------------------- | ---- | ---- |
| DIRECTION_VERTICAL | 0 | 竖屏<br/>**系统能力**:SystemCapability.Global.ResourceManager | | DIRECTION_VERTICAL | 0 | 竖屏 |
| DIRECTION_HORIZONTAL | 1 | 横屏<br/>**系统能力**:SystemCapability.Global.ResourceManager | | DIRECTION_HORIZONTAL | 1 | 横屏 |
## DeviceType ## DeviceType
用于表示当前设备类型。 用于表示当前设备类型。
**系统能力**:以下各项对应的系统能力均为SystemCapability.Global.ResourceManager
| 名称 | 默认值 | 说明 | | 名称 | 默认值 | 说明 |
| -------- | -------- | -------- | | -------------------- | ---- | ---- |
| DEVICE_TYPE_PHONE | 0x00 | 手机<br/>**系统能力**:SystemCapability.Global.ResourceManager | | DEVICE_TYPE_PHONE | 0x00 | 手机 |
| DEVICE_TYPE_TABLET | 0x01 | 平板<br/>**系统能力**:SystemCapability.Global.ResourceManager | | DEVICE_TYPE_TABLET | 0x01 | 平板 |
| DEVICE_TYPE_CAR | 0x02 | 汽车<br/>**系统能力**:SystemCapability.Global.ResourceManager | | DEVICE_TYPE_CAR | 0x02 | 汽车 |
| DEVICE_TYPE_PC | 0x03 | 电脑<br/>**系统能力**:SystemCapability.Global.ResourceManager | | DEVICE_TYPE_PC | 0x03 | 电脑 |
| DEVICE_TYPE_TV | 0x04 | 电视<br/>**系统能力**:SystemCapability.Global.ResourceManager | | DEVICE_TYPE_TV | 0x04 | 电视 |
| DEVICE_TYPE_WEARABLE | 0x06 | 穿戴<br/>**系统能力**:SystemCapability.Global.ResourceManager | | DEVICE_TYPE_WEARABLE | 0x06 | 穿戴 |
## ScreenDensity ## ScreenDensity
用于表示当前设备屏幕密度。 用于表示当前设备屏幕密度。
**系统能力**:以下各项对应的系统能力均为SystemCapability.Global.ResourceManager
| 名称 | 默认值 | 说明 | | 名称 | 默认值 | 说明 |
| -------- | -------- | -------- | | -------------- | ---- | ---------- |
| SCREEN_SDPI | 120 | 小规模的屏幕密度<br/>**系统能力**:SystemCapability.Global.ResourceManager | | SCREEN_SDPI | 120 | 小规模的屏幕密度 |
| SCREEN_MDPI | 160 | 中规模的屏幕密度<br/>**系统能力**:SystemCapability.Global.ResourceManager | | SCREEN_MDPI | 160 | 中规模的屏幕密度 |
| SCREEN_LDPI | 240 | 大规模的屏幕密度<br/>**系统能力**:SystemCapability.Global.ResourceManager | | SCREEN_LDPI | 240 | 大规模的屏幕密度 |
| SCREEN_XLDPI | 320 | 特大规模的屏幕密度<br/>**系统能力**:SystemCapability.Global.ResourceManager | | SCREEN_XLDPI | 320 | 特大规模的屏幕密度 |
| SCREEN_XXLDPI | 480 | 超大规模的屏幕密度<br/>**系统能力**:SystemCapability.Global.ResourceManager | | SCREEN_XXLDPI | 480 | 超大规模的屏幕密度 |
| SCREEN_XXXLDPI | 640 | 超特大规模的屏幕密度<br/>**系统能力**:SystemCapability.Global.ResourceManager | | SCREEN_XXXLDPI | 640 | 超特大规模的屏幕密度 |
## Configuration ## Configuration
表示当前设备的状态。 表示当前设备的状态。
**系统能力**:以下各项对应的系统能力均为SystemCapability.Global.ResourceManager
| 名称 | 参数类型 | 可读 | 可写 | 说明 | | 名称 | 参数类型 | 可读 | 可写 | 说明 |
| -------- | -------- | -------- | -------- | -------- | | --------- | ----------------------- | ---- | ---- | -------- |
| direction | [Direction](#direction) | 是 | 否 | 当前设备屏幕方向<br/>**系统能力**:SystemCapability.Global.ResourceManager | | direction | [Direction](#direction) | 是 | 否 | 当前设备屏幕方向 |
| locale | string | 是 | 否 | 当前系统语言<br/>**系统能力**:SystemCapability.Global.ResourceManager | | locale | string | 是 | 否 | 当前系统语言 |
## DeviceCapability ## DeviceCapability
表示设备支持的能力。 表示设备支持的能力。
**系统能力**:以下各项对应的系统能力均为SystemCapability.Global.ResourceManager
| 名称 | 参数类型 | 可读 | 可写 | 说明 | | 名称 | 参数类型 | 可读 | 可写 | 说明 |
| -------- | -------- | -------- | -------- | -------- | | ------------- | ------------------------------- | ---- | ---- | -------- |
| screenDensity | [ScreenDensity](#screendensity) | 是 | 否 | 当前设备屏幕密度<br/>**系统能力**:SystemCapability.Global.ResourceManager | | screenDensity | [ScreenDensity](#screendensity) | 是 | 否 | 当前设备屏幕密度 |
| deviceType | [DeviceType](#devicetype) | 是 | 否 | 当前设备类型<br/>**系统能力**:SystemCapability.Global.ResourceManager | | deviceType | [DeviceType](#devicetype) | 是 | 否 | 当前设备类型 |
## RawFileDescriptor<sup>8+</sup> ## RawFileDescriptor<sup>8+</sup>
表示rawfile的descriptor信息。 表示rawfile的descriptor信息。<br>
<br/><b>系统能力:</b> 以下各项对应的系统能力均为SystemCapability.Global.ResourceManager **系统能力:** 以下各项对应的系统能力均为SystemCapability.Global.ResourceManager
| 名称 | 类型 | 说明 | | 名称 | 类型 | 说明 |
| -------- | -------- | -------- | | ------ | ------ | ------------------ |
| fd | number | rawfile的descriptor | | fd | number | rawfile的descriptor |
| offset | number | rawfile的起始偏移量 | | offset | number | rawfile的起始偏移量 |
| length | number | rawfile的文件长度 | | length | number | rawfile的文件长度 |
...@@ -209,13 +219,13 @@ getString(resId: number, callback: AsyncCallback&lt;string&gt;): void ...@@ -209,13 +219,13 @@ getString(resId: number, callback: AsyncCallback&lt;string&gt;): void
**系统能力**:SystemCapability.Global.ResourceManager **系统能力**:SystemCapability.Global.ResourceManager
- 参数: **参数:**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | | -------- | --------------------------- | ---- | --------------- |
| resId | number | 是 | 资源ID值 | | resId | number | 是 | 资源ID值 |
| callback | AsyncCallback&lt;string&gt; | 是 | 异步回调,用于返回获取的字符串 | | callback | AsyncCallback&lt;string&gt; | 是 | 异步回调,用于返回获取的字符串 |
- 示例: **示例:**
``` ```
resourceManager.getResourceManager((error, mgr) => { resourceManager.getResourceManager((error, mgr) => {
mgr.getString($r('app.string.test').id, (error, value) => { mgr.getString($r('app.string.test').id, (error, value) => {
...@@ -237,17 +247,17 @@ getString(resId: number): Promise&lt;string&gt; ...@@ -237,17 +247,17 @@ getString(resId: number): Promise&lt;string&gt;
**系统能力**:SystemCapability.Global.ResourceManager **系统能力**:SystemCapability.Global.ResourceManager
- 参数: **参数:**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | | ----- | ------ | ---- | ----- |
| resId | number | 是 | 资源ID值 | | resId | number | 是 | 资源ID值 |
- 返回值: **返回值:**
| 类型 | 说明 | | 类型 | 说明 |
| -------- | -------- | | --------------------- | ----------- |
| Promise&lt;string&gt; | 资源ID值对应的字符串 | | Promise&lt;string&gt; | 资源ID值对应的字符串 |
- 示例: **示例:**
``` ```
resourceManager.getResourceManager((error, mgr) => { resourceManager.getResourceManager((error, mgr) => {
mgr.getString($r('app.string.test').id).then(value => { mgr.getString($r('app.string.test').id).then(value => {
...@@ -267,13 +277,13 @@ getStringArray(resId: number, callback: AsyncCallback&lt;Array&lt;string&gt;&gt; ...@@ -267,13 +277,13 @@ getStringArray(resId: number, callback: AsyncCallback&lt;Array&lt;string&gt;&gt;
**系统能力**:SystemCapability.Global.ResourceManager **系统能力**:SystemCapability.Global.ResourceManager
- 参数: **参数:**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | | -------- | ---------------------------------------- | ---- | ----------------- |
| resId | number | 是 | 资源ID值 | | resId | number | 是 | 资源ID值 |
| callback | AsyncCallback&lt;Array&lt;string&gt;&gt; | 是 | 异步回调,用于返回获取的字符串数组 | | callback | AsyncCallback&lt;Array&lt;string&gt;&gt; | 是 | 异步回调,用于返回获取的字符串数组 |
- 示例: **示例:**
``` ```
resourceManager.getResourceManager((error, mgr) => { resourceManager.getResourceManager((error, mgr) => {
mgr.getStringArray($r('app.strarray.test').id, (error, value) => { mgr.getStringArray($r('app.strarray.test').id, (error, value) => {
...@@ -295,17 +305,17 @@ getStringArray(resId: number): Promise&lt;Array&lt;string&gt;&gt; ...@@ -295,17 +305,17 @@ getStringArray(resId: number): Promise&lt;Array&lt;string&gt;&gt;
**系统能力**:SystemCapability.Global.ResourceManager **系统能力**:SystemCapability.Global.ResourceManager
- 参数: **参数:**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | | ----- | ------ | ---- | ----- |
| resId | number | 是 | 资源ID值 | | resId | number | 是 | 资源ID值 |
- 返回值: **返回值:**
| 类型 | 说明 | | 类型 | 说明 |
| -------- | -------- | | ---------------------------------- | ------------- |
| Promise&lt;Array&lt;string&gt;&gt; | 资源ID值对应的字符串数组 | | Promise&lt;Array&lt;string&gt;&gt; | 资源ID值对应的字符串数组 |
- 示例: **示例:**
``` ```
resourceManager.getResourceManager((error, mgr) => { resourceManager.getResourceManager((error, mgr) => {
mgr.getStringArray($r('app.strarray.test').id).then(value => { mgr.getStringArray($r('app.strarray.test').id).then(value => {
...@@ -325,13 +335,13 @@ getMedia(resId: number, callback: AsyncCallback&lt;Uint8Array&gt;): void ...@@ -325,13 +335,13 @@ getMedia(resId: number, callback: AsyncCallback&lt;Uint8Array&gt;): void
**系统能力**:SystemCapability.Global.ResourceManager **系统能力**:SystemCapability.Global.ResourceManager
- 参数: **参数:**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | | -------- | ------------------------------- | ---- | ------------------ |
| resId | number | 是 | 资源ID值 | | resId | number | 是 | 资源ID值 |
| callback | AsyncCallback&lt;Uint8Array&gt; | 是 | 异步回调,用于返回获取的媒体文件内容 | | callback | AsyncCallback&lt;Uint8Array&gt; | 是 | 异步回调,用于返回获取的媒体文件内容 |
- 示例: **示例:**
``` ```
resourceManager.getResourceManager((error, mgr) => { resourceManager.getResourceManager((error, mgr) => {
mgr.getMedia($r('app.media.test').id, (error, value) => { mgr.getMedia($r('app.media.test').id, (error, value) => {
...@@ -353,17 +363,17 @@ getMedia(resId: number): Promise&lt;Uint8Array&gt; ...@@ -353,17 +363,17 @@ getMedia(resId: number): Promise&lt;Uint8Array&gt;
**系统能力**:SystemCapability.Global.ResourceManager **系统能力**:SystemCapability.Global.ResourceManager
- 参数: **参数:**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | | ----- | ------ | ---- | ----- |
| resId | number | 是 | 资源ID值 | | resId | number | 是 | 资源ID值 |
- 返回值: **返回值:**
| 类型 | 说明 | | 类型 | 说明 |
| -------- | -------- | | ------------------------- | -------------- |
| Promise&lt;Uint8Array&gt; | 资源ID值对应的媒体文件内容 | | Promise&lt;Uint8Array&gt; | 资源ID值对应的媒体文件内容 |
- 示例: **示例:**
``` ```
resourceManager.getResourceManager((error, mgr) => { resourceManager.getResourceManager((error, mgr) => {
mgr.getMedia($r('app.media.test').id).then(value => { mgr.getMedia($r('app.media.test').id).then(value => {
...@@ -383,13 +393,13 @@ getMediaBase64(resId: number, callback: AsyncCallback&lt;string&gt;): void ...@@ -383,13 +393,13 @@ getMediaBase64(resId: number, callback: AsyncCallback&lt;string&gt;): void
**系统能力**:SystemCapability.Global.ResourceManager **系统能力**:SystemCapability.Global.ResourceManager
- 参数: **参数:**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | | -------- | --------------------------- | ---- | ------------------------ |
| resId | number | 是 | 资源ID值 | | resId | number | 是 | 资源ID值 |
| callback | AsyncCallback&lt;string&gt; | 是 | 异步回调,用于返回获取的图片资源Base64编码 | | callback | AsyncCallback&lt;string&gt; | 是 | 异步回调,用于返回获取的图片资源Base64编码 |
- 示例: **示例:**
``` ```
resourceManager.getResourceManager((error, mgr) => { resourceManager.getResourceManager((error, mgr) => {
mgr.getMediaBase64($r('app.media.test').id, (error, value) => { mgr.getMediaBase64($r('app.media.test').id, (error, value) => {
...@@ -411,17 +421,17 @@ getMediaBase64(resId: number): Promise&lt;string&gt; ...@@ -411,17 +421,17 @@ getMediaBase64(resId: number): Promise&lt;string&gt;
**系统能力**:SystemCapability.Global.ResourceManager **系统能力**:SystemCapability.Global.ResourceManager
- 参数: **参数:**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | | ----- | ------ | ---- | ----- |
| resId | number | 是 | 资源ID值 | | resId | number | 是 | 资源ID值 |
- 返回值: **返回值:**
| 类型 | 说明 | | 类型 | 说明 |
| -------- | -------- | | --------------------- | -------------------- |
| Promise&lt;string&gt; | 资源ID值对应的图片资源Base64编码 | | Promise&lt;string&gt; | 资源ID值对应的图片资源Base64编码 |
- 示例: **示例:**
``` ```
resourceManager.getResourceManager((error, mgr) => { resourceManager.getResourceManager((error, mgr) => {
mgr.getMediaBase64($r('app.media.test').id).then(value => { mgr.getMediaBase64($r('app.media.test').id).then(value => {
...@@ -441,12 +451,12 @@ getConfiguration(callback: AsyncCallback&lt;Configuration&gt;): void ...@@ -441,12 +451,12 @@ getConfiguration(callback: AsyncCallback&lt;Configuration&gt;): void
**系统能力**:SystemCapability.Global.ResourceManager **系统能力**:SystemCapability.Global.ResourceManager
- 参数: **参数:**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | | -------- | ---------------------------------------- | ---- | ------------------------- |
| callback | AsyncCallback&lt;[Configuration](#configuration)&gt; | 是 | 异步回调,用于返回设备的Configuration | | callback | AsyncCallback&lt;[Configuration](#configuration)&gt; | 是 | 异步回调,用于返回设备的Configuration |
- 示例: **示例:**
``` ```
resourceManager.getResourceManager((error, mgr) => { resourceManager.getResourceManager((error, mgr) => {
mgr.getConfiguration((error, value) => { mgr.getConfiguration((error, value) => {
...@@ -468,12 +478,12 @@ getConfiguration(): Promise&lt;Configuration&gt; ...@@ -468,12 +478,12 @@ getConfiguration(): Promise&lt;Configuration&gt;
**系统能力**:SystemCapability.Global.ResourceManager **系统能力**:SystemCapability.Global.ResourceManager
- 返回值: **返回值:**
| 类型 | 说明 | | 类型 | 说明 |
| -------- | -------- | | ---------------------------------------- | ---------------- |
| Promise&lt;[Configuration](#configuration)&gt; | 设备的Configuration | | Promise&lt;[Configuration](#configuration)&gt; | 设备的Configuration |
- 示例: **示例:**
``` ```
resourceManager.getResourceManager((error, mgr) => { resourceManager.getResourceManager((error, mgr) => {
mgr.getConfiguration().then(value => { mgr.getConfiguration().then(value => {
...@@ -493,12 +503,12 @@ getDeviceCapability(callback: AsyncCallback&lt;DeviceCapability&gt;): void ...@@ -493,12 +503,12 @@ getDeviceCapability(callback: AsyncCallback&lt;DeviceCapability&gt;): void
**系统能力**:SystemCapability.Global.ResourceManager **系统能力**:SystemCapability.Global.ResourceManager
- 参数: **参数:**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | | -------- | ---------------------------------------- | ---- | ---------------------------- |
| callback | AsyncCallback&lt;[DeviceCapability](#devicecapability)&gt; | 是 | 异步回调,用于返回设备的DeviceCapability | | callback | AsyncCallback&lt;[DeviceCapability](#devicecapability)&gt; | 是 | 异步回调,用于返回设备的DeviceCapability |
- 示例: **示例:**
``` ```
resourceManager.getResourceManager((error, mgr) => { resourceManager.getResourceManager((error, mgr) => {
mgr.getDeviceCapability((error, value) => { mgr.getDeviceCapability((error, value) => {
...@@ -520,12 +530,12 @@ getDeviceCapability(): Promise&lt;DeviceCapability&gt; ...@@ -520,12 +530,12 @@ getDeviceCapability(): Promise&lt;DeviceCapability&gt;
**系统能力**:SystemCapability.Global.ResourceManager **系统能力**:SystemCapability.Global.ResourceManager
- 返回值: **返回值:**
| 类型 | 说明 | | 类型 | 说明 |
| -------- | -------- | | ---------------------------------------- | ------------------- |
| Promise&lt;[DeviceCapability](#devicecapability)&gt; | 设备的DeviceCapability | | Promise&lt;[DeviceCapability](#devicecapability)&gt; | 设备的DeviceCapability |
- 示例: **示例:**
``` ```
resourceManager.getResourceManager((error, mgr) => { resourceManager.getResourceManager((error, mgr) => {
mgr.getDeviceCapability().then(value => { mgr.getDeviceCapability().then(value => {
...@@ -545,14 +555,14 @@ getPluralString(resId: number, num: number, callback: AsyncCallback&lt;string&gt ...@@ -545,14 +555,14 @@ getPluralString(resId: number, num: number, callback: AsyncCallback&lt;string&gt
**系统能力**:SystemCapability.Global.ResourceManager **系统能力**:SystemCapability.Global.ResourceManager
- 参数: **参数:**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | | -------- | --------------------------- | ---- | ------------------------------- |
| resId | number | 是 | 资源ID值 | | resId | number | 是 | 资源ID值 |
| num | number | 是 | 数量值 | | num | number | 是 | 数量值 |
| callback | AsyncCallback&lt;string&gt; | 是 | 异步回调,返回根据指定数量获取指定ID字符串表示的单复数字符串 | | callback | AsyncCallback&lt;string&gt; | 是 | 异步回调,返回根据指定数量获取指定ID字符串表示的单复数字符串 |
- 示例: **示例:**
``` ```
resourceManager.getResourceManager((error, mgr) => { resourceManager.getResourceManager((error, mgr) => {
mgr.getPluralString($r("app.plural.test").id, 1, (error, value) => { mgr.getPluralString($r("app.plural.test").id, 1, (error, value) => {
...@@ -574,18 +584,18 @@ getPluralString(resId: number, num: number): Promise&lt;string&gt; ...@@ -574,18 +584,18 @@ getPluralString(resId: number, num: number): Promise&lt;string&gt;
**系统能力**:SystemCapability.Global.ResourceManager **系统能力**:SystemCapability.Global.ResourceManager
- 参数: **参数:**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | | ----- | ------ | ---- | ----- |
| resId | number | 是 | 资源ID值 | | resId | number | 是 | 资源ID值 |
| num | number | 是 | 数量值 | | num | number | 是 | 数量值 |
- 返回值: **返回值:**
| 类型 | 说明 | | 类型 | 说明 |
| -------- | -------- | | --------------------- | ------------------------- |
| Promise&lt;string&gt; | 根据提供的数量获取对应ID字符串表示的单复数字符串 | | Promise&lt;string&gt; | 根据提供的数量获取对应ID字符串表示的单复数字符串 |
- 示例: **示例:**
``` ```
resourceManager.getResourceManager((error, mgr) => { resourceManager.getResourceManager((error, mgr) => {
mgr.getPluralString($r("app.plural.test").id, 1).then(value => { mgr.getPluralString($r("app.plural.test").id, 1).then(value => {
...@@ -604,13 +614,13 @@ getRawFile(path: string, callback: AsyncCallback&lt;Uint8Array&gt;): void ...@@ -604,13 +614,13 @@ getRawFile(path: string, callback: AsyncCallback&lt;Uint8Array&gt;): void
**系统能力**:SystemCapability.Global.ResourceManager **系统能力**:SystemCapability.Global.ResourceManager
- 参数: **参数:**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | | -------- | ------------------------------- | ---- | ----------------------- |
| path | string | 是 | rawfile文件路径 | | path | string | 是 | rawfile文件路径 |
| callback | AsyncCallback&lt;Uint8Array&gt; | 是 | 异步回调,用于返回获取的rawfile文件内容 | | callback | AsyncCallback&lt;Uint8Array&gt; | 是 | 异步回调,用于返回获取的rawfile文件内容 |
- 示例: **示例:**
``` ```
resourceManager.getResourceManager((error, mgr) => { resourceManager.getResourceManager((error, mgr) => {
mgr.getRawFile("test.xml", (error, value) => { mgr.getRawFile("test.xml", (error, value) => {
...@@ -631,17 +641,17 @@ getRawFile(path: string): Promise&lt;Uint8Array&gt; ...@@ -631,17 +641,17 @@ getRawFile(path: string): Promise&lt;Uint8Array&gt;
**系统能力**:SystemCapability.Global.ResourceManager **系统能力**:SystemCapability.Global.ResourceManager
- 参数: **参数:**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | | ---- | ------ | ---- | ----------- |
| path | string | 是 | rawfile文件路径 | | path | string | 是 | rawfile文件路径 |
- 返回值: **返回值:**
| 类型 | 说明 | | 类型 | 说明 |
| -------- | -------- | | ------------------------- | ----------- |
| Promise&lt;Uint8Array&gt; | rawfile文件内容 | | Promise&lt;Uint8Array&gt; | rawfile文件内容 |
- 示例: **示例:**
``` ```
resourceManager.getResourceManager((error, mgr) => { resourceManager.getResourceManager((error, mgr) => {
mgr.getRawFile("test.xml").then(value => { mgr.getRawFile("test.xml").then(value => {
...@@ -660,13 +670,13 @@ getRawFileDescriptor(path: string, callback: AsyncCallback&lt;RawFileDescriptor& ...@@ -660,13 +670,13 @@ getRawFileDescriptor(path: string, callback: AsyncCallback&lt;RawFileDescriptor&
**系统能力**:SystemCapability.Global.ResourceManager **系统能力**:SystemCapability.Global.ResourceManager
- 参数: **参数:**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | | -------- | ---------------------------------------- | ---- | -------------------------------- |
| path | string | 是 | rawfile文件路径 | | path | string | 是 | rawfile文件路径 |
| callback | AsyncCallback&lt;[RawFileDescriptor](#RawFileDescriptor<sup>8+</sup>)&gt; | 是 | 异步回调,用于返回获取的rawfile文件的descriptor | | callback | AsyncCallback&lt;[RawFileDescriptor](#rawfiledescriptor8+</sup)&gt; | 是 | 异步回调,用于返回获取的rawfile文件的descriptor |
- 示例: **示例:**
``` ```
resourceManager.getResourceManager((error, mgr) => { resourceManager.getResourceManager((error, mgr) => {
mgr.getRawFileDescriptor("test.xml", (error, value) => { mgr.getRawFileDescriptor("test.xml", (error, value) => {
...@@ -689,17 +699,17 @@ getRawFileDescriptor(path: string): Promise&lt;RawFileDescriptor&gt; ...@@ -689,17 +699,17 @@ getRawFileDescriptor(path: string): Promise&lt;RawFileDescriptor&gt;
**系统能力**:SystemCapability.Global.ResourceManager **系统能力**:SystemCapability.Global.ResourceManager
- 参数: **参数:**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | | ---- | ------ | ---- | ----------- |
| path | string | 是 | rawfile文件路径 | | path | string | 是 | rawfile文件路径 |
- 返回值: **返回值:**
| 类型 | 说明 | | 类型 | 说明 |
| -------- | -------- | | ---------------------------------------- | ------------------- |
| Promise&lt;[RawFileDescriptor](#RawFileDescriptor<sup>8+</sup>)&gt; | rawfile文件descriptor | | Promise&lt;[RawFileDescriptor](#rawfiledescriptor8)&gt; | rawfile文件descriptor |
- 示例: **示例:**
``` ```
resourceManager.getResourceManager((error, mgr) => { resourceManager.getResourceManager((error, mgr) => {
mgr.getRawFileDescriptor("test.xml").then(value => { mgr.getRawFileDescriptor("test.xml").then(value => {
...@@ -720,13 +730,13 @@ closeRawFileDescriptor(path: string, callback: AsyncCallback&lt;void&gt;): void ...@@ -720,13 +730,13 @@ closeRawFileDescriptor(path: string, callback: AsyncCallback&lt;void&gt;): void
**系统能力**:SystemCapability.Global.ResourceManager **系统能力**:SystemCapability.Global.ResourceManager
- 参数: **参数:**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | | -------- | ------------------------- | ---- | ----------- |
| path | string | 是 | rawfile文件路径 | | path | string | 是 | rawfile文件路径 |
| callback | AsyncCallback&lt;void&gt; | 是 | 异步回调 | | callback | AsyncCallback&lt;void&gt; | 是 | 异步回调 |
- 示例: **示例:**
``` ```
resourceManager.getResourceManager((error, mgr) => { resourceManager.getResourceManager((error, mgr) => {
mgr.closeRawFileDescriptor("test.xml", (error, value) => { mgr.closeRawFileDescriptor("test.xml", (error, value) => {
...@@ -745,17 +755,17 @@ closeRawFileDescriptor(path: string): Promise&lt;void&gt; ...@@ -745,17 +755,17 @@ closeRawFileDescriptor(path: string): Promise&lt;void&gt;
**系统能力**:SystemCapability.Global.ResourceManager **系统能力**:SystemCapability.Global.ResourceManager
- 参数: **参数:**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | | ---- | ------ | ---- | ----------- |
| path | string | 是 | rawfile文件路径 | | path | string | 是 | rawfile文件路径 |
- 返回值: **返回值:**
| 类型 | 说明 | | 类型 | 说明 |
| -------- | -------- | | ------------------- | ---- |
| Promise&lt;void&gt; | 无返回值 | | Promise&lt;void&gt; | 无返回值 |
- 示例: **示例:**
``` ```
resourceManager.getResourceManager((error, mgr) => { resourceManager.getResourceManager((error, mgr) => {
mgr.closeRawFileDescriptor("test.xml").then(value => { mgr.closeRawFileDescriptor("test.xml").then(value => {
...@@ -768,13 +778,13 @@ closeRawFileDescriptor(path: string): Promise&lt;void&gt; ...@@ -768,13 +778,13 @@ closeRawFileDescriptor(path: string): Promise&lt;void&gt;
### release<sup>7+</sup> ### release<sup>7+</sup>
release(); release()
用户释放创建的resourceManager。 用户释放创建的resourceManager。
**系统能力**:SystemCapability.Global.ResourceManager **系统能力**:SystemCapability.Global.ResourceManager
- 示例: **示例:**
``` ```
resourceManager.getResourceManager((error, mgr) => { resourceManager.getResourceManager((error, mgr) => {
mgr.release((error, value) => { mgr.release((error, value) => {
......
...@@ -22,14 +22,14 @@ on(type: SensorType.SENSOR_TYPE_ID_ACCELEROMETER, callback: Callback&lt;Acceler ...@@ -22,14 +22,14 @@ on(type: SensorType.SENSOR_TYPE_ID_ACCELEROMETER, callback: Callback&lt;Acceler
**系统能力**:SystemCapability.Sensors.Sensor **系统能力**:SystemCapability.Sensors.Sensor
- 参数: **参数:**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | | -------- | ---------------------------------------- | ---- | ---------------------------------------- |
| type | [SensorType](#sensortype) | 是 | 要订阅的加速度传感器类型为SENSOR_TYPE_ID_ACCELEROMETER。 | | type | [SensorType](#sensortype) | 是 | 要订阅的加速度传感器类型为SENSOR_TYPE_ID_ACCELEROMETER。 |
| callback | Callback&lt;[AccelerometerResponse](#accelerometerresponse)&gt; | 是 | 注册加速度传感器的回调函数,上报的数据类型为AccelerometerResponse。 | | callback | Callback&lt;[AccelerometerResponse](#accelerometerresponse)&gt; | 是 | 注册加速度传感器的回调函数,上报的数据类型为AccelerometerResponse。 |
| options | [Options](#options) | 否 | 可选参数列表,设置上报频率,默认值为200000000ns。 | | options | [Options](#options) | 否 | 可选参数列表,设置上报频率,默认值为200000000ns。 |
- 示例: **示例:**
``` ```
sensor.on(sensor.SensorType.SENSOR_TYPE_ID_ACCELEROMETER,function(data){ sensor.on(sensor.SensorType.SENSOR_TYPE_ID_ACCELEROMETER,function(data){
console.info('X-coordinate component: ' + data.x); console.info('X-coordinate component: ' + data.x);
...@@ -51,14 +51,14 @@ on(type: SensorType.SENSOR_TYPE_ID_LINEAR_ACCELERATION,callback:Callback&lt;Line ...@@ -51,14 +51,14 @@ on(type: SensorType.SENSOR_TYPE_ID_LINEAR_ACCELERATION,callback:Callback&lt;Line
**系统能力**:SystemCapability.Sensors.Sensor **系统能力**:SystemCapability.Sensors.Sensor
- 参数: **参数:**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | | -------- | ---------------------------------------- | ---- | ---------------------------------------- |
| type | [SensorType](#sensortype) | 是 | 要订阅的线性加速度传感器类型为SENSOR_TYPE_ID_LINEAR_ACCELERATION。 | | type | [SensorType](#sensortype) | 是 | 要订阅的线性加速度传感器类型为SENSOR_TYPE_ID_LINEAR_ACCELERATION。 |
| callback | Callback&lt;[LinearAccelerometerResponse](#linearaccelerometerresponse)&gt; | 是 | 注册线性加速度传感器的回调函数,上报的数据类型为LinearAccelerometerResponse。 | | callback | Callback&lt;[LinearAccelerometerResponse](#linearaccelerometerresponse)&gt; | 是 | 注册线性加速度传感器的回调函数,上报的数据类型为LinearAccelerometerResponse。 |
| options | [Options](#options) | 否 | 可选参数列表,设置上报频率,默认值为200000000ns。 | | options | [Options](#options) | 否 | 可选参数列表,设置上报频率,默认值为200000000ns。 |
- 示例: **示例:**
``` ```
sensor.on(sensor.SensorType.SENSOR_TYPE_ID_LINEAR_ACCELERATION,function(data){ sensor.on(sensor.SensorType.SENSOR_TYPE_ID_LINEAR_ACCELERATION,function(data){
console.info('X-coordinate component: ' + data.x); console.info('X-coordinate component: ' + data.x);
...@@ -80,14 +80,14 @@ on(type: SensorType.SENSOR_TYPE_ID_ACCELEROMETER_UNCALIBRATED,callback: Callback ...@@ -80,14 +80,14 @@ on(type: SensorType.SENSOR_TYPE_ID_ACCELEROMETER_UNCALIBRATED,callback: Callback
**系统能力**:SystemCapability.Sensors.Sensor **系统能力**:SystemCapability.Sensors.Sensor
- 参数: **参数:**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | | -------- | ---------------------------------------- | ---- | ---------------------------------------- |
| type | [SensorType](#sensortype) | 是 | 要订阅的未校准加速度计传感器类型为SENSOR_TYPE_ID_ACCELEROMETER_UNCALIBRATED。 | | type | [SensorType](#sensortype) | 是 | 要订阅的未校准加速度计传感器类型为SENSOR_TYPE_ID_ACCELEROMETER_UNCALIBRATED。 |
| callback | Callback&lt;[AccelerometerUncalibratedResponse](#accelerometeruncalibratedresponse)&gt; | 是 | 注册未校准加速度计传感器的回调函数,上报的数据类型为AccelerometerUncalibratedResponse。 | | callback | Callback&lt;[AccelerometerUncalibratedResponse](#accelerometeruncalibratedresponse)&gt; | 是 | 注册未校准加速度计传感器的回调函数,上报的数据类型为AccelerometerUncalibratedResponse。 |
| options | [Options](#options) | 否 | 可选参数列表,设置上报频率,默认值为200000000ns。 | | options | [Options](#options) | 否 | 可选参数列表,设置上报频率,默认值为200000000ns。 |
- 示例: **示例:**
``` ```
sensor.on(sensor.SensorType.SENSOR_TYPE_ID_ACCELEROMETER_UNCALIBRATED,function(data){ sensor.on(sensor.SensorType.SENSOR_TYPE_ID_ACCELEROMETER_UNCALIBRATED,function(data){
console.info('X-coordinate component: ' + data.x); console.info('X-coordinate component: ' + data.x);
...@@ -110,14 +110,14 @@ on(type: SensorType.SENSOR_TYPE_ID_GRAVITY, callback: Callback&lt;GravityRespons ...@@ -110,14 +110,14 @@ on(type: SensorType.SENSOR_TYPE_ID_GRAVITY, callback: Callback&lt;GravityRespons
**系统能力**:SystemCapability.Sensors.Sensor **系统能力**:SystemCapability.Sensors.Sensor
- 参数: **参数:**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | | -------- | ---------------------------------------- | ---- | ------------------------------------- |
| type | [SensorType](#sensortype) | 是 | 要订阅的重力传感器类型为SENSOR_TYPE_ID_GRAVITY。 | | type | [SensorType](#sensortype) | 是 | 要订阅的重力传感器类型为SENSOR_TYPE_ID_GRAVITY。 |
| callback | Callback&lt;[GravityResponse](#gravityresponse)&gt; | 是 | 注册重力传感器的回调函数,上报的数据类型为GravityResponse。 | | callback | Callback&lt;[GravityResponse](#gravityresponse)&gt; | 是 | 注册重力传感器的回调函数,上报的数据类型为GravityResponse。 |
| options | [Options](#options) | 否 | 可选参数列表,设置上报频率,默认值为200000000ns。 | | options | [Options](#options) | 否 | 可选参数列表,设置上报频率,默认值为200000000ns。 |
- 示例: **示例:**
``` ```
sensor.on(sensor.SensorType.SENSOR_TYPE_ID_GRAVITY,function(data){ sensor.on(sensor.SensorType.SENSOR_TYPE_ID_GRAVITY,function(data){
console.info('X-coordinate component: ' + data.x); console.info('X-coordinate component: ' + data.x);
...@@ -139,14 +139,14 @@ on(type: SensorType.SENSOR_TYPE_ID_GYROSCOPE, callback: Callback&lt;GyroscopeRes ...@@ -139,14 +139,14 @@ on(type: SensorType.SENSOR_TYPE_ID_GYROSCOPE, callback: Callback&lt;GyroscopeRes
**系统能力**:SystemCapability.Sensors.Sensor **系统能力**:SystemCapability.Sensors.Sensor
- 参数: **参数:**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | | -------- | ---------------------------------------- | ---- | ---------------------------------------- |
| type | [SensorType](#sensortype) | 是 | 要订阅的陀螺仪传感器类型为SENSOR_TYPE_ID_GYROSCOPE。 | | type | [SensorType](#sensortype) | 是 | 要订阅的陀螺仪传感器类型为SENSOR_TYPE_ID_GYROSCOPE。 |
| callback | Callback&lt;[GyroscopeResponse](#gyroscoperesponse)&gt; | 是 | 注册陀螺仪传感器的回调函数,上报的数据类型为GyroscopeResponse。 | | callback | Callback&lt;[GyroscopeResponse](#gyroscoperesponse)&gt; | 是 | 注册陀螺仪传感器的回调函数,上报的数据类型为GyroscopeResponse。 |
| options | [Options](#options) | 否 | 可选参数列表,设置上报频率,默认值为200000000ns。 | | options | [Options](#options) | 否 | 可选参数列表,设置上报频率,默认值为200000000ns。 |
- 示例: **示例:**
``` ```
sensor.on(sensor.SensorType.SENSOR_TYPE_ID_GYROSCOPE,function(data){ sensor.on(sensor.SensorType.SENSOR_TYPE_ID_GYROSCOPE,function(data){
console.info('X-coordinate component: ' + data.x); console.info('X-coordinate component: ' + data.x);
...@@ -168,14 +168,14 @@ on(type: SensorType.SENSOR_TYPE_ID_GYROSCOPE_UNCALIBRATED,callback:Callback&lt;G ...@@ -168,14 +168,14 @@ on(type: SensorType.SENSOR_TYPE_ID_GYROSCOPE_UNCALIBRATED,callback:Callback&lt;G
**系统能力**:SystemCapability.Sensors.Sensor **系统能力**:SystemCapability.Sensors.Sensor
- 参数: **参数:**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | | -------- | ---------------------------------------- | ---- | ---------------------------------------- |
| type | [SensorType](#sensortype) | 是 | 要订阅的未校准陀螺仪传感器类型为SENSOR_TYPE_ID_GYROSCOPE_UNCALIBRATED。 | | type | [SensorType](#sensortype) | 是 | 要订阅的未校准陀螺仪传感器类型为SENSOR_TYPE_ID_GYROSCOPE_UNCALIBRATED。 |
| callback | Callback&lt;[GyroscopeUncalibratedResponse](#gyroscopeuncalibratedresponse)&gt; | 是 | 注册未校准陀螺仪传感器的回调函数,上报的数据类型为GyroscopeUncalibratedResponse。 | | callback | Callback&lt;[GyroscopeUncalibratedResponse](#gyroscopeuncalibratedresponse)&gt; | 是 | 注册未校准陀螺仪传感器的回调函数,上报的数据类型为GyroscopeUncalibratedResponse。 |
| options | [Options](#options) | 否 | 可选参数列表,设置上报频率。 | | options | [Options](#options) | 否 | 可选参数列表,设置上报频率。 |
- 示例: **示例:**
``` ```
sensor.on(sensor.SensorType.SENSOR_TYPE_ID_GYROSCOPE_UNCALIBRATED,function(data){ sensor.on(sensor.SensorType.SENSOR_TYPE_ID_GYROSCOPE_UNCALIBRATED,function(data){
console.info('X-coordinate component: ' + data.x); console.info('X-coordinate component: ' + data.x);
...@@ -198,14 +198,14 @@ on(type: SensorType.SENSOR_TYPE_ID_SIGNIFICANT_MOTION, callback: Callback&lt;Sig ...@@ -198,14 +198,14 @@ on(type: SensorType.SENSOR_TYPE_ID_SIGNIFICANT_MOTION, callback: Callback&lt;Sig
**系统能力**:SystemCapability.Sensors.Sensor **系统能力**:SystemCapability.Sensors.Sensor
- 参数: **参数:**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | | -------- | ---------------------------------------- | ---- | ---------------------------------------- |
| type | [SensorType](#sensortype) | 是 | 要订阅的大幅动作传感器类型为SENSOR_TYPE_ID_SIGNIFICANT_MOTION。 | | type | [SensorType](#sensortype) | 是 | 要订阅的大幅动作传感器类型为SENSOR_TYPE_ID_SIGNIFICANT_MOTION。 |
| callback | Callback&lt;[SignificantMotionResponse](#significantmotionresponse)&gt; | 是 | 注册有效运动传感器的回调函数,上报的数据类型为SignificantMotionResponse。 | | callback | Callback&lt;[SignificantMotionResponse](#significantmotionresponse)&gt; | 是 | 注册有效运动传感器的回调函数,上报的数据类型为SignificantMotionResponse。 |
| options | [Options](#options) | 否 | 可选参数列表,设置上报频率,默认值为200000000ns。 | | options | [Options](#options) | 否 | 可选参数列表,设置上报频率,默认值为200000000ns。 |
- 示例: **示例:**
``` ```
sensor.on(sensor.SensorType.SENSOR_TYPE_ID_SIGNIFICANT_MOTION,function(data){ sensor.on(sensor.SensorType.SENSOR_TYPE_ID_SIGNIFICANT_MOTION,function(data){
console.info('Scalar data: ' + data.scalar); console.info('Scalar data: ' + data.scalar);
...@@ -225,14 +225,14 @@ on(type: SensorType.SENSOR_TYPE_ID_PEDOMETER_DETECTION, callback: Callback&lt;Pe ...@@ -225,14 +225,14 @@ on(type: SensorType.SENSOR_TYPE_ID_PEDOMETER_DETECTION, callback: Callback&lt;Pe
**系统能力**:SystemCapability.Sensors.Sensor **系统能力**:SystemCapability.Sensors.Sensor
- 参数: **参数:**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | | -------- | ---------------------------------------- | ---- | ---------------------------------------- |
| type | [SensorType](#sensortype) | 是 | 要订阅的计步检测传感器类型为SENSOR_TYPE_ID_PEDOMETER_DETECTION。 | | type | [SensorType](#sensortype) | 是 | 要订阅的计步检测传感器类型为SENSOR_TYPE_ID_PEDOMETER_DETECTION。 |
| callback | Callback&lt;[PedometerDetectionResponse](#pedometerdetectionresponse)&gt; | 是 | 注册计步检测传感器的回调函数,上报的数据类型为PedometerDetectionResponse。 | | callback | Callback&lt;[PedometerDetectionResponse](#pedometerdetectionresponse)&gt; | 是 | 注册计步检测传感器的回调函数,上报的数据类型为PedometerDetectionResponse。 |
| options | [Options](#options) | 否 | 可选参数列表,设置上报频率,默认值为200000000ns。 | | options | [Options](#options) | 否 | 可选参数列表,设置上报频率,默认值为200000000ns。 |
- 示例: **示例:**
``` ```
sensor.on(sensor.SensorType.SENSOR_TYPE_ID_PEDOMETER_DETECTION,function(data){ sensor.on(sensor.SensorType.SENSOR_TYPE_ID_PEDOMETER_DETECTION,function(data){
console.info('Scalar data: ' + data.scalar); console.info('Scalar data: ' + data.scalar);
...@@ -252,14 +252,14 @@ on(type: SensorType.SENSOR_TYPE_ID_PEDOMETER, callback: Callback&lt;PedometerRes ...@@ -252,14 +252,14 @@ on(type: SensorType.SENSOR_TYPE_ID_PEDOMETER, callback: Callback&lt;PedometerRes
**系统能力**:SystemCapability.Sensors.Sensor **系统能力**:SystemCapability.Sensors.Sensor
- 参数: **参数:**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | | -------- | ---------------------------------------- | ---- | --------------------------------------- |
| type | [SensorType](#sensortype) | 是 | 要订阅的计步传感器类型为SENSOR_TYPE_ID_PEDOMETER。 | | type | [SensorType](#sensortype) | 是 | 要订阅的计步传感器类型为SENSOR_TYPE_ID_PEDOMETER。 |
| callback | Callback&lt;[PedometerResponse](#pedometerresponse)&gt; | 是 | 注册计步传感器的回调函数,上报的数据类型为PedometerResponse。 | | callback | Callback&lt;[PedometerResponse](#pedometerresponse)&gt; | 是 | 注册计步传感器的回调函数,上报的数据类型为PedometerResponse。 |
| options | [Options](#options) | 否 | 可选参数列表,设置上报频率,默认值为200000000ns。 | | options | [Options](#options) | 否 | 可选参数列表,设置上报频率,默认值为200000000ns。 |
- 示例: **示例:**
``` ```
sensor.on(sensor.SensorType.SENSOR_TYPE_ID_PEDOMETER,function(data){ sensor.on(sensor.SensorType.SENSOR_TYPE_ID_PEDOMETER,function(data){
console.info('Steps: ' + data.steps); console.info('Steps: ' + data.steps);
...@@ -277,14 +277,14 @@ on(type:SensorType.SENSOR_TYPE_ID_AMBIENT_TEMPERATURE,callback:Callback&lt;Ambie ...@@ -277,14 +277,14 @@ on(type:SensorType.SENSOR_TYPE_ID_AMBIENT_TEMPERATURE,callback:Callback&lt;Ambie
**系统能力**:SystemCapability.Sensors.Sensor **系统能力**:SystemCapability.Sensors.Sensor
- 参数: **参数:**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | | -------- | ---------------------------------------- | ---- | ---------------------------------------- |
| type | [SensorType](#sensortype) | 是 | 要订阅的环境温度传感器类型为SENSOR_TYPE_ID_AMBIENT_TEMPERATURE。 | | type | [SensorType](#sensortype) | 是 | 要订阅的环境温度传感器类型为SENSOR_TYPE_ID_AMBIENT_TEMPERATURE。 |
| callback | Callback&lt;[AmbientTemperatureResponse](#ambienttemperatureresponse)&gt; | 是 | 注册环境温度传感器的回调函数,上报的数据类型为AmbientTemperatureResponse。 | | callback | Callback&lt;[AmbientTemperatureResponse](#ambienttemperatureresponse)&gt; | 是 | 注册环境温度传感器的回调函数,上报的数据类型为AmbientTemperatureResponse。 |
| options | [Options](#options) | 否 | 可选参数列表,设置上报频率,默认值为200000000ns。 | | options | [Options](#options) | 否 | 可选参数列表,设置上报频率,默认值为200000000ns。 |
- 示例: **示例:**
``` ```
sensor.on(sensor.SensorType.SENSOR_TYPE_ID_AMBIENT_TEMPERATURE,function(data){ sensor.on(sensor.SensorType.SENSOR_TYPE_ID_AMBIENT_TEMPERATURE,function(data){
console.info('Temperature: ' + data.temperature); console.info('Temperature: ' + data.temperature);
...@@ -302,14 +302,14 @@ on(type: SensorType.SENSOR_TYPE_ID_MAGNETIC_FIELD, callback: Callback&lt;Magneti ...@@ -302,14 +302,14 @@ on(type: SensorType.SENSOR_TYPE_ID_MAGNETIC_FIELD, callback: Callback&lt;Magneti
**系统能力**:SystemCapability.Sensors.Sensor **系统能力**:SystemCapability.Sensors.Sensor
- 参数: **参数:**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | | -------- | ---------------------------------------- | ---- | ---------------------------------------- |
| type | [SensorType](#sensortype) | 是 | 要订阅的磁场传感器类型为SENSOR_TYPE_ID_MAGNETIC_FIELD。 | | type | [SensorType](#sensortype) | 是 | 要订阅的磁场传感器类型为SENSOR_TYPE_ID_MAGNETIC_FIELD。 |
| callback | Callback&lt;[MagneticFieldResponse](#magneticfieldresponse)&gt; | 是 | 注册磁场传感器的回调函数,上报的数据类型为MagneticFieldResponse。 | | callback | Callback&lt;[MagneticFieldResponse](#magneticfieldresponse)&gt; | 是 | 注册磁场传感器的回调函数,上报的数据类型为MagneticFieldResponse。 |
| options | [Options](#options) | 否 | 可选参数列表,设置上报频率,默认值为200000000ns。 | | options | [Options](#options) | 否 | 可选参数列表,设置上报频率,默认值为200000000ns。 |
- 示例: **示例:**
``` ```
sensor.on(sensor.SensorType.SENSOR_TYPE_ID_MAGNETIC_FIELD,function(data){ sensor.on(sensor.SensorType.SENSOR_TYPE_ID_MAGNETIC_FIELD,function(data){
console.info('X-coordinate component: ' + data.x); console.info('X-coordinate component: ' + data.x);
...@@ -323,20 +323,20 @@ on(type: SensorType.SENSOR_TYPE_ID_MAGNETIC_FIELD, callback: Callback&lt;Magneti ...@@ -323,20 +323,20 @@ on(type: SensorType.SENSOR_TYPE_ID_MAGNETIC_FIELD, callback: Callback&lt;Magneti
## sensor.on(SensorType.SENSOR_TYPE_ID_MAGNETIC_FIELD_UNCALIBRATED) ## sensor.on(SensorType.SENSOR_TYPE_ID_MAGNETIC_FIELD_UNCALIBRATED)
on(type: SensorType.SENSOR_TYPE_ID_MAGNETIC_FIELD_UNCALIBRATED,callback: Callback&lt;MagneticFieldUncalibratedResponse&gt;, options: Options): void on(type: SensorType.SENSOR_TYPE_ID_MAGNETIC_FIELD_UNCALIBRATED,callback: Callback&lt;MagneticFieldUncalibratedResponse&gt;, options?: Options): void
监听未校准磁场传感器的数据变化。如果多次调用该接口,仅最后一次调用生效。 监听未校准磁场传感器的数据变化。如果多次调用该接口,仅最后一次调用生效。
**系统能力**:SystemCapability.Sensors.Sensor **系统能力**:SystemCapability.Sensors.Sensor
- 参数: **参数:**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | | -------- | ---------------------------------------- | ---- | ---------------------------------------- |
| type | [SensorType](#sensortype) | 是 | 要订阅的未校准磁场传感器类型为SENSOR_TYPE_ID_MAGNETIC_FIELD_UNCALIBRATED。 | | type | [SensorType](#sensortype) | 是 | 要订阅的未校准磁场传感器类型为SENSOR_TYPE_ID_MAGNETIC_FIELD_UNCALIBRATED。 |
| callback | Callback&lt;[MagneticFieldUncalibratedResponse](#magneticfielduncalibratedresponse)&gt; | 是 | 注册未校准磁场传感器的回调函数,上报的数据类型为MagneticFieldUncalibratedResponse。 | | callback | Callback&lt;[MagneticFieldUncalibratedResponse](#magneticfielduncalibratedresponse)&gt; | 是 | 注册未校准磁场传感器的回调函数,上报的数据类型为MagneticFieldUncalibratedResponse。 |
| options | [Options](#options) | 否 | 可选参数列表,设置上报频率,默认值为200000000ns。 | | options | [Options](#options) | 否 | 可选参数列表,设置上报频率,默认值为200000000ns。 |
- 示例: **示例:**
``` ```
sensor.on(sensor.SensorType.SENSOR_TYPE_ID_MAGNETIC_FIELD_UNCALIBRATED,function(data){ sensor.on(sensor.SensorType.SENSOR_TYPE_ID_MAGNETIC_FIELD_UNCALIBRATED,function(data){
console.info('X-coordinate component: ' + data.x); console.info('X-coordinate component: ' + data.x);
...@@ -359,14 +359,14 @@ on(type: SensorType.SENSOR_TYPE_ID_PROXIMITY, callback: Callback&lt;ProximityRes ...@@ -359,14 +359,14 @@ on(type: SensorType.SENSOR_TYPE_ID_PROXIMITY, callback: Callback&lt;ProximityRes
**系统能力**:SystemCapability.Sensors.Sensor **系统能力**:SystemCapability.Sensors.Sensor
- 参数: **参数:**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | | -------- | ---------------------------------------- | ---- | ---------------------------------------- |
| type | [SensorType](#sensortype) | 是 | 要订阅的接近光传感器类型为SENSOR_TYPE_ID_PROXIMITY。 | | type | [SensorType](#sensortype) | 是 | 要订阅的接近光传感器类型为SENSOR_TYPE_ID_PROXIMITY。 |
| callback | Callback&lt;[ProximityResponse](#proximityresponse)&gt; | 是 | 注册接近光传感器的回调函数,上报的数据类型为ProximityResponse。 | | callback | Callback&lt;[ProximityResponse](#proximityresponse)&gt; | 是 | 注册接近光传感器的回调函数,上报的数据类型为ProximityResponse。 |
| options | [Options](#options) | 否 | 可选参数列表,设置上报频率,默认值为200000000ns。 | | options | [Options](#options) | 否 | 可选参数列表,设置上报频率,默认值为200000000ns。 |
- 示例: **示例:**
``` ```
sensor.on(sensor.SensorType.SENSOR_TYPE_ID_PROXIMITY,function(data){ sensor.on(sensor.SensorType.SENSOR_TYPE_ID_PROXIMITY,function(data){
console.info('Distance: ' + data.distance); console.info('Distance: ' + data.distance);
...@@ -384,14 +384,14 @@ on(type: SensorType.SENSOR_TYPE_ID_HUMIDITY, callback: Callback&lt;HumidityRespo ...@@ -384,14 +384,14 @@ on(type: SensorType.SENSOR_TYPE_ID_HUMIDITY, callback: Callback&lt;HumidityRespo
**系统能力**:SystemCapability.Sensors.Sensor **系统能力**:SystemCapability.Sensors.Sensor
- 参数: **参数:**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | | -------- | ---------------------------------------- | ---- | -------------------------------------- |
| type | [SensorType](#sensortype) | 是 | 要订阅的湿度传感器类型为SENSOR_TYPE_ID_HUMIDITY。 | | type | [SensorType](#sensortype) | 是 | 要订阅的湿度传感器类型为SENSOR_TYPE_ID_HUMIDITY。 |
| callback | Callback&lt;[HumidityResponse](#humidityresponse)&gt; | 是 | 注册湿度传感器的回调函数,上报的数据类型为HumidityResponse。 | | callback | Callback&lt;[HumidityResponse](#humidityresponse)&gt; | 是 | 注册湿度传感器的回调函数,上报的数据类型为HumidityResponse。 |
| options | [Options](#options) | 否 | 可选参数列表,设置上报频率,默认值为200000000ns。 | | options | [Options](#options) | 否 | 可选参数列表,设置上报频率,默认值为200000000ns。 |
- 示例: **示例:**
``` ```
sensor.on(sensor.SensorType.SENSOR_TYPE_ID_HUMIDITY,function(data){ sensor.on(sensor.SensorType.SENSOR_TYPE_ID_HUMIDITY,function(data){
console.info('Humidity: ' + data.humidity); console.info('Humidity: ' + data.humidity);
...@@ -409,14 +409,14 @@ on(type: SensorType.SENSOR_TYPE_ID_BAROMETER, callback: Callback&lt;BarometerRes ...@@ -409,14 +409,14 @@ on(type: SensorType.SENSOR_TYPE_ID_BAROMETER, callback: Callback&lt;BarometerRes
**系统能力**:SystemCapability.Sensors.Sensor **系统能力**:SystemCapability.Sensors.Sensor
- 参数: **参数:**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | | -------- | ---------------------------------------- | ---- | ---------------------------------------- |
| type | [SensorType](#sensortype) | 是 | 要订阅的气压计传感器类型为SENSOR_TYPE_ID_BAROMETER。 | | type | [SensorType](#sensortype) | 是 | 要订阅的气压计传感器类型为SENSOR_TYPE_ID_BAROMETER。 |
| callback | Callback&lt;[BarometerResponse](#barometerresponse)&gt; | 是 | 注册气压计传感器的回调函数,上报的数据类型为BarometerResponse。 | | callback | Callback&lt;[BarometerResponse](#barometerresponse)&gt; | 是 | 注册气压计传感器的回调函数,上报的数据类型为BarometerResponse。 |
| options | [Options](#options) | 否 | 可选参数列表,设置上报频率,默认值为200000000ns。 | | options | [Options](#options) | 否 | 可选参数列表,设置上报频率,默认值为200000000ns。 |
- 示例: **示例:**
``` ```
sensor.on(sensor.SensorType.SENSOR_TYPE_ID_BAROMETER,function(data){ sensor.on(sensor.SensorType.SENSOR_TYPE_ID_BAROMETER,function(data){
console.info('Atmospheric pressure: ' + data.pressure); console.info('Atmospheric pressure: ' + data.pressure);
...@@ -434,14 +434,14 @@ on(type: SensorType.SENSOR_TYPE_ID_HALL, callback: Callback&lt;HallResponse&gt;, ...@@ -434,14 +434,14 @@ on(type: SensorType.SENSOR_TYPE_ID_HALL, callback: Callback&lt;HallResponse&gt;,
**系统能力**:SystemCapability.Sensors.Sensor **系统能力**:SystemCapability.Sensors.Sensor
- 参数: **参数:**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | | -------- | ---------------------------------------- | ---- | ---------------------------------------- |
| type | [SensorType](#sensortype) | 是 | 要订阅的霍尔传感器类型为SENSOR_TYPE_ID_HALL。 | | type | [SensorType](#sensortype) | 是 | 要订阅的霍尔传感器类型为SENSOR_TYPE_ID_HALL。 |
| callback | Callback&lt;[HallResponse](#hallresponse)&gt; | 是 | 注册霍尔传感器的回调函数,上报的数据类型为&nbsp;HallResponse。 | | callback | Callback&lt;[HallResponse](#hallresponse)&gt; | 是 | 注册霍尔传感器的回调函数,上报的数据类型为&nbsp;HallResponse。 |
| options | [Options](#options) | 否 | 可选参数列表,设置上报频率,默认值为200000000ns。 | | options | [Options](#options) | 否 | 可选参数列表,设置上报频率,默认值为200000000ns。 |
- 示例: **示例:**
``` ```
sensor.on(sensor.SensorType.SENSOR_TYPE_ID_HALL,function(data){ sensor.on(sensor.SensorType.SENSOR_TYPE_ID_HALL,function(data){
console.info('Status: ' + data.status); console.info('Status: ' + data.status);
...@@ -459,14 +459,14 @@ on(type: SensorType.SENSOR_TYPE_ID_AMBIENT_LIGHT, callback: Callback&lt;LightRes ...@@ -459,14 +459,14 @@ on(type: SensorType.SENSOR_TYPE_ID_AMBIENT_LIGHT, callback: Callback&lt;LightRes
**系统能力**:SystemCapability.Sensors.Sensor **系统能力**:SystemCapability.Sensors.Sensor
- 参数: **参数:**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | | -------- | ---------------------------------------- | ---- | ---------------------------------------- |
| type | [SensorType](#sensortype) | 是 | 要订阅的环境光传感器类型为SENSOR_TYPE_ID_AMBIENT_LIGHT。 | | type | [SensorType](#sensortype) | 是 | 要订阅的环境光传感器类型为SENSOR_TYPE_ID_AMBIENT_LIGHT。 |
| callback | Callback&lt;[LightResponse](#lightresponse)&gt; | 是 | 注册环境光传感器的回调函数,上报的数据类型为LightResponse。 | | callback | Callback&lt;[LightResponse](#lightresponse)&gt; | 是 | 注册环境光传感器的回调函数,上报的数据类型为LightResponse。 |
| options | [Options](#options) | 否 | 可选参数列表,设置上报频率,默认值为200000000ns。 | | options | [Options](#options) | 否 | 可选参数列表,设置上报频率,默认值为200000000ns。 |
- 示例: **示例:**
``` ```
sensor.on(sensor.SensorType.SENSOR_TYPE_ID_AMBIENT_LIGHT,function(data){ sensor.on(sensor.SensorType.SENSOR_TYPE_ID_AMBIENT_LIGHT,function(data){
console.info(' Illumination: ' + data.intensity); console.info(' Illumination: ' + data.intensity);
...@@ -484,14 +484,14 @@ on(type: SensorType.SENSOR_TYPE_ID_ORIENTATION, callback: Callback&lt;Orientatio ...@@ -484,14 +484,14 @@ on(type: SensorType.SENSOR_TYPE_ID_ORIENTATION, callback: Callback&lt;Orientatio
**系统能力**:SystemCapability.Sensors.Sensor **系统能力**:SystemCapability.Sensors.Sensor
- 参数: **参数:**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | | -------- | ---------------------------------------- | ---- | ---------------------------------------- |
| type | [SensorType](#sensortype) | 是 | 要订阅的方向传感器类型为SENSOR_TYPE_ID_ORIENTATION | | type | [SensorType](#sensortype) | 是 | 要订阅的方向传感器类型为SENSOR_TYPE_ID_ORIENTATION |
| callback | Callback&lt;[OrientationResponse](#orientationresponse)&gt; | 是 | 注册方向传感器的回调函数,上报的数据类型为OrientationResponse。 | | callback | Callback&lt;[OrientationResponse](#orientationresponse)&gt; | 是 | 注册方向传感器的回调函数,上报的数据类型为OrientationResponse。 |
| options | [Options](#options) | 否 | 可选参数列表,设置上报频率,默认值为200000000ns。 | | options | [Options](#options) | 否 | 可选参数列表,设置上报频率,默认值为200000000ns。 |
- 示例: **示例:**
``` ```
sensor.on(sensor.SensorType.SENSOR_TYPE_ID_ORIENTATION,function(data){ sensor.on(sensor.SensorType.SENSOR_TYPE_ID_ORIENTATION,function(data){
console.info('The device rotates at an angle around the X axis: ' + data.beta); 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&lt;HeartRateRe ...@@ -512,14 +512,14 @@ on(type: SensorType.SENSOR_TYPE_ID_HEART_RATE, callback: Callback&lt;HeartRateRe
**系统能力**:SystemCapability.Sensors.Sensor **系统能力**:SystemCapability.Sensors.Sensor
- 参数: **参数:**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | ------------------------------------------------------- | ---- | ------------------------------------------------------------ | | -------- | ---------------------------------------- | ---- | ---------------------------------------- |
| type | [SensorType](#sensortype) | 是 | 要订阅的心率传感器类型为SENSOR_TYPE_ID_HEART_RATE。 | | type | [SensorType](#sensortype) | 是 | 要订阅的心率传感器类型为SENSOR_TYPE_ID_HEART_RATE。 |
| callback | Callback&lt;[HeartRateResponse](#heartrateresponse)&gt; | 是 | 注册一次心率传感器的回调函数,上报的数据类型为HeartRateResponse。 | | callback | Callback&lt;[HeartRateResponse](#heartrateresponse)&gt; | 是 | 注册一次心率传感器的回调函数,上报的数据类型为HeartRateResponse。 |
- 示例: **示例:**
``` ```
sensor.on(sensor.SensorType.SENSOR_TYPE_ID_HEART_RATE,function(data){ 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&lt;Rotatio ...@@ -537,14 +537,14 @@ on(type: SensorType.SENSOR_TYPE_ID_ROTATION_VECTOR,callback: Callback&lt;Rotatio
**系统能力**:SystemCapability.Sensors.Sensor **系统能力**:SystemCapability.Sensors.Sensor
- 参数: **参数:**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | | -------- | ---------------------------------------- | ---- | ---------------------------------------- |
| type | [SensorType](#sensortype) | 是 | 要订阅的旋转矢量传感器类型为SENSOR_TYPE_ID_ROTATION_VECTOR。 | | type | [SensorType](#sensortype) | 是 | 要订阅的旋转矢量传感器类型为SENSOR_TYPE_ID_ROTATION_VECTOR。 |
| callback | Callback&lt;[RotationVectorResponse](#rotationvectorresponse)&gt; | 是 | 注册旋转矢量传感器的回调函数,上报的数据类型为RotationVectorResponse。 | | callback | Callback&lt;[RotationVectorResponse](#rotationvectorresponse)&gt; | 是 | 注册旋转矢量传感器的回调函数,上报的数据类型为RotationVectorResponse。 |
| options | [Options](#options) | 否 | 可选参数列表,设置上报频率,默认值为200000000ns。 | | options | [Options](#options) | 否 | 可选参数列表,设置上报频率,默认值为200000000ns。 |
- 示例: **示例:**
``` ```
sensor.on(sensor.SensorType.SENSOR_TYPE_ID_ROTATION_VECTOR,function(data){ sensor.on(sensor.SensorType.SENSOR_TYPE_ID_ROTATION_VECTOR,function(data){
console.info('X-coordinate component: ' + data.x); console.info('X-coordinate component: ' + data.x);
...@@ -565,14 +565,14 @@ on(type: SensorType.SENSOR_TYPE_ID_WEAR_DETECTION, callback: Callback&lt;WearDet ...@@ -565,14 +565,14 @@ on(type: SensorType.SENSOR_TYPE_ID_WEAR_DETECTION, callback: Callback&lt;WearDet
**系统能力**:SystemCapability.Sensors.Sensor **系统能力**:SystemCapability.Sensors.Sensor
- 参数: **参数:**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | | -------- | ---------------------------------------- | ---- | ---------------------------------------- |
| type | [SensorType](#sensortype) | 是 | 要订阅的佩戴检测传感器类型为SENSOR_TYPE_ID_WEAR_DETECTION。 | | type | [SensorType](#sensortype) | 是 | 要订阅的佩戴检测传感器类型为SENSOR_TYPE_ID_WEAR_DETECTION。 |
| callback | Callback&lt;[WearDetectionResponse](#weardetectionresponse)&gt; | 是 | 注册佩戴检测传感器的回调函数,上报的数据类型为WearDetectionResponse。 | | callback | Callback&lt;[WearDetectionResponse](#weardetectionresponse)&gt; | 是 | 注册佩戴检测传感器的回调函数,上报的数据类型为WearDetectionResponse。 |
| options | [Options](#options) | 否 | 可选参数列表,设置上报频率,默认值为200000000ns。 | | options | [Options](#options) | 否 | 可选参数列表,设置上报频率,默认值为200000000ns。 |
- 示例: **示例:**
``` ```
sensor.on(sensor.SensorType.SENSOR_TYPE_ID_WEAR_DETECTION,function(data){ sensor.on(sensor.SensorType.SENSOR_TYPE_ID_WEAR_DETECTION,function(data){
console.info('Wear status: ' + data.value); console.info('Wear status: ' + data.value);
...@@ -592,13 +592,13 @@ once(type: SensorType.SENSOR_TYPE_ID_ACCELEROMETER, callback: Callback&lt;Accele ...@@ -592,13 +592,13 @@ once(type: SensorType.SENSOR_TYPE_ID_ACCELEROMETER, callback: Callback&lt;Accele
**系统能力**:SystemCapability.Sensors.Sensor **系统能力**:SystemCapability.Sensors.Sensor
- 参数: **参数:**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | | -------- | ---------------------------------------- | ---- | ---------------------------------------- |
| type | [SensorType](#sensortype) | 是 | 加速度传感器类型为SENSOR_TYPE_ID_ACCELEROMETER。 | | type | [SensorType](#sensortype) | 是 | 加速度传感器类型为SENSOR_TYPE_ID_ACCELEROMETER。 |
| callback | Callback&lt;[AccelerometerResponse](#accelerometerresponse)&gt; | 是 | 注册一次加速度传感器的回调函数,上报的数据类型为AccelerometerResponse。 | | callback | Callback&lt;[AccelerometerResponse](#accelerometerresponse)&gt; | 是 | 注册一次加速度传感器的回调函数,上报的数据类型为AccelerometerResponse。 |
- 示例: **示例:**
``` ```
sensor.once(sensor.SensorType.SENSOR_TYPE_ID_ACCELEROMETER,function(data){ sensor.once(sensor.SensorType.SENSOR_TYPE_ID_ACCELEROMETER,function(data){
console.info('X-coordinate component: ' + data.x); console.info('X-coordinate component: ' + data.x);
...@@ -619,13 +619,13 @@ once(type: SensorType.SENSOR_TYPE_ID_LINEAR_ACCELERATION,callback:Callback&lt;Li ...@@ -619,13 +619,13 @@ once(type: SensorType.SENSOR_TYPE_ID_LINEAR_ACCELERATION,callback:Callback&lt;Li
**系统能力**:SystemCapability.Sensors.Sensor **系统能力**:SystemCapability.Sensors.Sensor
- 参数: **参数:**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | | -------- | ---------------------------------------- | ---- | ---------------------------------------- |
| type | [SensorType](#sensortype) | 是 | 线性加速度传感器类型为SENSOR_TYPE_ID_LINEAR_ACCELERATION。 | | type | [SensorType](#sensortype) | 是 | 线性加速度传感器类型为SENSOR_TYPE_ID_LINEAR_ACCELERATION。 |
| callback | Callback&lt;[LinearAccelerometerResponse](#linearaccelerometerresponse)&gt; | 是 | 注册一次线性加速度传感器的回调函数,上报的数据类型为LinearAccelerometerResponse。 | | callback | Callback&lt;[LinearAccelerometerResponse](#linearaccelerometerresponse)&gt; | 是 | 注册一次线性加速度传感器的回调函数,上报的数据类型为LinearAccelerometerResponse。 |
- 示例: **示例:**
``` ```
sensor.once(sensor.SensorType.SENSOR_TYPE_ID_LINEAR_ACCELERATION, function(data) { sensor.once(sensor.SensorType.SENSOR_TYPE_ID_LINEAR_ACCELERATION, function(data) {
console.info('X-coordinate component: ' + data.x); console.info('X-coordinate component: ' + data.x);
...@@ -646,13 +646,13 @@ once(type: SensorType.SENSOR_TYPE_ID_ACCELEROMETER_UNCALIBRATED,callback: Callba ...@@ -646,13 +646,13 @@ once(type: SensorType.SENSOR_TYPE_ID_ACCELEROMETER_UNCALIBRATED,callback: Callba
**系统能力**:SystemCapability.Sensors.Sensor **系统能力**:SystemCapability.Sensors.Sensor
- 参数: **参数:**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | | -------- | ---------------------------------------- | ---- | ---------------------------------------- |
| type | [SensorType](#sensortype) | 是 | 未校准加速度传感器类型为SENSOR_TYPE_ID_ACCELEROMETER_UNCALIBRATED。 | | type | [SensorType](#sensortype) | 是 | 未校准加速度传感器类型为SENSOR_TYPE_ID_ACCELEROMETER_UNCALIBRATED。 |
| callback | Callback&lt;[AccelerometerUncalibratedResponse](#accelerometeruncalibratedresponse)&gt; | 是 | 注册一次未校准加速度传感器的回调函数,上报的数据类型为AccelerometerUncalibratedResponse。 | | callback | Callback&lt;[AccelerometerUncalibratedResponse](#accelerometeruncalibratedresponse)&gt; | 是 | 注册一次未校准加速度传感器的回调函数,上报的数据类型为AccelerometerUncalibratedResponse。 |
- 示例: **示例:**
``` ```
sensor.once(sensor.SensorType.SENSOR_TYPE_ID_ACCELEROMETER_UNCALIBRATED, function(data) { sensor.once(sensor.SensorType.SENSOR_TYPE_ID_ACCELEROMETER_UNCALIBRATED, function(data) {
console.info('X-coordinate component: ' + data.x); console.info('X-coordinate component: ' + data.x);
...@@ -674,13 +674,13 @@ once(type: SensorType.SENSOR_TYPE_ID_GRAVITY, callback: Callback&lt;GravityRespo ...@@ -674,13 +674,13 @@ once(type: SensorType.SENSOR_TYPE_ID_GRAVITY, callback: Callback&lt;GravityRespo
**系统能力**:SystemCapability.Sensors.Sensor **系统能力**:SystemCapability.Sensors.Sensor
- 参数: **参数:**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | | -------- | ---------------------------------------- | ---- | --------------------------------------- |
| type | [SensorType](#sensortype) | 是 | 重力传感器类型为SENSOR_TYPE_ID_GRAVITY。 | | type | [SensorType](#sensortype) | 是 | 重力传感器类型为SENSOR_TYPE_ID_GRAVITY。 |
| callback | Callback&lt;[GravityResponse](#gravityresponse)&gt; | 是 | 注册一次重力传感器的回调函数,上报的数据类型为GravityResponse。 | | callback | Callback&lt;[GravityResponse](#gravityresponse)&gt; | 是 | 注册一次重力传感器的回调函数,上报的数据类型为GravityResponse。 |
- 示例: **示例:**
``` ```
sensor.once(sensor.SensorType.SENSOR_TYPE_ID_GRAVITY, function(data) { sensor.once(sensor.SensorType.SENSOR_TYPE_ID_GRAVITY, function(data) {
console.info('X-coordinate component: ' + data.x); console.info('X-coordinate component: ' + data.x);
...@@ -701,13 +701,13 @@ once(type: SensorType.SENSOR_TYPE_ID_GYROSCOPE, callback: Callback&lt;GyroscopeR ...@@ -701,13 +701,13 @@ once(type: SensorType.SENSOR_TYPE_ID_GYROSCOPE, callback: Callback&lt;GyroscopeR
**系统能力**:SystemCapability.Sensors.Sensor **系统能力**:SystemCapability.Sensors.Sensor
- 参数: **参数:**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | | -------- | ---------------------------------------- | ---- | ---------------------------------------- |
| type | [SensorType](#sensortype) | 是 | 陀螺仪传感器类型为SENSOR_TYPE_ID_GYROSCOPE。 | | type | [SensorType](#sensortype) | 是 | 陀螺仪传感器类型为SENSOR_TYPE_ID_GYROSCOPE。 |
| callback | Callback&lt;[GyroscopeResponse](#gyroscoperesponse)&gt; | 是 | 注册一次陀螺仪传感器的回调函数,上报的数据类型为GyroscopeResponse。 | | callback | Callback&lt;[GyroscopeResponse](#gyroscoperesponse)&gt; | 是 | 注册一次陀螺仪传感器的回调函数,上报的数据类型为GyroscopeResponse。 |
- 示例: **示例:**
``` ```
sensor.once(sensor.SensorType.SENSOR_TYPE_ID_GYROSCOPE, function(data) { sensor.once(sensor.SensorType.SENSOR_TYPE_ID_GYROSCOPE, function(data) {
console.info('X-coordinate component: ' + data.x); console.info('X-coordinate component: ' + data.x);
...@@ -728,13 +728,13 @@ once(type: SensorType.SENSOR_TYPE_ID_GYROSCOPE_UNCALIBRATED,callback: Callback&l ...@@ -728,13 +728,13 @@ once(type: SensorType.SENSOR_TYPE_ID_GYROSCOPE_UNCALIBRATED,callback: Callback&l
**系统能力**:SystemCapability.Sensors.Sensor **系统能力**:SystemCapability.Sensors.Sensor
- 参数: **参数:**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | | -------- | ---------------------------------------- | ---- | ---------------------------------------- |
| type | [SensorType](#sensortype) | 是 | 未校准陀螺仪传感器类型为SENSOR_TYPE_ID_GYROSCOPE_UNCALIBRATED。 | | type | [SensorType](#sensortype) | 是 | 未校准陀螺仪传感器类型为SENSOR_TYPE_ID_GYROSCOPE_UNCALIBRATED。 |
| callback | Callback&lt;[GyroscopeUncalibratedResponse](#gyroscopeuncalibratedresponse)&gt; | 是 | 注册一次未校准陀螺仪传感器的回调函数,上报的数据类型为GyroscopeUncalibratedResponse。 | | callback | Callback&lt;[GyroscopeUncalibratedResponse](#gyroscopeuncalibratedresponse)&gt; | 是 | 注册一次未校准陀螺仪传感器的回调函数,上报的数据类型为GyroscopeUncalibratedResponse。 |
- 示例: **示例:**
``` ```
sensor.once(sensor.SensorType.SENSOR_TYPE_ID_GYROSCOPE_UNCALIBRATED, function(data) { sensor.once(sensor.SensorType.SENSOR_TYPE_ID_GYROSCOPE_UNCALIBRATED, function(data) {
console.info('X-coordinate component: ' + data.x); console.info('X-coordinate component: ' + data.x);
...@@ -756,13 +756,13 @@ once(type: SensorType.SENSOR_TYPE_ID_SIGNIFICANT_MOTION,callback: Callback&lt;Si ...@@ -756,13 +756,13 @@ once(type: SensorType.SENSOR_TYPE_ID_SIGNIFICANT_MOTION,callback: Callback&lt;Si
**系统能力**:SystemCapability.Sensors.Sensor **系统能力**:SystemCapability.Sensors.Sensor
- 参数: **参数:**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | | -------- | ---------------------------------------- | ---- | ---------------------------------------- |
| type | [SensorType](#sensortype) | 是 | 有效运动传感器类型为SENSOR_TYPE_ID_SIGNIFICANT_MOTION。 | | type | [SensorType](#sensortype) | 是 | 有效运动传感器类型为SENSOR_TYPE_ID_SIGNIFICANT_MOTION。 |
| callback | Callback&lt;[SignificantMotionResponse](#significantmotionresponse)&gt; | 是 | 注册一次有效运动传感器的回调函数,上报的数据类型为SignificantMotionResponse。 | | callback | Callback&lt;[SignificantMotionResponse](#significantmotionresponse)&gt; | 是 | 注册一次有效运动传感器的回调函数,上报的数据类型为SignificantMotionResponse。 |
- 示例: **示例:**
``` ```
sensor.once(sensor.SensorType.SENSOR_TYPE_ID_SIGNIFICANT_MOTION, function(data) { sensor.once(sensor.SensorType.SENSOR_TYPE_ID_SIGNIFICANT_MOTION, function(data) {
console.info('Scalar data: ' + data.scalar); console.info('Scalar data: ' + data.scalar);
...@@ -781,13 +781,13 @@ once(type: SensorType.SENSOR_TYPE_ID_PEDOMETER_DETECTION,callback: Callback&lt;P ...@@ -781,13 +781,13 @@ once(type: SensorType.SENSOR_TYPE_ID_PEDOMETER_DETECTION,callback: Callback&lt;P
**系统能力**:SystemCapability.Sensors.Sensor **系统能力**:SystemCapability.Sensors.Sensor
- 参数: **参数:**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | | -------- | ---------------------------------------- | ---- | ---------------------------------------- |
| type | [SensorType](#sensortype) | 是 | 计步检测传感器类型为SENSOR_TYPE_ID_PEDOMETER_DETECTION。 | | type | [SensorType](#sensortype) | 是 | 计步检测传感器类型为SENSOR_TYPE_ID_PEDOMETER_DETECTION。 |
| callback | Callback&lt;[PedometerDetectionResponse](#pedometerdetectionresponse)&gt; | 是 | 注册一次计步检测传感器的回调函数,上报的数据类型为PedometerDetectionResponse。 | | callback | Callback&lt;[PedometerDetectionResponse](#pedometerdetectionresponse)&gt; | 是 | 注册一次计步检测传感器的回调函数,上报的数据类型为PedometerDetectionResponse。 |
- 示例: **示例:**
``` ```
sensor.once(sensor.SensorType.SENSOR_TYPE_ID_PEDOMETER_DETECTION, function(data) { sensor.once(sensor.SensorType.SENSOR_TYPE_ID_PEDOMETER_DETECTION, function(data) {
console.info('Scalar data: ' + data.scalar); console.info('Scalar data: ' + data.scalar);
...@@ -806,13 +806,13 @@ once(type: SensorType.SENSOR_TYPE_ID_PEDOMETER, callback: Callback&lt;PedometerR ...@@ -806,13 +806,13 @@ once(type: SensorType.SENSOR_TYPE_ID_PEDOMETER, callback: Callback&lt;PedometerR
**系统能力**:SystemCapability.Sensors.Sensor **系统能力**:SystemCapability.Sensors.Sensor
- 参数: **参数:**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | | -------- | ---------------------------------------- | ---- | ---------------------------------------- |
| type | [SensorType](#sensortype) | 是 | 计步传感器类型为SENSOR_TYPE_ID_PEDOMETER。 | | type | [SensorType](#sensortype) | 是 | 计步传感器类型为SENSOR_TYPE_ID_PEDOMETER。 |
| callback | Callback&lt;[PedometerResponse](#pedometerresponse)&gt; | 是 | 注册一次计步传感器的回调函数,上报的数据类型为PedometerResponse。 | | callback | Callback&lt;[PedometerResponse](#pedometerresponse)&gt; | 是 | 注册一次计步传感器的回调函数,上报的数据类型为PedometerResponse。 |
- 示例: **示例:**
``` ```
sensor.once(sensor.SensorType.SENSOR_TYPE_ID_PEDOMETER, function(data) { sensor.once(sensor.SensorType.SENSOR_TYPE_ID_PEDOMETER, function(data) {
console.info('Steps: ' + data.steps); console.info('Steps: ' + data.steps);
...@@ -829,13 +829,13 @@ once(type: SensorType.SENSOR_TYPE_ID_AMBIENT_TEMPERATURE,callback: Callback&lt;A ...@@ -829,13 +829,13 @@ once(type: SensorType.SENSOR_TYPE_ID_AMBIENT_TEMPERATURE,callback: Callback&lt;A
**系统能力**:SystemCapability.Sensors.Sensor **系统能力**:SystemCapability.Sensors.Sensor
- 参数: **参数:**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | | -------- | ---------------------------------------- | ---- | ---------------------------------------- |
| type | [SensorType](#sensortype) | 是 | 环境温度传感器类型为SENSOR_TYPE_ID_AMBIENT_TEMPERATURE。 | | type | [SensorType](#sensortype) | 是 | 环境温度传感器类型为SENSOR_TYPE_ID_AMBIENT_TEMPERATURE。 |
| callback | Callback&lt;[AmbientTemperatureResponse](#ambienttemperatureresponse)&gt; | 是 | 注册一次环境温度传感器的回调函数,上报的数据类型为AmbientTemperatureResponse。 | | callback | Callback&lt;[AmbientTemperatureResponse](#ambienttemperatureresponse)&gt; | 是 | 注册一次环境温度传感器的回调函数,上报的数据类型为AmbientTemperatureResponse。 |
- 示例: **示例:**
``` ```
sensor.once(sensor.SensorType.SENSOR_TYPE_ID_AMBIENT_TEMPERATURE, function(data) { sensor.once(sensor.SensorType.SENSOR_TYPE_ID_AMBIENT_TEMPERATURE, function(data) {
console.info('Temperature: ' + data.temperature); console.info('Temperature: ' + data.temperature);
...@@ -852,13 +852,13 @@ once(type: SensorType.SENSOR_TYPE_ID_MAGNETIC_FIELD, callback: Callback&lt;Magne ...@@ -852,13 +852,13 @@ once(type: SensorType.SENSOR_TYPE_ID_MAGNETIC_FIELD, callback: Callback&lt;Magne
**系统能力**:SystemCapability.Sensors.Sensor **系统能力**:SystemCapability.Sensors.Sensor
- 参数: **参数:**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | | -------- | ---------------------------------------- | ---- | ---------------------------------------- |
| type | [SensorType](#sensortype) | 是 | 磁场传感器类型为SENSOR_TYPE_ID_MAGNETIC_FIELD。 | | type | [SensorType](#sensortype) | 是 | 磁场传感器类型为SENSOR_TYPE_ID_MAGNETIC_FIELD。 |
| callback | Callback&lt;[MagneticFieldResponse](#magneticfieldresponse)&gt; | 是 | 注册一次磁场传感器的回调函数,上报的数据类型为MagneticFieldResponse。 | | callback | Callback&lt;[MagneticFieldResponse](#magneticfieldresponse)&gt; | 是 | 注册一次磁场传感器的回调函数,上报的数据类型为MagneticFieldResponse。 |
- 示例: **示例:**
``` ```
sensor.once(sensor.SensorType.SENSOR_TYPE_ID_MAGNETIC_FIELD, function(data) { sensor.once(sensor.SensorType.SENSOR_TYPE_ID_MAGNETIC_FIELD, function(data) {
console.info('X-coordinate component: ' + data.x); console.info('X-coordinate component: ' + data.x);
...@@ -877,13 +877,13 @@ once(type: SensorType.SENSOR_TYPE_ID_MAGNETIC_FIELD_UNCALIBRATED,callback: Callb ...@@ -877,13 +877,13 @@ once(type: SensorType.SENSOR_TYPE_ID_MAGNETIC_FIELD_UNCALIBRATED,callback: Callb
**系统能力**:SystemCapability.Sensors.Sensor **系统能力**:SystemCapability.Sensors.Sensor
- 参数: **参数:**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | | -------- | ---------------------------------------- | ---- | ---------------------------------------- |
| type | [SensorType](#sensortype) | 是 | 未校准磁场传感器类型为SENSOR_TYPE_ID_MAGNETIC_FIELD_UNCALIBRATED。 | | type | [SensorType](#sensortype) | 是 | 未校准磁场传感器类型为SENSOR_TYPE_ID_MAGNETIC_FIELD_UNCALIBRATED。 |
| callback | Callback&lt;[MagneticFieldUncalibratedResponse](#magneticfielduncalibratedresponse)&gt; | 是 | 注册一次未校准磁场传感器的回调函数,上报的数据类型为MagneticFieldUncalibratedResponse。 | | callback | Callback&lt;[MagneticFieldUncalibratedResponse](#magneticfielduncalibratedresponse)&gt; | 是 | 注册一次未校准磁场传感器的回调函数,上报的数据类型为MagneticFieldUncalibratedResponse。 |
- 示例: **示例:**
``` ```
sensor.once(sensor.SensorType.SENSOR_TYPE_ID_MAGNETIC_FIELD_UNCALIBRATED, function(data) { sensor.once(sensor.SensorType.SENSOR_TYPE_ID_MAGNETIC_FIELD_UNCALIBRATED, function(data) {
console.info('X-coordinate component: ' + data.x); console.info('X-coordinate component: ' + data.x);
...@@ -905,13 +905,13 @@ once(type: SensorType.SENSOR_TYPE_ID_PROXIMITY, callback: Callback&lt;ProximityR ...@@ -905,13 +905,13 @@ once(type: SensorType.SENSOR_TYPE_ID_PROXIMITY, callback: Callback&lt;ProximityR
**系统能力**:SystemCapability.Sensors.Sensor **系统能力**:SystemCapability.Sensors.Sensor
- 参数: **参数:**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | | -------- | ---------------------------------------- | ---- | ---------------------------------------- |
| type | [SensorType](#sensortype) | 是 | 接近光传感器类型为SENSOR_TYPE_ID_PROXIMITY。 | | type | [SensorType](#sensortype) | 是 | 接近光传感器类型为SENSOR_TYPE_ID_PROXIMITY。 |
| callback | Callback&lt;[ProximityResponse](#proximityresponse)&gt; | 是 | 注册一次接近光传感器的回调函数,上报的数据类型为ProximityResponse。 | | callback | Callback&lt;[ProximityResponse](#proximityresponse)&gt; | 是 | 注册一次接近光传感器的回调函数,上报的数据类型为ProximityResponse。 |
- 示例: **示例:**
``` ```
sensor.once(sensor.SensorType.SENSOR_TYPE_ID_PROXIMITY, function(error, data) { sensor.once(sensor.SensorType.SENSOR_TYPE_ID_PROXIMITY, function(error, data) {
if (error) { if (error) {
...@@ -932,13 +932,13 @@ once(type: SensorType.SENSOR_TYPE_ID_HUMIDITY, callback: Callback&lt;HumidityRes ...@@ -932,13 +932,13 @@ once(type: SensorType.SENSOR_TYPE_ID_HUMIDITY, callback: Callback&lt;HumidityRes
**系统能力**:SystemCapability.Sensors.Sensor **系统能力**:SystemCapability.Sensors.Sensor
- 参数: **参数:**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | | -------- | ---------------------------------------- | ---- | ---------------------------------------- |
| type | [SensorType](#sensortype) | 是 | 湿度传感器类型为SENSOR_TYPE_ID_HUMIDITY。 | | type | [SensorType](#sensortype) | 是 | 湿度传感器类型为SENSOR_TYPE_ID_HUMIDITY。 |
| callback | Callback&lt;[HumidityResponse](#humidityresponse)&gt; | 是 | 注册一次湿度传感器的回调函数,上报的数据类型为HumidityResponse。 | | callback | Callback&lt;[HumidityResponse](#humidityresponse)&gt; | 是 | 注册一次湿度传感器的回调函数,上报的数据类型为HumidityResponse。 |
- 示例: **示例:**
``` ```
sensor.once(sensor.SensorType.SENSOR_TYPE_ID_HUMIDITY, function(data) { sensor.once(sensor.SensorType.SENSOR_TYPE_ID_HUMIDITY, function(data) {
console.info('Humidity: ' + data.humidity); console.info('Humidity: ' + data.humidity);
...@@ -955,13 +955,13 @@ once(type: SensorType.SENSOR_TYPE_ID_BAROMETER, callback: Callback&lt;BarometerR ...@@ -955,13 +955,13 @@ once(type: SensorType.SENSOR_TYPE_ID_BAROMETER, callback: Callback&lt;BarometerR
**系统能力**:SystemCapability.Sensors.Sensor **系统能力**:SystemCapability.Sensors.Sensor
- 参数: **参数:**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | | -------- | ---------------------------------------- | ---- | ---------------------------------------- |
| type | [SensorType](#sensortype) | 是 | 气压计传感器类型为SENSOR_TYPE_ID_BAROMETER。 | | type | [SensorType](#sensortype) | 是 | 气压计传感器类型为SENSOR_TYPE_ID_BAROMETER。 |
| callback | Callback&lt;[BarometerResponse](#barometerresponse)&gt; | 是 | 注册一次气压计传感器的回调函数,上报的数据类型为BarometerResponse。 | | callback | Callback&lt;[BarometerResponse](#barometerresponse)&gt; | 是 | 注册一次气压计传感器的回调函数,上报的数据类型为BarometerResponse。 |
- 示例: **示例:**
``` ```
sensor.once(sensor.SensorType.SENSOR_TYPE_ID_BAROMETER, function(data) { sensor.once(sensor.SensorType.SENSOR_TYPE_ID_BAROMETER, function(data) {
console.info('Atmospheric pressure: ' + data.pressure); console.info('Atmospheric pressure: ' + data.pressure);
...@@ -978,13 +978,13 @@ once(type: SensorType.SENSOR_TYPE_ID_HALL, callback: Callback&lt;HallResponse&gt ...@@ -978,13 +978,13 @@ once(type: SensorType.SENSOR_TYPE_ID_HALL, callback: Callback&lt;HallResponse&gt
**系统能力**:SystemCapability.Sensors.Sensor **系统能力**:SystemCapability.Sensors.Sensor
- 参数: **参数:**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | | -------- | ---------------------------------------- | ---- | ------------------------------------ |
| type | [SensorType](#sensortype) | 是 | 霍尔传感器类型为SENSOR_TYPE_ID_HALL。 | | type | [SensorType](#sensortype) | 是 | 霍尔传感器类型为SENSOR_TYPE_ID_HALL。 |
| callback | Callback&lt;[HallResponse](#hallresponse)&gt; | 是 | 注册一次霍尔传感器的回调函数,上报的数据类型为HallResponse。 | | callback | Callback&lt;[HallResponse](#hallresponse)&gt; | 是 | 注册一次霍尔传感器的回调函数,上报的数据类型为HallResponse。 |
- 示例: **示例:**
``` ```
sensor.once(sensor.SensorType.SENSOR_TYPE_ID_HALL, function(data) { sensor.once(sensor.SensorType.SENSOR_TYPE_ID_HALL, function(data) {
console.info('Status: ' + data.status); console.info('Status: ' + data.status);
...@@ -1001,13 +1001,13 @@ once(type: SensorType.SENSOR_TYPE_ID_AMBIENT_LIGHT, callback: Callback&lt;LightR ...@@ -1001,13 +1001,13 @@ once(type: SensorType.SENSOR_TYPE_ID_AMBIENT_LIGHT, callback: Callback&lt;LightR
**系统能力**:SystemCapability.Sensors.Sensor **系统能力**:SystemCapability.Sensors.Sensor
- 参数: **参数:**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | | -------- | ---------------------------------------- | ---- | -------------------------------------- |
| type | [SensorType](#sensortype) | 是 | 环境光传感器类型为SENSOR_TYPE_ID_AMBIENT_LIGHT。 | | type | [SensorType](#sensortype) | 是 | 环境光传感器类型为SENSOR_TYPE_ID_AMBIENT_LIGHT。 |
| callback | Callback&lt;[LightResponse](#lightresponse)&gt; | 是 | 注册一次环境光传感器的回调函数,上报的数据类型为LightResponse。 | | callback | Callback&lt;[LightResponse](#lightresponse)&gt; | 是 | 注册一次环境光传感器的回调函数,上报的数据类型为LightResponse。 |
- 示例: **示例:**
``` ```
sensor.once(sensor.SensorType.SENSOR_TYPE_ID_AMBIENT_LIGHT, function(data) { sensor.once(sensor.SensorType.SENSOR_TYPE_ID_AMBIENT_LIGHT, function(data) {
console.info(' Illumination: ' + data.intensity); console.info(' Illumination: ' + data.intensity);
...@@ -1024,13 +1024,13 @@ once(type: SensorType.SENSOR_TYPE_ID_ORIENTATION, callback: Callback&lt;Orientat ...@@ -1024,13 +1024,13 @@ once(type: SensorType.SENSOR_TYPE_ID_ORIENTATION, callback: Callback&lt;Orientat
**系统能力**:SystemCapability.Sensors.Sensor **系统能力**:SystemCapability.Sensors.Sensor
- 参数: **参数:**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | | -------- | ---------------------------------------- | ---- | ---------------------------------------- |
| type | [SensorType](#sensortype) | 是 | 方向传感器类型为SENSOR_TYPE_ID_ORIENTATION。 | | type | [SensorType](#sensortype) | 是 | 方向传感器类型为SENSOR_TYPE_ID_ORIENTATION。 |
| callback | Callback&lt;[OrientationResponse](#orientationresponse)&gt; | 是 | 注册一次方向传感器的回调函数,上报的数据类型为OrientationResponse。 | | callback | Callback&lt;[OrientationResponse](#orientationresponse)&gt; | 是 | 注册一次方向传感器的回调函数,上报的数据类型为OrientationResponse。 |
- 示例: **示例:**
``` ```
sensor.once(sensor.SensorType.SENSOR_TYPE_ID_ORIENTATION, function(data) { sensor.once(sensor.SensorType.SENSOR_TYPE_ID_ORIENTATION, function(data) {
console.info('The device rotates at an angle around the X axis: ' + data.beta); 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&lt;Rota ...@@ -1049,13 +1049,13 @@ once(type: SensorType.SENSOR_TYPE_ID_ROTATION_VECTOR, callback: Callback&lt;Rota
**系统能力**:SystemCapability.Sensors.Sensor **系统能力**:SystemCapability.Sensors.Sensor
- 参数: **参数:**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | | -------- | ---------------------------------------- | ---- | ---------------------------------------- |
| type | [SensorType](#sensortype) | 是 | 旋转矢量传感器类型为SENSOR_TYPE_ID_ROTATION_VECTOR。 | | type | [SensorType](#sensortype) | 是 | 旋转矢量传感器类型为SENSOR_TYPE_ID_ROTATION_VECTOR。 |
| callback | Callback&lt;[RotationVectorResponse](#rotationvectorresponse)&gt; | 是 | 注册一次旋转矢量传感器的回调函数,上报的数据类型为RotationVectorResponse。 | | callback | Callback&lt;[RotationVectorResponse](#rotationvectorresponse)&gt; | 是 | 注册一次旋转矢量传感器的回调函数,上报的数据类型为RotationVectorResponse。 |
- 示例: **示例:**
``` ```
sensor.once(sensor.SensorType.SENSOR_TYPE_ID_ROTATION_VECTOR, function(data) { sensor.once(sensor.SensorType.SENSOR_TYPE_ID_ROTATION_VECTOR, function(data) {
console.info('X-coordinate component: ' + data.x); console.info('X-coordinate component: ' + data.x);
...@@ -1077,13 +1077,13 @@ once(type: SensorType.SENSOR_TYPE_ID_HEART_RATE, callback: Callback&lt;HeartRate ...@@ -1077,13 +1077,13 @@ once(type: SensorType.SENSOR_TYPE_ID_HEART_RATE, callback: Callback&lt;HeartRate
**系统能力**:SystemCapability.Sensors.Sensor **系统能力**:SystemCapability.Sensors.Sensor
- 参数: **参数:**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | | -------- | ---------------------------------------- | ---- | ---------------------------------------- |
| type | [SensorType](#sensortype) | 是 | 心率传感器类型为SENSOR_TYPE_ID_HEART_RATE。 | | type | [SensorType](#sensortype) | 是 | 心率传感器类型为SENSOR_TYPE_ID_HEART_RATE。 |
| callback | Callback&lt;[HeartRateResponse](#heartrateresponse)&gt; | 是 | 注册一次心率传感器的回调函数,上报的数据类型为HeartRateResponse。 | | callback | Callback&lt;[HeartRateResponse](#heartrateresponse)&gt; | 是 | 注册一次心率传感器的回调函数,上报的数据类型为HeartRateResponse。 |
- 示例: **示例:**
``` ```
sensor.once(sensor.SensorType.SENSOR_TYPE_ID_HEART_RATE, function(data) { sensor.once(sensor.SensorType.SENSOR_TYPE_ID_HEART_RATE, function(data) {
console.info("Heart rate: " + data.heartRate); console.info("Heart rate: " + data.heartRate);
...@@ -1100,13 +1100,13 @@ once(type: SensorType.SENSOR_TYPE_ID_WEAR_DETECTION, callback: Callback&lt;WearD ...@@ -1100,13 +1100,13 @@ once(type: SensorType.SENSOR_TYPE_ID_WEAR_DETECTION, callback: Callback&lt;WearD
**系统能力**:SystemCapability.Sensors.Sensor **系统能力**:SystemCapability.Sensors.Sensor
- 参数: **参数:**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | | -------- | ---------------------------------------- | ---- | ---------------------------------------- |
| type | [SensorType](#sensortype) | 是 | 佩戴检测传感器类型为SENSOR_TYPE_ID_WEAR_DETECTION。 | | type | [SensorType](#sensortype) | 是 | 佩戴检测传感器类型为SENSOR_TYPE_ID_WEAR_DETECTION。 |
| callback | Callback&lt;[WearDetectionResponse](#weardetectionresponse)&gt; | 是 | 注册一次穿戴检测传感器的回调函数,上报的数据类型为WearDetectionResponse。 | | callback | Callback&lt;[WearDetectionResponse](#weardetectionresponse)&gt; | 是 | 注册一次穿戴检测传感器的回调函数,上报的数据类型为WearDetectionResponse。 |
- 示例: **示例:**
``` ```
sensor.once(sensor.SensorType.SENSOR_TYPE_ID_WEAR_DETECTION, function(data) { sensor.once(sensor.SensorType.SENSOR_TYPE_ID_WEAR_DETECTION, function(data) {
console.info("Wear status: "+ data.value); console.info("Wear status: "+ data.value);
...@@ -1124,14 +1124,14 @@ off(type: SensorType.SENSOR_TYPE_ID_ACCELEROMETER, callback?: Callback&lt;Accele ...@@ -1124,14 +1124,14 @@ off(type: SensorType.SENSOR_TYPE_ID_ACCELEROMETER, callback?: Callback&lt;Accele
**系统能力**:SystemCapability.Sensors.Sensor **系统能力**:SystemCapability.Sensors.Sensor
- 参数: **参数:**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | ------------------------------------------------------------ | ---- | ------------------------------------------------------------ | | -------- | ---------------------------------------- | ---- | ---------------------------------------- |
| type | [SensorType](#sensortype) | 是 | 要取消订阅的加速度传感器类型为SENSOR_TYPE_ID_ACCELEROMETER。 | | type | [SensorType](#sensortype) | 是 | 要取消订阅的加速度传感器类型为SENSOR_TYPE_ID_ACCELEROMETER。 |
| callback | Callback&lt;[AccelerometerResponse](#accelerometerresponse)&gt; | 是 | 取消注册加速度传感器的回调函数,上报的数据类型为AccelerometerResponse。 | | callback | Callback&lt;[AccelerometerResponse](#accelerometerresponse)&gt; | 是 | 取消注册加速度传感器的回调函数,上报的数据类型为AccelerometerResponse。 |
- 示例: **示例:**
``` ```
function callback(data) { function callback(data) {
...@@ -1152,14 +1152,14 @@ off(type: SensorType.SENSOR_TYPE_ID_ACCELEROMETER_UNCALIBRATED, callback?: Callb ...@@ -1152,14 +1152,14 @@ off(type: SensorType.SENSOR_TYPE_ID_ACCELEROMETER_UNCALIBRATED, callback?: Callb
**系统能力**:SystemCapability.Sensors.Sensor **系统能力**:SystemCapability.Sensors.Sensor
- 参数: **参数:**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | ------------------------------------------------------------ | ---- | ------------------------------------------------------------ | | -------- | ---------------------------------------- | ---- | ---------------------------------------- |
| type | [SensorType](#sensortype) | 是 | 要取消订阅的未校准加速度计传感器类型为SENSOR_TYPE_ID_ACCELEROMETER_UNCALIBRATED。 | | type | [SensorType](#sensortype) | 是 | 要取消订阅的未校准加速度计传感器类型为SENSOR_TYPE_ID_ACCELEROMETER_UNCALIBRATED。 |
| callback | Callback&lt;[AccelerometerUncalibratedResponse](#accelerometeruncalibratedresponse)&gt; | 是 | 取消注册未校准加速度计传感器的回调函数,上报的数据类型为AccelerometerUncalibratedResponse。 | | callback | Callback&lt;[AccelerometerUncalibratedResponse](#accelerometeruncalibratedresponse)&gt; | 是 | 取消注册未校准加速度计传感器的回调函数,上报的数据类型为AccelerometerUncalibratedResponse。 |
- 示例: **示例:**
``` ```
function callback(data) { function callback(data) {
...@@ -1181,14 +1181,14 @@ off(type: SensorType.SENSOR_TYPE_ID_AMBIENT_LIGHT, callback?: Callback&lt;LightR ...@@ -1181,14 +1181,14 @@ off(type: SensorType.SENSOR_TYPE_ID_AMBIENT_LIGHT, callback?: Callback&lt;LightR
**系统能力**:SystemCapability.Sensors.Sensor **系统能力**:SystemCapability.Sensors.Sensor
- 参数: **参数:**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | ----------------------------------------------- | ---- | ------------------------------------------------------------ | | -------- | ---------------------------------------- | ---- | ---------------------------------------- |
| type | [SensorType](#sensortype) | 是 | 要取消订阅的环境光传感器类型为SENSOR_TYPE_ID_AMBIENT_LIGHT。 | | type | [SensorType](#sensortype) | 是 | 要取消订阅的环境光传感器类型为SENSOR_TYPE_ID_AMBIENT_LIGHT。 |
| callback | Callback&lt;[LightResponse](#lightresponse)&gt; | 是 | 取消注册环境光传感器的回调函数,上报的数据类型为LightResponse。 | | callback | Callback&lt;[LightResponse](#lightresponse)&gt; | 是 | 取消注册环境光传感器的回调函数,上报的数据类型为LightResponse。 |
- 示例: **示例:**
``` ```
function callback(data) { function callback(data) {
...@@ -1205,14 +1205,14 @@ off(type: SensorType.SENSOR_TYPE_ID_AMBIENT_TEMPERATURE, callback?: Callback&lt; ...@@ -1205,14 +1205,14 @@ off(type: SensorType.SENSOR_TYPE_ID_AMBIENT_TEMPERATURE, callback?: Callback&lt;
**系统能力**:SystemCapability.Sensors.Sensor **系统能力**:SystemCapability.Sensors.Sensor
- 参数: **参数:**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | ------------------------------------------------------------ | ---- | ------------------------------------------------------------ | | -------- | ---------------------------------------- | ---- | ---------------------------------------- |
| type | [SensorType](#sensortype) | 是 | 要取消订阅的环境温度传感器类型为SENSOR_TYPE_ID_AMBIENT_TEMPERATURE。 | | type | [SensorType](#sensortype) | 是 | 要取消订阅的环境温度传感器类型为SENSOR_TYPE_ID_AMBIENT_TEMPERATURE。 |
| callback | Callback&lt;[AmbientTemperatureResponse](#ambienttemperatureresponse)&gt; | 是 | 取消注册环境温度传感器的回调函数,上报的数据类型为AmbientTemperatureResponse。 | | callback | Callback&lt;[AmbientTemperatureResponse](#ambienttemperatureresponse)&gt; | 是 | 取消注册环境温度传感器的回调函数,上报的数据类型为AmbientTemperatureResponse。 |
- 示例: **示例:**
``` ```
function callback(data) { function callback(data) {
...@@ -1229,14 +1229,14 @@ off(type: SensorType.SENSOR_TYPE_ID_BAROMETER, callback?: Callback&lt;BarometerR ...@@ -1229,14 +1229,14 @@ off(type: SensorType.SENSOR_TYPE_ID_BAROMETER, callback?: Callback&lt;BarometerR
**系统能力**:SystemCapability.Sensors.Sensor **系统能力**:SystemCapability.Sensors.Sensor
- 参数: **参数:**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | ------------------------------------------------------- | ---- | ------------------------------------------------------------ | | -------- | ---------------------------------------- | ---- | ---------------------------------------- |
| type | [SensorType](#sensortype) | 是 | 要取消订阅的气压计传感器类型为SENSOR_TYPE_ID_BAROMETER。 | | type | [SensorType](#sensortype) | 是 | 要取消订阅的气压计传感器类型为SENSOR_TYPE_ID_BAROMETER。 |
| callback | Callback&lt;[BarometerResponse](#barometerresponse)&gt; | 是 | 取消注册气压计传感器的回调函数,上报的数据类型为BarometerResponse。 | | callback | Callback&lt;[BarometerResponse](#barometerresponse)&gt; | 是 | 取消注册气压计传感器的回调函数,上报的数据类型为BarometerResponse。 |
- 示例: **示例:**
``` ```
function callback(data) { function callback(data) {
...@@ -1253,14 +1253,14 @@ off(type: SensorType.SENSOR_TYPE_ID_GRAVITY, callback?: Callback&lt;GravityRespo ...@@ -1253,14 +1253,14 @@ off(type: SensorType.SENSOR_TYPE_ID_GRAVITY, callback?: Callback&lt;GravityRespo
**系统能力**:SystemCapability.Sensors.Sensor **系统能力**:SystemCapability.Sensors.Sensor
- 参数: **参数:**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | --------------------------------------------------- | ---- | ------------------------------------------------------------ | | -------- | ---------------------------------------- | ---- | ---------------------------------------- |
| type | [SensorType](#sensortype) | 是 | 要取消订阅的重力传感器类型为SENSOR_TYPE_ID_GRAVITY。 | | type | [SensorType](#sensortype) | 是 | 要取消订阅的重力传感器类型为SENSOR_TYPE_ID_GRAVITY。 |
| callback | Callback&lt;[GravityResponse](#gravityresponse)&gt; | 是 | 取消注册注册重力传感器的回调函数,上报的数据类型为GravityResponse。 | | callback | Callback&lt;[GravityResponse](#gravityresponse)&gt; | 是 | 取消注册注册重力传感器的回调函数,上报的数据类型为GravityResponse。 |
- 示例: **示例:**
``` ```
function callback(data) { function callback(data) {
...@@ -1281,14 +1281,14 @@ off(type: SensorType.SENSOR_TYPE_ID_GYROSCOPE, callback?: Callback&lt;GyroscopeR ...@@ -1281,14 +1281,14 @@ off(type: SensorType.SENSOR_TYPE_ID_GYROSCOPE, callback?: Callback&lt;GyroscopeR
**系统能力**:SystemCapability.Sensors.Sensor **系统能力**:SystemCapability.Sensors.Sensor
- 参数: **参数:**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | ------------------------------------------------------- | ---- | ------------------------------------------------------------ | | -------- | ---------------------------------------- | ---- | ---------------------------------------- |
| type | [SensorType](#sensortype) | 是 | 要取消订阅的陀螺仪传感器类型为SENSOR_TYPE_ID_GYROSCOPE。 | | type | [SensorType](#sensortype) | 是 | 要取消订阅的陀螺仪传感器类型为SENSOR_TYPE_ID_GYROSCOPE。 |
| callback | Callback&lt;[GyroscopeResponse](#gyroscoperesponse)&gt; | 是 | 取消注册陀螺仪传感器的回调函数,上报的数据类型为GyroscopeResponse。 | | callback | Callback&lt;[GyroscopeResponse](#gyroscoperesponse)&gt; | 是 | 取消注册陀螺仪传感器的回调函数,上报的数据类型为GyroscopeResponse。 |
- 示例: **示例:**
``` ```
function callback(data) { function callback(data) {
...@@ -1309,14 +1309,14 @@ off(type: SensorType.SENSOR_TYPE_ID_GYROSCOPE_UNCALIBRATED, callback?: Callback& ...@@ -1309,14 +1309,14 @@ off(type: SensorType.SENSOR_TYPE_ID_GYROSCOPE_UNCALIBRATED, callback?: Callback&
**系统能力**:SystemCapability.Sensors.Sensor **系统能力**:SystemCapability.Sensors.Sensor
- 参数: **参数:**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | ------------------------------------------------------------ | ---- | ------------------------------------------------------------ | | -------- | ---------------------------------------- | ---- | ---------------------------------------- |
| type | [SensorType](#sensortype) | 是 | 要取消订阅的未校准陀螺仪传感器类型为SENSOR_TYPE_ID_GYROSCOPE_UNCALIBRATED。 | | type | [SensorType](#sensortype) | 是 | 要取消订阅的未校准陀螺仪传感器类型为SENSOR_TYPE_ID_GYROSCOPE_UNCALIBRATED。 |
| callback | Callback&lt;[GyroscopeUncalibratedResponse](#gyroscopeuncalibratedresponse)&gt; | 是 | 取消注册未校准陀螺仪传感器的回调函数,上报的数据类型为GyroscopeUncalibratedResponse。 | | callback | Callback&lt;[GyroscopeUncalibratedResponse](#gyroscopeuncalibratedresponse)&gt; | 是 | 取消注册未校准陀螺仪传感器的回调函数,上报的数据类型为GyroscopeUncalibratedResponse。 |
- 示例: **示例:**
``` ```
function callback(data) { function callback(data) {
...@@ -1335,14 +1335,14 @@ off(type: SensorType.SENSOR_TYPE_ID_HALL, callback?: Callback&lt;HallResponse&gt ...@@ -1335,14 +1335,14 @@ off(type: SensorType.SENSOR_TYPE_ID_HALL, callback?: Callback&lt;HallResponse&gt
**系统能力**:SystemCapability.Sensors.Sensor **系统能力**:SystemCapability.Sensors.Sensor
- 参数: **参数:**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | --------------------------------------------- | ---- | ------------------------------------------------------------ | | -------- | ---------------------------------------- | ---- | ---------------------------------------- |
| type | [SensorType](#sensortype) | 是 | 要取消订阅的霍尔传感器类型为SENSOR_TYPE_ID_HALL。 | | type | [SensorType](#sensortype) | 是 | 要取消订阅的霍尔传感器类型为SENSOR_TYPE_ID_HALL。 |
| callback | Callback&lt;[HallResponse](#hallresponse)&gt; | 是 | 取消注册霍尔传感器的回调函数,上报的数据类型为&nbsp;HallResponse。 | | callback | Callback&lt;[HallResponse](#hallresponse)&gt; | 是 | 取消注册霍尔传感器的回调函数,上报的数据类型为&nbsp;HallResponse。 |
- 示例: **示例:**
``` ```
function callback(data) { function callback(data) {
...@@ -1361,14 +1361,14 @@ off(type: SensorType.SENSOR_TYPE_ID_HEART_RATE, callback?: Callback&lt;HeartRate ...@@ -1361,14 +1361,14 @@ off(type: SensorType.SENSOR_TYPE_ID_HEART_RATE, callback?: Callback&lt;HeartRate
**系统能力**:SystemCapability.Sensors.Sensor **系统能力**:SystemCapability.Sensors.Sensor
- 参数: **参数:**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | ------------------------------------------------------- | ---- | ------------------------------------------------------------ | | -------- | ---------------------------------------- | ---- | ---------------------------------------- |
| type | [SensorType](#sensortype)[SensorType](#sensortype) | 是 | 要取消订阅的心率传感器类型为SENSOR_TYPE_ID_HEART_RATE。 | | type | [SensorType](#sensortype)[SensorType](#sensortype) | 是 | 要取消订阅的心率传感器类型为SENSOR_TYPE_ID_HEART_RATE。 |
| callback | Callback&lt;[HeartRateResponse](#heartrateresponse)&gt; | 是 | 取消注册一次心率传感器的回调函数,上报的数据类型为HeartRateResponse。 | | callback | Callback&lt;[HeartRateResponse](#heartrateresponse)&gt; | 是 | 取消注册一次心率传感器的回调函数,上报的数据类型为HeartRateResponse。 |
- 示例: **示例:**
``` ```
function callback(data) { function callback(data) {
...@@ -1387,14 +1387,14 @@ off(type: SensorType.SENSOR_TYPE_ID_HUMIDITY, callback?: Callback&lt;HumidityRes ...@@ -1387,14 +1387,14 @@ off(type: SensorType.SENSOR_TYPE_ID_HUMIDITY, callback?: Callback&lt;HumidityRes
**系统能力**:SystemCapability.Sensors.Sensor **系统能力**:SystemCapability.Sensors.Sensor
- 参数: **参数:**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | ----------------------------------------------------- | ---- | ------------------------------------------------------------ | | -------- | ---------------------------------------- | ---- | ---------------------------------------- |
| type | [SensorType](#sensortype) | 是 | 要取消订阅的湿度传感器类型为SENSOR_TYPE_ID_HUMIDITY。 | | type | [SensorType](#sensortype) | 是 | 要取消订阅的湿度传感器类型为SENSOR_TYPE_ID_HUMIDITY。 |
| callback | Callback&lt;[HumidityResponse](#humidityresponse)&gt; | 是 | 取消注册湿度传感器的回调函数,上报的数据类型为HumidityResponse。 | | callback | Callback&lt;[HumidityResponse](#humidityresponse)&gt; | 是 | 取消注册湿度传感器的回调函数,上报的数据类型为HumidityResponse。 |
- 示例: **示例:**
``` ```
function callback(data) { function callback(data) {
...@@ -1413,14 +1413,14 @@ off(type: SensorType.SENSOR_TYPE_ID_LINEAR_ACCELERATION, callback?: Callback&lt; ...@@ -1413,14 +1413,14 @@ off(type: SensorType.SENSOR_TYPE_ID_LINEAR_ACCELERATION, callback?: Callback&lt;
**系统能力**:SystemCapability.Sensors.Sensor **系统能力**:SystemCapability.Sensors.Sensor
- 参数: **参数:**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | ------------------------------------------------------------ | ---- | ------------------------------------------------------------ | | -------- | ---------------------------------------- | ---- | ---------------------------------------- |
| type | [SensorType](#sensortype) | 是 | 要取消订阅的线性加速度传感器类型为SENSOR_TYPE_ID_LINEAR_ACCELERATION。 | | type | [SensorType](#sensortype) | 是 | 要取消订阅的线性加速度传感器类型为SENSOR_TYPE_ID_LINEAR_ACCELERATION。 |
| callback | Callback&lt;[LinearAccelerometerResponse](#linearaccelerometerresponse)&gt; | 是 | 取消注册性加速度传感器的回调函数,上报的数据类型为LinearAccelerometerResponse。 | | callback | Callback&lt;[LinearAccelerometerResponse](#linearaccelerometerresponse)&gt; | 是 | 取消注册性加速度传感器的回调函数,上报的数据类型为LinearAccelerometerResponse。 |
- 示例: **示例:**
``` ```
function callback(data) { function callback(data) {
...@@ -1441,14 +1441,14 @@ sensor.off(sensor.SensorType.SENSOR_TYPE_ID_LINEAR_ACCELERATION, callback); ...@@ -1441,14 +1441,14 @@ sensor.off(sensor.SensorType.SENSOR_TYPE_ID_LINEAR_ACCELERATION, callback);
**系统能力**:SystemCapability.Sensors.Sensor **系统能力**:SystemCapability.Sensors.Sensor
- 参数: **参数:**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| ---------------- | ------------------------------------------------------------ | ---- | ------------------------------------------------------------ | | ---------------- | ---------------------------------------- | ---- | ---------------------------------------- |
| type | [SensorType](#sensortype) | 是 | 要取消订阅的磁场传感器类型为SENSOR_TYPE_ID_MAGNETIC_FIELD。 | | type | [SensorType](#sensortype) | 是 | 要取消订阅的磁场传感器类型为SENSOR_TYPE_ID_MAGNETIC_FIELD。 |
| callbackcallback | Callback&lt;[MagneticFieldResponse](#magneticfieldresponse)&gt; | 是 | 取消注册磁场传感器的回调函数,上报的数据类型为MagneticFieldResponse。 | | callbackcallback | Callback&lt;[MagneticFieldResponse](#magneticfieldresponse)&gt; | 是 | 取消注册磁场传感器的回调函数,上报的数据类型为MagneticFieldResponse。 |
- 示例: **示例:**
``` ```
function callback(data) { function callback(data) {
...@@ -1467,14 +1467,14 @@ sensor.off(sensor.SensorType.SENSOR_TYPE_ID_MAGNETIC_FIELD, callback); ...@@ -1467,14 +1467,14 @@ sensor.off(sensor.SensorType.SENSOR_TYPE_ID_MAGNETIC_FIELD, callback);
**系统能力**:SystemCapability.Sensors.Sensor **系统能力**:SystemCapability.Sensors.Sensor
- 参数: **参数:**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | ------------------------------------------------------------ | ---- | ------------------------------------------------------------ | | -------- | ---------------------------------------- | ---- | ---------------------------------------- |
| type | [SensorType](#sensortype) | 是 | 要取消订阅的未校准磁场传感器类型为SENSOR_TYPE_ID_MAGNETIC_FIELD_UNCALIBRATED。 | | type | [SensorType](#sensortype) | 是 | 要取消订阅的未校准磁场传感器类型为SENSOR_TYPE_ID_MAGNETIC_FIELD_UNCALIBRATED。 |
| callback | Callback&lt;[MagneticFieldUncalibratedResponse](#magneticfielduncalibratedresponse)&gt; | 是 | 取消注册未校准磁场传感器的回调函数,上报的数据类型为MagneticFieldUncalibratedResponse。 | | callback | Callback&lt;[MagneticFieldUncalibratedResponse](#magneticfielduncalibratedresponse)&gt; | 是 | 取消注册未校准磁场传感器的回调函数,上报的数据类型为MagneticFieldUncalibratedResponse。 |
- 示例: **示例:**
``` ```
function callback(data) { function callback(data) {
...@@ -1496,14 +1496,14 @@ sensor.off(sensor.SensorType.SENSOR_TYPE_ID_MAGNETIC_FIELD_UNCALIBRATED, callbac ...@@ -1496,14 +1496,14 @@ sensor.off(sensor.SensorType.SENSOR_TYPE_ID_MAGNETIC_FIELD_UNCALIBRATED, callbac
**系统能力**:SystemCapability.Sensors.Sensor **系统能力**:SystemCapability.Sensors.Sensor
- 参数: **参数:**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | ----------------------------------------------------------- | ---- | ------------------------------------------------------------ | | -------- | ---------------------------------------- | ---- | ---------------------------------------- |
| type | [SensorType](#sensortype) | 是 | 要取消订阅的方向传感器类型为SENSOR_TYPE_ID_ORIENTATION | | type | [SensorType](#sensortype) | 是 | 要取消订阅的方向传感器类型为SENSOR_TYPE_ID_ORIENTATION |
| callback | Callback&lt;[OrientationResponse](#orientationresponse)&gt; | 是 | 取消注册方向传感器的回调函数,上报的数据类型为OrientationResponse。 | | callback | Callback&lt;[OrientationResponse](#orientationresponse)&gt; | 是 | 取消注册方向传感器的回调函数,上报的数据类型为OrientationResponse。 |
- 示例: **示例:**
``` ```
function callback(data) { function callback(data) {
...@@ -1522,14 +1522,14 @@ off(type: SensorType.SENSOR_TYPE_ID_PEDOMETER, callback?: Callback&lt;PedometerR ...@@ -1522,14 +1522,14 @@ off(type: SensorType.SENSOR_TYPE_ID_PEDOMETER, callback?: Callback&lt;PedometerR
**系统能力**:SystemCapability.Sensors.Sensor **系统能力**:SystemCapability.Sensors.Sensor
- 参数: **参数:**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | ------------------------------------------------------- | ---- | ------------------------------------------------------------ | | -------- | ---------------------------------------- | ---- | ---------------------------------------- |
| type | [SensorType](#sensortype) | 是 | 要取消订阅的计步传感器类型为SENSOR_TYPE_ID_PEDOMETER。 | | type | [SensorType](#sensortype) | 是 | 要取消订阅的计步传感器类型为SENSOR_TYPE_ID_PEDOMETER。 |
| callback | Callback&lt;[PedometerResponse](#pedometerresponse)&gt; | 是 | 取消注册计步传感器的回调函数,上报的数据类型为PedometerResponse。 | | callback | Callback&lt;[PedometerResponse](#pedometerresponse)&gt; | 是 | 取消注册计步传感器的回调函数,上报的数据类型为PedometerResponse。 |
- 示例; **返回值:** ;
``` ```
function callback(data) { function callback(data) {
...@@ -1548,14 +1548,14 @@ off(type: SensorType.SENSOR_TYPE_ID_PEDOMETER_DETECTION, callback?: Callback&lt; ...@@ -1548,14 +1548,14 @@ off(type: SensorType.SENSOR_TYPE_ID_PEDOMETER_DETECTION, callback?: Callback&lt;
**系统能力**:SystemCapability.Sensors.Sensor **系统能力**:SystemCapability.Sensors.Sensor
- 参数: **参数:**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | ------------------------------------------------------------ | ---- | ------------------------------------------------------------ | | -------- | ---------------------------------------- | ---- | ---------------------------------------- |
| type | [SensorType](#sensortype) | 是 | 要取消订阅的计步检测传感器类型为SENSOR_TYPE_ID_PEDOMETER_DETECTION。 | | type | [SensorType](#sensortype) | 是 | 要取消订阅的计步检测传感器类型为SENSOR_TYPE_ID_PEDOMETER_DETECTION。 |
| callback | Callback&lt;[PedometerDetectionResponse](#pedometerdetectionresponse)&gt; | 是 | 取消注册计步检测传感器的回调函数,上报的数据类型为PedometerDetectionResponse。 | | callback | Callback&lt;[PedometerDetectionResponse](#pedometerdetectionresponse)&gt; | 是 | 取消注册计步检测传感器的回调函数,上报的数据类型为PedometerDetectionResponse。 |
- 示例: **示例:**
``` ```
function callback(data) { function callback(data) {
...@@ -1572,14 +1572,14 @@ off(type: SensorType.SENSOR_TYPE_ID_PROXIMITY, callback?: Callback&lt;ProximityR ...@@ -1572,14 +1572,14 @@ off(type: SensorType.SENSOR_TYPE_ID_PROXIMITY, callback?: Callback&lt;ProximityR
**系统能力**:SystemCapability.Sensors.Sensor **系统能力**:SystemCapability.Sensors.Sensor
- 参数: **参数:**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | ------------------------------------------------------- | ---- | ------------------------------------------------------------ | | -------- | ---------------------------------------- | ---- | ---------------------------------------- |
| type | [SensorType](#sensortype) | 是 | 要取消订阅的接近光传感器类型为SENSOR_TYPE_ID_PROXIMITY。 | | type | [SensorType](#sensortype) | 是 | 要取消订阅的接近光传感器类型为SENSOR_TYPE_ID_PROXIMITY。 |
| callback | Callback&lt;[ProximityResponse](#proximityresponse)&gt; | 是 | 取消注册接近光传感器的回调函数,上报的数据类型为ProximityResponse。 | | callback | Callback&lt;[ProximityResponse](#proximityresponse)&gt; | 是 | 取消注册接近光传感器的回调函数,上报的数据类型为ProximityResponse。 |
- 示例: **示例:**
``` ```
function callback(data) { function callback(data) {
...@@ -1596,14 +1596,14 @@ off(type: SensorType.SENSOR_TYPE_ID_ROTATION_VECTOR, callback?: Callback&lt;Rota ...@@ -1596,14 +1596,14 @@ off(type: SensorType.SENSOR_TYPE_ID_ROTATION_VECTOR, callback?: Callback&lt;Rota
**系统能力**:SystemCapability.Sensors.Sensor **系统能力**:SystemCapability.Sensors.Sensor
- 参数: **参数:**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | ------------------------------------------------------------ | ---- | ------------------------------------------------------------ | | -------- | ---------------------------------------- | ---- | ---------------------------------------- |
| type | [SensorType](#sensortype) | 是 | 要取消订阅的旋转矢量传感器类型为SENSOR_TYPE_ID_ROTATION_VECTOR。 | | type | [SensorType](#sensortype) | 是 | 要取消订阅的旋转矢量传感器类型为SENSOR_TYPE_ID_ROTATION_VECTOR。 |
| callback | Callback&lt;[RotationVectorResponse](#rotationvectorresponse)&gt; | 是 | 取消注册旋转矢量传感器的回调函数,上报的数据类型为RotationVectorResponse。 | | callback | Callback&lt;[RotationVectorResponse](#rotationvectorresponse)&gt; | 是 | 取消注册旋转矢量传感器的回调函数,上报的数据类型为RotationVectorResponse。 |
- 示例: **示例:**
``` ```
function callback(data) { function callback(data) {
...@@ -1623,14 +1623,14 @@ off(type: SensorType.SENSOR_TYPE_ID_SIGNIFICANT_MOTION, callback?: Callback&lt;S ...@@ -1623,14 +1623,14 @@ off(type: SensorType.SENSOR_TYPE_ID_SIGNIFICANT_MOTION, callback?: Callback&lt;S
**系统能力**:SystemCapability.Sensors.Sensor **系统能力**:SystemCapability.Sensors.Sensor
- 参数: **参数:**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | ------------------------------------------------------------ | ---- | ------------------------------------------------------------ | | -------- | ---------------------------------------- | ---- | ---------------------------------------- |
| type | [SensorType](#sensortype) | 是 | 要取消订阅的大幅动作传感器类型为SENSOR_TYPE_ID_SIGNIFICANT_MOTION。 | | type | [SensorType](#sensortype) | 是 | 要取消订阅的大幅动作传感器类型为SENSOR_TYPE_ID_SIGNIFICANT_MOTION。 |
| callback | Callback&lt;[SignificantMotionResponse](#significantmotionresponse)&gt; | 是 | 取消注册有效运动传感器的回调函数,上报的数据类型为SignificantMotionResponse。 | | callback | Callback&lt;[SignificantMotionResponse](#significantmotionresponse)&gt; | 是 | 取消注册有效运动传感器的回调函数,上报的数据类型为SignificantMotionResponse。 |
- 示例: **示例:**
``` ```
function callback(data) { function callback(data) {
...@@ -1647,14 +1647,14 @@ off(type: SensorType.SENSOR_TYPE_ID_WEAR_DETECTION, callback?: Callback&lt;WearD ...@@ -1647,14 +1647,14 @@ off(type: SensorType.SENSOR_TYPE_ID_WEAR_DETECTION, callback?: Callback&lt;WearD
**系统能力**:SystemCapability.Sensors.Sensor **系统能力**:SystemCapability.Sensors.Sensor
- 参数: **参数:**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | ------------------------------------------------------------ | ---- | ------------------------------------------------------------ | | -------- | ---------------------------------------- | ---- | ---------------------------------------- |
| type | [SensorType](#sensortype) | 是 | 要取消订阅的佩戴检测传感器类型为SENSOR_TYPE_ID_WEAR_DETECTION。 | | type | [SensorType](#sensortype) | 是 | 要取消订阅的佩戴检测传感器类型为SENSOR_TYPE_ID_WEAR_DETECTION。 |
| callback | Callback&lt;[WearDetectionResponse](#weardetectionresponse)&gt; | 是 | 取消注册佩戴检测传感器的回调函数,上报的数据类型为WearDetectionResponse。 | | callback | Callback&lt;[WearDetectionResponse](#weardetectionresponse)&gt; | 是 | 取消注册佩戴检测传感器的回调函数,上报的数据类型为WearDetectionResponse。 |
- 示例: **示例:**
``` ```
function accCallback(data) { function accCallback(data) {
...@@ -1671,18 +1671,18 @@ transformCoordinateSystem(inRotationVector: Array&lt;number&gt;, coordinates: Co ...@@ -1671,18 +1671,18 @@ transformCoordinateSystem(inRotationVector: Array&lt;number&gt;, coordinates: Co
**系统能力**:SystemCapability.Sensors.Sensor **系统能力**:SystemCapability.Sensors.Sensor
- 参数 **参数:**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| ---------------- | ----------------------------------------- | ---- | ---------------------- | | ---------------- | ---------------------------------------- | ---- | ----------- |
| inRotationVector | Array&lt;number&gt; | 是 | 表示旋转矩阵。 | | inRotationVector | Array&lt;number&gt; | 是 | 表示旋转矩阵。 |
| coordinates | [CoordinatesOptions](#coordinatesoptions) | 是 | 表示坐标系方向。 | | coordinates | [CoordinatesOptions](#coordinatesoptions) | 是 | 表示坐标系方向。 |
| callback | AsyncCallback&lt;Array&lt;number&gt;&gt; | 是 | 返回转换后的旋转矩阵。 | | callback | AsyncCallback&lt;Array&lt;number&gt;&gt; | 是 | 返回转换后的旋转矩阵。 |
- 示例 **示例:**
``` ```
sensor.transformCoordinateSystem([1, 0, 0, 0, 1, 0, 0, 0, 1], {'axisX':2, 'axisY':3}, function(err, data) { sensor.transformCoordinateSystem([1, 0, 0, 0, 1, 0, 0, 0, 1], {'axisX':2, 'axisY':3}, function(err, data) {
if (err) { if (err) {
console.error("Operation failed. Error code: " + err.code + ", message: " + err.message); console.error("Operation failed. Error code: " + err.code + ", message: " + err.message);
return; return;
...@@ -1692,8 +1692,7 @@ transformCoordinateSystem(inRotationVector: Array&lt;number&gt;, coordinates: Co ...@@ -1692,8 +1692,7 @@ transformCoordinateSystem(inRotationVector: Array&lt;number&gt;, coordinates: Co
console.info("transformCoordinateSystem data[ " + i + "] = " + data[i]); console.info("transformCoordinateSystem data[ " + i + "] = " + data[i]);
} }
}) })
``` ```
## sensor.transformCoordinateSystem ## sensor.transformCoordinateSystem
transformCoordinateSystem(inRotationVector: Array&lt;number&gt;, coordinates: CoordinatesOptions): Promise&lt;Array&lt;number&gt;&gt; transformCoordinateSystem(inRotationVector: Array&lt;number&gt;, coordinates: CoordinatesOptions): Promise&lt;Array&lt;number&gt;&gt;
...@@ -1702,23 +1701,23 @@ transformCoordinateSystem(inRotationVector: Array&lt;number&gt;, coordinates: Co ...@@ -1702,23 +1701,23 @@ transformCoordinateSystem(inRotationVector: Array&lt;number&gt;, coordinates: Co
**系统能力**:SystemCapability.Sensors.Sensor **系统能力**:SystemCapability.Sensors.Sensor
- 参数 **参数:**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| ---------------- | ----------------------------------------- | ---- | ---------------- | | ---------------- | ---------------------------------------- | ---- | -------- |
| inRotationVector | Array&lt;number&gt; | 是 | 表示旋转矩阵。 | | inRotationVector | Array&lt;number&gt; | 是 | 表示旋转矩阵。 |
| coordinates | [CoordinatesOptions](#coordinatesoptions) | 是 | 表示坐标系方向。 | | coordinates | [CoordinatesOptions](#coordinatesoptions) | 是 | 表示坐标系方向。 |
- 返回值 **返回值:**
| 类型 | 说明 | | 类型 | 说明 |
| ---------------------------------- | ---------------------- | | ---------------------------------- | ----------- |
| Promise&lt;Array&lt;number&gt;&gt; | 返回转换后的旋转矩阵。 | | Promise&lt;Array&lt;number&gt;&gt; | 返回转换后的旋转矩阵。 |
- 示例 **示例:**
``` ```
const promise = sensor.transformCoordinateSystem([1, 0, 0, 0, 1, 0, 0, 0, 1], {'axisX':2, 'axisY':3}); const promise = sensor.transformCoordinateSystem([1, 0, 0, 0, 1, 0, 0, 0, 1], {'axisX':2, 'axisY':3});
promise.then((data) => { promise.then((data) => {
console.info("Operation successed."); console.info("Operation successed.");
for (var i=0; i < data.length; i++) { for (var i=0; i < data.length; i++) {
...@@ -1726,11 +1725,8 @@ transformCoordinateSystem(inRotationVector: Array&lt;number&gt;, coordinates: Co ...@@ -1726,11 +1725,8 @@ transformCoordinateSystem(inRotationVector: Array&lt;number&gt;, coordinates: Co
} }
}).catch((err) => { }).catch((err) => {
console.info("Operation failed"); console.info("Operation failed");
}) })
``` ```
## sensor.getGeomagneticField ## sensor.getGeomagneticField
...@@ -1740,16 +1736,16 @@ getGeomagneticField(locationOptions: LocationOptions, timeMillis: number, callba ...@@ -1740,16 +1736,16 @@ getGeomagneticField(locationOptions: LocationOptions, timeMillis: number, callba
**系统能力**:SystemCapability.Sensors.Sensor **系统能力**:SystemCapability.Sensors.Sensor
- 参数 **参数:**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | | --------------- | ---------------------------------------- | ---- | ----------------- |
| locationOptions | [LocationOptions](#locationoptions) | 是 | 地理位置。 | | locationOptions | [LocationOptions](#locationoptions) | 是 | 地理位置。 |
| timeMillis | number | 是 | 表示获取磁偏角的时间,单位为毫秒。 | | timeMillis | number | 是 | 表示获取磁偏角的时间,单位为毫秒。 |
| callback | AsyncCallback&lt;[GeomagneticResponse](#geomagneticresponse)&gt; | 是 | 返回磁场信息。 | | callback | AsyncCallback&lt;[GeomagneticResponse](#geomagneticresponse)&gt; | 是 | 返回磁场信息。 |
- 示例 **示例:**
``` ```
sensor.getGeomagneticField([80, 0, 0], {'timeMillis':1580486400000}, function(err, data) { sensor.getGeomagneticField([80, 0, 0], {'timeMillis':1580486400000}, function(err, data) {
if (err) { if (err) {
console.error('Operation failed. Error code: ' + err.code + '; message: ' + err.message); console.error('Operation failed. Error code: ' + err.code + '; message: ' + err.message);
return; return;
...@@ -1757,10 +1753,8 @@ getGeomagneticField(locationOptions: LocationOptions, timeMillis: number, callba ...@@ -1757,10 +1753,8 @@ getGeomagneticField(locationOptions: LocationOptions, timeMillis: number, callba
console.info('sensor_getGeomagneticField_promise x: ' + data.x + ',y: ' + data.y + ',z: ' + console.info('sensor_getGeomagneticField_promise x: ' + data.x + ',y: ' + data.y + ',z: ' +
data.z + ',geomagneticDip: ' + data.geomagneticDip + ',deflectionAngle: ' + data.deflectionAngle + data.z + ',geomagneticDip: ' + data.geomagneticDip + ',deflectionAngle: ' + data.deflectionAngle +
',levelIntensity: ' + data.levelIntensity + ',totalIntensity: ' + data.totalIntensity); ',levelIntensity: ' + data.levelIntensity + ',totalIntensity: ' + data.totalIntensity);
}); });
``` ```
## sensor.getGeomagneticField ## sensor.getGeomagneticField
getGeomagneticField(locationOptions: LocationOptions, timeMillis: number): Promise&lt;GeomagneticResponse&gt; getGeomagneticField(locationOptions: LocationOptions, timeMillis: number): Promise&lt;GeomagneticResponse&gt;
...@@ -1769,18 +1763,18 @@ getGeomagneticField(locationOptions: LocationOptions, timeMillis: number): Promi ...@@ -1769,18 +1763,18 @@ getGeomagneticField(locationOptions: LocationOptions, timeMillis: number): Promi
**系统能力**:SystemCapability.Sensors.Sensor **系统能力**:SystemCapability.Sensors.Sensor
- 参数 **参数:**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | | --------------- | ----------------------------------- | ---- | ----------------- |
| locationOptions | [LocationOptions](#locationoptions) | 是 | 地理位置。 | | locationOptions | [LocationOptions](#locationoptions) | 是 | 地理位置。 |
| timeMillis | number | 是 | 表示获取磁偏角的时间,单位为毫秒。 | | timeMillis | number | 是 | 表示获取磁偏角的时间,单位为毫秒。 |
- 返回值 **返回值:**
| 类型 | 说明 | | 类型 | 说明 |
| -------- | -------- | | ---------------------------------------- | ------- |
| Promise&lt;[GeomagneticResponse](#geomagneticresponse)&gt; | 返回磁场信息。 | | Promise&lt;[GeomagneticResponse](#geomagneticresponse)&gt; | 返回磁场信息。 |
- 示例 **返回值:**
``` ```
const promise = sensor.getGeomagneticField([80, 0, 0], {'timeMillis':1580486400000}); const promise = sensor.getGeomagneticField([80, 0, 0], {'timeMillis':1580486400000});
promise.then((data) => { promise.then((data) => {
...@@ -1800,15 +1794,15 @@ getAltitude(seaPressure: number, currentPressure: number, callback: AsyncCallbac ...@@ -1800,15 +1794,15 @@ getAltitude(seaPressure: number, currentPressure: number, callback: AsyncCallbac
**系统能力**:SystemCapability.Sensors.Sensor **系统能力**:SystemCapability.Sensors.Sensor
- 参数 **参数:**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| --------------- | --------------------------- | ---- | ------------------------------------- | | --------------- | --------------------------- | ---- | -------------------- |
| seaPressure | number | 是 | 表示海平面气压值,单位为hPa。 | | seaPressure | number | 是 | 表示海平面气压值,单位为hPa。 |
| currentPressure | number | 是 | 表示设备所在高度的气压值,单位为hPa。 | | currentPressure | number | 是 | 表示设备所在高度的气压值,单位为hPa。 |
| callback | AsyncCallback&lt;number&gt; | 是 | 返回设备所在的海拔高度,单位为米。 | | callback | AsyncCallback&lt;number&gt; | 是 | 返回设备所在的海拔高度,单位为米。 |
- 示例 **返回值:**
``` ```
sensor.getAltitude(0, 200, function(err, data) { sensor.getAltitude(0, 200, function(err, data) {
...@@ -1829,20 +1823,20 @@ getAltitude(seaPressure: number, currentPressure: number): Promise&lt;number&gt; ...@@ -1829,20 +1823,20 @@ getAltitude(seaPressure: number, currentPressure: number): Promise&lt;number&gt;
**系统能力**:SystemCapability.Sensors.Sensor **系统能力**:SystemCapability.Sensors.Sensor
- 参数 **参数:**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| --------------- | ------ | ---- | ------------------------------------- | | --------------- | ------ | ---- | -------------------- |
| seaPressure | number | 是 | 表示海平面气压值,单位为hPa。 | | seaPressure | number | 是 | 表示海平面气压值,单位为hPa。 |
| currentPressure | number | 是 | 表示设备所在高度的气压值,单位为hPa。 | | currentPressure | number | 是 | 表示设备所在高度的气压值,单位为hPa。 |
- 返回值 **返回值:**
| 类型 | 说明 | | 类型 | 说明 |
| --------------------- | ------------------------------------ | | --------------------- | ------------------ |
| Promise&lt;number&gt; | 返回设备所在的海拔高度(单位:米)。 | | Promise&lt;number&gt; | 返回设备所在的海拔高度(单位:米)。 |
- 示例 **返回值:**
``` ```
const promise = sensor.getAltitude(0, 200); const promise = sensor.getAltitude(0, 200);
...@@ -1862,14 +1856,14 @@ getGeomagneticDip(inclinationMatrix: Array&lt;number&gt;, callback: AsyncCallbac ...@@ -1862,14 +1856,14 @@ getGeomagneticDip(inclinationMatrix: Array&lt;number&gt;, callback: AsyncCallbac
**系统能力**:SystemCapability.Sensors.Sensor **系统能力**:SystemCapability.Sensors.Sensor
- 参数 **参数:**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| ----------------- | --------------------------- | ---- | ---------------------------- | | ----------------- | --------------------------- | ---- | -------------- |
| inclinationMatrix | Array&lt;number&gt; | 是 | 表示倾斜矩阵。 | | inclinationMatrix | Array&lt;number&gt; | 是 | 表示倾斜矩阵。 |
| callback | AsyncCallback&lt;number&gt; | 是 | 返回地磁倾斜角,单位为弧度。 | | callback | AsyncCallback&lt;number&gt; | 是 | 返回地磁倾斜角,单位为弧度。 |
- 示例 **返回值:**
``` ```
sensor.getGeomagneticDip([1, 0, 0, 0, 1, 0, 0, 0, 1], function(err, data) { sensor.getGeomagneticDip([1, 0, 0, 0, 1, 0, 0, 0, 1], function(err, data) {
...@@ -1878,7 +1872,7 @@ getGeomagneticDip(inclinationMatrix: Array&lt;number&gt;, callback: AsyncCallbac ...@@ -1878,7 +1872,7 @@ getGeomagneticDip(inclinationMatrix: Array&lt;number&gt;, callback: AsyncCallbac
err.message); err.message);
return; 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&lt;number&gt;): Promise&lt;number&gt; ...@@ -1890,19 +1884,19 @@ getGeomagneticDip(inclinationMatrix: Array&lt;number&gt;): Promise&lt;number&gt;
**系统能力**:SystemCapability.Sensors.Sensor **系统能力**:SystemCapability.Sensors.Sensor
- 参数 **参数:**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| ----------------- | ------------------- | ---- | -------------- | | ----------------- | ------------------- | ---- | ------- |
| inclinationMatrix | Array&lt;number&gt; | 是 | 表示倾斜矩阵。 | | inclinationMatrix | Array&lt;number&gt; | 是 | 表示倾斜矩阵。 |
- 返回值 **返回值:**
| 类型 | 说明 | | 类型 | 说明 |
| --------------------- | ---------------------------- | | --------------------- | -------------- |
| Promise&lt;number&gt; | 返回地磁倾斜角,单位为弧度。 | | Promise&lt;number&gt; | 返回地磁倾斜角,单位为弧度。 |
- 示例 **返回值:**
``` ```
const promise = sensor.getGeomagneticDip([1, 0, 0, 0, 1, 0, 0, 0, 1]); const promise = sensor.getGeomagneticDip([1, 0, 0, 0, 1, 0, 0, 0, 1]);
...@@ -1921,15 +1915,15 @@ getAngleModify(currentRotationMatrix: Array&lt;number&gt;, preRotationMatrix: Ar ...@@ -1921,15 +1915,15 @@ getAngleModify(currentRotationMatrix: Array&lt;number&gt;, preRotationMatrix: Ar
**系统能力**:SystemCapability.Sensors.Sensor **系统能力**:SystemCapability.Sensors.Sensor
- 参数 **参数:**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| --------------------- | ---------------------------------------- | ---- | --------------------------------- | | --------------------- | ---------------------------------------- | ---- | ------------------ |
| currentRotationMatrix | Array&lt;number&gt; | 是 | 表示当前旋转矩阵。 | | currentRotationMatrix | Array&lt;number&gt; | 是 | 表示当前旋转矩阵。 |
| preRotationMatrix | Array&lt;number&gt; | 是 | 表示旋转矩阵。 | | preRotationMatrix | Array&lt;number&gt; | 是 | 表示旋转矩阵。 |
| callback | AsyncCallback&lt;Array&lt;number&gt;&gt; | 是 | 返回z、x、y轴方向的旋转角度变化。 | | callback | AsyncCallback&lt;Array&lt;number&gt;&gt; | 是 | 返回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) { 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&lt;number&gt;, preRotationMatrix: Ar ...@@ -1954,20 +1948,20 @@ getAngleModify(currentRotationMatrix: Array&lt;number&gt;, preRotationMatrix: Ar
**系统能力**:SystemCapability.Sensors.Sensor **系统能力**:SystemCapability.Sensors.Sensor
- 参数 **参数:**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| --------------------- | ------------------- | ---- | ------------------ | | --------------------- | ------------------- | ---- | --------- |
| currentRotationMatrix | Array&lt;number&gt; | 是 | 表示当前旋转矩阵。 | | currentRotationMatrix | Array&lt;number&gt; | 是 | 表示当前旋转矩阵。 |
| preRotationMatrix | Array&lt;number&gt; | 是 | 表示旋转矩阵。 | | preRotationMatrix | Array&lt;number&gt; | 是 | 表示旋转矩阵。 |
- 返回值 **返回值:**
| 类型 | 说明 | | 类型 | 说明 |
| ---------------------------------- | --------------------------------- | | ---------------------------------- | ------------------ |
| Promise&lt;Array&lt;number&gt;&gt; | 返回z、x、y轴方向的旋转角度变化。 | | Promise&lt;Array&lt;number&gt;&gt; | 返回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]); 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&lt;number&gt;, callback: AsyncCallbac ...@@ -1990,14 +1984,14 @@ createRotationMatrix(rotationVector: Array&lt;number&gt;, callback: AsyncCallbac
**系统能力**:SystemCapability.Sensors.Sensor **系统能力**:SystemCapability.Sensors.Sensor
- 参数 **参数:**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------------- | ---------------------------------------- | ---- | -------------- | | -------------- | ---------------------------------------- | ---- | ------- |
| rotationVector | Array&lt;number&gt; | 是 | 表示旋转矢量。 | | rotationVector | Array&lt;number&gt; | 是 | 表示旋转矢量。 |
| callback | AsyncCallback&lt;Array&lt;number&gt;&gt; | 是 | 返回旋转矩阵。 | | callback | AsyncCallback&lt;Array&lt;number&gt;&gt; | 是 | 返回旋转矩阵。 |
- 示例 **返回值:**
``` ```
sensor.createRotationMatrix([0.20046076, 0.21907, 0.73978853, 0.60376877], function(err, data) { sensor.createRotationMatrix([0.20046076, 0.21907, 0.73978853, 0.60376877], function(err, data) {
...@@ -2022,19 +2016,19 @@ createRotationMatrix(rotationVector: Array&lt;number&gt;): Promise&lt;Array&lt;n ...@@ -2022,19 +2016,19 @@ createRotationMatrix(rotationVector: Array&lt;number&gt;): Promise&lt;Array&lt;n
**系统能力**:SystemCapability.Sensors.Sensor **系统能力**:SystemCapability.Sensors.Sensor
- 参数 **参数:**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------------- | ------------------- | ---- | -------------- | | -------------- | ------------------- | ---- | ------- |
| rotationVector | Array&lt;number&gt; | 是 | 表示旋转矢量。 | | rotationVector | Array&lt;number&gt; | 是 | 表示旋转矢量。 |
- 返回值 **返回值:**
| 类型 | 说明 | | 类型 | 说明 |
| ---------------------------------- | -------------- | | ---------------------------------- | ------- |
| Promise&lt;Array&lt;number&gt;&gt; | 返回旋转矩阵。 | | Promise&lt;Array&lt;number&gt;&gt; | 返回旋转矩阵。 |
- 示例 **返回值:**
``` ```
const promise = sensor.createRotationMatrix([0.20046076, 0.21907, 0.73978853, 0.60376877]); const promise = sensor.createRotationMatrix([0.20046076, 0.21907, 0.73978853, 0.60376877]);
...@@ -2057,14 +2051,14 @@ createQuaternion(rotationVector: Array&lt;number&gt;, callback: AsyncCallback&lt ...@@ -2057,14 +2051,14 @@ createQuaternion(rotationVector: Array&lt;number&gt;, callback: AsyncCallback&lt
**系统能力**:SystemCapability.Sensors.Sensor **系统能力**:SystemCapability.Sensors.Sensor
- 参数 **参数:**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------------- | ---------------------------------------- | ---- | -------------- | | -------------- | ---------------------------------------- | ---- | ------- |
| rotationVector | Array&lt;number&gt; | 是 | 表示旋转矢量。 | | rotationVector | Array&lt;number&gt; | 是 | 表示旋转矢量。 |
| callback | AsyncCallback&lt;Array&lt;number&gt;&gt; | 是 | 返回四元数。 | | callback | AsyncCallback&lt;Array&lt;number&gt;&gt; | 是 | 返回四元数。 |
- 示例 **返回值:**
``` ```
sensor.createQuaternion([0.20046076, 0.21907, 0.73978853, 0.60376877], function(err, data) { sensor.createQuaternion([0.20046076, 0.21907, 0.73978853, 0.60376877], function(err, data) {
...@@ -2089,19 +2083,19 @@ createQuaternion(rotationVector: Array&lt;number&gt;): Promise&lt;Array&lt;numbe ...@@ -2089,19 +2083,19 @@ createQuaternion(rotationVector: Array&lt;number&gt;): Promise&lt;Array&lt;numbe
**系统能力**:SystemCapability.Sensors.Sensor **系统能力**:SystemCapability.Sensors.Sensor
- 参数 **参数:**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------------- | ------------------- | ---- | -------------- | | -------------- | ------------------- | ---- | ------- |
| rotationVector | Array&lt;number&gt; | 是 | 表示旋转矢量。 | | rotationVector | Array&lt;number&gt; | 是 | 表示旋转矢量。 |
- 返回值 **返回值:**
| 类型 | 说明 | | 类型 | 说明 |
| ---------------------------------- | ------------ | | ---------------------------------- | ------ |
| Promise&lt;Array&lt;number&gt;&gt; | 返回四元数。 | | Promise&lt;Array&lt;number&gt;&gt; | 返回四元数。 |
- 示例 **返回值:**
``` ```
const promise = sensor.createQuaternion([0.20046076, 0.21907, 0.73978853, 0.60376877]); const promise = sensor.createQuaternion([0.20046076, 0.21907, 0.73978853, 0.60376877]);
...@@ -2124,14 +2118,14 @@ getDirection(rotationMatrix: Array&lt;number&gt;, callback: AsyncCallback&lt;Arr ...@@ -2124,14 +2118,14 @@ getDirection(rotationMatrix: Array&lt;number&gt;, callback: AsyncCallback&lt;Arr
**系统能力**:SystemCapability.Sensors.Sensor **系统能力**:SystemCapability.Sensors.Sensor
- 参数 **参数:**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------------- | ---------------------------------------- | ---- | --------------------------------- | | -------------- | ---------------------------------------- | ---- | ------------------ |
| rotationMatrix | Array&lt;number&gt; | 是 | 表示旋转矩阵。 | | rotationMatrix | Array&lt;number&gt; | 是 | 表示旋转矩阵。 |
| callback | AsyncCallback&lt;Array&lt;number&gt;&gt; | 是 | 返回围绕z、x、y轴方向的旋转角度。 | | callback | AsyncCallback&lt;Array&lt;number&gt;&gt; | 是 | 返回围绕z、x、y轴方向的旋转角度。 |
- 示例 **返回值:**
``` ```
sensor.getDirection([1, 0, 0, 0, 1, 0, 0, 0, 1], function(err, data) { sensor.getDirection([1, 0, 0, 0, 1, 0, 0, 0, 1], function(err, data) {
...@@ -2156,19 +2150,19 @@ getDirection(rotationMatrix: Array&lt;number&gt;): Promise&lt;Array&lt;number&gt ...@@ -2156,19 +2150,19 @@ getDirection(rotationMatrix: Array&lt;number&gt;): Promise&lt;Array&lt;number&gt
**系统能力**:SystemCapability.Sensors.Sensor **系统能力**:SystemCapability.Sensors.Sensor
- 参数 **参数:**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------------- | ------------------- | ---- | -------------- | | -------------- | ------------------- | ---- | ------- |
| rotationMatrix | Array&lt;number&gt; | 是 | 表示旋转矩阵。 | | rotationMatrix | Array&lt;number&gt; | 是 | 表示旋转矩阵。 |
- 返回值 **返回值:**
| 类型 | 说明 | | 类型 | 说明 |
| ---------------------------------- | --------------------------------- | | ---------------------------------- | ------------------ |
| Promise&lt;Array&lt;number&gt;&gt; | 返回围绕z、x、y轴方向的旋转角度。 | | Promise&lt;Array&lt;number&gt;&gt; | 返回围绕z、x、y轴方向的旋转角度。 |
- 示例 **返回值:**
``` ```
const promise = sensor.getDirection([1, 0, 0, 0, 1, 0, 0, 0, 1]); const promise = sensor.getDirection([1, 0, 0, 0, 1, 0, 0, 0, 1]);
...@@ -2191,15 +2185,15 @@ createRotationMatrix(gravity: Array&lt;number&gt;, geomagnetic: Array&lt;number& ...@@ -2191,15 +2185,15 @@ createRotationMatrix(gravity: Array&lt;number&gt;, geomagnetic: Array&lt;number&
**系统能力**:SystemCapability.Sensors.Sensor **系统能力**:SystemCapability.Sensors.Sensor
- 参数 **参数:**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| ----------- | ------------------------------------------------------------ | ---- | -------------- | | ----------- | ---------------------------------------- | ---- | ------- |
| gravity | Array&lt;number&gt; | 是 | 表示重力向量。 | | gravity | Array&lt;number&gt; | 是 | 表示重力向量。 |
| geomagnetic | Array&lt;number&gt; | 是 | 表示地磁矢量。 | | geomagnetic | Array&lt;number&gt; | 是 | 表示地磁矢量。 |
| callback | AsyncCallback&lt;[RotationMatrixResponse](#rotationmatrixresponse)&gt; | 是 | 返回旋转矩阵。 | | callback | AsyncCallback&lt;[RotationMatrixResponse](#rotationmatrixresponse)&gt; | 是 | 返回旋转矩阵。 |
- 示例 **返回值:**
``` ```
sensor.createRotationMatrix([-0.27775216, 0.5351276, 9.788099], [210.87253, -78.6096, -111.44444], function(err, data) { sensor.createRotationMatrix([-0.27775216, 0.5351276, 9.788099], [210.87253, -78.6096, -111.44444], function(err, data) {
...@@ -2224,20 +2218,20 @@ createRotationMatrix(gravity: Array&lt;number&gt;, geomagnetic: Array&lt;number& ...@@ -2224,20 +2218,20 @@ createRotationMatrix(gravity: Array&lt;number&gt;, geomagnetic: Array&lt;number&
**系统能力**:SystemCapability.Sensors.Sensor **系统能力**:SystemCapability.Sensors.Sensor
- 参数 **参数:**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| ----------- | ------------------- | ---- | -------------- | | ----------- | ------------------- | ---- | ------- |
| gravity | Array&lt;number&gt; | 是 | 表示重力向量。 | | gravity | Array&lt;number&gt; | 是 | 表示重力向量。 |
| geomagnetic | Array&lt;number&gt; | 是 | 表示地磁矢量。 | | geomagnetic | Array&lt;number&gt; | 是 | 表示地磁矢量。 |
- 返回值 **返回值:**
| 类型 | 说明 | | 类型 | 说明 |
| ------------------------------------------------------------ | -------------- | | ---------------------------------------- | ------- |
| Promise&lt;[RotationMatrixResponse](#rotationmatrixresponse)&gt; | 返回旋转矩阵。 | | Promise&lt;[RotationMatrixResponse](#rotationmatrixresponse)&gt; | 返回旋转矩阵。 |
- 示例 **返回值:**
``` ```
const promise = sensor.createRotationMatrix([-0.27775216, 0.5351276, 9.788099], [210.87253, -78.6096, -111.44444]); const promise = sensor.createRotationMatrix([-0.27775216, 0.5351276, 9.788099], [210.87253, -78.6096, -111.44444]);
...@@ -2260,7 +2254,7 @@ createRotationMatrix(gravity: Array&lt;number&gt;, geomagnetic: Array&lt;number& ...@@ -2260,7 +2254,7 @@ createRotationMatrix(gravity: Array&lt;number&gt;, geomagnetic: Array&lt;number&
| 名称 | 默认值 | 说明 | | 名称 | 默认值 | 说明 |
| -------- | -------- | -------- | | ---------------------------------------- | ---- | ----------- |
| SENSOR_TYPE_ID_ACCELEROMETER | 1 | 加速度传感器。 | | SENSOR_TYPE_ID_ACCELEROMETER | 1 | 加速度传感器。 |
| SENSOR_TYPE_ID_GYROSCOPE | 2 | 陀螺仪传感器。 | | SENSOR_TYPE_ID_GYROSCOPE | 2 | 陀螺仪传感器。 |
| SENSOR_TYPE_ID_AMBIENT_LIGHT | 5 | 环境光传感器。 | | SENSOR_TYPE_ID_AMBIENT_LIGHT | 5 | 环境光传感器。 |
...@@ -2291,7 +2285,7 @@ createRotationMatrix(gravity: Array&lt;number&gt;, geomagnetic: Array&lt;number& ...@@ -2291,7 +2285,7 @@ createRotationMatrix(gravity: Array&lt;number&gt;, geomagnetic: Array&lt;number&
**系统能力**:以下各项对应的系统能力均为SystemCapability.Sensors.Sensor **系统能力**:以下各项对应的系统能力均为SystemCapability.Sensors.Sensor
| 名称 | 参数类型 | 可读 | 可写 | 说明 | | 名称 | 参数类型 | 可读 | 可写 | 说明 |
| -------- | -------- | -------- | -------- | -------- | | --------- | ------ | ---- | ---- | ------------ |
| timestamp | number | 是 | 是 | 传感器数据上报的时间戳。 | | timestamp | number | 是 | 是 | 传感器数据上报的时间戳。 |
...@@ -2303,7 +2297,7 @@ createRotationMatrix(gravity: Array&lt;number&gt;, geomagnetic: Array&lt;number& ...@@ -2303,7 +2297,7 @@ createRotationMatrix(gravity: Array&lt;number&gt;, geomagnetic: Array&lt;number&
| 名称 | 参数类型 | 可读 | 可写 | 说明 | | 名称 | 参数类型 | 可读 | 可写 | 说明 |
| -------- | -------- | -------- | -------- | -------- | | ---- | ------ | ---- | ---- | ---------------------- |
| x | number | 是 | 是 | 施加在设备x轴的加速度,单位 : m/s2。 | | x | number | 是 | 是 | 施加在设备x轴的加速度,单位 : m/s2。 |
| y | number | 是 | 是 | 施加在设备y轴的加速度,单位 : m/s2。 | | y | number | 是 | 是 | 施加在设备y轴的加速度,单位 : m/s2。 |
| z | number | 是 | 是 | 施加在设备z轴的加速度,单位 : m/s2。 | | z | number | 是 | 是 | 施加在设备z轴的加速度,单位 : m/s2。 |
...@@ -2317,7 +2311,7 @@ createRotationMatrix(gravity: Array&lt;number&gt;, geomagnetic: Array&lt;number& ...@@ -2317,7 +2311,7 @@ createRotationMatrix(gravity: Array&lt;number&gt;, geomagnetic: Array&lt;number&
| 名称 | 参数类型 | 可读 | 可写 | 说明 | | 名称 | 参数类型 | 可读 | 可写 | 说明 |
| -------- | -------- | -------- | -------- | -------- | | ---- | ------ | ---- | ---- | ------------------------ |
| x | number | 是 | 是 | 施加在设备x轴的线性加速度,单位 : m/s2。 | | x | number | 是 | 是 | 施加在设备x轴的线性加速度,单位 : m/s2。 |
| y | number | 是 | 是 | 施加在设备y轴的线性加速度,单位 : m/s2。 | | y | number | 是 | 是 | 施加在设备y轴的线性加速度,单位 : m/s2。 |
| z | number | 是 | 是 | 施加在设备z轴的线性加速度,单位 : m/s2。 | | z | number | 是 | 是 | 施加在设备z轴的线性加速度,单位 : m/s2。 |
...@@ -2331,7 +2325,7 @@ createRotationMatrix(gravity: Array&lt;number&gt;, geomagnetic: Array&lt;number& ...@@ -2331,7 +2325,7 @@ createRotationMatrix(gravity: Array&lt;number&gt;, geomagnetic: Array&lt;number&
| 名称 | 参数类型 | 可读 | 可写 | 说明 | | 名称 | 参数类型 | 可读 | 可写 | 说明 |
| -------- | -------- | -------- | -------- | -------- | | ----- | ------ | ---- | ---- | ---------------------------- |
| x | number | 是 | 是 | 施加在设备x轴未校准的加速度,单位 : m/s2。 | | x | number | 是 | 是 | 施加在设备x轴未校准的加速度,单位 : m/s2。 |
| y | number | 是 | 是 | 施加在设备y轴未校准的加速度,单位 : m/s2。 | | y | number | 是 | 是 | 施加在设备y轴未校准的加速度,单位 : m/s2。 |
| z | number | 是 | 是 | 施加在设备z轴未校准的加速度,单位 : m/s2。 | | z | number | 是 | 是 | 施加在设备z轴未校准的加速度,单位 : m/s2。 |
...@@ -2348,7 +2342,7 @@ createRotationMatrix(gravity: Array&lt;number&gt;, geomagnetic: Array&lt;number& ...@@ -2348,7 +2342,7 @@ createRotationMatrix(gravity: Array&lt;number&gt;, geomagnetic: Array&lt;number&
| 名称 | 参数类型 | 可读 | 可写 | 说明 | | 名称 | 参数类型 | 可读 | 可写 | 说明 |
| -------- | -------- | -------- | -------- | -------- | | ---- | ------ | ---- | ---- | ------------------------ |
| x | number | 是 | 是 | 施加在设备x轴的重力加速度,单位 : m/s2。 | | x | number | 是 | 是 | 施加在设备x轴的重力加速度,单位 : m/s2。 |
| y | number | 是 | 是 | 施加在设备y轴的重力加速度,单位 : m/s2。 | | y | number | 是 | 是 | 施加在设备y轴的重力加速度,单位 : m/s2。 |
| z | number | 是 | 是 | 施加在设备z轴的重力加速度,单位 : m/s2。 | | z | number | 是 | 是 | 施加在设备z轴的重力加速度,单位 : m/s2。 |
...@@ -2362,7 +2356,7 @@ createRotationMatrix(gravity: Array&lt;number&gt;, geomagnetic: Array&lt;number& ...@@ -2362,7 +2356,7 @@ createRotationMatrix(gravity: Array&lt;number&gt;, geomagnetic: Array&lt;number&
| 名称 | 参数类型 | 可读 | 可写 | 说明 | | 名称 | 参数类型 | 可读 | 可写 | 说明 |
| -------- | -------- | -------- | -------- | -------- | | ----- | ------ | ---- | ---- | ------------------------ |
| alpha | number | 是 | 是 | 设备围绕 Z 轴旋转一定角度,单位 : rad。 | | alpha | number | 是 | 是 | 设备围绕 Z 轴旋转一定角度,单位 : rad。 |
| beta | number | 是 | 是 | 设备围绕 X轴旋转一定角度,单位 : rad。 | | beta | number | 是 | 是 | 设备围绕 X轴旋转一定角度,单位 : rad。 |
| gamma | number | 是 | 是 | 设备围绕 Y轴旋转一定角度,单位 : rad。 | | gamma | number | 是 | 是 | 设备围绕 Y轴旋转一定角度,单位 : rad。 |
...@@ -2376,7 +2370,7 @@ createRotationMatrix(gravity: Array&lt;number&gt;, geomagnetic: Array&lt;number& ...@@ -2376,7 +2370,7 @@ createRotationMatrix(gravity: Array&lt;number&gt;, geomagnetic: Array&lt;number&
| 名称 | 参数类型 | 可读 | 可写 | 说明 | | 名称 | 参数类型 | 可读 | 可写 | 说明 |
| -------- | -------- | -------- | -------- | -------- | | ---- | ------ | ---- | ---- | --------- |
| x | number | 是 | 是 | 旋转矢量x轴分量。 | | x | number | 是 | 是 | 旋转矢量x轴分量。 |
| y | number | 是 | 是 | 旋转矢量y轴分量。 | | y | number | 是 | 是 | 旋转矢量y轴分量。 |
| z | number | 是 | 是 | 旋转矢量z轴分量。 | | z | number | 是 | 是 | 旋转矢量z轴分量。 |
...@@ -2391,7 +2385,7 @@ createRotationMatrix(gravity: Array&lt;number&gt;, geomagnetic: Array&lt;number& ...@@ -2391,7 +2385,7 @@ createRotationMatrix(gravity: Array&lt;number&gt;, geomagnetic: Array&lt;number&
| 名称 | 参数类型 | 可读 | 可写 | 说明 | | 名称 | 参数类型 | 可读 | 可写 | 说明 |
| -------- | -------- | -------- | -------- | -------- | | ---- | ------ | ---- | ---- | ------------------- |
| x | number | 是 | 是 | 设备x轴的旋转角速度,单位rad/s。 | | x | number | 是 | 是 | 设备x轴的旋转角速度,单位rad/s。 |
| y | number | 是 | 是 | 设备y轴的旋转角速度,单位rad/s。 | | y | number | 是 | 是 | 设备y轴的旋转角速度,单位rad/s。 |
| z | number | 是 | 是 | 设备z轴的旋转角速度,单位rad/s。 | | z | number | 是 | 是 | 设备z轴的旋转角速度,单位rad/s。 |
...@@ -2405,7 +2399,7 @@ createRotationMatrix(gravity: Array&lt;number&gt;, geomagnetic: Array&lt;number& ...@@ -2405,7 +2399,7 @@ createRotationMatrix(gravity: Array&lt;number&gt;, geomagnetic: Array&lt;number&
| 名称 | 参数类型 | 可读 | 可写 | 说明 | | 名称 | 参数类型 | 可读 | 可写 | 说明 |
| -------- | -------- | -------- | -------- | -------- | | ----- | ------ | ---- | ---- | ------------------------ |
| x | number | 是 | 是 | 设备x轴未校准的旋转角速度,单位rad/s。 | | x | number | 是 | 是 | 设备x轴未校准的旋转角速度,单位rad/s。 |
| y | number | 是 | 是 | 设备y轴未校准的旋转角速度,单位rad/s。 | | y | number | 是 | 是 | 设备y轴未校准的旋转角速度,单位rad/s。 |
| z | number | 是 | 是 | 设备z轴未校准的旋转角速度,单位rad/s。 | | z | number | 是 | 是 | 设备z轴未校准的旋转角速度,单位rad/s。 |
...@@ -2422,7 +2416,7 @@ createRotationMatrix(gravity: Array&lt;number&gt;, geomagnetic: Array&lt;number& ...@@ -2422,7 +2416,7 @@ createRotationMatrix(gravity: Array&lt;number&gt;, geomagnetic: Array&lt;number&
| 名称 | 参数类型 | 可读 | 可写 | 说明 | | 名称 | 参数类型 | 可读 | 可写 | 说明 |
| -------- | -------- | -------- | -------- | -------- | | ------ | ------ | ---- | ---- | ---------------------------------------- |
| scalar | number | 是 | 是 | 表示剧烈运动程度。测量三个物理轴(x、y&nbsp;&nbsp;z)上,设备是否存在大幅度运动;如果取值为1则代表存在大幅度运动,取值为0则代表没有大幅度运动。 | | scalar | number | 是 | 是 | 表示剧烈运动程度。测量三个物理轴(x、y&nbsp;&nbsp;z)上,设备是否存在大幅度运动;如果取值为1则代表存在大幅度运动,取值为0则代表没有大幅度运动。 |
...@@ -2434,7 +2428,7 @@ createRotationMatrix(gravity: Array&lt;number&gt;, geomagnetic: Array&lt;number& ...@@ -2434,7 +2428,7 @@ createRotationMatrix(gravity: Array&lt;number&gt;, geomagnetic: Array&lt;number&
| 名称 | 参数类型 | 可读 | 可写 | 说明 | | 名称 | 参数类型 | 可读 | 可写 | 说明 |
| -------- | -------- | -------- | -------- | -------- | | -------- | ------ | ---- | ---- | ---------------------------- |
| distance | number | 是 | 是 | 可见物体与设备显示器的接近程度。0表示接近,1表示远离。 | | distance | number | 是 | 是 | 可见物体与设备显示器的接近程度。0表示接近,1表示远离。 |
...@@ -2446,7 +2440,7 @@ createRotationMatrix(gravity: Array&lt;number&gt;, geomagnetic: Array&lt;number& ...@@ -2446,7 +2440,7 @@ createRotationMatrix(gravity: Array&lt;number&gt;, geomagnetic: Array&lt;number&
| 名称 | 参数类型 | 可读 | 可写 | 说明 | | 名称 | 参数类型 | 可读 | 可写 | 说明 |
| -------- | -------- | -------- | -------- | -------- | | --------- | ------ | ---- | ---- | ----------- |
| intensity | number | 是 | 是 | 光强(单位:勒克斯)。 | | intensity | number | 是 | 是 | 光强(单位:勒克斯)。 |
...@@ -2458,7 +2452,7 @@ createRotationMatrix(gravity: Array&lt;number&gt;, geomagnetic: Array&lt;number& ...@@ -2458,7 +2452,7 @@ createRotationMatrix(gravity: Array&lt;number&gt;, geomagnetic: Array&lt;number&
| 名称 | 参数类型 | 可读 | 可写 | 说明 | | 名称 | 参数类型 | 可读 | 可写 | 说明 |
| -------- | -------- | -------- | -------- | -------- | | ------ | ------ | ---- | ---- | --------------------------------- |
| status | number | 是 | 是 | 显示霍尔状态。测量设备周围是否存在磁力吸引,0表示有,1表示没有。 | | status | number | 是 | 是 | 显示霍尔状态。测量设备周围是否存在磁力吸引,0表示有,1表示没有。 |
...@@ -2470,7 +2464,7 @@ createRotationMatrix(gravity: Array&lt;number&gt;, geomagnetic: Array&lt;number& ...@@ -2470,7 +2464,7 @@ createRotationMatrix(gravity: Array&lt;number&gt;, geomagnetic: Array&lt;number&
| 名称 | 参数类型 | 可读 | 可写 | 说明 | | 名称 | 参数类型 | 可读 | 可写 | 说明 |
| -------- | -------- | -------- | -------- | -------- | | ---- | ------ | ---- | ---- | ------------------ |
| x | number | 是 | 是 | x轴环境磁场强度,单位 : μT。 | | x | number | 是 | 是 | x轴环境磁场强度,单位 : μT。 |
| y | number | 是 | 是 | y轴环境磁场强度,单位 : μT。 | | y | number | 是 | 是 | y轴环境磁场强度,单位 : μT。 |
| z | number | 是 | 是 | z轴环境磁场强度,单位 : μT。。 | | z | number | 是 | 是 | z轴环境磁场强度,单位 : μT。。 |
...@@ -2484,7 +2478,7 @@ createRotationMatrix(gravity: Array&lt;number&gt;, geomagnetic: Array&lt;number& ...@@ -2484,7 +2478,7 @@ createRotationMatrix(gravity: Array&lt;number&gt;, geomagnetic: Array&lt;number&
| 名称 | 参数类型 | 可读 | 可写 | 说明 | | 名称 | 参数类型 | 可读 | 可写 | 说明 |
| -------- | -------- | -------- | -------- | -------- | | ----- | ------ | ---- | ---- | ---------------------- |
| x | number | 是 | 是 | x轴未校准环境磁场强度,单位 : μT。 | | x | number | 是 | 是 | x轴未校准环境磁场强度,单位 : μT。 |
| y | number | 是 | 是 | y轴未校准环境磁场强度,单位 : μT。 | | y | number | 是 | 是 | y轴未校准环境磁场强度,单位 : μT。 |
| z | number | 是 | 是 | z轴未校准环境磁场强度,单位 : μT。 | | z | number | 是 | 是 | z轴未校准环境磁场强度,单位 : μT。 |
...@@ -2501,7 +2495,7 @@ createRotationMatrix(gravity: Array&lt;number&gt;, geomagnetic: Array&lt;number& ...@@ -2501,7 +2495,7 @@ createRotationMatrix(gravity: Array&lt;number&gt;, geomagnetic: Array&lt;number&
| 名称 | 参数类型 | 可读 | 可写 | 说明 | | 名称 | 参数类型 | 可读 | 可写 | 说明 |
| -------- | -------- | -------- | -------- | -------- | | ----- | ------ | ---- | ---- | -------- |
| steps | number | 是 | 是 | 用户的行走步数。 | | steps | number | 是 | 是 | 用户的行走步数。 |
...@@ -2513,7 +2507,7 @@ createRotationMatrix(gravity: Array&lt;number&gt;, geomagnetic: Array&lt;number& ...@@ -2513,7 +2507,7 @@ createRotationMatrix(gravity: Array&lt;number&gt;, geomagnetic: Array&lt;number&
| 名称 | 参数类型 | 可读 | 可写 | 说明 | | 名称 | 参数类型 | 可读 | 可写 | 说明 |
| -------- | -------- | -------- | -------- | -------- | | -------- | ------ | ---- | ---- | ------------------------------------ |
| humidity | number | 是 | 是 | 湿度值。测量环境的相对湿度,以百分比&nbsp;(%)&nbsp;表示。 | | humidity | number | 是 | 是 | 湿度值。测量环境的相对湿度,以百分比&nbsp;(%)&nbsp;表示。 |
...@@ -2525,7 +2519,7 @@ createRotationMatrix(gravity: Array&lt;number&gt;, geomagnetic: Array&lt;number& ...@@ -2525,7 +2519,7 @@ createRotationMatrix(gravity: Array&lt;number&gt;, geomagnetic: Array&lt;number&
| 名称 | 参数类型 | 可读 | 可写 | 说明 | | 名称 | 参数类型 | 可读 | 可写 | 说明 |
| -------- | -------- | -------- | -------- | -------- | | ------ | ------ | ---- | ---- | ---------------------------------------- |
| scalar | number | 是 | 是 | 计步器检测。检测用户的计步动作,如果取值为1则代表用户产生了计步行走的动作,取值为0则代表用户没有发生运动。 | | scalar | number | 是 | 是 | 计步器检测。检测用户的计步动作,如果取值为1则代表用户产生了计步行走的动作,取值为0则代表用户没有发生运动。 |
...@@ -2537,7 +2531,7 @@ createRotationMatrix(gravity: Array&lt;number&gt;, geomagnetic: Array&lt;number& ...@@ -2537,7 +2531,7 @@ createRotationMatrix(gravity: Array&lt;number&gt;, geomagnetic: Array&lt;number&
| 名称 | 参数类型 | 可读 | 可写 | 说明 | | 名称 | 参数类型 | 可读 | 可写 | 说明 |
| -------- | -------- | -------- | -------- | -------- | | ----------- | ------ | ---- | ---- | ------------- |
| temperature | number | 是 | 是 | 环境温度(单位:摄氏度)。 | | temperature | number | 是 | 是 | 环境温度(单位:摄氏度)。 |
...@@ -2549,7 +2543,7 @@ createRotationMatrix(gravity: Array&lt;number&gt;, geomagnetic: Array&lt;number& ...@@ -2549,7 +2543,7 @@ createRotationMatrix(gravity: Array&lt;number&gt;, geomagnetic: Array&lt;number&
| 名称 | 参数类型 | 可读 | 可写 | 说明 | | 名称 | 参数类型 | 可读 | 可写 | 说明 |
| -------- | -------- | -------- | -------- | -------- | | -------- | ------ | ---- | ---- | ------------ |
| pressure | number | 是 | 是 | 压力值(单位:帕斯卡)。 | | pressure | number | 是 | 是 | 压力值(单位:帕斯卡)。 |
...@@ -2561,7 +2555,7 @@ createRotationMatrix(gravity: Array&lt;number&gt;, geomagnetic: Array&lt;number& ...@@ -2561,7 +2555,7 @@ createRotationMatrix(gravity: Array&lt;number&gt;, geomagnetic: Array&lt;number&
| 名称 | 参数类型 | 可读 | 可写 | 说明 | | 名称 | 参数类型 | 可读 | 可写 | 说明 |
| -------- | -------- | -------- | -------- | -------- | | --------- | ------ | ---- | ---- | --------------------- |
| heartRate | number | 是 | 是 | 心率值。测量用户的心率数值,单位:bpm。 | | heartRate | number | 是 | 是 | 心率值。测量用户的心率数值,单位:bpm。 |
...@@ -2573,7 +2567,7 @@ createRotationMatrix(gravity: Array&lt;number&gt;, geomagnetic: Array&lt;number& ...@@ -2573,7 +2567,7 @@ createRotationMatrix(gravity: Array&lt;number&gt;, geomagnetic: Array&lt;number&
| 名称 | 参数类型 | 可读 | 可写 | 说明 | | 名称 | 参数类型 | 可读 | 可写 | 说明 |
| -------- | -------- | -------- | -------- | -------- | | ----- | ------ | ---- | ---- | ------------------------- |
| value | number | 是 | 是 | 表示设备是否被穿戴(1表示已穿戴,0表示未穿戴)。 | | value | number | 是 | 是 | 表示设备是否被穿戴(1表示已穿戴,0表示未穿戴)。 |
...@@ -2584,7 +2578,7 @@ createRotationMatrix(gravity: Array&lt;number&gt;, geomagnetic: Array&lt;number& ...@@ -2584,7 +2578,7 @@ createRotationMatrix(gravity: Array&lt;number&gt;, geomagnetic: Array&lt;number&
**系统能力**:以下各项对应的系统能力均为SystemCapability.Sensors.Sensor **系统能力**:以下各项对应的系统能力均为SystemCapability.Sensors.Sensor
| 名称 | 参数类型 | 说明 | | 名称 | 参数类型 | 说明 |
| -------- | -------- | -------- | | -------- | ------ | --------------------------- |
| interval | number | 表示传感器的上报频率,默认值为200000000ns。 | | interval | number | 表示传感器的上报频率,默认值为200000000ns。 |
## RotationMatrixResponse ## RotationMatrixResponse
...@@ -2594,7 +2588,7 @@ createRotationMatrix(gravity: Array&lt;number&gt;, geomagnetic: Array&lt;number& ...@@ -2594,7 +2588,7 @@ createRotationMatrix(gravity: Array&lt;number&gt;, geomagnetic: Array&lt;number&
**系统能力**:以下各项对应的系统能力均为SystemCapability.Sensors.Sensor **系统能力**:以下各项对应的系统能力均为SystemCapability.Sensors.Sensor
| 名称 | 参数类型 | 可读 | 可写 | 说明 | | 名称 | 参数类型 | 可读 | 可写 | 说明 |
| ----------- | ------------------- | ---- | ---- | ---------- | | ----------- | ------------------- | ---- | ---- | ----- |
| rotation | Array&lt;number&gt; | 是 | 是 | 旋转矩阵。 | | rotation | Array&lt;number&gt; | 是 | 是 | 旋转矩阵。 |
| inclination | Array&lt;number&gt; | 是 | 是 | 倾斜矩阵。 | | inclination | Array&lt;number&gt; | 是 | 是 | 倾斜矩阵。 |
...@@ -2606,7 +2600,7 @@ createRotationMatrix(gravity: Array&lt;number&gt;, geomagnetic: Array&lt;number& ...@@ -2606,7 +2600,7 @@ createRotationMatrix(gravity: Array&lt;number&gt;, geomagnetic: Array&lt;number&
**系统能力**:以下各项对应的系统能力均为SystemCapability.Sensors.Sensor **系统能力**:以下各项对应的系统能力均为SystemCapability.Sensors.Sensor
| 名称 | 参数类型 | 可读 | 可写 | 说明 | | 名称 | 参数类型 | 可读 | 可写 | 说明 |
| ---- | -------- | ---- | ---- | ----------- | | ---- | ------ | ---- | ---- | ------ |
| x | number | 是 | 是 | x坐标方向。 | | x | number | 是 | 是 | x坐标方向。 |
| y | number | 是 | 是 | y坐标方向。 | | y | number | 是 | 是 | y坐标方向。 |
...@@ -2618,7 +2612,7 @@ createRotationMatrix(gravity: Array&lt;number&gt;, geomagnetic: Array&lt;number& ...@@ -2618,7 +2612,7 @@ createRotationMatrix(gravity: Array&lt;number&gt;, geomagnetic: Array&lt;number&
**系统能力**:以下各项对应的系统能力均为SystemCapability.Sensors.Sensor **系统能力**:以下各项对应的系统能力均为SystemCapability.Sensors.Sensor
| 名称 | 参数类型 | 可读 | 可写 | 说明 | | 名称 | 参数类型 | 可读 | 可写 | 说明 |
| -------- | -------- | -------- | -------- | -------- | | --------------- | ------ | ---- | ---- | ------------------------- |
| x | number | 是 | 是 | 地磁场的北分量。 | | x | number | 是 | 是 | 地磁场的北分量。 |
| y | number | 是 | 是 | 地磁场的东分量。 | | y | number | 是 | 是 | 地磁场的东分量。 |
| z | number | 是 | 是 | 地磁场的垂直分量。 | | z | number | 是 | 是 | 地磁场的垂直分量。 |
...@@ -2634,7 +2628,7 @@ createRotationMatrix(gravity: Array&lt;number&gt;, geomagnetic: Array&lt;number& ...@@ -2634,7 +2628,7 @@ createRotationMatrix(gravity: Array&lt;number&gt;, geomagnetic: Array&lt;number&
**系统能力**:以下各项对应的系统能力均为SystemCapability.Sensors.Sensor **系统能力**:以下各项对应的系统能力均为SystemCapability.Sensors.Sensor
| 名称 | 参数类型 | 可读 | 可写 | 说明 | | 名称 | 参数类型 | 可读 | 可写 | 说明 |
| -------- | -------- | -------- | -------- | -------- | | --------- | ------ | ---- | ---- | ----- |
| latitude | number | 是 | 是 | 纬度。 | | latitude | number | 是 | 是 | 纬度。 |
| longitude | number | 是 | 是 | 经度。 | | longitude | number | 是 | 是 | 经度。 |
| altitude | number | 是 | 是 | 海拔高度。 | | altitude | number | 是 | 是 | 海拔高度。 |
...@@ -31,14 +31,14 @@ getUpdater(upgradeFile: string, updateType?: UpdateTypes): Updater ...@@ -31,14 +31,14 @@ getUpdater(upgradeFile: string, updateType?: UpdateTypes): Updater
**参数:** **参数:**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| ----------- | --------------------------- | ---- | -------- | | ----------- | --------------------------- | ---- | ---- |
| upgradeFile | string | 是 | 升级文件 | | upgradeFile | string | 是 | 升级文件 |
| updateType | [UpdateTypes](#updatetypes) | 是 | 升级类型 | | updateType | [UpdateTypes](#updatetypes) | 是 | 升级类型 |
**返回值:** **返回值:**
| 类型 | 说明 | | 类型 | 说明 |
| ------------------- | -------- | | ------------------- | ---- |
| [Updater](#updater) | 升级对象 | | [Updater](#updater) | 升级对象 |
**示例:** **示例:**
...@@ -62,7 +62,7 @@ getUpdaterForOther(upgradeFile: string, device: string, updateType?: UpdateTypes ...@@ -62,7 +62,7 @@ getUpdaterForOther(upgradeFile: string, device: string, updateType?: UpdateTypes
**参数:** **参数:**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| ----------- | --------------------------- | ---- | ---------- | | ----------- | --------------------------- | ---- | ----- |
| upgradeFile | string | 是 | 升级文件 | | upgradeFile | string | 是 | 升级文件 |
| device | string | 是 | 待升级设备 | | device | string | 是 | 待升级设备 |
| updateType | [UpdateTypes](#updatetypes) | 是 | 升级类型 | | updateType | [UpdateTypes](#updatetypes) | 是 | 升级类型 |
...@@ -70,7 +70,7 @@ getUpdaterForOther(upgradeFile: string, device: string, updateType?: UpdateTypes ...@@ -70,7 +70,7 @@ getUpdaterForOther(upgradeFile: string, device: string, updateType?: UpdateTypes
**返回值:** **返回值:**
| 类型 | 说明 | | 类型 | 说明 |
| ------------------- | -------- | | ------------------- | ---- |
| [Updater](#updater) | 升级对象 | | [Updater](#updater) | 升级对象 |
**示例:** **示例:**
...@@ -94,7 +94,7 @@ getUpdaterFromOther(upgradeFile: string, device: string, updateType?: UpdateType ...@@ -94,7 +94,7 @@ getUpdaterFromOther(upgradeFile: string, device: string, updateType?: UpdateType
**参数:** **参数:**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| ----------- | --------------------------- | ---- | ---------- | | ----------- | --------------------------- | ---- | ----- |
| upgradeFile | string | 是 | 升级文件 | | upgradeFile | string | 是 | 升级文件 |
| device | string | 是 | 待升级设备 | | device | string | 是 | 待升级设备 |
| updateType | [UpdateTypes](#updatetypes) | 是 | 升级类型 | | updateType | [UpdateTypes](#updatetypes) | 是 | 升级类型 |
...@@ -102,7 +102,7 @@ getUpdaterFromOther(upgradeFile: string, device: string, updateType?: UpdateType ...@@ -102,7 +102,7 @@ getUpdaterFromOther(upgradeFile: string, device: string, updateType?: UpdateType
**返回值:** **返回值:**
| 类型 | 说明 | | 类型 | 说明 |
| ------------------- | -------- | | ------------------- | ---- |
| [Updater](#updater) | 升级对象 | | [Updater](#updater) | 升级对象 |
**示例:** **示例:**
...@@ -128,7 +128,7 @@ getNewVersionInfo(callback: AsyncCallback\<NewVersionInfo>): void ...@@ -128,7 +128,7 @@ getNewVersionInfo(callback: AsyncCallback\<NewVersionInfo>): void
**参数:** **参数:**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | ------------------------------------------------ | ---- | ------------------ | | -------- | ---------------------------------------- | ---- | --------- |
| callback | AsyncCallback<[NewVersionInfo](#newversioninfo)> | 否 | 回调返回新版本信息 | | callback | AsyncCallback<[NewVersionInfo](#newversioninfo)> | 否 | 回调返回新版本信息 |
**示例:** **示例:**
...@@ -153,7 +153,7 @@ getNewVersionInfo(): Promise\<NewVersionInfo> ...@@ -153,7 +153,7 @@ getNewVersionInfo(): Promise\<NewVersionInfo>
**返回值:** **返回值:**
| 类型 | 说明 | | 类型 | 说明 |
| ------------------------------------------- | ------------------------- | | ---------------------------------------- | ---------------- |
| Promise\<[NewVersionInfo](#newversioninfo)> | Promise,用于异步获取结果 | | Promise\<[NewVersionInfo](#newversioninfo)> | Promise,用于异步获取结果 |
**示例:** **示例:**
...@@ -179,7 +179,7 @@ checkNewVersion(callback: AsyncCallback\<NewVersionInfo>): void ...@@ -179,7 +179,7 @@ checkNewVersion(callback: AsyncCallback\<NewVersionInfo>): void
**参数:** **参数:**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | ------------------------------------------------- | ---- | ------------------ | | -------- | ---------------------------------------- | ---- | --------- |
| callback | AsyncCallback\<[NewVersionInfo](#newversioninfo)> | 否 | 回调返回新版本信息 | | callback | AsyncCallback\<[NewVersionInfo](#newversioninfo)> | 否 | 回调返回新版本信息 |
**示例:** **示例:**
...@@ -204,7 +204,7 @@ checkNewVersion(): Promise\<NewVersionInfo> ...@@ -204,7 +204,7 @@ checkNewVersion(): Promise\<NewVersionInfo>
**返回值:** **返回值:**
| 类型 | 说明 | | 类型 | 说明 |
| ------------------------------------------- | ------------------------- | | ---------------------------------------- | ---------------- |
| Promise\<[NewVersionInfo](#newversioninfo)> | Promise函数返回新版本信息 | | Promise\<[NewVersionInfo](#newversioninfo)> | Promise函数返回新版本信息 |
**示例:** **示例:**
...@@ -230,7 +230,7 @@ verifyUpdatePackage(upgradeFile: string, certsFile: string): void ...@@ -230,7 +230,7 @@ verifyUpdatePackage(upgradeFile: string, certsFile: string): void
**参数:** **参数:**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| ----------- | ------ | ---- | ------------------ | | ----------- | ------ | ---- | --------- |
| upgradeFile | string | 是 | 待校验的升级包路径 | | upgradeFile | string | 是 | 待校验的升级包路径 |
| certsFile | string | 是 | 证书路径 | | certsFile | string | 是 | 证书路径 |
...@@ -254,7 +254,7 @@ rebootAndCleanUserData(): Promise\<number> ...@@ -254,7 +254,7 @@ rebootAndCleanUserData(): Promise\<number>
**返回值:** **返回值:**
| 类型 | 说明 | | 类型 | 说明 |
| ---------------- | ------------------------------- | | ---------------- | ------------------- |
| Promise\<number> | Promise示例,用于异步获取结果。 | | Promise\<number> | Promise示例,用于异步获取结果。 |
**示例:** **示例:**
...@@ -300,7 +300,7 @@ applyNewVersion(): Promise\<number> ...@@ -300,7 +300,7 @@ applyNewVersion(): Promise\<number>
**返回值:** **返回值:**
| 类型 | 说明 | | 类型 | 说明 |
| ---------------- | ------------------------------- | | ---------------- | ------------------- |
| Promise\<number> | Promise示例,用于异步获取结果。 | | Promise\<number> | Promise示例,用于异步获取结果。 |
**示例:** **示例:**
...@@ -356,7 +356,7 @@ updater.download(); ...@@ -356,7 +356,7 @@ updater.download();
### upgrade ### upgrade
updater.upgrade():void upgrade():void
启动升级。 启动升级。
...@@ -384,7 +384,7 @@ setUpdatePolicy(policy: UpdatePolicy, callback: AsyncCallback\<number>): void ...@@ -384,7 +384,7 @@ setUpdatePolicy(policy: UpdatePolicy, callback: AsyncCallback\<number>): void
**参数:** **参数:**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | ----------------------------- | ---- | ------------ | | -------- | ----------------------------- | ---- | ------ |
| policy | [UpdatePolicy](#updatepolicy) | 是 | 设置升级策略 | | policy | [UpdatePolicy](#updatepolicy) | 是 | 设置升级策略 |
| callback | AsyncCallback\<number> | 是 | 回调返回结果 | | callback | AsyncCallback\<number> | 是 | 回调返回结果 |
...@@ -415,13 +415,13 @@ setUpdatePolicy(policy: UpdatePolicy): Promise\<number> ...@@ -415,13 +415,13 @@ setUpdatePolicy(policy: UpdatePolicy): Promise\<number>
**参数:** **参数:**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| ------ | ----------------------------- | ---- | ------------ | | ------ | ----------------------------- | ---- | ------ |
| policy | [UpdatePolicy](#updatepolicy) | 是 | 设置升级策略 | | policy | [UpdatePolicy](#updatepolicy) | 是 | 设置升级策略 |
**返回值:** **返回值:**
| 类型 | 说明 | | 类型 | 说明 |
| ---------------- | ----------------------- | | ---------------- | --------------- |
| Promise\<number> | Promise函数返回设置结果 | | Promise\<number> | Promise函数返回设置结果 |
**示例:** **示例:**
...@@ -452,7 +452,7 @@ getUpdatePolicy(callback: AsyncCallback\<UpdatePolicy>): void ...@@ -452,7 +452,7 @@ getUpdatePolicy(callback: AsyncCallback\<UpdatePolicy>): void
**参数:** **参数:**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | --------------------------------------------- | ---- | -------------------- | | -------- | ---------------------------------------- | ---- | ---------- |
| callback | AsyncCallback\<[UpdatePolicy](#updatepolicy)> | 否 | 回调返回升级策略信息 | | callback | AsyncCallback\<[UpdatePolicy](#updatepolicy)> | 否 | 回调返回升级策略信息 |
**示例:** **示例:**
...@@ -477,7 +477,7 @@ getUpdatePolicy(): Promise\<UpdatePolicy> ...@@ -477,7 +477,7 @@ getUpdatePolicy(): Promise\<UpdatePolicy>
**返回值:** **返回值:**
| 类型 | 说明 | | 类型 | 说明 |
| --------------------------------------- | --------------------------- | | --------------------------------------- | ----------------- |
| Promise\<[UpdatePolicy](#updatepolicy)> | Promise函数返回升级策略信息 | | Promise\<[UpdatePolicy](#updatepolicy)> | Promise函数返回升级策略信息 |
**示例:** **示例:**
...@@ -499,7 +499,7 @@ update.getUpdatePolicy().then(value => { ...@@ -499,7 +499,7 @@ update.getUpdatePolicy().then(value => {
**系统能力**:以下各项对应的系统能力均为:SystemCapability.Update.UpdateService **系统能力**:以下各项对应的系统能力均为:SystemCapability.Update.UpdateService
| 参数名 | 说明 | | 参数名 | 说明 |
| ------ | -------- | | ----- | ----- |
| OTA | OTA升级 | | OTA | OTA升级 |
| patch | 补丁升级 | | patch | 补丁升级 |
...@@ -510,7 +510,7 @@ update.getUpdatePolicy().then(value => { ...@@ -510,7 +510,7 @@ update.getUpdatePolicy().then(value => {
**系统能力**:以下各项对应的系统能力均为:SystemCapability.Update.UpdateService **系统能力**:以下各项对应的系统能力均为:SystemCapability.Update.UpdateService
| 参数名 | 默认值 | 说明 | | 参数名 | 默认值 | 说明 |
| -------------------- | ------ | -------------- | | -------------------- | ---- | ------- |
| PACKAGE_TYPE_NORMAL | 1 | 通用升级包 | | PACKAGE_TYPE_NORMAL | 1 | 通用升级包 |
| PACKAGE_TYPE_BASE | 2 | 基础升级包 | | PACKAGE_TYPE_BASE | 2 | 基础升级包 |
| PACKAGE_TYPE_CUST | 3 | 定制升级包 | | PACKAGE_TYPE_CUST | 3 | 定制升级包 |
...@@ -526,7 +526,7 @@ update.getUpdatePolicy().then(value => { ...@@ -526,7 +526,7 @@ update.getUpdatePolicy().then(value => {
**系统能力**:以下各项对应的系统能力均为:SystemCapability.Update.UpdateService **系统能力**:以下各项对应的系统能力均为:SystemCapability.Update.UpdateService
| 参数名 | 默认值 | 说明 | | 参数名 | 默认值 | 说明 |
| ------------------- | ------ | -------- | | ------------------- | ---- | ---- |
| INSTALL_MODE_NORMAL | 0 | 正常升级 | | INSTALL_MODE_NORMAL | 0 | 正常升级 |
| INSTALL_MODE_NIGHT | 1 | 夜间升级 | | INSTALL_MODE_NIGHT | 1 | 夜间升级 |
| INSTALL_MODE_AUTO | 2 | 自动升级 | | INSTALL_MODE_AUTO | 2 | 自动升级 |
...@@ -538,7 +538,7 @@ update.getUpdatePolicy().then(value => { ...@@ -538,7 +538,7 @@ update.getUpdatePolicy().then(value => {
**系统能力**:以下各项对应的系统能力均为:SystemCapability.Update.UpdateService **系统能力**:以下各项对应的系统能力均为:SystemCapability.Update.UpdateService
| 参数名 | 默认值 | 说明 | | 参数名 | 默认值 | 说明 |
| ------------------- | ------ | ---------------- | | ------------------- | ---- | -------- |
| VERSION_STATUS_ERR | -1 | 检测版本时出错 | | VERSION_STATUS_ERR | -1 | 检测版本时出错 |
| VERSION_STATUS_NEW | 0 | 检测到新版本 | | VERSION_STATUS_NEW | 0 | 检测到新版本 |
| VERSION_STATUS_NONE | 1 | 没有检测到新版本 | | VERSION_STATUS_NONE | 1 | 没有检测到新版本 |
...@@ -551,7 +551,7 @@ update.getUpdatePolicy().then(value => { ...@@ -551,7 +551,7 @@ update.getUpdatePolicy().then(value => {
**系统能力**:以下各项对应的系统能力均为:SystemCapability.Update.UpdateService **系统能力**:以下各项对应的系统能力均为:SystemCapability.Update.UpdateService
| 名称 | 参数类型 | 必填 | 说明 | | 名称 | 参数类型 | 必填 | 说明 |
| ------------------- | --------------------------- | ---- | -------------- | | ------------------- | --------------------------- | ---- | ------- |
| autoDownload | bool | 是 | 自动升级开关 | | autoDownload | bool | 是 | 自动升级开关 |
| installMode | [InstallMode](#installmode) | 是 | 安装模式 | | installMode | [InstallMode](#installmode) | 是 | 安装模式 |
| autoUpgradeInterval | Array\<number> | 是 | 自动升级时间段 | | autoUpgradeInterval | Array\<number> | 是 | 自动升级时间段 |
...@@ -563,7 +563,7 @@ update.getUpdatePolicy().then(value => { ...@@ -563,7 +563,7 @@ update.getUpdatePolicy().then(value => {
**系统能力**:以下各项对应的系统能力均为:SystemCapability.Update.UpdateService **系统能力**:以下各项对应的系统能力均为:SystemCapability.Update.UpdateService
| 名称 | 参数类型 | 必填 | 说明 | | 名称 | 参数类型 | 必填 | 说明 |
| --------------- | ------------------------------------------- | ---- | -------- | | --------------- | ---------------------------------------- | ---- | ---- |
| status | [NewVersionStatus](#newversionstatus) | 是 | 升级状态 | | status | [NewVersionStatus](#newversionstatus) | 是 | 升级状态 |
| errMsg | string | 是 | 错误信息 | | errMsg | string | 是 | 错误信息 |
| checkResults | Array<[CheckResult](#checkresult)> | 是 | 检测结果 | | checkResults | Array<[CheckResult](#checkresult)> | 是 | 检测结果 |
...@@ -576,7 +576,7 @@ update.getUpdatePolicy().then(value => { ...@@ -576,7 +576,7 @@ update.getUpdatePolicy().then(value => {
**系统能力**:以下各项对应的系统能力均为:SystemCapability.Update.UpdateService **系统能力**:以下各项对应的系统能力均为:SystemCapability.Update.UpdateService
| 名称 | 参数类型 | 必填 | 说明 | | 名称 | 参数类型 | 必填 | 说明 |
| ------------- | ----------------------------- | ---- | ------------ | | ------------- | ----------------------------- | ---- | ------ |
| versionName | string | 是 | 版本名称 | | versionName | string | 是 | 版本名称 |
| versionCode | number | 是 | 版本编码 | | versionCode | number | 是 | 版本编码 |
| size | number | 是 | 版本大小 | | size | number | 是 | 版本大小 |
...@@ -591,6 +591,6 @@ update.getUpdatePolicy().then(value => { ...@@ -591,6 +591,6 @@ update.getUpdatePolicy().then(value => {
**系统能力**:以下各项对应的系统能力均为:SystemCapability.Update.UpdateService **系统能力**:以下各项对应的系统能力均为:SystemCapability.Update.UpdateService
| 名称 | 参数类型 | 必填 | 说明 | | 名称 | 参数类型 | 必填 | 说明 |
| ------------- | -------- | ---- | ----------------- | | ------------- | ------ | ---- | ------------- |
| descriptionId | string | 是 | 版本versionId信息 | | descriptionId | string | 是 | 版本versionId信息 |
| content | string | 是 | 版本changelog信息 | | content | string | 是 | 版本changelog信息 |
\ No newline at end of file
...@@ -22,18 +22,18 @@ vibrate(duration: number): Promise&lt;void&gt; ...@@ -22,18 +22,18 @@ vibrate(duration: number): Promise&lt;void&gt;
**系统能力**:SystemCapability.Sensors.MiscDevice **系统能力**:SystemCapability.Sensors.MiscDevice
- 参数: **参数:**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | | -------- | ------ | ---- | ------------ |
| duration | number | 是 | 指示马达振动的持续时间。 | | duration | number | 是 | 指示马达振动的持续时间。 |
- 返回值: **返回值:**
| 类型 | 说明 | | 类型 | 说明 |
| -------- | -------- | | ------------------- | ----------- |
| Promise&lt;void&gt; | 指示触发振动是否成功。 | | Promise&lt;void&gt; | 指示触发振动是否成功。 |
- 示例: **示例:**
``` ```
vibrator.vibrate(1000).then(()=>{ vibrator.vibrate(1000).then(()=>{
console.log("Promise returned to indicate a successful vibration."); console.log("Promise returned to indicate a successful vibration.");
...@@ -53,13 +53,13 @@ vibrate(duration: number, callback?: AsyncCallback&lt;void&gt;): void ...@@ -53,13 +53,13 @@ vibrate(duration: number, callback?: AsyncCallback&lt;void&gt;): void
**系统能力**:SystemCapability.Sensors.MiscDevice **系统能力**:SystemCapability.Sensors.MiscDevice
- 参数: **参数:**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | | -------- | ------------------------- | ---- | ----------------------- |
| duration | number | 是 | 指示马达振动的持续时间。 | | duration | number | 是 | 指示马达振动的持续时间。 |
| callback | AsyncCallback&lt;void&gt; | 否 | 马达执行振动的回调函数,指示触发振动是否成功。 | | callback | AsyncCallback&lt;void&gt; | 否 | 马达执行振动的回调函数,指示触发振动是否成功。 |
- 示例: **示例:**
``` ```
vibrator.vibrate(1000,function(error){ vibrator.vibrate(1000,function(error){
if(error){ if(error){
...@@ -81,17 +81,17 @@ vibrate(effectId: EffectId): Promise&lt;void&gt; ...@@ -81,17 +81,17 @@ vibrate(effectId: EffectId): Promise&lt;void&gt;
**系统能力**:SystemCapability.Sensors.MiscDevice **系统能力**:SystemCapability.Sensors.MiscDevice
- 参数: **参数:**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | | -------- | --------------------- | ---- | ------------- |
| effectId | [EffectId](#effectid) | 是 | 指示马达振动效果的字符串。 | | effectId | [EffectId](#effectid) | 是 | 指示马达振动效果的字符串。 |
- 返回值: **返回值:**
| 类型 | 说明 | | 类型 | 说明 |
| -------- | -------- | | ------------------- | ----------- |
| Promise&lt;void&gt; | 指示触发振动是否成功。 | | Promise&lt;void&gt; | 指示触发振动是否成功。 |
- 示例: **示例:**
``` ```
vibrator.vibrate(vibrator.EffectId.EFFECT_CLOCK_TIMER).then(()=>{ vibrator.vibrate(vibrator.EffectId.EFFECT_CLOCK_TIMER).then(()=>{
console.log("Promise returned to indicate a successful vibration."); console.log("Promise returned to indicate a successful vibration.");
...@@ -111,13 +111,13 @@ vibrate(effectId: EffectId, callback?: AsyncCallback&lt;void&gt;): void ...@@ -111,13 +111,13 @@ vibrate(effectId: EffectId, callback?: AsyncCallback&lt;void&gt;): void
**系统能力**:SystemCapability.Sensors.MiscDevice **系统能力**:SystemCapability.Sensors.MiscDevice
- 参数: **参数:**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | | -------- | ------------------------- | ---- | ----------------------- |
| effectId | [EffectId](#effectid) | 是 | 指示马达振动效果的字符串。 | | effectId | [EffectId](#effectid) | 是 | 指示马达振动效果的字符串。 |
| callback | AsyncCallback&lt;void&gt; | 否 | 马达执行振动的回调函数,指示触发振动是否成功。 | | callback | AsyncCallback&lt;void&gt; | 否 | 马达执行振动的回调函数,指示触发振动是否成功。 |
- 示例: **示例:**
``` ```
vibrator.vibrate(vibrator.EffectId.EFFECT_CLOCK_TIMER, function(error){ vibrator.vibrate(vibrator.EffectId.EFFECT_CLOCK_TIMER, function(error){
if(error){ if(error){
...@@ -139,17 +139,17 @@ stop(stopMode: VibratorStopMode): Promise&lt;void&gt; ...@@ -139,17 +139,17 @@ stop(stopMode: VibratorStopMode): Promise&lt;void&gt;
**系统能力**:SystemCapability.Sensors.MiscDevice **系统能力**:SystemCapability.Sensors.MiscDevice
- 参数: **参数:**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | | -------- | ------------------------------------- | ---- | --------------- |
| stopMode | [VibratorStopMode](#vibratorstopmode) | 是 | 指示马达要停止指定的振动模式。 | | stopMode | [VibratorStopMode](#vibratorstopmode) | 是 | 指示马达要停止指定的振动模式。 |
- 返回值: **返回值:**
| 类型 | 说明 | | 类型 | 说明 |
| -------- | -------- | | ------------------- | ----------- |
| Promise&lt;void&gt; | 指示停止振动是否成功。 | | Promise&lt;void&gt; | 指示停止振动是否成功。 |
- 示例: **示例:**
``` ```
vibrator.stop(vibrator.VibratorStopMode.VIBRATOR_STOP_MODE_PRESET).then(()=>{ vibrator.stop(vibrator.VibratorStopMode.VIBRATOR_STOP_MODE_PRESET).then(()=>{
console.log("Promise returned to indicate a successful vibration."); console.log("Promise returned to indicate a successful vibration.");
...@@ -169,13 +169,13 @@ stop(stopMode: VibratorStopMode, callback?: AsyncCallback&lt;void&gt;): void; ...@@ -169,13 +169,13 @@ stop(stopMode: VibratorStopMode, callback?: AsyncCallback&lt;void&gt;): void;
**系统能力**:SystemCapability.Sensors.MiscDevice **系统能力**:SystemCapability.Sensors.MiscDevice
- 参数: **参数:**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | | -------- | ------------------------------------- | ---- | ----------------------- |
| stopMode | [VibratorStopMode](#vibratorstopmode) | 是 | 指示马达要停止指定的振动模式。 | | stopMode | [VibratorStopMode](#vibratorstopmode) | 是 | 指示马达要停止指定的振动模式。 |
| callback | AsyncCallback&lt;void&gt; | 否 | 马达停止振动的回调函数,指示停止振动是否成功。 | | callback | AsyncCallback&lt;void&gt; | 否 | 马达停止振动的回调函数,指示停止振动是否成功。 |
- 示例: **示例:**
``` ```
vibrator.stop(vibrator.VibratorStopMode.VIBRATOR_STOP_MODE_PRESET, function(error){ vibrator.stop(vibrator.VibratorStopMode.VIBRATOR_STOP_MODE_PRESET, function(error){
if(error){ if(error){
...@@ -194,7 +194,7 @@ stop(stopMode: VibratorStopMode, callback?: AsyncCallback&lt;void&gt;): void; ...@@ -194,7 +194,7 @@ stop(stopMode: VibratorStopMode, callback?: AsyncCallback&lt;void&gt;): void;
**系统能力**:以下各项对应的系统能力均为SystemCapability.Sensors.MiscDevice **系统能力**:以下各项对应的系统能力均为SystemCapability.Sensors.MiscDevice
| 名称 | 默认值 | 说明 | | 名称 | 默认值 | 说明 |
| -------- | -------- | -------- | | ------------------ | -------------------- | --------------- |
| EFFECT_CLOCK_TIMER | "haptic.clock.timer" | 调整定时器时振动器的振动效果。 | | EFFECT_CLOCK_TIMER | "haptic.clock.timer" | 调整定时器时振动器的振动效果。 |
...@@ -205,6 +205,6 @@ stop(stopMode: VibratorStopMode, callback?: AsyncCallback&lt;void&gt;): void; ...@@ -205,6 +205,6 @@ stop(stopMode: VibratorStopMode, callback?: AsyncCallback&lt;void&gt;): void;
**系统能力**:以下各项对应的系统能力均为SystemCapability.Sensors.MiscDevice **系统能力**:以下各项对应的系统能力均为SystemCapability.Sensors.MiscDevice
| 名称 | 默认值 | 说明 | | 名称 | 默认值 | 说明 |
| -------- | -------- | -------- | | ------------------------- | -------- | ---------------------------------------- |
| VIBRATOR_STOP_MODE_TIME | "time" | 停止模式为duration模式的振动。即触发振动时参数类型为number,参数本身为指示振动持续时间的触发方式。 | | VIBRATOR_STOP_MODE_TIME | "time" | 停止模式为duration模式的振动。即触发振动时参数类型为number,参数本身为指示振动持续时间的触发方式。 |
| VIBRATOR_STOP_MODE_PRESET | "preset" | 停止模式为预置EffectId的振动。即触发振动时参数类型为EffectId,参数本身为指示马达振动效果的字符串的触发方式。 | | VIBRATOR_STOP_MODE_PRESET | "preset" | 停止模式为预置EffectId的振动。即触发振动时参数类型为EffectId,参数本身为指示马达振动效果的字符串的触发方式。 |
...@@ -20,13 +20,13 @@ startWork(work: WorkInfo): boolean ...@@ -20,13 +20,13 @@ startWork(work: WorkInfo): boolean
**参数** **参数**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | | ---- | --------------------- | ---- | -------------- |
| work | [WorkInfo](#workinfo) | 是 | 指示要添加到执行队列的工作。 | | work | [WorkInfo](#workinfo) | 是 | 指示要添加到执行队列的工作。 |
**返回值** **返回值**
| 类型 | 说明 | | 类型 | 说明 |
| -------- | -------- | | ------- | -------------------------------- |
| boolean | 如果工作成功添加到执行队列,则返回true,否则返回false。 | | boolean | 如果工作成功添加到执行队列,则返回true,否则返回false。 |
**示例** **示例**
...@@ -55,14 +55,14 @@ stopWork(work: WorkInfo, needCancel?: boolean): boolean ...@@ -55,14 +55,14 @@ stopWork(work: WorkInfo, needCancel?: boolean): boolean
**参数** **参数**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | | ---------- | --------------------- | ---- | ---------- |
| work | [WorkInfo](#workinfo) | 是 | 指示要停止的工作。 | | work | [WorkInfo](#workinfo) | 是 | 指示要停止的工作。 |
|needCancel|boolean| 是| 是否需要取消的工作。| | needCancel | boolean | 是 | 是否需要取消的工作。 |
**返回值** **返回值**
| 类型 | 说明 | | 类型 | 说明 |
| -------- | -------- | | ------- | ----------------------- |
| boolean | 如果成功,则返回true,否则返回false。 | | boolean | 如果成功,则返回true,否则返回false。 |
**示例** **示例**
...@@ -91,9 +91,9 @@ getWorkStatus(workId: number, callback : AsyncCallback\<WorkInfo>): void ...@@ -91,9 +91,9 @@ getWorkStatus(workId: number, callback : AsyncCallback\<WorkInfo>): void
**参数** **参数**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | | -------- | ------------------------------------- | ---- | ---------------------------------------- |
| workId | number | 是 | work的id。 | | workId | number | 是 | work的id。 |
|callback|AsyncCallback\<[WorkInfo](#workinfo)>| 是| 指定的callback回调方法。如果指定的工作Id有效,则返回从WorkSchedulerService获取的有效工作状态;否则返回null。| | callback | AsyncCallback\<[WorkInfo](#workinfo)> | 是 | 指定的callback回调方法。如果指定的工作Id有效,则返回从WorkSchedulerService获取的有效工作状态;否则返回null。 |
**示例** **示例**
...@@ -110,7 +110,7 @@ getWorkStatus(workId: number, callback : AsyncCallback\<WorkInfo>): void ...@@ -110,7 +110,7 @@ getWorkStatus(workId: number, callback : AsyncCallback\<WorkInfo>): void
``` ```
## workScheduler.getWorkStatus ## workScheduler.getWorkStatus
getWorkStatus(workID: number): Promise\<WorkInfo> getWorkStatus(workId: number): Promise\<WorkInfo>
获取工作的最新状态,使用Promise形式返回。 获取工作的最新状态,使用Promise形式返回。
...@@ -119,13 +119,13 @@ getWorkStatus(workID: number): Promise\<WorkInfo> ...@@ -119,13 +119,13 @@ getWorkStatus(workID: number): Promise\<WorkInfo>
**参数** **参数**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | | ------ | ------ | ---- | -------- |
| workId | number | 是 | work的id。 | | workId | number | 是 | work的id。 |
**返回值** **返回值**
| 类型 | 说明 | | 类型 | 说明 |
| -------- | -------- | | ------------------------------- | ---------------------------------------- |
| Promise\<[WorkInfo](#workinfo)> | 指定的Promise回调方法。如果指定的工作ID有效,则返回从WorkSchedulerService获取的有效工作状态;否则返回null。 | | Promise\<[WorkInfo](#workinfo)> | 指定的Promise回调方法。如果指定的工作ID有效,则返回从WorkSchedulerService获取的有效工作状态;否则返回null。 |
**示例** **示例**
...@@ -150,13 +150,13 @@ obtainAllWorks(callback : AsyncCallback\<void>): Array\<WorkInfo> ...@@ -150,13 +150,13 @@ obtainAllWorks(callback : AsyncCallback\<void>): Array\<WorkInfo>
**参数** **参数**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | | -------- | -------------------- | ---- | ------------------------------- |
|callback|AsyncCallback\<void>| 是| 指定的callback回调方法。返回与应用程序关联的所有工作。| | callback | AsyncCallback\<void> | 是 | 指定的callback回调方法。返回与应用程序关联的所有工作。 |
**返回值** **返回值**
| 类型 | 说明 | | 类型 | 说明 |
| -------- | -------- | | ----------------------------- | --------------- |
| Array\<[WorkInfo](#workinfo)> | 返回与应用程序关联的所有工作。 | | Array\<[WorkInfo](#workinfo)> | 返回与应用程序关联的所有工作。 |
**示例** **示例**
...@@ -181,8 +181,8 @@ obtainAllWorks(): Promise<Array\<WorkInfo>> ...@@ -181,8 +181,8 @@ obtainAllWorks(): Promise<Array\<WorkInfo>>
**返回值** **返回值**
| 类型 | 说明 | | 类型 | 说明 |
| -------- | -------- | | -------------------------------------- | ------------------------------ |
| Promise<Array\<[WorkInfo](#workinfo)>> | 指定的Promise回调方法。返回与应用程序关联的所有工作。| | Promise<Array\<[WorkInfo](#workinfo)>> | 指定的Promise回调方法。返回与应用程序关联的所有工作。 |
**示例** **示例**
...@@ -218,14 +218,14 @@ isLastWorkTimeOut(workId: number, callback : AsyncCallback\<void>): boolean ...@@ -218,14 +218,14 @@ isLastWorkTimeOut(workId: number, callback : AsyncCallback\<void>): boolean
**参数** **参数**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | | -------- | -------------------- | ---- | ---------------------------------------- |
| workId | number | 是 | work的id。 | | workId | number | 是 | work的id。 |
|callback|AsyncCallback\<void>| 是| 指定的callback回调方法。如果指定工作的最后一次执行是超时操作,则返回true;否则返回false。| | callback | AsyncCallback\<void> | 是 | 指定的callback回调方法。如果指定工作的最后一次执行是超时操作,则返回true;否则返回false。 |
**返回值** **返回值**
| 类型 | 说明 | | 类型 | 说明 |
| -------- | -------- | | ------- | ---------------------------------------- |
| boolean | 指定的callback回调方法。如果指定工作的最后一次执行是超时操作,则返回true;否则返回false。 | | boolean | 指定的callback回调方法。如果指定工作的最后一次执行是超时操作,则返回true;否则返回false。 |
**示例** **示例**
...@@ -250,14 +250,14 @@ isLastWorkTimeOut(workId: number): Promise\<boolean> ...@@ -250,14 +250,14 @@ isLastWorkTimeOut(workId: number): Promise\<boolean>
**参数** **参数**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | | ------ | ------ | ---- | -------- |
| workId | number | 是 | work的id。 | | workId | number | 是 | work的id。 |
**返回值** **返回值**
| 类型 | 说明 | | 类型 | 说明 |
| -------- | -------- | | ----------------- | ---------------------------------------- |
| Promise\<boolean> | 指定的Promise回调方法。如果指定工作的最后一次执行是超时操作,则返回true;否则返回false。| | Promise\<boolean> | 指定的Promise回调方法。如果指定工作的最后一次执行是超时操作,则返回true;否则返回false。 |
**示例** **示例**
...@@ -277,56 +277,56 @@ isLastWorkTimeOut(workId: number): Promise\<boolean> ...@@ -277,56 +277,56 @@ isLastWorkTimeOut(workId: number): Promise\<boolean>
**系统能力**:以下各项对应的系统能力均为SystemCapability.ResourceSchedule.WorkScheduler **系统能力**:以下各项对应的系统能力均为SystemCapability.ResourceSchedule.WorkScheduler
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | | --------------- | --------------------------------- | ---- | ---------------- |
|workId |number |是 |当前工作的ID| | workId | number | 是 | 当前工作的ID |
|bundleName |string |是| 延迟任务包名| | bundleName | string | 是 | 延迟任务包名 |
|abilityName | string| 是| 延迟任务回调通知的组件名(必填)| | abilityName | string | 是 | 延迟任务回调通知的组件名(必填) |
|networkType | [NetworkType](#networktype) | 否| 网络类型 | | networkType | [NetworkType](#networktype) | 否 | 网络类型 |
|isCharging | boolean| 否|是否充电 | | isCharging | boolean | 否 | 是否充电 |
|chargerType | [ChargingType](#chargingtype) | 否|充电类型 | | chargerType | [ChargingType](#chargingtype) | 否 | 充电类型 |
|batteryLevel | number| 否|电量| | batteryLevel | number | 否 | 电量 |
|batteryStatus| [BatteryStatus](#batterystatus) | 否|电池状态| | batteryStatus | [BatteryStatus](#batterystatus) | 否 | 电池状态 |
|storageRequest|[StorageRequest](#storagerequest)| 否|存储状态| | storageRequest | [StorageRequest](#storagerequest) | 否 | 存储状态 |
|isRepeat|boolean|否|是否循环任务| | isRepeat | boolean | 否 | 是否循环任务 |
|repeatCycleTime |number|否|循环间隔| | repeatCycleTime | number | 否 | 循环间隔 |
|repeatCount |number|否|循环次数| | repeatCount | number | 否 | 循环次数 |
## NetworkType ## NetworkType
触发工作的网络类型。 触发工作的网络类型。
**系统能力**:以下各项对应的系统能力均为SystemCapability.ResourceSchedule.WorkScheduler **系统能力**:以下各项对应的系统能力均为SystemCapability.ResourceSchedule.WorkScheduler
|名称 |默认值 |说明| | 名称 | 默认值 | 说明 |
| -------- | -------- | -------- | | ---------------------- | ---- | ----------------------- |
|NETWORK_TYPE_ANY |0 |表示这个触发条件是任何类型的网络连接。| | NETWORK_TYPE_ANY | 0 | 表示这个触发条件是任何类型的网络连接。 |
|NETWORK_TYPE_MOBILE |1| 表示这个触发条件是Mobile网络连接。| | NETWORK_TYPE_MOBILE | 1 | 表示这个触发条件是Mobile网络连接。 |
|NETWORK_TYPE_WIFI |2 |表示这个触发条件是Wifi类型的网络连接。| | NETWORK_TYPE_WIFI | 2 | 表示这个触发条件是Wifi类型的网络连接。 |
|NETWORK_TYPE_BLUETOOTH |3 |表示这个触发条件是Bluetooth网络连接。| | NETWORK_TYPE_BLUETOOTH | 3 | 表示这个触发条件是Bluetooth网络连接。 |
|NETWORK_TYPE_WIFI_P2P |4 |表示这个触发条件是Wifi P2P网络连接。| | NETWORK_TYPE_WIFI_P2P | 4 | 表示这个触发条件是Wifi P2P网络连接。 |
|NETWORK_TYPE_ETHERNET |5 |表示这个触发条件是有线网络连接。| | NETWORK_TYPE_ETHERNET | 5 | 表示这个触发条件是有线网络连接。 |
## ChargingType ## ChargingType
触发工作的充电类型。 触发工作的充电类型。
**系统能力**:以下各项对应的系统能力均为SystemCapability.ResourceSchedule.WorkScheduler **系统能力**:以下各项对应的系统能力均为SystemCapability.ResourceSchedule.WorkScheduler
|名称 |默认值 |说明| | 名称 | 默认值 | 说明 |
| -------- | -------- | -------- | | ------------------------- | ---- | -------------------- |
|CHARGING_PLUGGED_ANY |0| 表示这个触发条件是任何类型的充电器连接。| | CHARGING_PLUGGED_ANY | 0 | 表示这个触发条件是任何类型的充电器连接。 |
|CHARGING_PLUGGED_AC |1 |表示这个触发条件是直流充电器连接。| | CHARGING_PLUGGED_AC | 1 | 表示这个触发条件是直流充电器连接。 |
|CHARGING_PLUGGED_USB |2 |表示这个触发条件是USB充连接。| | CHARGING_PLUGGED_USB | 2 | 表示这个触发条件是USB充连接。 |
|CHARGING_PLUGGED_WIRELESS |3| 表示这个触发条件是无线充电器连接。| | CHARGING_PLUGGED_WIRELESS | 3 | 表示这个触发条件是无线充电器连接。 |
## BatteryStatus ## BatteryStatus
触发工作的电池状态。 触发工作的电池状态。
**系统能力**:以下各项对应的系统能力均为SystemCapability.ResourceSchedule.WorkScheduler **系统能力**:以下各项对应的系统能力均为SystemCapability.ResourceSchedule.WorkScheduler
|名称 |默认值 |说明| | 名称 | 默认值 | 说明 |
| -------- | -------- | -------- | | -------------------------- | ---- | -------------------------- |
|BATTERY_STATUS_LOW |0 |表示这个触发条件是低电告警。| | BATTERY_STATUS_LOW | 0 | 表示这个触发条件是低电告警。 |
|BATTERY_STATUS_OKAY |1| 表示这个触发条件是从低电恢复到正常电量。| | BATTERY_STATUS_OKAY | 1 | 表示这个触发条件是从低电恢复到正常电量。 |
|BATTERY_STATUS_LOW_OR_OKAY |2 |表示这个触发条件是从低电恢复到正常电量或者低电告警。| | BATTERY_STATUS_LOW_OR_OKAY | 2 | 表示这个触发条件是从低电恢复到正常电量或者低电告警。 |
## StorageRequest ## StorageRequest
触发工作的存储状态。 触发工作的存储状态。
......
Markdown is supported
0% .
You are about to add 0 people to the discussion. Proceed with caution.
先完成此消息的编辑!
想要评论请 注册