Skip to content
体验新版
项目
组织
正在加载...
登录
切换导航
打开侧边栏
OpenHarmony
Docs
提交
b8924e5c
D
Docs
项目概览
OpenHarmony
/
Docs
1 年多 前同步成功
通知
159
Star
292
Fork
28
代码
文件
提交
分支
Tags
贡献者
分支图
Diff
Issue
0
列表
看板
标记
里程碑
合并请求
0
Wiki
0
Wiki
分析
仓库
DevOps
项目成员
Pages
D
Docs
项目概览
项目概览
详情
发布
仓库
仓库
文件
提交
分支
标签
贡献者
分支图
比较
Issue
0
Issue
0
列表
看板
标记
里程碑
合并请求
0
合并请求
0
Pages
分析
分析
仓库分析
DevOps
Wiki
0
Wiki
成员
成员
收起侧边栏
关闭侧边栏
动态
分支图
创建新Issue
提交
Issue看板
未验证
提交
b8924e5c
编写于
3月 16, 2022
作者:
O
openharmony_ci
提交者:
Gitee
3月 16, 2022
浏览文件
操作
浏览文件
下载
差异文件
!2085 文件管理相关文档更新syscap
Merge pull request !2085 from shuzhouhao/master
上级
e97555c9
312f17e0
变更
6
展开全部
隐藏空白更改
内联
并排
Showing
6 changed file
with
304 addition
and
28 deletion
+304
-28
zh-cn/application-dev/reference/apis/js-apis-environment.md
zh-cn/application-dev/reference/apis/js-apis-environment.md
+4
-12
zh-cn/application-dev/reference/apis/js-apis-fileio.md
zh-cn/application-dev/reference/apis/js-apis-fileio.md
+248
-0
zh-cn/application-dev/reference/apis/js-apis-filemanager.md
zh-cn/application-dev/reference/apis/js-apis-filemanager.md
+16
-4
zh-cn/application-dev/reference/apis/js-apis-statfs.md
zh-cn/application-dev/reference/apis/js-apis-statfs.md
+8
-4
zh-cn/application-dev/reference/apis/js-apis-storage-statistics.md
...lication-dev/reference/apis/js-apis-storage-statistics.md
+14
-4
zh-cn/application-dev/reference/apis/js-apis-volumemanager.md
...n/application-dev/reference/apis/js-apis-volumemanager.md
+14
-4
未找到文件。
zh-cn/application-dev/reference/apis/js-apis-environment.md
浏览文件 @
b8924e5c
...
@@ -17,9 +17,7 @@ getStorageDataDir():Promise<string>
...
@@ -17,9 +17,7 @@ getStorageDataDir():Promise<string>
异步方法获取内存存储根目录,以promise形式返回结果。
异步方法获取内存存储根目录,以promise形式返回结果。
-
系统能力:
**系统能力**
:SystemCapability.FileManagement.File.Environment
SystemCapability.FileManagement.File.Environment
-
返回值:
-
返回值:
...
@@ -43,9 +41,7 @@ getStorageDataDir(callback:AsyncCallback<string>):void
...
@@ -43,9 +41,7 @@ getStorageDataDir(callback:AsyncCallback<string>):void
异步方法获取内存存储根目录,以callback形式返回结果。
异步方法获取内存存储根目录,以callback形式返回结果。
-
系统能力:
**系统能力**
:SystemCapability.FileManagement.File.Environment
SystemCapability.FileManagement.File.Environment
-
参数:
-
参数:
...
@@ -67,9 +63,7 @@ getUserDataDir():Promise<string>
...
@@ -67,9 +63,7 @@ getUserDataDir():Promise<string>
异步方法获取公共文件根目录,以promise形式返回结果。
异步方法获取公共文件根目录,以promise形式返回结果。
-
系统能力:
**系统能力**
:SystemCapability.FileManagement.File.Environment
SystemCapability.FileManagement.File.Environment
-
返回值:
-
返回值:
...
@@ -93,9 +87,7 @@ getUserDataDir(callback:AsyncCallback<string>): void
...
@@ -93,9 +87,7 @@ getUserDataDir(callback:AsyncCallback<string>): void
异步方法获取公共文件根目录,以callback形式返回结果。
异步方法获取公共文件根目录,以callback形式返回结果。
-
系统能力:
**系统能力**
:SystemCapability.FileManagement.File.Environment
SystemCapability.FileManagement.File.Environment
-
参数:
-
参数:
...
...
zh-cn/application-dev/reference/apis/js-apis-fileio.md
浏览文件 @
b8924e5c
此差异已折叠。
点击以展开。
zh-cn/application-dev/reference/apis/js-apis-filemanager.md
浏览文件 @
b8924e5c
...
@@ -9,16 +9,14 @@
...
@@ -9,16 +9,14 @@
import
filemanager
from
'
@ohos.fileManager
'
;
import
filemanager
from
'
@ohos.fileManager
'
;
```
```
## 系统能力
SystemCapability.FileManagement.FileManagerService
## filemanager.getRoot
## filemanager.getRoot
getRoot(options? : {dev? : DevInfo}) : Promise
<
FileInfo[]
>
getRoot(options? : {dev? : DevInfo}) : Promise
<
FileInfo[]
>
以异步方法获取第一层相册,目录信息。使用promise形式返回结果。
以异步方法获取第一层相册,目录信息。使用promise形式返回结果。
**系统能力**
:SystemCapability.FileManagement.FileManagerService
-
参数
-
参数
| 参数名 | 类型 | 必填 | 说明 |
| 参数名 | 类型 | 必填 | 说明 |
| --- | --- | --- | -- |
| --- | --- | --- | -- |
...
@@ -50,6 +48,8 @@ getRoot(options? : {dev? : DevInfo}, callback : AsyncCallback<FileInfo[]>)
...
@@ -50,6 +48,8 @@ getRoot(options? : {dev? : DevInfo}, callback : AsyncCallback<FileInfo[]>)
以异步方法获取第一层相册,目录信息。使用callback形式返回结果。
以异步方法获取第一层相册,目录信息。使用callback形式返回结果。
**系统能力**
:SystemCapability.FileManagement.FileManagerService
-
参数
-
参数
| 参数名 | 类型 | 必填 | 说明 |
| 参数名 | 类型 | 必填 | 说明 |
...
@@ -75,6 +75,8 @@ listFile(path : string, type : string, options? : {dev? : DevInfo, offset? : num
...
@@ -75,6 +75,8 @@ listFile(path : string, type : string, options? : {dev? : DevInfo, offset? : num
以异步方法获取第二层相册,文件信息。使用promise形式返回结果。
以异步方法获取第二层相册,文件信息。使用promise形式返回结果。
**系统能力**
:SystemCapability.FileManagement.FileManagerService
-
参数
-
参数
| 参数名 | 类型 | 必填 | 说明 |
| 参数名 | 类型 | 必填 | 说明 |
| --- | --- | --- | -- |
| --- | --- | --- | -- |
...
@@ -118,6 +120,8 @@ listFile(path : string, type : string, options? : {dev? : DevInfo, offset? : num
...
@@ -118,6 +120,8 @@ listFile(path : string, type : string, options? : {dev? : DevInfo, offset? : num
以异步方法获取第二层相册,文件信息。使用callback形式返回结果。
以异步方法获取第二层相册,文件信息。使用callback形式返回结果。
**系统能力**
:SystemCapability.FileManagement.FileManagerService
-
参数
-
参数
| 参数名 | 类型 | 必填 | 说明 |
| 参数名 | 类型 | 必填 | 说明 |
...
@@ -154,6 +158,8 @@ filemanager.createFile(path : string, filename : string, options? : {dev? : DevI
...
@@ -154,6 +158,8 @@ filemanager.createFile(path : string, filename : string, options? : {dev? : DevI
以异步方法创建文件到指定路径,返回文件uri。使用promise形式返回结果。
以异步方法创建文件到指定路径,返回文件uri。使用promise形式返回结果。
**系统能力**
:SystemCapability.FileManagement.FileManagerService
-
参数
-
参数
| 参数名 | 类型 | 必填 | 说明 |
| 参数名 | 类型 | 必填 | 说明 |
| --- | --- | --- | -- |
| --- | --- | --- | -- |
...
@@ -194,6 +200,8 @@ createFile(path : string, filename: string, options? : {dev? : DevInfo}, callbac
...
@@ -194,6 +200,8 @@ createFile(path : string, filename: string, options? : {dev? : DevInfo}, callbac
以异步方法创建文件到指定路径,返回文件uri。使用callback形式返回结果。
以异步方法创建文件到指定路径,返回文件uri。使用callback形式返回结果。
**系统能力**
:SystemCapability.FileManagement.FileManagerService
-
参数
-
参数
| 参数名 | 类型 | 必填 | 说明 |
| 参数名 | 类型 | 必填 | 说明 |
...
@@ -226,6 +234,8 @@ filemanager.createFile(media_path, name, (err, uri) => {
...
@@ -226,6 +234,8 @@ filemanager.createFile(media_path, name, (err, uri) => {
## FileInfo
## FileInfo
文件信息类型,通过getRoot, listFile等接口返回的类型。
文件信息类型,通过getRoot, listFile等接口返回的类型。
**系统能力**
:以下各项对应的系统能力均为SystemCapability.FileManagement.FileManagerService。
### 属性
### 属性
| 参数名 | 类型 | 可读 | 可写 | 说明 |
| 参数名 | 类型 | 可读 | 可写 | 说明 |
...
@@ -240,6 +250,8 @@ filemanager.createFile(media_path, name, (err, uri) => {
...
@@ -240,6 +250,8 @@ filemanager.createFile(media_path, name, (err, uri) => {
## DevInfo
## DevInfo
设备类型,配置接口访问的设备类型。
设备类型,配置接口访问的设备类型。
**系统能力**
:以下各项对应的系统能力均为SystemCapability.FileManagement.FileManagerService。
### 属性
### 属性
| 参数名 | 类型 | 可读 | 可写 | 说明 |
| 参数名 | 类型 | 可读 | 可写 | 说明 |
...
...
zh-cn/application-dev/reference/apis/js-apis-statfs.md
浏览文件 @
b8924e5c
...
@@ -21,16 +21,14 @@ import statfs from '@ohos.statfs';
...
@@ -21,16 +21,14 @@ import statfs from '@ohos.statfs';
let
path
=
dir
+
"
xxx.txt
"
;
let
path
=
dir
+
"
xxx.txt
"
;
```
```
## 系统能力
SystemCapability.FileManagement.File.FileIO
## statfs.getFreeBytes
## statfs.getFreeBytes
getFreeBytes(path:string):Promise
<
number
>
getFreeBytes(path:string):Promise
<
number
>
异步方法获取指定文件系统空闲字节数,以Promise形式返回结果。
异步方法获取指定文件系统空闲字节数,以Promise形式返回结果。
**系统能力**
:SystemCapability.FileManagement.File.FileIO
-
参数:
-
参数:
| 参数名 | 类型 | 必填 | 说明 |
| 参数名 | 类型 | 必填 | 说明 |
...
@@ -60,6 +58,8 @@ getFreeBytes(path:string, callback:AsyncCallback<number>): void
...
@@ -60,6 +58,8 @@ getFreeBytes(path:string, callback:AsyncCallback<number>): void
异步方法获取指定文件系统空闲字节数,使用callback形式返回结果。
异步方法获取指定文件系统空闲字节数,使用callback形式返回结果。
**系统能力**
:SystemCapability.FileManagement.File.FileIO
-
参数:
-
参数:
| 参数名 | 类型 | 必填 | 说明 |
| 参数名 | 类型 | 必填 | 说明 |
...
@@ -81,6 +81,8 @@ getTotalBytes(path: string): Promise<number>
...
@@ -81,6 +81,8 @@ getTotalBytes(path: string): Promise<number>
异步方法获取指定文件系统总字节数,以Promise形式返回结果。
异步方法获取指定文件系统总字节数,以Promise形式返回结果。
**系统能力**
:SystemCapability.FileManagement.File.FileIO
-
参数:
-
参数:
| 参数 | 类型 | 必填 | 说明 |
| 参数 | 类型 | 必填 | 说明 |
...
@@ -110,6 +112,8 @@ getTotalBytes(path: string, callback: AsyncCallback<number>): void
...
@@ -110,6 +112,8 @@ getTotalBytes(path: string, callback: AsyncCallback<number>): void
异步方法获取指定文件系统总字节数,使用callback形式返回结果。
异步方法获取指定文件系统总字节数,使用callback形式返回结果。
**系统能力**
:SystemCapability.FileManagement.File.FileIO
-
参数:
-
参数:
| 参数名 | 类型 | 必填 | 说明 |
| 参数名 | 类型 | 必填 | 说明 |
...
...
zh-cn/application-dev/reference/apis/js-apis-storage-statistics.md
浏览文件 @
b8924e5c
...
@@ -11,16 +11,14 @@
...
@@ -11,16 +11,14 @@
import
storagestatistics
from
"
@ohos.storageStatistics
"
;
import
storagestatistics
from
"
@ohos.storageStatistics
"
;
```
```
## 系统能力
SystemCapability.FileManagement.StorageService.SpatialStatistics
## storagestatistics.getTotalSizeOfVolume
## storagestatistics.getTotalSizeOfVolume
getTotalSizeOfVolume(volumeUuid: string): Promise
<
number
>
getTotalSizeOfVolume(volumeUuid: string): Promise
<
number
>
异步获取指定卷的总空间大小,以promise方式返回。
异步获取指定卷的总空间大小,以promise方式返回。
**系统能力**
:SystemCapability.FileManagement.StorageService.SpatialStatistics
-
参数
-
参数
| 参数名 | 类型 | 必填 | 说明 |
| 参数名 | 类型 | 必填 | 说明 |
...
@@ -50,6 +48,8 @@ getTotalSizeOfVolume(volumeUuid: string, callback:AsyncCallback<number>):v
...
@@ -50,6 +48,8 @@ getTotalSizeOfVolume(volumeUuid: string, callback:AsyncCallback<number>):v
异步获取指定卷的总空间大小,以callback方式返回。
异步获取指定卷的总空间大小,以callback方式返回。
**系统能力**
:SystemCapability.FileManagement.StorageService.SpatialStatistics
-
参数
-
参数
| 参数名 | 类型 | 必填 | 说明 |
| 参数名 | 类型 | 必填 | 说明 |
...
@@ -75,6 +75,8 @@ getFreeSizeOfVolume(volumeUuid: string): Promise<number>
...
@@ -75,6 +75,8 @@ getFreeSizeOfVolume(volumeUuid: string): Promise<number>
异步获取指定卷的可用空间大小,以promise方式返回。
异步获取指定卷的可用空间大小,以promise方式返回。
**系统能力**
:SystemCapability.FileManagement.StorageService.SpatialStatistics
-
参数
-
参数
| 参数名 | 类型 | 必填 | 说明 |
| 参数名 | 类型 | 必填 | 说明 |
...
@@ -105,6 +107,8 @@ getFreeSizeOfVolume(volumeUuid: string, callback:AsyncCallback<number>):vo
...
@@ -105,6 +107,8 @@ getFreeSizeOfVolume(volumeUuid: string, callback:AsyncCallback<number>):vo
异步获取指定卷的可用空间大小,以callback方式返回。
异步获取指定卷的可用空间大小,以callback方式返回。
**系统能力**
:SystemCapability.FileManagement.StorageService.SpatialStatistics
-
参数
-
参数
| 参数名 | 类型 | 必填 | 说明 |
| 参数名 | 类型 | 必填 | 说明 |
...
@@ -128,6 +132,8 @@ getBundleStats(packageName: string): Promise<BundleStats>
...
@@ -128,6 +132,8 @@ getBundleStats(packageName: string): Promise<BundleStats>
异步获取应用存储状态,以promise方式返回。
异步获取应用存储状态,以promise方式返回。
**系统能力**
:SystemCapability.FileManagement.StorageService.SpatialStatistics
-
参数
-
参数
| 参数名 | 类型 | 必填 | 说明 |
| 参数名 | 类型 | 必填 | 说明 |
...
@@ -157,6 +163,8 @@ getBundleStats(packageName: string, callback: AsyncCallback<BundleStats>)
...
@@ -157,6 +163,8 @@ getBundleStats(packageName: string, callback: AsyncCallback<BundleStats>)
异步获取应用存储状态,以callback方式返回。
异步获取应用存储状态,以callback方式返回。
**系统能力**
:SystemCapability.FileManagement.StorageService.SpatialStatistics
-
参数
-
参数
| 参数名 | 类型 | 必填 | 说明 |
| 参数名 | 类型 | 必填 | 说明 |
...
@@ -176,6 +184,8 @@ getBundleStats(packageName: string, callback: AsyncCallback<BundleStats>)
...
@@ -176,6 +184,8 @@ getBundleStats(packageName: string, callback: AsyncCallback<BundleStats>)
## BundleStats<sup>9+</sup>
## BundleStats<sup>9+</sup>
**系统能力**
:以下各项对应的系统能力均为SystemCapability.FileManagement.StorageService.SpatialStatistics。
### 属性
### 属性
| 名称 | 类型 | 说明 |
| 名称 | 类型 | 说明 |
...
...
zh-cn/application-dev/reference/apis/js-apis-volumemanager.md
浏览文件 @
b8924e5c
...
@@ -11,16 +11,14 @@
...
@@ -11,16 +11,14 @@
import
volumemanager
from
"
@ohos.volumeManager
"
;
import
volumemanager
from
"
@ohos.volumeManager
"
;
```
```
## 系统能力
SystemCapability.FileManagement.StorageService.Volume
## volumemanager.getAllVolumes
## volumemanager.getAllVolumes
getAllVolumes(): Promise
<
Array
<
Volume
>>
getAllVolumes(): Promise
<
Array
<
Volume
>>
异步获取当前所有可获得的卷信息,以promise方式返回。
异步获取当前所有可获得的卷信息,以promise方式返回。
**系统能力**
:SystemCapability.FileManagement.StorageService.Volume
-
返回值
-
返回值
| 类型 | 说明 |
| 类型 | 说明 |
...
@@ -41,6 +39,8 @@ getAllVolumes(callback: AsyncCallback<Array<Volume>>): void
...
@@ -41,6 +39,8 @@ getAllVolumes(callback: AsyncCallback<Array<Volume>>): void
异步获取当前所有可获得的卷信息,以callback方式返回。
异步获取当前所有可获得的卷信息,以callback方式返回。
**系统能力**
:SystemCapability.FileManagement.StorageService.Volume
-
参数
-
参数
| 参数名 | 类型 | 必填 | 说明 |
| 参数名 | 类型 | 必填 | 说明 |
...
@@ -63,6 +63,8 @@ mount(volumeId: string): Promise<boolean>
...
@@ -63,6 +63,8 @@ mount(volumeId: string): Promise<boolean>
异步挂载指定卷,以promise方式返回。
异步挂载指定卷,以promise方式返回。
**系统能力**
:SystemCapability.FileManagement.StorageService.Volume
-
参数
-
参数
| 参数名 | 类型 | 必填 | 说明 |
| 参数名 | 类型 | 必填 | 说明 |
...
@@ -90,6 +92,8 @@ mount(volumeId: string, callback:AsyncCallback<boolean>):void
...
@@ -90,6 +92,8 @@ mount(volumeId: string, callback:AsyncCallback<boolean>):void
异步获取指定卷的可用空间大小,以callback方式返回。
异步获取指定卷的可用空间大小,以callback方式返回。
**系统能力**
:SystemCapability.FileManagement.StorageService.Volume
-
参数
-
参数
| 参数名 | 类型 | 必填 | 说明 |
| 参数名 | 类型 | 必填 | 说明 |
...
@@ -112,6 +116,8 @@ unmount(volumeId: string): Promise<boolean>
...
@@ -112,6 +116,8 @@ unmount(volumeId: string): Promise<boolean>
异步卸载指定卷,以promise方式返回。
异步卸载指定卷,以promise方式返回。
**系统能力**
:SystemCapability.FileManagement.StorageService.Volume
-
参数
-
参数
| 参数名 | 类型 | 必填 | 说明 |
| 参数名 | 类型 | 必填 | 说明 |
...
@@ -139,6 +145,8 @@ unmount(volumeId: string, callback:AsyncCallback<boolean>):void
...
@@ -139,6 +145,8 @@ unmount(volumeId: string, callback:AsyncCallback<boolean>):void
异步卸载指定卷,以callback方式返回。
异步卸载指定卷,以callback方式返回。
**系统能力**
:SystemCapability.FileManagement.StorageService.Volume
-
参数
-
参数
| 参数名 | 类型 | 必填 | 说明 |
| 参数名 | 类型 | 必填 | 说明 |
...
@@ -157,6 +165,8 @@ unmount(volumeId: string, callback:AsyncCallback<boolean>):void
...
@@ -157,6 +165,8 @@ unmount(volumeId: string, callback:AsyncCallback<boolean>):void
## Volume<sup>9+</sup>
## Volume<sup>9+</sup>
**系统能力**
:以下各项对应的系统能力均为SystemCapability.FileManagement.StorageService.Volume。
### 属性
### 属性
| 名称 | 类型 | 说明 |
| 名称 | 类型 | 说明 |
...
...
编辑
预览
Markdown
is supported
0%
请重试
或
添加新附件
.
添加附件
取消
You are about to add
0
people
to the discussion. Proceed with caution.
先完成此消息的编辑!
取消
想要评论请
注册
或
登录