diff --git a/zh-cn/application-dev/reference/apis/Readme-CN.md b/zh-cn/application-dev/reference/apis/Readme-CN.md index db1adcf6b2cd003b0b993e793910616fa72e9106..f71f1306afbc3582b6a581b92ca76e514dd8e47c 100644 --- a/zh-cn/application-dev/reference/apis/Readme-CN.md +++ b/zh-cn/application-dev/reference/apis/Readme-CN.md @@ -32,6 +32,8 @@ - [文件管理](js-apis-fileio.md) - [Statfs](js-apis-statfs.md) - [目录环境](js-apis-environment.md) + - [应用空间统计](js-apis-storage-statistics.md) + - [卷管理](js-apis-volumemanager.md) - 账号管理 - [分布式帐号管理](js-apis-distributed-account.md) - [应用帐号管理](js-apis-appAccount.md) diff --git a/zh-cn/application-dev/reference/apis/js-apis-environment.md b/zh-cn/application-dev/reference/apis/js-apis-environment.md index 2d38edd1d107c7713d9ef9e6815710e403650ecc..c4077db9a74a56395243a1a98eb8f059d1e010d5 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-environment.md +++ b/zh-cn/application-dev/reference/apis/js-apis-environment.md @@ -1,18 +1,17 @@ # 目录环境能力 - +> ![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'; ``` +## 系统能力 - -## 权限列表 - -无 +SystemCapability.FileManagement.File.Environment ## environment.getStorageDataDir @@ -28,7 +27,7 @@ getStorageDataDir():Promise<string> - 示例： - ``` + ```js environment.getStorageDataDir().then(function(path){ // do something }).catch(function(error){ @@ -50,7 +49,7 @@ getStorageDataDir(callback:AsyncCallback<string>):void - 示例： - ``` + ```js environment.getStorageDataDir(function(error, path){ // do something }); @@ -70,7 +69,7 @@ getUserDataDir():Promise<string> - 示例： - ``` + ```js environment.getUserDataDir().then(function(path){ // do something }).catch(function(error){ @@ -92,7 +91,7 @@ getUserDataDir(callback:AsyncCallback<string>): void - 示例： - ``` + ```js environment.getUserDataDir(function(error, path){ // do something }); diff --git a/zh-cn/application-dev/reference/apis/js-apis-filemanager.md b/zh-cn/application-dev/reference/apis/js-apis-filemanager.md index 897f1063eadeedf1ce2acfbb392f85139d4e959a..173e64ef45ade4c21a26e7cd3346eebedf826fe6 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-filemanager.md +++ b/zh-cn/application-dev/reference/apis/js-apis-filemanager.md @@ -1,16 +1,18 @@ # 公共文件访问与管理 - +>![](../../public_sys-resources/icon-note.gif) **说明：** +>本模块首批接口从API version 8开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。 ## 导入模块 -``` +```js import filemanager from 'ohos.filemanager' ``` -## 权限 +## 系统能力 -应用需要拥有SystemCapability.FileManagement.FileManagerService权限 +SystemCapability.FileManagement.FileManagerService ## filemanager.getRoot + getRoot(options? : {dev? : DevInfo}) : Promise<FileInfo[]> 以异步方法获取第一层相册，目录信息。使用promise形式返回结果。 @@ -18,13 +20,13 @@ getRoot(options? : {dev? : DevInfo}) : Promise<FileInfo[]> - 参数 | 参数名 | 类型 | 必填 | 说明 | | --- | --- | --- | -- | - | dev | DevInfo | 否 | 设备名, 当前仅支持设备'local' | + | dev | [DevInfo](#devinfo) | 否 | 设备名, 不填为默认值dev = {name: "local"}, 当前仅支持设备'local' | - 返回值 | 类型 | 说明 | | --- | -- | - | Promise<FileInfo[]> | 第一层目录相册信息 | + | Promise<[FileInfo](#fileinfo)[]> | 第一层目录相册信息 | - 示例 @@ -52,8 +54,8 @@ getRoot(options? : {dev? : DevInfo}, callback : AsyncCallback<FileInfo[]>) | 参数名 | 类型 | 必填 | 说明 | | -------- | ------------------------- | ---- | ----------------------------- | - | dev | DevInfo | 否 | 设备名, 当前仅支持设备'local' | - | callback | AsyncCallback<FileInfo[]> | 是 | 异步获取文件的信息之后的回调 | + | dev | [DevInfo](#devinfo) | 否 | 设备名, 不填为默认值dev = {name: "local"}, 当前仅支持设备'local' | + | callback | AsyncCallback<[FileInfo](#fileinfo)[]> | 是 | 异步获取文件的信息之后的回调 | - 示例 @@ -78,10 +80,10 @@ listFile(path : string, type : string, options? : {dev? : DevInfo, offset? : num | --- | --- | --- | -- | | type | string | 是 | 待查询文件类型, 支持以下类型 "file", "image", "audio", "video" | | path | string | 是 | 待查询目录uri | - | dev | DevInfo | 是 | 设备名, 当前仅支持设备'local' | + | dev | [DevInfo](#devinfo) | 是 | 设备名, 不填为默认值dev = {name: "local"}, 当前仅支持设备'local' | | offset | number | 否 | 待查询文件偏移 | | count | number | 否 | 待查询文件个数 | - + - 返回值 | 类型 | 说明 | @@ -123,10 +125,10 @@ listFile(path : string, type : string, options? : {dev? : DevInfo, offset? : num | -------- | ------------------------- | ---- | ------------------------------------------------------------ | | type | string | 是 | 待查询文件类型, 支持以下类型 "file", "image", "audio", "video" | | path | string | 是 | 待查询目录uri | - | dev | DevInfo | 否 | 设备名, 当前仅支持设备'local' | + | dev | [DevInfo](#devinfo) | 否 | 设备名, 不填为默认值dev = {name: "local"}, 当前仅支持设备'local' | | offset | number | 否 | 待查询文件偏移 | | count | number | 否 | 待查询文件个数 | - | callback | AsyncCallback<FileInfo[]> | 是 | 异步获取文件的信息之后的回调 | + | callback | AsyncCallback<[FileInfo](#fileinfo)[]> | 是 | 异步获取文件的信息之后的回调 | - 异常 | 错误名称 | 错误类型 | 错误码 | 说明 | @@ -158,7 +160,7 @@ filemanager.createFile(path : string, filename : string, options? : {dev? : DevI | --- | --- | --- | -- | | filename | string | 是 | 待创建的文件名 | | 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 | -------- | ------------------------- | ---- | ----------------------------- | | filename | string | 是 | 待创建的文件名 | | path | string | 是 | 待保存目的相册uri | - | dev | DevInfo | 否 | 设备名, 当前仅支持设备'local' | - | callback | AsyncCallback<FileInfo[]> | 是 | 异步获取文件的信息之后的回调 | + | dev | [DevInfo](#devinfo) | 否 | 设备名, 不填为默认值dev = {name: "local"}, 当前仅支持设备'local' | + | callback | AsyncCallback<[FileInfo](#fileinfo)[]> | 是 | 异步获取文件的信息之后的回调 | - 异常 @@ -225,6 +227,8 @@ filemanager.createFile(media_path, name, (err, uri) => { ## FileInfo 文件信息类型，通过getRoot, listFile等接口返回的类型。 +### 属性 + | 参数名 | 类型 | 可读 | 可写 | 说明 | | --- | -- | -- | -- | -- | | name | string | 是 | 否 | 文件名称 | @@ -237,6 +241,8 @@ filemanager.createFile(media_path, name, (err, uri) => { ## DevInfo 设备类型，配置接口访问的设备类型。 +### 属性 + | 参数名 | 类型 | 可读 | 可写 | 说明 | | --- | -- | -- | -- | -- | | name | string | 是 | 是 | 设备名称 | \ No newline at end of file diff --git a/zh-cn/application-dev/reference/apis/js-apis-statfs.md b/zh-cn/application-dev/reference/apis/js-apis-statfs.md index de83a64b5d31a3da69ec9c072ce0391d8f27f809..12921a2a4140cd9daea8d20149e9e40e78ee9a54 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-statfs.md +++ b/zh-cn/application-dev/reference/apis/js-apis-statfs.md @@ -1,10 +1,11 @@ # statfs - +> ![icon-note.gif](D:/docs/zh-cn/application-dev/reference/apis/public_sys-resources/icon-note.gif) **说明：** +> 本模块首批接口从API version 8开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。 ## 导入模块 -``` +```js import statfs from '@ohos.statfs' ``` @@ -16,13 +17,13 @@ import statfs from '@ohos.statfs' 通过上述接口获取到应用目录路径dir，文件名为“xxx.txt”，文件所在绝对路径为： -``` +```js let path = dir + "xxx.txt" ``` -## 权限列表 +## 系统能力 -无 +SystemCapability.FileManagement.File.FileIO ## statfs.getFreeBytes @@ -44,7 +45,7 @@ getFreeBytes(path:string):Promise<number> - 示例： - ``` + ```js let num = await statfs.getFreeBytes(path); ``` @@ -63,7 +64,7 @@ getFreeBytes(path:string, callback:AsyncCallback<number>): void - 示例： - ``` + ```js statfs.getFreeBytes(path, function(err, number){ //do something }); @@ -89,7 +90,7 @@ getTotalBytes.(path:string):Promise<number> - 示例： - ``` + ```js let num = await statfs.getTotalBytes(path); ``` @@ -108,7 +109,7 @@ getTotalBytes(path:string, callback:AsyncCallback<number>): void - 示例： - ``` + ```js statfs.getTotalBytes(path, function(err, number){ //do something }); diff --git a/zh-cn/application-dev/reference/apis/js-apis-storage-statistics.md b/zh-cn/application-dev/reference/apis/js-apis-storage-statistics.md new file mode 100644 index 0000000000000000000000000000000000000000..e4be7d73cfe532fc00f9bd33919660d90a966a84 --- /dev/null +++ b/zh-cn/application-dev/reference/apis/js-apis-storage-statistics.md @@ -0,0 +1,176 @@ +# 应用空间统计 + +> ![icon-note.gif](D:/docs/zh-cn/application-dev/reference/apis/public_sys-resources/icon-note.gif) **说明：** +> 本模块首批接口从API version 8开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本 + +## 导入模块 + +```js +import storagestatistics from "@ohos.storagestatistics"; +``` + +## 系统能力 + +SystemCapability.FileManagement.StorageService.SpatialStatistics + +## storagestatistics.getTotalSizeOfVolume + +getTotalSizeOfVolume(volumeUuid: string): Promise\ + +异步获取指定卷的总空间大小，以promise方式返回。 + +- 参数 + + | 参数名 | 类型 | 必填 | 说明 | + | ---------- | ------ | ---- | ---- | + | volumeUuid | string | 是 | 卷id | + +- 返回值 + + | 类型 | 说明 | + | ----------------- | ---------------- | + | Promise\ | 返回指定卷总空间 | + +- 示例 + + ```js + let uuid = ""; + storagestatistics.getTotalSizeOfVolume(uuid).then(function(number){ + // do something + }); + ``` + +## storagestatistics.getTotalSizeOfVolume + +getTotalSizeOfVolume(volumeUuid: string, callback:AsyncCallback\):void + +异步获取指定卷的总空间大小，以callback方式返回。 + +- 参数 + + | 参数名 | 类型 | 必填 | 说明 | + | ---------- | -------------------------------- | ---- | -------------------------- | + | volumeUuid | string | 是 | 卷id | + | callback | callback:AsyncCallback\ | 是 | 获取指定卷总空间之后的回调 | + +- 示例 + + ```js + let uuid = ""; + storagestatistics.getTotalSizeOfVolume(uuid, function(error, number){ + // do something + }); + ``` + + + +## storagestatistics.getFreeSizeOfVolume + +getFreeSizeOfVolume(volumeUuid: string): Promise\ + +异步获取指定卷的可用空间大小，以promise方式返回。 + +- 参数 + + | 参数名 | 类型 | 必填 | 说明 | + | ---------- | ------ | ---- | ---- | + | volumeUuid | string | 是 | 卷id | + +- 返回值 + + | 类型 | 说明 | + | ----------------- | ------------------ | + | Promise\ | 返回指定卷可用空间 | + +- 示例 + + ```js + let uuid = ""; + storagestatistics.getFreeSizeOfVolume(uuid).then(function(number){ + // do something + }); + ``` + +## storagestatistics.getFreeSizeOfVolume + +getFreeSizeOfVolume(volumeUuid: string, callback:AsyncCallback\):void + +异步获取指定卷的可用空间大小，以callback方式返回。 + +- 参数 + + | 参数名 | 类型 | 必填 | 说明 | + | ---------- | -------------------------------- | ---- | ---------------------------- | + | volumeUuid | string | 是 | 卷id | + | callback | callback:AsyncCallback\ | 是 | 获取指定卷可用空间之后的回调 | + +- 示例 + + ```js + let uuid = ""; + storagestatistics.getFreeSizeOfVolume(uuid, function(error, number){ + // do something + }); + ``` + +## storagestatistics.getBundleStats + +getBundleStats(volumeUuid: string, packageName:String, ): Promise\ + +异步获取指定卷上的应用存储状态，以promise方式返回。 + +- 参数 + + | 参数名 | 类型 | 必填 | 说明 | + | ----------- | ------ | ---- | -------- | + | volumeUuid | string | 是 | 卷id | + | packageName | string | 是 | 应用包名 | + +- 返回值 + + | 类型 | 说明 | + | ------------------------------------------ | -------------------------- | + | Promise<[Bundlestats](#bundlestats)> | 返回指定卷上的应用存储状态 | + +- 示例 + + ```js + let uuid = ""; + let packageName = ""; + storagestatistics.getBundleStats(uuid, packageName).then(function(BundleStats){ + // do something + }); + ``` + +## storagestatistics.getBundleStats + +getBundleStats(volumeUuid: string, callback:AsyncCallback\):void + +异步获取指定卷上的应用存储状态，以callback方式返回。 + +- 参数 + + | 参数名 | 类型 | 必填 | 说明 | + | ---------- | ----------------------------------------------------- | ---- | ------------------------------------ | + | volumeUuid | string | 是 | 卷id | + | callback | callback:AsyncCallback\<[Bundlestats](#bundlestats)\> | 是 | 获取指定卷上的应用存储状态之后的回调 | + +- 示例 + + ```js + let uuid = ""; + let packageName = ""; + storagestatistics.getBundleStats(uuid, packageName, function(error, BundleStats){ + // do something + }); + ``` + +## BundleStats + +### 属性 + +| 名称 | 类型 | 说明 | +| --------- | ------ | -------------- | +| appSize | number | app数据大小 | +| cacheSize | number | 缓存数据大小 | +| dataSize | number | 应用总数据大小 | \ No newline at end of file diff --git a/zh-cn/application-dev/reference/apis/js-apis-volumemanager.md b/zh-cn/application-dev/reference/apis/js-apis-volumemanager.md new file mode 100644 index 0000000000000000000000000000000000000000..6353fcdc6e7b4365bbf488b25d5ef7abe2aebf99 --- /dev/null +++ b/zh-cn/application-dev/reference/apis/js-apis-volumemanager.md @@ -0,0 +1,167 @@ +# 卷管理 + +> ![icon-note.gif](D:/docs/zh-cn/application-dev/reference/apis/public_sys-resources/icon-note.gif) **说明：** +> 本模块首批接口从API version 8开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本 + +## 导入模块 + +```js +import volumemanager from "@ohos.volumemanager"; +``` + +## 系统能力 + +SystemCapability.FileManagement.StorageService.Volume + +## volumemanager.getAllVolumes + +getAllVolumes(): Promise\ + +异步获取当前所有可获得的卷信息，以promise方式返回。 + +- 返回值 + + | 类型 | 说明 | + | ------------------------------ | -------------------------- | + | Promise\<[Volume](#volume)[]\> | 返回当前所有可获得的卷信息 | + +- 示例 + + ```js + volumemanager.getAllVolumes().then(function(volumes){ + // do something + }); + ``` + +## volumemanager.getAllVolumes + +getAllVolumes(callback:AsyncCallback\):void + +异步获取当前所有可获得的卷信息，以callback方式返回。 + +- 参数 + + | 参数名 | 类型 | 必填 | 说明 | + | -------- | --------------------------------------------- | ---- | ------------------------------------ | + | callback | callback:AsyncCallback\<[Volume](#volume)[]\> | 是 | 获取当前所有可获得的卷信息之后的回调 | + +- 示例 + + ```js + let uuid = ""; + volumemanager.getAllVolumes(uuid, function(error, volumes){ + // do something + }); + ``` + + +## volumemanager.mount + +mount(volumeId: string): Promise\ + +异步挂载指定卷，以promise方式返回。 + +- 参数 + + | 参数名 | 类型 | 必填 | 说明 | + | -------- | ------ | ---- | ---- | + | volumeId | string | 是 | 卷id | + +- 返回值 + + | 类型 | 说明 | + | ------------------ | ---------- | + | Promise\ | 挂载指定卷 | + +- 示例 + + ```js + let volumeId = ""; + volumemanager.mount(volumeId).then(function(flag){ + // do something + }); + ``` + +## volumemanager.mount + +mount(volumeId: string, callback:AsyncCallback\):void + +异步获取指定卷的可用空间大小，以callback方式返回。 + +- 参数 + + | 参数名 | 类型 | 必填 | 说明 | + | -------- | --------------------------------- | ---- | -------------------- | + | volumeId | string | 是 | 卷id | + | callback | callback:AsyncCallback\ | 是 | 挂载指定卷之后的回调 | + +- 示例 + + ```js + let volumeId = ""; + volumemanager.mount(volumeId, function(error, flag){ + // do something + }); + ``` + +## volumemanager.unmount + +unmount(volumeId: string): Promise\ + +异步卸载指定卷，以promise方式返回。 + +- 参数 + + | 参数名 | 类型 | 必填 | 说明 | + | -------- | ------ | ---- | ---- | + | volumeId | string | 是 | 卷id | + +- 返回值 + + | 类型 | 说明 | + | ------------------ | ---------- | + | Promise\ | 卸载指定卷 | + +- 示例 + + ```js + let volumeId = ""; + volumemanager.unmount(volumeId).then(function(flag){ + // do something + }); + ``` + +## volumemanager.unmount + +unmount(volumeId: string, callback:AsyncCallback\):void + +异步卸载指定卷，以callback方式返回。 + +- 参数 + + | 参数名 | 类型 | 必填 | 说明 | + | -------- | --------------------------------- | ---- | -------------------- | + | volumeId | string | 是 | 卷id | + | callback | callback:AsyncCallback\ | 是 | 卸载指定卷之后的回调 | + +- 示例 + + ```js + let volumeId = ""; + volumemanager.unmount(volumeId, function(error, flag){ + // do something + }); + ``` + +## Volume + +### 属性 + +| 名称 | 类型 | 说明 | +| ----------- | ------- | -------------------- | +| id | number | 卷id | +| uuid | string | 卷uuid | +| description | string | 卷相关描述 | +| removeAble | boolean | 是否为可移动存储设备 | +| state | int | 当前卷状态 | +| path | string | 卷的挂载地址 | \ No newline at end of file