提交 cb234977 编写于 作者: Z zengyawen

update docs

Signed-off-by: Nzengyawen <zengyawen1@huawei.com>
上级 217f7621
...@@ -4,8 +4,8 @@ ...@@ -4,8 +4,8 @@
> **说明:** > **说明:**
> >
> 本模块首批接口从API version 8开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。 > - 本模块首批接口从API version 8开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。
> 本模块接口为系统接口,三方应用不支持调用。 > - 本模块接口为系统接口,三方应用不支持调用。
## 导入模块 ## 导入模块
......
...@@ -209,7 +209,7 @@ createFileAccessHelper(context: Context) : FileAccessHelper ...@@ -209,7 +209,7 @@ createFileAccessHelper(context: Context) : FileAccessHelper
| mtime | number | 是 | 否 | 文件(夹)的修改时间 | | mtime | number | 是 | 否 | 文件(夹)的修改时间 |
| mimeType | string | 是 | 否 | 文件(夹)的媒体资源类型 | | mimeType | string | 是 | 否 | 文件(夹)的媒体资源类型 |
### listfile ### listFile
listFile(filter?: Filter) : FileIterator listFile(filter?: Filter) : FileIterator
...@@ -265,7 +265,7 @@ listFile(filter?: Filter) : FileIterator ...@@ -265,7 +265,7 @@ listFile(filter?: Filter) : FileIterator
} }
``` ```
### scanfile ### scanFile
scanFile(filter?: Filter) : FileIterator; scanFile(filter?: Filter) : FileIterator;
...@@ -373,12 +373,14 @@ next() : { value: FileInfo, done: boolean } ...@@ -373,12 +373,14 @@ next() : { value: FileInfo, done: boolean }
| displayName | string | 是 | 否 | 设备名称 | | displayName | string | 是 | 否 | 设备名称 |
| deviceFlags | number | 是 | 否 | 设备支持的能力 | | deviceFlags | number | 是 | 否 | 设备支持的能力 |
### listfile ### listFile
listFile(filter?: Filter) : FileIterator listFile(filter?: Filter) : FileIterator
以同步方法从某设备根节点开始,基于过滤器,获取第一级符合条件的文件(夹)信息的迭代器对象FileIterator,然后通过[next](#next)方法返回[FileInfo](#fileinfo)。目前仅支持内置存储设备过滤,外置存储设备不支持过滤。 以同步方法从某设备根节点开始,基于过滤器,获取第一级符合条件的文件(夹)信息的迭代器对象FileIterator,然后通过[next](#next)方法返回[FileInfo](#fileinfo)。目前仅支持内置存储设备过滤,外置存储设备不支持过滤。
**模型约束**:此接口仅可在Stage模型下使用。
**系统能力**:SystemCapability.FileManagement.UserFileService **系统能力**:SystemCapability.FileManagement.UserFileService
**需要权限**:ohos.permission.FILE_ACCESS_MANAGER **需要权限**:ohos.permission.FILE_ACCESS_MANAGER
...@@ -433,6 +435,8 @@ scanFile(filter?: Filter) : FileIterator ...@@ -433,6 +435,8 @@ scanFile(filter?: Filter) : FileIterator
以同步方法从某设备根节点开始,基于过滤器,递归获取符合条件的文件信息的迭代器对象FileIterator,然后通过[next](#next)方法返回[FileInfo](#fileinfo)。目前仅支持内置存储设备。 以同步方法从某设备根节点开始,基于过滤器,递归获取符合条件的文件信息的迭代器对象FileIterator,然后通过[next](#next)方法返回[FileInfo](#fileinfo)。目前仅支持内置存储设备。
**模型约束**:此接口仅可在Stage模型下使用。
**系统能力**:SystemCapability.FileManagement.UserFileService **系统能力**:SystemCapability.FileManagement.UserFileService
**需要权限**:ohos.permission.FILE_ACCESS_MANAGER **需要权限**:ohos.permission.FILE_ACCESS_MANAGER
......
...@@ -575,7 +575,7 @@ delete(uri: string): Promise&lt;void&gt;; ...@@ -575,7 +575,7 @@ delete(uri: string): Promise&lt;void&gt;;
| -------- | ------------------------- | ---- | ---------- | | -------- | ------------------------- | ---- | ---------- |
| uri | string | 是 | 媒体文件uri | | uri | string | 是 | 媒体文件uri |
**返回值:** **返回值:**
| 类型 | 说明 | | 类型 | 说明 |
| --------------------------------------- | ----------------- | | --------------------------------------- | ----------------- |
...@@ -1477,7 +1477,7 @@ getCount(): number ...@@ -1477,7 +1477,7 @@ getCount(): number
**系统能力**:SystemCapability.FileManagement.UserFileManager.Core **系统能力**:SystemCapability.FileManagement.UserFileManager.Core
**返回值:** **返回值:**
| 类型 | 说明 | | 类型 | 说明 |
| ------ | -------- | | ------ | -------- |
...@@ -1509,7 +1509,7 @@ isAfterLast(): boolean ...@@ -1509,7 +1509,7 @@ isAfterLast(): boolean
**系统能力**:SystemCapability.FileManagement.UserFileManager.Core **系统能力**:SystemCapability.FileManagement.UserFileManager.Core
**返回值:** **返回值:**
| 类型 | 说明 | | 类型 | 说明 |
| ------- | ---------------------------------- | | ------- | ---------------------------------- |
...@@ -1613,7 +1613,7 @@ getFirstObject(): Promise&lt;T&gt; ...@@ -1613,7 +1613,7 @@ getFirstObject(): Promise&lt;T&gt;
**系统能力**:SystemCapability.FileManagement.UserFileManager.Core **系统能力**:SystemCapability.FileManagement.UserFileManager.Core
**返回值:** **返回值:**
| 类型 | 说明 | | 类型 | 说明 |
| --------------------------------------- | -------------------------- | | --------------------------------------- | -------------------------- |
...@@ -1685,7 +1685,7 @@ async function example() { ...@@ -1685,7 +1685,7 @@ async function example() {
**系统能力**:SystemCapability.FileManagement.UserFileManager.Core **系统能力**:SystemCapability.FileManagement.UserFileManager.Core
**返回值:** **返回值:**
| 类型 | 说明 | | 类型 | 说明 |
| --------------------------------------- | ----------------- | | --------------------------------------- | ----------------- |
...@@ -1757,7 +1757,7 @@ getLastObject(): Promise&lt;T&gt; ...@@ -1757,7 +1757,7 @@ getLastObject(): Promise&lt;T&gt;
**系统能力**:SystemCapability.FileManagement.UserFileManager.Core **系统能力**:SystemCapability.FileManagement.UserFileManager.Core
**返回值:** **返回值:**
| 类型 | 说明 | | 类型 | 说明 |
| --------------------------------------- | ----------------- | | --------------------------------------- | ----------------- |
...@@ -1833,7 +1833,7 @@ getPositionObject(index: number): Promise&lt;T&gt; ...@@ -1833,7 +1833,7 @@ getPositionObject(index: number): Promise&lt;T&gt;
| ----- | ------ | ---- | -------------- | | ----- | ------ | ---- | -------------- |
| index | number | 是 | 要获取的文件的索引,从0开始 | | index | number | 是 | 要获取的文件的索引,从0开始 |
**返回值:** **返回值:**
| 类型 | 说明 | | 类型 | 说明 |
| --------------------------------------- | ----------------- | | --------------------------------------- | ----------------- |
...@@ -2011,7 +2011,7 @@ commitModify(): Promise&lt;void&gt;; ...@@ -2011,7 +2011,7 @@ commitModify(): Promise&lt;void&gt;;
**系统能力**:SystemCapability.FileManagement.UserFileManager.Core **系统能力**:SystemCapability.FileManagement.UserFileManager.Core
**返回值:** **返回值:**
| 类型 | 说明 | | 类型 | 说明 |
| ------------------- | ------------ | | ------------------- | ------------ |
...@@ -2118,7 +2118,7 @@ getPhotoAssets(options: FetchOptions): Promise&lt;FetchResult&lt;FileAsset&gt;&g ...@@ -2118,7 +2118,7 @@ getPhotoAssets(options: FetchOptions): Promise&lt;FetchResult&lt;FileAsset&gt;&g
| -------- | ------------------------- | ---- | ---------- | | -------- | ------------------------- | ---- | ---------- |
| options | [FetchOptions](#fetchoptions) | 是 | 检索选项 | | options | [FetchOptions](#fetchoptions) | 是 | 检索选项 |
**返回值:** **返回值:**
| 类型 | 说明 | | 类型 | 说明 |
| --------------------------------------- | ----------------- | | --------------------------------------- | ----------------- |
...@@ -2204,7 +2204,7 @@ delete(uri: string): Promise&lt;void&gt;; ...@@ -2204,7 +2204,7 @@ delete(uri: string): Promise&lt;void&gt;;
| -------- | ------------------------- | ---- | ---------- | | -------- | ------------------------- | ---- | ---------- |
| uri | string | 是 | 相册uri | | uri | string | 是 | 相册uri |
**返回值:** **返回值:**
| 类型 | 说明 | | 类型 | 说明 |
| --------------------------------------- | ----------------- | | --------------------------------------- | ----------------- |
...@@ -2295,7 +2295,7 @@ recover(uri: string): Promise&lt;void&gt;; ...@@ -2295,7 +2295,7 @@ recover(uri: string): Promise&lt;void&gt;;
| -------- | ------------------------- | ---- | ---------- | | -------- | ------------------------- | ---- | ---------- |
| uri | string | 是 | 相册uri | | uri | string | 是 | 相册uri |
**返回值:** **返回值:**
| 类型 | 说明 | | 类型 | 说明 |
| --------------------------------------- | ----------------- | | --------------------------------------- | ----------------- |
......
Markdown is supported
0% .
You are about to add 0 people to the discussion. Proceed with caution.
先完成此消息的编辑!
想要评论请 注册