提交 6ec796f1 编写于 作者: W wangbo

文档修改

Signed-off-by: Nwangbo <wangbo448@huawei.com>
上级 8de08c44
......@@ -12,7 +12,7 @@ import document from '@ohos.document';
## document.choose
choose(type:string[]): Promise&lt;string&gt;
choose(types:string[]): Promise&lt;string&gt;
通过文件管理器选择文件,异步返回文件URI,使用promise形式返回结果。
......@@ -22,7 +22,7 @@ choose(type:string[]): Promise&lt;string&gt;
| 参数名 | 类型 | 必填 | 说明 |
| ------ | ------ | ---- | ---------------------------- |
| type | string[] | 否 | 限定文件选择的类型 |
| types | string[] | 否 | 限定文件选择的类型 |
- 返回值:
......@@ -33,7 +33,8 @@ choose(type:string[]): Promise&lt;string&gt;
- 示例:
```js
await document.choose(type);
let tpyes = [];
document.choose(types);
```
## document.choose
......@@ -52,13 +53,14 @@ choose(callback:AsyncCallback&lt;string&gt;): void
- 示例:
```js
await document.choose(function(err, uri) {
let uri = "";
document.choose(function(err, uri) {
//do something with uri
});
```
## document.choose
choose(type:string[], callback:AsyncCallback&lt;string&gt;): void
choose(types:string[], callback:AsyncCallback&lt;string&gt;): void
通过文件管理器选择文件,异步返回文件URI,使用callback形式返回结果。
......@@ -68,20 +70,22 @@ choose(type:string[], callback:AsyncCallback&lt;string&gt;): void
| 参数名 | 类型 | 必填 | 说明 |
| -------- | --------------------------- | ---- | ---------------------------- |
| type | string[] | 否 | 限定选择文件的类型 |
| types | string[] | 否 | 限定选择文件的类型 |
| callback | AsyncCallback&lt;string&gt; | 是 | 异步获取对应文件URI(注:当前返回错误码) |
- 示例:
```js
await document.choose(type, function(err, uri) {
let types = [];
let uri = "";
document.choose(types, function(err, uri) {
//do something with uri
});
```
## document.show
show(url:string, type:string):Promise&lt;number&gt;
show(url:string, types:string):Promise&lt;number&gt;
异步打开URI对应的文件,使用promise形式返回结果。
......@@ -92,7 +96,7 @@ show(url:string, type:string):Promise&lt;number&gt;
| 参数 | 类型 | 必填 | 说明 |
| ---- | ------ | ---- | ---------------------------- |
| uri | string | 是 | 待打开的文件URI |
| type | string | 是 | 待打开文件的类型 |
| types | string | 是 | 待打开文件的类型 |
- 返回值:
......@@ -103,12 +107,14 @@ show(url:string, type:string):Promise&lt;number&gt;
- 示例:
```js
await document.show(uri, type);
let types = "";
let uri = "";
document.show(uri, types);
```
## document.show
show(url:string, type:string, callback:AsyncCallback&lt;void&gt;): void
show(url:string, types:string, callback:AsyncCallback&lt;void&gt;): void
异步打开URI对应的文件,使用callback形式返回结果。
......@@ -119,13 +125,15 @@ show(url:string, type:string, callback:AsyncCallback&lt;void&gt;): void
| 参数名 | 类型 | 必填 | 说明 |
| -------- | --------------------------- | ---- | ---------------------------- |
| uri | string | 是 | 待打开的文件URI |
| type | string | 是 | 待打开文件的类型 |
| types | string | 是 | 待打开文件的类型 |
| callback | AsyncCallback&lt;void&gt; | 是 | 异步打开uri对应文件(注:当前返回错误码) |
- 示例:
```js
await document.show(uri, type, function(err) {
let types = "";
let uri = "";
document.show(uri, types, function(err) {
//do something
});
```
......
......@@ -111,7 +111,7 @@ listFile(path : string, type : string, options? : {dev? : DevInfo, offset? : num
```js
// 获取目录下所有文件
// 通过listFile、getRoot获取的文件uri
let media_path = file.path
let media_path = ""
filemanager.listFile(media_path, "file")
.then((fileInfo) => {
if(Array.isArray(fileInfo)) {
......@@ -120,6 +120,9 @@ listFile(path : string, type : string, options? : {dev? : DevInfo, offset? : num
}
}
}).catch((err) => {
console.log(err)
});
```
......@@ -152,7 +155,7 @@ listFile(path : string, type : string, options? : {dev? : DevInfo, offset? : num
```js
// 通过listFile、getRoot获取的文件path
let fileInfos = await filemanager.getRoot();
let fileInfos = filemanager.getRoot();
let media_path = "";
for (let i = 0; i < fileInfos.length; i++) {
if (fileInfos[i].name == "image_album") {
......@@ -197,7 +200,7 @@ createFile(path : string, filename : string, options? : {dev? : DevInfo}) : P
| 类型 | 说明 |
| --- | -- |
| Promise&lt;string&gt; | 文件uri |
| string | 文件uri |
- 异常
| 错误名称 | 错误类型 | 错误码 |说明 |
......@@ -211,7 +214,7 @@ createFile(path : string, filename : string, options? : {dev? : DevInfo}) : P
```js
// 创建文件,返回文件uri
let media_path = file.uri // 通过listFile、getRoot获取的文件uri
let media_path = "" // 通过listFile、getRoot获取的文件uri
let name = "xxx.jpg" // 待保存文件的后缀
filemanager.createFile(media_path, name).then((uri) => {
// 返回uri给应用
......@@ -252,13 +255,15 @@ createFile(path : string, filename: string, options? : {dev? : DevInfo}, callbac
```js
// 创建文件,返回文件uri
// 通过listFile、getRoot获取的文件uri
let media_path = file.path
let media_path = ""
// 待保存文件的后缀
let name = "xxx.jpg"
filemanager.createFile(media_path, name, (err, uri) => {
let dev = "";
filemanager.createFile(media_path, name, { DevInfo: dev }, function(err, uri) {
// 返回uri给应用
console.log("file uri:"+uri);
});
console.log("file uri:"+uri);
});
```
## FileInfo
......
# 数据标签
> ![icon-note.gif](public_sys-resources/icon-note.gif) **说明:**
> 本模块首批接口从API version 9开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。
该模块提供文件数据安全等级的相关功能:向应用程序提供查询、设置文件数据安全等级的JS接口。
## 导入模块
```js
import securityLabel from '@ohos.securityLabel';
```
## 使用说明
使用该功能模块对文件/目录进行操作前,需要先获取其应用沙箱路径,获取方式及其接口用法请参考:
```js
import featureAbility from '@ohos.ability.featureAbility';
let context = featureAbility.getContext();
let path = context.getFilesDir();
```
## securityLabel.setSecurityLabel
setSecurityLabel(path:string, dataLevel:string):Promise&lt;void&gt;
以异步方法设置数据标签,以promise形式返回结果。
**系统能力**:SystemCapability.FileManagement.File.DistributedFile
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| --------- | ------ | ---- | -------------------------------------------- |
| path | string | 是 | 文件路径 |
| dataLevel | string | 是 | 文件等级属性,只支持"s0","s1","s2","s3","s4" |
**返回值:**
| 类型 | 说明 |
| ------------------- | ---------------- |
| Promise&lt;void&gt; | Promise实例,用于异步获取结果。本调用将返回空值。|
**示例:**
```js
let dataLevel = "s4";
securityLabel.setSecurityLabel(path, dataLevel).then(function(){
console.info("setSecurityLabel successfully");
}).catch(function(error){
console.info("setSecurityLabel failed with error:" + error);
});
```
## securityLabel.setSecurityLabel
setSecurityLabel(path:string, dataLevel:string, callback: AsyncCallback&lt;void&gt;):void
以异步方法设置数据标签,以callback形式返回结果。
**系统能力**:SystemCapability.FileManagement.File.DistributedFile
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| --------- | ------------------------- | ---- | -------------------------------------------- |
| path | string | 是 | 文件路径 |
| dataLevel | string | 是 | 文件等级属性,只支持"s0","s1","s2","s3","s4" |
| callback | AsyncCallback&lt;void&gt; | 是 | 是否设置数据标签之后的回调 |
**示例:**
```js
let dataLevel = "s4";
securityLabel.setSecurityLabel(path, dataLevel, function(error){
console.info("setSecurityLabel:" + JSON.stringify(error));
});
```
## securityLabel.setSecurityLabelSync
setSecurityLabelSync(path:string, dataLevel:string):void
以同步方法设置数据标签。
**系统能力**:SystemCapability.FileManagement.File.DistributedFile
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| --------- | ------ | ---- | -------------------------------------------- |
| path | string | 是 | 文件路径 |
| dataLevel | string | 是 | 文件等级属性,只支持"s0","s1","s2","s3","s4" |
**示例:**
```js
let dataLevel = "s4";
securityLabel.setSecurityLabelSync(path, dataLevel);
```
## securityLabel.getSecurityLabel
getSecurityLabel(path:string):Promise&lt;string&gt;
异步方法获取数据标签,以promise形式返回结果。
**系统能力**:SystemCapability.FileManagement.File.DistributedFile
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| ------ | ------ | ---- | -------- |
| path | string | 是 | 文件路径 |
**返回值:**
| 类型 | 说明 |
| --------------------- | ------------ |
| Promise&lt;string&gt; | 返回数据标签 |
**示例:**
```js
let dataLevel = "s4";
securityLabel.getSecurityLabel(path).then(function(dataLevel){
console.log("getSecurityLabel successfully:" + dataLevel);
}).catch(function(error){
console.log("getSecurityLabel failed with error:" + error);
});
```
## securityLabel.getSecurityLabel
getSecurityLabel(path:string, callback:AsyncCallback&lt;string&gt;): void
异步方法获取数据标签,以callback形式返回结果。
**系统能力**:SystemCapability.FileManagement.File.DistributedFile
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | --------------------------- | ---- | -------------------------- |
| path | string | 是 | 文件路径 |
| callback | AsyncCallback&lt;string&gt; | 是 | 异步获取数据标签之后的回调 |
**示例:**
```js
let dataLevel = "s4";
securityLabel.getSecurityLabel(path,function(error, dataLevel){
console.log("getSecurityLabel successfully:" + dataLevel);
});
```
## securityLabel.getSecurityLabelSync
getSecurityLabelSync(path:string):string
以同步方法获取数据标签。
**系统能力**:SystemCapability.FileManagement.File.DistributedFile
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| ------ | ------ | ---- | -------- |
| path | string | 是 | 文件路径 |
**返回值:**
| 类型 | 说明 |
| ------ | ------------ |
| string | 返回数据标签 |
**示例:**
```js
let result = securityLabel.getSecurityLabelSync(path);
console.log("getSecurityLabel successfully:" + result);
```
......@@ -4,14 +4,13 @@
>
> - 本模块首批接口从API version 8开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。
> - API 9当前为Canary版本,仅供试用,不保证接口可稳定调用。
> - 本模块接口为系统接口,三方应用不支持调用。
该模块提供空间查询相关的常用功能:包括对内外卡的空间查询,对应用分类数据统计的查询,对应用数据的查询等。
## 导入模块
```js
import storagestatistics from "@ohos.storageStatistics";
import storageStatistics from "@ohos.storageStatistics";
```
## storagestatistics.getTotalSizeOfVolume
......@@ -20,8 +19,12 @@ getTotalSizeOfVolume(volumeUuid: string): Promise&lt;number&gt;
异步获取指定卷的总空间大小,以promise方式返回。
**需要权限**:ohos.permission.STORAGE_MANAGER
**系统能力**:SystemCapability.FileManagement.StorageService.SpatialStatistics
**系统API**:该接口为系统接口,三方应用不支持调用
- 参数
| 参数名 | 类型 | 必填 | 说明 |
......@@ -51,8 +54,12 @@ getTotalSizeOfVolume(volumeUuid: string, callback:AsyncCallback&lt;number&gt;):v
异步获取指定卷的总空间大小,以callback方式返回。
**需要权限**:ohos.permission.STORAGE_MANAGER
**系统能力**:SystemCapability.FileManagement.StorageService.SpatialStatistics
**系统API**:该接口为系统接口,三方应用不支持调用
- 参数
| 参数名 | 类型 | 必填 | 说明 |
......@@ -78,8 +85,12 @@ getFreeSizeOfVolume(volumeUuid: string): Promise&lt;number&gt;
异步获取指定卷的可用空间大小,以promise方式返回。
**需要权限**:ohos.permission.STORAGE_MANAGER
**系统能力**:SystemCapability.FileManagement.StorageService.SpatialStatistics
**系统API**:该接口为系统接口,三方应用不支持调用
- 参数
| 参数名 | 类型 | 必填 | 说明 |
......@@ -110,8 +121,12 @@ getFreeSizeOfVolume(volumeUuid: string, callback:AsyncCallback&lt;number&gt;):vo
异步获取指定卷的可用空间大小,以callback方式返回。
**需要权限**:ohos.permission.STORAGE_MANAGER
**系统能力**:SystemCapability.FileManagement.StorageService.SpatialStatistics
**系统API**:该接口为系统接口,三方应用不支持调用
- 参数
| 参数名 | 类型 | 必填 | 说明 |
......@@ -135,8 +150,12 @@ getBundleStats(packageName: string): Promise&lt;BundleStats&gt;
异步获取应用存储数据,以promise方式返回。
**需要权限**:ohos.permission.STORAGE_MANAGER
**系统能力**:SystemCapability.FileManagement.StorageService.SpatialStatistics
**系统API**:该接口为系统接口,三方应用不支持调用
- 参数
| 参数名 | 类型 | 必填 | 说明 |
......@@ -166,8 +185,12 @@ getBundleStats(packageName: string, callback: AsyncCallback&lt;BundleStats&gt;)
异步获取应用存储数据,以callback方式返回。
**需要权限**:ohos.permission.STORAGE_MANAGER
**系统能力**:SystemCapability.FileManagement.StorageService.SpatialStatistics
**系统API**:该接口为系统接口,三方应用不支持调用
- 参数
| 参数名 | 类型 | 必填 | 说明 |
......@@ -185,14 +208,311 @@ getBundleStats(packageName: string, callback: AsyncCallback&lt;BundleStats&gt;)
});
```
## storagestatistics.getCurrentBundleStats<sup>9+</sup>
getCurrentBundleStats(): Promise<BundleStats>
第三方应用异步获取占用空间,以promise方式返回。
**系统能力**:SystemCapability.FileManagement.StorageService.SpatialStatistics
- 返回值
| 类型 | 说明 |
| ------------------------------------------ | -------------------------- |
| Promise&lt;[Bundlestats](#bundlestats)&gt; | 返回指定卷上的应用存储状态 |
- 示例
```js
let bundleStats = storageStatistics.getCurrentBundleStats();
console.info("getCurrentBundleStats successfully:"+ JSON.stringify(bundleStats));
```
## storagestatistics.getCurrentBundleStats<sup>9+</sup>
getCurrentBundleStats(callback: AsyncCallback<BundleStats>): void
第三方应用异步获取占用空间,以callback方式返回。
**系统能力**:SystemCapability.FileManagement.StorageService.SpatialStatistics
- 参数
| 参数名 | 类型 | 必填 | 说明 |
| -------- | --------------------------------------------------------- | ---- | ------------------------------------ |
| callback | callback:AsyncCallback&lt;[BundleStats](#bundlestats)&gt; | 是 | 获取指定卷上的应用存储状态之后的回调 |
- 示例
```js
storagestatistics.getCurrentBundleStats(function(error, bundleStats){
// do something
console.info("getCurrentBundleStats successfully:"+ JSON.stringify(bundleStats));
});
```
## BundleStats<sup>9+</sup>
**系统能力**:以下各项对应的系统能力均为SystemCapability.FileManagement.StorageService.SpatialStatistics。
### 属性
- 属性
| 名称 | 类型 | 说明 |
| --------- | ------ | -------------- |
| appSize | number | app数据大小 |
| cacheSize | number | 缓存数据大小 |
| dataSize | number | 应用总数据大小 |
## storagestatistics.getTotalSize<sup>9+</sup>
getTotalSize(): Promise<number>
获取内卡的总空间大小,以promise方式返回。
**需要权限**:ohos.permission.STORAGE_MANAGER
**系统能力**:SystemCapability.FileManagement.StorageService.SpatialStatistics
**系统API**:该接口为系统接口,三方应用不支持调用
- 返回值
| 类型 | 说明 |
| --------------------- | ------------------ |
| Promise&lt;number&gt; | 返回内卡的总空间大小 |
- 示例
```js
let number = storageStatistics.getTotalSize();
console.info("getTotalSize successfully:"+ JSON.stringify(number));
```
## storagestatistics.getTotalSize<sup>9+</sup>
getTotalSize(callback: AsyncCallback<number>): void
获取内卡的总空间大小,以callback方式返回。
**需要权限**:ohos.permission.STORAGE_MANAGER
**系统能力**:SystemCapability.FileManagement.StorageService.SpatialStatistics
**系统API**:该接口为系统接口,三方应用不支持调用
- 参数
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ------------------------------------ | ---- | ------------------------ |
| callback | callback:AsyncCallback&lt;number&gt; | 是 | 获取内卡的总空间大小之后的回调 |
- 示例
```js
storagestatistics.getTotalSize(function(error, number){
// do something
console.info("getTotalSize successfully:"+ JSON.stringify(number));
});
```
## storagestatistics.getFreeSize<sup>9+</sup>
getFreeSize(): Promise<number>
获取内卡的可用空间大小,以promise方式返回。
**需要权限**:ohos.permission.STORAGE_MANAGER
**系统能力**:SystemCapability.FileManagement.StorageService.SpatialStatistics
**系统API**:该接口为系统接口,三方应用不支持调用
- 返回值
| 类型 | 说明 |
| --------------------- | ------------------ |
| Promise&lt;number&gt; | 返回内卡的可用空间大小 |
- 示例
```js
let number = storageStatistics.getFreeSize();
console.info("getFreeSize successfully:"+ JSON.stringify(number));
```
## storagestatistics.getFreeSize<sup>9+</sup>
getFreeSize(callback: AsyncCallback<number>): void
获取内卡的可用空间大小,以callback方式返回。
**需要权限**:ohos.permission.STORAGE_MANAGER
**系统能力**:SystemCapability.FileManagement.StorageService.SpatialStatistics
**系统API**:该接口为系统接口,三方应用不支持调用
- 参数
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ------------------------------------ | ---- | ------------------------- |
| callback | callback:AsyncCallback&lt;number&gt; | 是 | 获取内卡的可用空间大小之后的回调 |
- 示例
```js
storagestatistics.getFreeSize(function(error, number){
// do something
console.info("getFreeSize successfully:"+ JSON.stringify(number));
});
```
## storagestatistics.getSystemSize<sup>9+</sup>
getSystemSize(): Promise&lt;number&gt;
异步获取系统空间大小,以promise方式返回。
**需要权限**:ohos.permission.STORAGE_MANAGER
**系统能力**:SystemCapability.FileManagement.StorageService.SpatialStatistics
**系统API**:该接口为系统接口,三方应用不支持调用
- 返回值
| 类型 | 说明 |
| --------------------- | ---------------- |
| Promise&lt;number&gt; | 返回系统空间大小 |
- 示例
```js
storagestatistics.getSystemSize().then(function(number){
console.info("getSystemSize successfully:"+ number);
}).catch(function(err){
console.info("getSystemSize failed with error:"+ err);
});
```
## storagestatistics.getSystemSize<sup>9+</sup>
getSystemSize(callback:AsyncCallback&lt;number&gt;):void
异步获取系统空间大小,以callback方式返回。
**需要权限**:ohos.permission.STORAGE_MANAGER
**系统能力**:SystemCapability.FileManagement.StorageService.SpatialStatistics
**系统API**:该接口为系统接口,三方应用不支持调用
- 参数
| 参数名 | 类型 | 必填 | 说明 |
| ---------- | ------------------------------------ | ---- | -------------------------- |
| callback | callback:AsyncCallback&lt;number&gt; | 是 | 获取系统空间大小之后的回调 |
- 示例
```js
storagestatistics.getSystemSize(function(error, number){
// do something
console.info("getSystemSize successfully:"+ number);
});
```
## storagestatistics.getUserStorageStats<sup>9+</sup>
getUserStorageStats(userId?: string): Promise&lt;StorageStats&gt;
异步获取用户各类别数据大小,以promise方式返回。
**需要权限**:ohos.permission.STORAGE_MANAGER
**系统能力**:SystemCapability.FileManagement.StorageService.SpatialStatistics
**系统API**:该接口为系统接口,三方应用不支持调用
- 参数
| 参数名 | 类型 | 必填 | 说明 |
| ---------- | ------ | ---- | ---- |
| userId | string | 否 | 用户id <br/>确认当前用户:<br/>-&nbsp;有值:表示指定用户。<br/>-&nbsp;无值:表示当前用户。|
- 返回值
| 类型 | 说明 |
| --------------------- | ---------------- |
| Promise&lt;[StorageStats](#StorageStats)&gt; | 返回各类别数据大小 |
- 示例
```js
let userId = "";
storagestatistics.getUserStorageStats(userId).then(function(StorageStats){
console.info("getUserStorageStats successfully:"+ JSON.stringify(StorageStats));
}).catch(function(err){
console.info("getUserStorageStats failed with error:"+ err);
});
```
## storagestatistics.getUserStorageStats<sup>9+</sup>
getUserStorageStats(userId?: string, callback:AsyncCallback&lt;StorageStats&gt;):void
异步获取用户各类别数据大小,以callback方式返回。
**需要权限**:ohos.permission.STORAGE_MANAGER
**系统能力**:SystemCapability.FileManagement.StorageService.SpatialStatistics
**系统API**:该接口为系统接口,三方应用不支持调用
- 参数
| 参数名 | 类型 | 必填 | 说明 |
| ---------- | ------------------------------------ | ---- | -------------------------- |
| userId | string | 否 | 用户id <br/>确认当前用户:<br/>-&nbsp;有值:表示指定用户。<br/>-&nbsp;无值:表示当前用户。 |
| callback | callback:AsyncCallback&lt;[StorageStats](#StorageStats)&gt; | 是 | 返回各类别数据大小之后的回调 |
- 示例
```js
let userId = "";
storagestatistics.getUserStorageStats(userId, function(error, StorageStats){
// do something
console.info("getUserStorageStats successfully:"+ JSON.stringify(StorageStats));
});
```
## StorageStats<sup>9+</sup>
**系统能力**:以下各项对应的系统能力均为SystemCapability.FileManagement.StorageService.SpatialStatistics。
- 属性
| 名称 | 类型 | 说明 |
| --------- | ------ | -------------- |
| appSize<sup>9+</sup> | number | app数据大小 |
| cacheSize<sup>9+</sup> | number | 缓存数据大小 |
| dataSize<sup>9+</sup> | number | 应用总数据大小 |
\ No newline at end of file
| total | number | 内卡总空间大小 |
| audio | number | 音频数据大小 |
| video | number | 视频数据大小 |
| image | number | 图像数据大小 |
| file | number | 文件数据大小 |
| app | number | 应用数据大小 |
Markdown is supported
0% .
You are about to add 0 people to the discussion. Proceed with caution.
先完成此消息的编辑!
想要评论请 注册