提交 b75aa8d8 编写于 作者: Z zhangxingxia

update apis

Signed-off-by: Nzhangxingxia <zhangxingxia1@huawei.com>
上级 ffc50099
...@@ -32,6 +32,7 @@ ...@@ -32,6 +32,7 @@
- [文件管理](js-apis-fileio.md) - [文件管理](js-apis-fileio.md)
- [Statfs](js-apis-statfs.md) - [Statfs](js-apis-statfs.md)
- [目录环境](js-apis-environment.md) - [目录环境](js-apis-environment.md)
- [公共文件访问与管理](js-apis-filemanager.md)
- 账号管理 - 账号管理
- [分布式帐号管理](js-apis-distributed-account.md) - [分布式帐号管理](js-apis-distributed-account.md)
- [应用帐号管理](js-apis-appAccount.md) - [应用帐号管理](js-apis-appAccount.md)
......
# 目录环境能力 # 目录环境能力
> ![icon-note.gif](D:/docs/zh-cn/application-dev/reference/apis/public_sys-resources/icon-note.gif) **说明:**
> 本模块首批接口从API version 8开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。
## 导入模块 ## 导入模块
``` ```js
import environment from '@ohos.environment'; import environment from '@ohos.environment';
``` ```
## 系统能力
SystemCapability.FileManagement.File.Environment
## 权限列表
## environment.getStorageDataDir ## environment.getStorageDataDir
...@@ -28,7 +27,7 @@ getStorageDataDir():Promise&lt;string&gt; ...@@ -28,7 +27,7 @@ getStorageDataDir():Promise&lt;string&gt;
- 示例: - 示例:
``` ```js
environment.getStorageDataDir().then(function(path){ environment.getStorageDataDir().then(function(path){
// do something // do something
}).catch(function(error){ }).catch(function(error){
...@@ -50,7 +49,7 @@ getStorageDataDir(callback:AsyncCallback&lt;string&gt;):void ...@@ -50,7 +49,7 @@ getStorageDataDir(callback:AsyncCallback&lt;string&gt;):void
- 示例: - 示例:
``` ```js
environment.getStorageDataDir(function(error, path){ environment.getStorageDataDir(function(error, path){
// do something // do something
}); });
...@@ -70,7 +69,7 @@ getUserDataDir():Promise&lt;string&gt; ...@@ -70,7 +69,7 @@ getUserDataDir():Promise&lt;string&gt;
- 示例: - 示例:
``` ```js
environment.getUserDataDir().then(function(path){ environment.getUserDataDir().then(function(path){
// do something // do something
}).catch(function(error){ }).catch(function(error){
...@@ -92,7 +91,7 @@ getUserDataDir(callback:AsyncCallback&lt;string&gt;): void ...@@ -92,7 +91,7 @@ getUserDataDir(callback:AsyncCallback&lt;string&gt;): void
- 示例: - 示例:
``` ```js
environment.getUserDataDir(function(error, path){ environment.getUserDataDir(function(error, path){
// do something // do something
}); });
......
# 公共文件访问与管理 # 公共文件访问与管理
>![](../../public_sys-resources/icon-note.gif) **说明:**
>本模块首批接口从API version 8开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。
## 导入模块 ## 导入模块
``` ```js
import filemanager from 'ohos.filemanager' import filemanager from 'ohos.filemanager'
``` ```
## 权限 ## 系统能力
应用需要拥有SystemCapability.FileManagement.FileManagerService权限 SystemCapability.FileManagement.FileManagerService
## filemanager.getRoot ## filemanager.getRoot
getRoot(options? : {dev? : DevInfo}) : Promise&lt;FileInfo[]&gt; getRoot(options? : {dev? : DevInfo}) : Promise&lt;FileInfo[]&gt;
以异步方法获取第一层相册,目录信息。使用promise形式返回结果。 以异步方法获取第一层相册,目录信息。使用promise形式返回结果。
...@@ -18,13 +20,13 @@ getRoot(options? : {dev? : DevInfo}) : Promise&lt;FileInfo[]&gt; ...@@ -18,13 +20,13 @@ getRoot(options? : {dev? : DevInfo}) : Promise&lt;FileInfo[]&gt;
- 参数 - 参数
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| --- | --- | --- | -- | | --- | --- | --- | -- |
| dev | DevInfo | 否 | 设备名, 当前仅支持设备'local' | | dev | [DevInfo](#devinfo) | 否 | 设备名, 不填为默认值dev = {name: "local"}, 当前仅支持设备'local' |
- 返回值 - 返回值
| 类型 | 说明 | | 类型 | 说明 |
| --- | -- | | --- | -- |
| Promise&lt;FileInfo[]&gt; | 第一层目录相册信息 | | Promise&lt;[FileInfo](#fileinfo)[]&gt; | 第一层目录相册信息 |
- 示例 - 示例
...@@ -52,8 +54,8 @@ getRoot(options? : {dev? : DevInfo}, callback : AsyncCallback&lt;FileInfo[]&gt;) ...@@ -52,8 +54,8 @@ getRoot(options? : {dev? : DevInfo}, callback : AsyncCallback&lt;FileInfo[]&gt;)
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | ------------------------- | ---- | ----------------------------- | | -------- | ------------------------- | ---- | ----------------------------- |
| dev | DevInfo | 否 | 设备名, 当前仅支持设备'local' | | dev | [DevInfo](#devinfo) | 否 | 设备名, 不填为默认值dev = {name: "local"}, 当前仅支持设备'local' |
| callback | AsyncCallback&lt;FileInfo[]&gt; | 是 | 异步获取文件的信息之后的回调 | | callback | AsyncCallback&lt;[FileInfo](#fileinfo)[]&gt; | 是 | 异步获取文件的信息之后的回调 |
- 示例 - 示例
...@@ -78,10 +80,10 @@ listFile(path : string, type : string, options? : {dev? : DevInfo, offset? : num ...@@ -78,10 +80,10 @@ listFile(path : string, type : string, options? : {dev? : DevInfo, offset? : num
| --- | --- | --- | -- | | --- | --- | --- | -- |
| type | string | 是 | 待查询文件类型, 支持以下类型 "file", "image", "audio", "video" | | type | string | 是 | 待查询文件类型, 支持以下类型 "file", "image", "audio", "video" |
| path | string | 是 | 待查询目录uri | | path | string | 是 | 待查询目录uri |
| dev | DevInfo | 是 | 设备名, 当前仅支持设备'local' | | dev | [DevInfo](#devinfo) | 是 | 设备名, 不填为默认值dev = {name: "local"}, 当前仅支持设备'local' |
| offset | number | 否 | 待查询文件偏移 | | offset | number | 否 | 待查询文件偏移 |
| count | number | 否 | 待查询文件个数 | | count | number | 否 | 待查询文件个数 |
- 返回值 - 返回值
| 类型 | 说明 | | 类型 | 说明 |
...@@ -123,10 +125,10 @@ listFile(path : string, type : string, options? : {dev? : DevInfo, offset? : num ...@@ -123,10 +125,10 @@ listFile(path : string, type : string, options? : {dev? : DevInfo, offset? : num
| -------- | ------------------------- | ---- | ------------------------------------------------------------ | | -------- | ------------------------- | ---- | ------------------------------------------------------------ |
| type | string | 是 | 待查询文件类型, 支持以下类型 "file", "image", "audio", "video" | | type | string | 是 | 待查询文件类型, 支持以下类型 "file", "image", "audio", "video" |
| path | string | 是 | 待查询目录uri | | path | string | 是 | 待查询目录uri |
| dev | DevInfo | 否 | 设备名, 当前仅支持设备'local' | | dev | [DevInfo](#devinfo) | 否 | 设备名, 不填为默认值dev = {name: "local"}, 当前仅支持设备'local' |
| offset | number | 否 | 待查询文件偏移 | | offset | number | 否 | 待查询文件偏移 |
| count | number | 否 | 待查询文件个数 | | count | number | 否 | 待查询文件个数 |
| callback | AsyncCallback&lt;FileInfo[]&gt; | 是 | 异步获取文件的信息之后的回调 | | callback | AsyncCallback&lt;[FileInfo](#fileinfo)[]&gt; | 是 | 异步获取文件的信息之后的回调 |
- 异常 - 异常
| 错误名称 | 错误类型 | 错误码 | 说明 | | 错误名称 | 错误类型 | 错误码 | 说明 |
...@@ -158,7 +160,7 @@ filemanager.createFile(path : string, filename : string, options? : {dev? : DevI ...@@ -158,7 +160,7 @@ filemanager.createFile(path : string, filename : string, options? : {dev? : DevI
| --- | --- | --- | -- | | --- | --- | --- | -- |
| filename | string | 是 | 待创建的文件名 | | filename | string | 是 | 待创建的文件名 |
| path | string | 是 | 待保存目的相册uri | | path | string | 是 | 待保存目的相册uri |
| dev | DevInfo | 否 | 设备名, 当前仅支持设备'local' | | dev | [DevInfo](#devinfo) | 否 | 设备名, 不填为默认值dev = {name: "local"}, 当前仅支持设备'local' |
- 返回值 - 返回值
...@@ -199,8 +201,8 @@ createFile(path : string, filename: string, options? : {dev? : DevInfo}, callbac ...@@ -199,8 +201,8 @@ createFile(path : string, filename: string, options? : {dev? : DevInfo}, callbac
| -------- | ------------------------- | ---- | ----------------------------- | | -------- | ------------------------- | ---- | ----------------------------- |
| filename | string | 是 | 待创建的文件名 | | filename | string | 是 | 待创建的文件名 |
| path | string | 是 | 待保存目的相册uri | | path | string | 是 | 待保存目的相册uri |
| dev | DevInfo | 否 | 设备名, 当前仅支持设备'local' | | dev | [DevInfo](#devinfo) | 否 | 设备名, 不填为默认值dev = {name: "local"}, 当前仅支持设备'local' |
| callback | AsyncCallback&lt;FileInfo[]&gt; | 是 | 异步获取文件的信息之后的回调 | | callback | AsyncCallback&lt;[FileInfo](#fileinfo)[]&gt; | 是 | 异步获取文件的信息之后的回调 |
- 异常 - 异常
...@@ -225,6 +227,8 @@ filemanager.createFile(media_path, name, (err, uri) => { ...@@ -225,6 +227,8 @@ filemanager.createFile(media_path, name, (err, uri) => {
## FileInfo ## FileInfo
文件信息类型,通过getRoot, listFile等接口返回的类型。 文件信息类型,通过getRoot, listFile等接口返回的类型。
### 属性
| 参数名 | 类型 | 可读 | 可写 | 说明 | | 参数名 | 类型 | 可读 | 可写 | 说明 |
| --- | -- | -- | -- | -- | | --- | -- | -- | -- | -- |
| name | string | 是 | 否 | 文件名称 | | name | string | 是 | 否 | 文件名称 |
...@@ -237,6 +241,8 @@ filemanager.createFile(media_path, name, (err, uri) => { ...@@ -237,6 +241,8 @@ filemanager.createFile(media_path, name, (err, uri) => {
## DevInfo ## DevInfo
设备类型,配置接口访问的设备类型。 设备类型,配置接口访问的设备类型。
### 属性
| 参数名 | 类型 | 可读 | 可写 | 说明 | | 参数名 | 类型 | 可读 | 可写 | 说明 |
| --- | -- | -- | -- | -- | | --- | -- | -- | -- | -- |
| name | string | 是 | 是 | 设备名称 | | name | string | 是 | 是 | 设备名称 |
\ No newline at end of file
Markdown is supported
0% .
You are about to add 0 people to the discussion. Proceed with caution.
先完成此消息的编辑!
想要评论请 注册