未验证 提交 f398ffcb 编写于 作者: O openharmony_ci 提交者: Gitee

!6119 文档修改

Merge pull request !6119 from wangbo/master
......@@ -16,7 +16,7 @@ choose(types:string[]): Promise<string>
通过文件管理器选择文件,异步返回文件URI,使用promise形式返回结果。
**系统能力**:SystemCapability.FileManagement.File.FileIO
**系统能力**:SystemCapability.FileManagement.UserFileService
- 参数:
......@@ -42,7 +42,7 @@ choose(callback:AsyncCallback<string>): void
通过文件管理器选择文件,异步返回文件URI,使用callback形式返回结果。
**系统能力**:SystemCapability.FileManagement.File.FileIO
**系统能力**:SystemCapability.FileManagement.UserFileService
- 参数:
......@@ -64,7 +64,7 @@ choose(types:string[], callback:AsyncCallback<string>): void
通过文件管理器选择文件,异步返回文件URI,使用callback形式返回结果。
**系统能力**:SystemCapability.FileManagement.File.FileIO
**系统能力**:SystemCapability.FileManagement.UserFileService
- 参数:
......@@ -85,11 +85,11 @@ choose(types:string[], callback:AsyncCallback<string>): void
## document.show
show(url:string, types:string):Promise<number>
show(uri:string, types:string):Promise<void>
异步打开URI对应的文件,使用promise形式返回结果。
**系统能力**:SystemCapability.FileManagement.File.FileIO
**系统能力**:SystemCapability.FileManagement.UserFileService
- 参数:
......@@ -114,11 +114,11 @@ show(url:string, types:string):Promise<number>
## document.show
show(url:string, types:string, callback:AsyncCallback<void>): void
show(uri:string, types:string, callback:AsyncCallback<void>): void
异步打开URI对应的文件,使用callback形式返回结果。
**系统能力**:SystemCapability.FileManagement.File.FileIO
**系统能力**:SystemCapability.FileManagement.UserFileService
- 参数:
......
......@@ -18,7 +18,7 @@ getRoot(options? : {dev? : DevInfo}) : Promise<FileInfo[]>
以异步方法获取第一层相册,目录信息。使用promise形式返回结果。
**系统能力**:SystemCapability.FileManagement.FileManagerService
**系统能力**:SystemCapability.FileManagement.UserFileService
- 参数
| 参数名 | 类型 | 必填 | 说明 |
......@@ -51,7 +51,7 @@ getRoot(options? : {dev? : DevInfo}, callback : AsyncCallback<FileInfo[]>)
以异步方法获取第一层相册,目录信息。使用callback形式返回结果。
**系统能力**:SystemCapability.FileManagement.FileManagerService
**系统能力**:SystemCapability.FileManagement.UserFileService
- 参数
......@@ -84,7 +84,7 @@ listFile(path : string, type : string, options? : {dev? : DevInfo, offset? : num
以异步方法获取第二层相册,文件信息。使用promise形式返回结果。
**系统能力**:SystemCapability.FileManagement.FileManagerService
**系统能力**:SystemCapability.FileManagement.UserFileService
- 参数
| 参数名 | 类型 | 必填 | 说明 |
......@@ -133,7 +133,7 @@ listFile(path : string, type : string, options? : {dev? : DevInfo, offset? : num
以异步方法获取第二层相册,文件信息。使用callback形式返回结果。
**系统能力**:SystemCapability.FileManagement.FileManagerService
**系统能力**:SystemCapability.FileManagement.UserFileService
- 参数
......@@ -187,7 +187,7 @@ createFile(path : string, filename : string, options? : {dev? : DevInfo}) : P
以异步方法创建文件到指定路径,返回文件uri。使用promise形式返回结果。
**系统能力**:SystemCapability.FileManagement.FileManagerService
**系统能力**:SystemCapability.FileManagement.UserFileService
- 参数
| 参数名 | 类型 | 必填 | 说明 |
......@@ -230,7 +230,7 @@ createFile(path : string, filename: string, options? : {dev? : DevInfo}, callbac
以异步方法创建文件到指定路径,返回文件uri。使用callback形式返回结果。
**系统能力**:SystemCapability.FileManagement.FileManagerService
**系统能力**:SystemCapability.FileManagement.UserFileService
- 参数
......@@ -269,7 +269,7 @@ createFile(path : string, filename: string, options? : {dev? : DevInfo}, callbac
## FileInfo
文件信息类型,通过getRoot, listFile等接口返回的类型。
**系统能力**:以下各项对应的系统能力均为SystemCapability.FileManagement.FileManagerService。
**系统能力**:以下各项对应的系统能力均为SystemCapability.FileManagement.UserFileService。
### 属性
......@@ -286,7 +286,7 @@ createFile(path : string, filename: string, options? : {dev? : DevInfo}, callbac
设备类型,配置接口访问的设备类型。
**系统能力**:以下各项对应的系统能力均为SystemCapability.FileManagement.FileManagerService。
**系统能力**:以下各项对应的系统能力均为SystemCapability.FileManagement.UserFileService。
### 属性
......
......@@ -23,18 +23,18 @@ let path = context.getFilesDir();
## securityLabel.setSecurityLabel
setSecurityLabel(path:string, dataLevel:string):Promise<void>
setSecurityLabel(path:string, type:dataLevel):Promise<void>
以异步方法设置数据标签,以promise形式返回结果。
**系统能力**:SystemCapability.FileManagement.File.DistributedFile
**系统能力**:SystemCapability.FileManagement.File.FileIO
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| --------- | ------ | ---- | -------------------------------------------- |
| path | string | 是 | 文件路径 |
| dataLevel | string | 是 | 文件等级属性,只支持"s0","s1","s2","s3","s4" |
| 参数名 | 类型 | 必填 | 说明 |
| --------- | ------ | ---- | -------------------------------------------- |
| path | string | 是 | 文件路径 |
| type | dataLevel | 是 | 文件等级属性,只支持"s0","s1","s2","s3","s4" |
**返回值:**
......@@ -45,8 +45,8 @@ setSecurityLabel(path:string, dataLevel:string):Promise<void>
**示例:**
```js
let dataLevel = "s4";
securityLabel.setSecurityLabel(path, dataLevel).then(function(){
let type = "s4";
securityLabel.setSecurityLabel(path, type).then(function(){
console.info("setSecurityLabel successfully");
}).catch(function(error){
console.info("setSecurityLabel failed with error:" + error);
......@@ -55,25 +55,25 @@ setSecurityLabel(path:string, dataLevel:string):Promise<void>
## securityLabel.setSecurityLabel
setSecurityLabel(path:string, dataLevel:string, callback: AsyncCallback<void>):void
setSecurityLabel(path:string, type:dataLevel, callback: AsyncCallback<void>):void
以异步方法设置数据标签,以callback形式返回结果。
**系统能力**:SystemCapability.FileManagement.File.DistributedFile
**系统能力**:SystemCapability.FileManagement.File.FileIO
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| --------- | ------------------------- | ---- | -------------------------------------------- |
| path | string | 是 | 文件路径 |
| dataLevel | string | 是 | 文件等级属性,只支持"s0","s1","s2","s3","s4" |
| type | dataLevel | 是 | 文件等级属性,只支持"s0","s1","s2","s3","s4" |
| callback | AsyncCallback<void> | 是 | 是否设置数据标签之后的回调 |
**示例:**
```js
let dataLevel = "s4";
securityLabel.setSecurityLabel(path, dataLevel, function(error){
let type = "s4";
securityLabel.setSecurityLabel(path, type, function(error){
console.info("setSecurityLabel:" + JSON.stringify(error));
});
```
......@@ -83,20 +83,20 @@ setSecurityLabelSync(path:string, dataLevel:string):void
以同步方法设置数据标签。
**系统能力**:SystemCapability.FileManagement.File.DistributedFile
**系统能力**:SystemCapability.FileManagement.File.FileIO
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| --------- | ------ | ---- | -------------------------------------------- |
| path | string | 是 | 文件路径 |
| dataLevel | string | 是 | 文件等级属性,只支持"s0","s1","s2","s3","s4" |
| type | dataLevel | 是 | 文件等级属性,只支持"s0","s1","s2","s3","s4" |
**示例:**
```js
let dataLevel = "s4";
securityLabel.setSecurityLabelSync(path, dataLevel);
let type = "s4";
securityLabel.setSecurityLabelSync(path, type);
```
## securityLabel.getSecurityLabel
......@@ -105,7 +105,7 @@ getSecurityLabel(path:string):Promise<string>
异步方法获取数据标签,以promise形式返回结果。
**系统能力**:SystemCapability.FileManagement.File.DistributedFile
**系统能力**:SystemCapability.FileManagement.File.FileIO
**参数:**
......@@ -122,9 +122,9 @@ getSecurityLabel(path:string):Promise<string>
**示例:**
```js
let dataLevel = "s4";
securityLabel.getSecurityLabel(path).then(function(dataLevel){
console.log("getSecurityLabel successfully:" + dataLevel);
let type = "s4";
securityLabel.getSecurityLabel(path).then(function(type){
console.log("getSecurityLabel successfully:" + type);
}).catch(function(error){
console.log("getSecurityLabel failed with error:" + error);
});
......@@ -136,7 +136,7 @@ getSecurityLabel(path:string, callback:AsyncCallback<string>): void
异步方法获取数据标签,以callback形式返回结果。
**系统能力**:SystemCapability.FileManagement.File.DistributedFile
**系统能力**:SystemCapability.FileManagement.File.FileIO
**参数:**
......@@ -148,9 +148,9 @@ getSecurityLabel(path:string, callback:AsyncCallback<string>): void
**示例:**
```js
let dataLevel = "s4";
securityLabel.getSecurityLabel(path,function(error, dataLevel){
console.log("getSecurityLabel successfully:" + dataLevel);
let type = "s4";
securityLabel.getSecurityLabel(path,function(error, type){
console.log("getSecurityLabel successfully:" + type);
});
```
## securityLabel.getSecurityLabelSync
......@@ -159,7 +159,7 @@ getSecurityLabelSync(path:string):string
以同步方法获取数据标签。
**系统能力**:SystemCapability.FileManagement.File.DistributedFile
**系统能力**:SystemCapability.FileManagement.File.FileIO
**参数:**
......
......@@ -23,7 +23,7 @@ getTotalSizeOfVolume(volumeUuid: string): Promise<number>
**系统能力**:SystemCapability.FileManagement.StorageService.SpatialStatistics
**系统API**该接口为系统接口,三方应用不支持调用
该接口为系统接口,三方应用不支持调用
- 参数
......@@ -58,7 +58,7 @@ getTotalSizeOfVolume(volumeUuid: string, callback:AsyncCallback<number>):v
**系统能力**:SystemCapability.FileManagement.StorageService.SpatialStatistics
**系统API**该接口为系统接口,三方应用不支持调用
该接口为系统接口,三方应用不支持调用
- 参数
......@@ -89,7 +89,7 @@ getFreeSizeOfVolume(volumeUuid: string): Promise<number>
**系统能力**:SystemCapability.FileManagement.StorageService.SpatialStatistics
**系统API**该接口为系统接口,三方应用不支持调用
该接口为系统接口,三方应用不支持调用
- 参数
......@@ -125,7 +125,7 @@ getFreeSizeOfVolume(volumeUuid: string, callback:AsyncCallback<number>):vo
**系统能力**:SystemCapability.FileManagement.StorageService.SpatialStatistics
**系统API**该接口为系统接口,三方应用不支持调用
该接口为系统接口,三方应用不支持调用
- 参数
......@@ -154,7 +154,7 @@ getBundleStats(packageName: string): Promise<BundleStats>
**系统能力**:SystemCapability.FileManagement.StorageService.SpatialStatistics
**系统API**该接口为系统接口,三方应用不支持调用
该接口为系统接口,三方应用不支持调用
- 参数
......@@ -189,7 +189,7 @@ getBundleStats(packageName: string, callback: AsyncCallback<BundleStats>)
**系统能力**:SystemCapability.FileManagement.StorageService.SpatialStatistics
**系统API**该接口为系统接口,三方应用不支持调用
该接口为系统接口,三方应用不支持调用
- 参数
......@@ -259,6 +259,7 @@ getCurrentBundleStats(callback: AsyncCallback<BundleStats>): void
## BundleStats<sup>9+</sup>
**系统能力**:以下各项对应的系统能力均为SystemCapability.FileManagement.StorageService.SpatialStatistics。
该接口为系统接口,三方应用不支持调用
- 属性
......@@ -281,7 +282,7 @@ getTotalSize(): Promise<number>
**系统能力**:SystemCapability.FileManagement.StorageService.SpatialStatistics
**系统API**该接口为系统接口,三方应用不支持调用
该接口为系统接口,三方应用不支持调用
- 返回值
......@@ -306,7 +307,7 @@ getTotalSize(callback: AsyncCallback<number>): void
**系统能力**:SystemCapability.FileManagement.StorageService.SpatialStatistics
**系统API**该接口为系统接口,三方应用不支持调用
该接口为系统接口,三方应用不支持调用
- 参数
......@@ -334,7 +335,7 @@ getFreeSize(): Promise<number>
**系统能力**:SystemCapability.FileManagement.StorageService.SpatialStatistics
**系统API**该接口为系统接口,三方应用不支持调用
该接口为系统接口,三方应用不支持调用
- 返回值
......@@ -360,7 +361,7 @@ getFreeSize(callback: AsyncCallback<number>): void
**系统能力**:SystemCapability.FileManagement.StorageService.SpatialStatistics
**系统API**该接口为系统接口,三方应用不支持调用
该接口为系统接口,三方应用不支持调用
- 参数
......@@ -389,7 +390,7 @@ getSystemSize(): Promise&lt;number&gt;
**系统能力**:SystemCapability.FileManagement.StorageService.SpatialStatistics
**系统API**该接口为系统接口,三方应用不支持调用
该接口为系统接口,三方应用不支持调用
- 返回值
......@@ -417,7 +418,7 @@ getSystemSize(callback:AsyncCallback&lt;number&gt;):void
**系统能力**:SystemCapability.FileManagement.StorageService.SpatialStatistics
**系统API**该接口为系统接口,三方应用不支持调用
该接口为系统接口,三方应用不支持调用
- 参数
......@@ -438,7 +439,7 @@ getSystemSize(callback:AsyncCallback&lt;number&gt;):void
## storagestatistics.getUserStorageStats<sup>9+</sup>
getUserStorageStats(userId?: string): Promise&lt;StorageStats&gt;
getUserStorageStats(userId?: number): Promise&lt;StorageStats&gt;
异步获取用户各类别数据大小,以promise方式返回。
......@@ -446,7 +447,7 @@ getUserStorageStats(userId?: string): Promise&lt;StorageStats&gt;
**系统能力**:SystemCapability.FileManagement.StorageService.SpatialStatistics
**系统API**该接口为系统接口,三方应用不支持调用
该接口为系统接口,三方应用不支持调用
- 参数
......@@ -473,7 +474,7 @@ getUserStorageStats(userId?: string): Promise&lt;StorageStats&gt;
## storagestatistics.getUserStorageStats<sup>9+</sup>
getUserStorageStats(userId?: string, callback:AsyncCallback&lt;StorageStats&gt;):void
getUserStorageStats(userId?: number, callback:AsyncCallback&lt;StorageStats&gt;):void
异步获取用户各类别数据大小,以callback方式返回。
......@@ -481,7 +482,7 @@ getUserStorageStats(userId?: string, callback:AsyncCallback&lt;StorageStats&gt;)
**系统能力**:SystemCapability.FileManagement.StorageService.SpatialStatistics
**系统API**该接口为系统接口,三方应用不支持调用
该接口为系统接口,三方应用不支持调用
- 参数
......@@ -505,7 +506,7 @@ getUserStorageStats(userId?: string, callback:AsyncCallback&lt;StorageStats&gt;)
## StorageStats<sup>9+</sup>
**系统能力**:以下各项对应的系统能力均为SystemCapability.FileManagement.StorageService.SpatialStatistics。
该接口为系统接口,三方应用不支持调用
- 属性
| 名称 | 类型 | 说明 |
......
Markdown is supported
0% .
You are about to add 0 people to the discussion. Proceed with caution.
先完成此消息的编辑!
想要评论请 注册