Skip to content

D
Docs

OpenHarmony / Docs
大约 2 年 前同步成功

通知 161
Star 293
Fork 28
D
Docs
“0a418e8b5001758713f359c007003ebb2cfd6056”上不存在“...device-dev/kernel/kernel-small-debug-shell-cmd-stack.md”
提交 f279d150 编写于 作者: Z zhangxingxia
浏览文件
操作

update apis 

Signed-off-by: Nzhangxingxia <zhangxingxia1@huawei.com>
上级 06ebabe9
隐藏空白更改
内联 并排
Showing with 285 addition and 246 deletion
zh-cn/application-dev/reference/apis/js-apis-document.md
浏览文件 @ f279d150
......@@ -12,28 +12,28 @@ import document from '@ohos.document';
## document.choose
choose(types:string[]): Promise&lt;string&gt;
choose(types? : string[]): Promise&lt;string&gt;
通过文件管理器选择文件，异步返回文件URI，使用promise形式返回结果。
**系统能力**：SystemCapability.FileManagement.UserFileService
- 参数：
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| ------ | ------ | ---- | ---------------------------- |
| types | string[] | 否 | 限定文件选择的类型 |
- 返回值：
**返回值：**
| 类型 | 说明 |
| --------------------- | -------------- |
| Promise&lt;string&gt; | 异步返回文件URI（注：当前返回错误码） |
- 示例：
**示例：**
```js
let tpyes = [];
let types = [];
document.choose(types);
```
## document.choose
......@@ -44,13 +44,13 @@ choose(callback:AsyncCallback&lt;string&gt;): void
**系统能力**：SystemCapability.FileManagement.UserFileService
- 参数：
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | --------------------------- | ---- | ---------------------------- |
| callback | AsyncCallback&lt;string&gt; | 是 | 异步获取对应文件URI（注：当前返回错误码） |
- 示例：
**示例：**
```js
let uri = "";
......@@ -66,14 +66,14 @@ choose(types:string[], callback:AsyncCallback&lt;string&gt;): void
**系统能力**：SystemCapability.FileManagement.UserFileService
- 参数：
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | --------------------------- | ---- | ---------------------------- |
| types | string[] | 否 | 限定选择文件的类型 |
| callback | AsyncCallback&lt;string&gt; | 是 | 异步获取对应文件URI（注：当前返回错误码） |
- 示例：
**示例：**
```js
let types = [];
......@@ -91,20 +91,20 @@ show(uri:string, type:string):Promise&lt;void&gt;
**系统能力**：SystemCapability.FileManagement.UserFileService
- 参数：
**参数：**
| 参数 | 类型 | 必填 | 说明 |
| ---- | ------ | ---- | ---------------------------- |
| uri | string | 是 | 待打开的文件URI |
| type | string | 是 | 待打开文件的类型 |
- 返回值：
**返回值：**
| 类型 | 说明 |
| --------------------- | ------------ |
| Promise&lt;void&gt; | Promise回调返回void表示成功打开文件（注：当前返回错误码） |
- 示例：
**示例：**
```js
let type = "";
......@@ -120,7 +120,7 @@ show(uri:string, type:string, callback:AsyncCallback&lt;void&gt;): void
**系统能力**：SystemCapability.FileManagement.UserFileService
- 参数：
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | --------------------------- | ---- | ---------------------------- |
......@@ -128,7 +128,7 @@ show(uri:string, type:string, callback:AsyncCallback&lt;void&gt;): void
| type | string | 是 | 待打开文件的类型 |
| callback | AsyncCallback&lt;void&gt; | 是 | 异步打开uri对应文件（注：当前返回错误码） |
- 示例：
**示例：**
```js
let type = "";
......
zh-cn/application-dev/reference/apis/js-apis-fileio.md
浏览文件 @ f279d150
# 文件管理
文件管理
> ![icon-note.gif](public_sys-resources/icon-note.gif) **说明：**
> 本模块首批接口从API version 6开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。
......@@ -22,7 +22,7 @@ import fileio from '@ohos.fileio';
context.getFilesDir().then((data) => {
path = data;
})
```
```
## fileio.stat
......@@ -546,7 +546,7 @@ open(path: string, flags?: number, mode?: number): Promise&lt;number&gt;
```js
fileio.open(path, 0o1, 0o0200).then(function(number){
console.info("open file succeed");
}).catch(function(error){
}).catch(function(err){
console.info("open file failed with error:"+ err);
});
```
......@@ -639,11 +639,11 @@ read(fd: number, buffer: ArrayBuffer, options?: {
```js
let fd = fileio.openSync(path, 0o2);
let buf = new ArrayBuffer(4096);
fileio.read(fd, buf).then(function(readout){
fileio.read(fd, buf).then(function(readOut){
console.info("read file data succeed");
console.log(String.fromCharCode.apply(null, new Uint8Array(readOut.buffer)));
}).catch(function(error){
console.info("read file data failed with error:"+ error);
}).catch(function(err){
console.info("read file data failed with error:"+ err);
});
```
......@@ -879,7 +879,7 @@ write(fd: number, buffer: ArrayBuffer | string, options?: {
**示例：**
```js
let fd = fileio.openSync(fpath, 0o100 | 0o2, 0o666);
let fd = fileio.openSync(path, 0o100 | 0o2, 0o666);
fileio.write(fd, "hello, world").then(function(number){
console.info("write data to file succeed and size is:"+ number);
}).catch(function(err){
......@@ -998,7 +998,7 @@ hash(path: string, algorithm: string, callback: AsyncCallback&lt;string&gt;): vo
**示例：**
```js
fileio.hash(fpath, "sha256", function(err, hashStr) {
fileio.hash(path, "sha256", function(err, hashStr) {
if (hashStr) {
console.info("calculate file hash succeed:"+ hashStr);
}
......@@ -1074,7 +1074,7 @@ chmodSync(path: string, mode: number): void
**示例：**
```js
fileio.chmodSync(fpath, mode);
fileio.chmodSync(path, mode);
```
......@@ -1409,7 +1409,7 @@ lstat(path: string): Promise&lt;Stat&gt;
**示例：**
```js
fileio.lstat(path).then(function(stat){
console.info("get link status succeed:"+ number);
console.info("get link status succeed:"+ JSON.stringify(stat));
}).catch(function(err){
console.info("get link status failed with error:"+ err);
});
......@@ -1663,7 +1663,7 @@ fsyncSync(fd: number): void
**示例：**
```js
fileio.fyncsSync(fd);
fileio.fsyncSync(fd);
```
......@@ -1857,7 +1857,7 @@ chown(path: string, uid: number, gid: number, callback: AsyncCallback&lt;void&gt
**示例：**
```js
let stat = fileio.statSync(fpath)
let stat = fileio.statSync(path)
fileio.chown(path, stat.uid, stat.gid, function (err){
// do something
});
......@@ -1881,7 +1881,7 @@ chownSync(path: string, uid: number, gid: number): void
**示例：**
```js
let stat = fileio.statSync(fpath)
let stat = fileio.statSync(path)
fileio.chownSync(path, stat.uid, stat.gid);
```
......@@ -2078,7 +2078,7 @@ createStream(path: string, mode: string, callback: AsyncCallback&lt;Stream&gt;):
**示例：**
```js
fileio.createStream(path, mode, function(err, stream){
fileio.createStream(path, "r+", function(err, stream){
// do something
});
```
......@@ -2130,7 +2130,8 @@ fdopenStream(fd: number, mode: string): Promise&lt;Stream&gt;
**示例：**
```js
fileio.fdopenStream(fd, mode).then(function(stream){
let fd = fileio.openSync(path);
fileio.fdopenStream(fd, "r+").then(function(stream){
console.info("openStream succeed");
}).catch(function(err){
console.info("openStream failed with error:"+ err);
......@@ -2155,7 +2156,8 @@ fdopenStream(fd: number, mode: string, callback: AsyncCallback&lt;Stream&gt;): v
**示例：**
```js
fileio.fdopenStream(fd, mode, function (err, stream) {
let fd = fileio.openSync(path);
fileio.fdopenStream(fd, "r+", function (err, stream) {
// do something
});
```
......@@ -2182,6 +2184,7 @@ fdopenStreamSync(fd: number, mode: string): Stream
**示例：**
```js
let fd = fileio.openSync(path);
let ss = fileio.fdopenStreamSync(fd, "r+");
```
......@@ -2235,7 +2238,7 @@ fchown(fd: number, uid: number, gid: number, callback: AsyncCallback&lt;void&gt;
**示例：**
```js
let stat = fileio.statSync(fpath);
let stat = fileio.statSync(path);
fileio.fchown(fd, stat.uid, stat.gid, function (err){
// do something
});
......@@ -2259,7 +2262,7 @@ fchownSync(fd: number, uid: number, gid: number): void
**示例：**
```js
let stat = fileio.statSync(fpath);
let stat = fileio.statSync(path);
fileio.fchownSync(fd, stat.uid, stat.gid);
```
......@@ -2364,9 +2367,11 @@ createWatcher(filename: string, events: number, callback: AsyncCallback&lt;numbe
**示例：**
```js
fileio.createWatcher(filename, events, function(watcher){
// do something
let filename = path +"/test.txt";
fileio.createWatcher(filename, 1, function(number){
console.info("Monitoring times: "+number);
});
```
......@@ -2498,7 +2503,7 @@ isFile(): boolean
**示例：**
```js
let isFile = fileio.statSync(fpath).isFile();
let isFile = fileio.statSync(path).isFile();
```
......@@ -2555,7 +2560,13 @@ stop(): Promise&lt;void&gt;
**示例：**
```js
fileio.stop();
let filename = path +"/test.txt";
let watcher = await fileio.createWatcher(filename, 1, function(number){
console.info("Monitoring times: "+number);
});
watcher.stop().then(function(){
console.info("close watcher succeed");
});
```
......@@ -2574,13 +2585,17 @@ stop(callback: AsyncCallback&lt;void&gt;): void
**示例：**
```js
fileio.stop(function(err){
// do something
let filename = path +"/test.txt";
let watcher = await fileio.createWatcher(filename, 1, function(number){
console.info("Monitoring times: "+number);
});
watcher.stop(function(){
console.info("close watcher succeed");
})
```
## Stream<sup>7+</sup>
## Stream
文件流，在调用Stream的方法前，需要先通过createStream()方法（同步或异步）来构建一个Stream实例。
......@@ -2600,7 +2615,7 @@ close(): Promise&lt;void&gt;
**示例：**
```js
let ss= fileio.createStreamSync(path);
let ss= fileio.createStreamSync(path, "r+");
ss.close().then(function(){
console.info("close fileStream succeed");
}).catch(function(err){
......@@ -2624,7 +2639,7 @@ close(callback: AsyncCallback&lt;void&gt;): void
**示例：**
```js
let ss= fileio.createStreamSync(path);
let ss= fileio.createStreamSync(path, "r+");
ss.close(function (err) {
// do something
});
......@@ -2641,7 +2656,7 @@ closeSync(): void
**示例：**
```js
let ss= fileio.createStreamSync(path);
let ss= fileio.createStreamSync(path, "r+");
ss.closeSync();
```
......@@ -2661,7 +2676,7 @@ flush(): Promise&lt;void&gt;
**示例：**
```js
let ss= fileio.createStreamSync(path);
let ss= fileio.createStreamSync(path, "r+");
ss.flush().then(function (){
console.info("flush succeed");
}).catch(function(err){
......@@ -2685,7 +2700,7 @@ flush(callback: AsyncCallback&lt;void&gt;): void
**示例：**
```js
let ss= fileio.createStreamSync(path);
let ss= fileio.createStreamSync(path, "r+");
ss.flush(function (err) {
// do something
});
......@@ -2702,7 +2717,7 @@ flushSync(): void
**示例：**
```js
let ss= fileio.createStreamSync(path);
let ss= fileio.createStreamSync(path, "r+");
ss.flushSync();
```
......@@ -2733,7 +2748,7 @@ write(buffer: ArrayBuffer | string, options?: {
**示例：**
```js
let ss= fileio.createStreamSync(fpath, "r+");
let ss= fileio.createStreamSync(path, "r+");
ss.write("hello, world",{offset: 1,length: 5,position: 5,encoding :'utf-8'}).then(function (number){
console.info("write succeed and size is:"+ number);
}).catch(function(err){
......@@ -2764,7 +2779,7 @@ write(buffer: ArrayBuffer | string, options: {
**示例：**
```js
let ss= fileio.createStreamSync(fpath, "r+");
let ss= fileio.createStreamSync(path, "r+");
ss.write("hello, world", {offset: 1, length: 5, position: 5, encoding :'utf-8'}, function (err, bytesWritten) {
if (bytesWritten) {
// do something
......@@ -2800,7 +2815,7 @@ writeSync(buffer: ArrayBuffer | string, options?: {
**示例：**
```js
let ss= fileio.createStreamSync(fpath,"r+");
let ss= fileio.createStreamSync(path,"r+");
let num = ss.writeSync("hello, world", {offset: 1, length: 5, position: 5, encoding :'utf-8'});
```
......@@ -2830,7 +2845,7 @@ read(buffer: ArrayBuffer, options?: {
**示例：**
```js
let ss = fileio.createStreamSync(fpath, "r+");
let ss = fileio.createStreamSync(path, "r+");
ss.read(new ArrayBuffer(4096), {offset: 1, length: 5, position: 5}).then(function (readout){
console.info("read data succeed");
console.log(String.fromCharCode.apply(null, new Uint8Array(readOut.buffer)));
......@@ -2861,7 +2876,7 @@ read(buffer: ArrayBuffer, options: {
**示例：**
```js
let ss = fileio.createStreamSync(fpath, "r+");
let ss = fileio.createStreamSync(path, "r+");
ss.read(new ArrayBuffer(4096),{offset: 1, length: 5, position: 5},function (err, readOut) {
if (readOut) {
console.info("read data succeed");
......@@ -2898,7 +2913,7 @@ readSync(buffer: ArrayBuffer, options?: {
**示例：**
```js
let ss = fileio.createStreamSync(fpath, "r+");
let ss = fileio.createStreamSync(path, "r+");
let num = ss.readSync(new ArrayBuffer(4096), {offset: 1, length: 5, position: 5});
```
......
zh-cn/application-dev/reference/apis/js-apis-filemanager.md
浏览文件 @ f279d150
......@@ -20,18 +20,18 @@ getRoot(options? : {dev? : DevInfo}) : Promise&lt;FileInfo[]&gt;
**系统能力**：SystemCapability.FileManagement.UserFileService
- 参数
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| --- | --- | --- | -- |
| options | Object | 否 | 支持如下选项：<br/>-&nbsp;dev，[DevInfo](#devinfo)类型，不填默认dev = {name: "local"}, 当前仅支持设备'local' |
- 返回值
**返回值：**
| 类型 | 说明 |
| --- | -- |
| Promise&lt;[FileInfo](#fileinfo)[]&gt; | 第一层目录相册信息 |
- 示例
**示例：**
```js
filemanager.getRoot().then((fileInfo) => {
......@@ -53,22 +53,22 @@ getRoot(options? : {dev? : DevInfo}, callback : AsyncCallback&lt;FileInfo[]&gt;)
**系统能力**：SystemCapability.FileManagement.UserFileService
- 参数
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ------------------------- | ---- | ----------------------------- |
| options | Object | 否 | 支持如下选项：<br/>-&nbsp;dev，[DevInfo](#devinfo)类型，不填默认dev = {name: "local"}, 当前仅支持设备'local' |
| callback | AsyncCallback&lt;[FileInfo](#fileinfo)[]&gt; | 是 | 异步获取文件的信息之后的回调 |
- 示例
**示例：**
```js
let option = {
"dev":{
name:"",
}
let options = {
"dev":{
"name":"local"
}
};
filemanager.getRoot(option,(err, fileInfo)=>{
filemanager.getRoot(options, (err, fileInfo)=>{
if(Array.isArray(fileInfo)) {
for (var i = 0; i < fileInfo.length; i++) {
console.log("file:"+JSON.stringify(fileInfo));
......@@ -86,27 +86,28 @@ listFile(path : string, type : string, options? : {dev? : DevInfo, offset? : num
**系统能力**：SystemCapability.FileManagement.UserFileService
- 参数
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| --- | --- | --- | -- |
| path | string | 是 | 待查询目录uri |
| type | string | 是 | 待查询文件类型, 支持以下类型 "file", "image", "audio", "video" |
| options | Object | 否 | 支持如下选项：<br/>-&nbsp;dev，[DevInfo](#devinfo)类型，不填默认dev = {name: "local"}, 当前仅支持设备'local'。<br/>-&nbsp;offset，number类型，待查询文件偏移个数。<br/>-&nbsp;count，number类型，待查询文件个数。 |
- 返回值
**返回值：**
| 类型 | 说明 |
| --- | -- |
| Promise&lt;FileInfo[]&gt; | 文件信息 |
- 异常
**异常：**
| 错误名称 | 错误类型 | 错误码 |说明 |
| --- | -- | --- | -- |
| 对应的目录、相册不存在 | No such file or directory | 2 | uri对应的目录、相册不存在 |
| 获取FMS服务失败 | No such process | 3 | 获取FMS服务失败 |
| path对应uri不是相册、目录 | Not a directory | 20 | path对应uri不是相册、目录 |
- 示例
**示例：**
```js
// 获取目录下所有文件
......@@ -120,10 +121,7 @@ listFile(path : string, type : string, options? : {dev? : DevInfo, offset? : num
}
}
}).catch((err) => {
console.log(err)
console.log("failed to get file"+err);
});
```
......@@ -135,23 +133,24 @@ listFile(path : string, type : string, options? : {dev? : DevInfo, offset? : num
**系统能力**：SystemCapability.FileManagement.UserFileService
- 参数
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ------------------------- | ---- | ------------------------------------------------------------ |
| path | string | 是 | 待查询目录uri |
| type | string | 是 | 待查询文件类型, 支持以下类型 "file", "image", "audio", "video" |
| options | Object | 否 | 支持如下选项：<br/>-&nbsp;dev，[DevInfo](#devinfo)类型，不填默认dev = {name: "local"}, 当前仅支持设备'local'。<br/>-&nbsp;offset，number类型，待查询文件偏移个数。<br/>-&nbsp;count，number类型，待查询文件个数。 |
| callback | AsyncCallback&lt;[FileInfo](#fileinfo)[]&gt; | 是 | 异步获取文件的信息之后的回调 |
- 异常
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ------------------------- | ---- | ------------------------------------------------------------ |
| path | string | 是 | 待查询目录uri |
| type | string | 是 | 待查询文件类型, 支持以下类型 "file", "image", "audio", "video" |
| options | Object | 否 | 支持如下选项：<br/>-&nbsp;dev，[DevInfo](#devinfo)类型，不填默认dev = {name: "local"}, 当前仅支持设备'local'。<br/>-&nbsp;offset，number类型，待查询文件偏移个数。<br/>-&nbsp;count，number类型，待查询文件个数。 |
| callback | AsyncCallback&lt;[FileInfo](#fileinfo)[]&gt; | 是 | 异步获取文件的信息之后的回调 |
| 错误名称 | 错误类型 | 错误码 | 说明 |
| ------------------------- | ------------------------- | ------ | ------------------------- |
| 对应的目录、相册不存在 | No such file or directory | 2 | uri对应的目录、相册不存在 |
| 获取FMS服务失败 | No such process | 3 | 获取FMS服务失败 |
| path对应uri不是相册、目录 | Not a directory | 20 | path对应uri不是相册、目录 |
**异常：**
| 错误名称 | 错误类型 | 错误码 | 说明 |
| ------------------------- | ------------------------- | ------ | ------------------------- |
| 对应的目录、相册不存在 | No such file or directory | 2 | uri对应的目录、相册不存在 |
| 获取FMS服务失败 | No such process | 3 | 获取FMS服务失败 |
| path对应uri不是相册、目录 | Not a directory | 20 | path对应uri不是相册、目录 |
- 示例
**示例：**
```js
// 通过listFile、getRoot获取的文件path
......@@ -177,7 +176,7 @@ listFile(path : string, type : string, options? : {dev? : DevInfo, offset? : num
}
}
}).catch((err) => {
console.log(err)
console.log("failed to get file"+err);
});
```
......@@ -189,20 +188,21 @@ createFile(path : string, filename : string, options? : {dev? : DevInfo}) : P
**系统能力**：SystemCapability.FileManagement.UserFileService
- 参数
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| --- | --- | --- | -- |
| filename | string | 是 | 待创建的文件名 |
| path | string | 是 | 待保存目的相册uri |
| options | Object | 否 | 支持如下选项：<br/>-&nbsp;dev，[DevInfo](#devinfo)类型，不填默认dev = {name: "local"}, 当前仅支持设备'local' |
- 返回值
**返回值：**
| 类型 | 说明 |
| --- | -- |
| string | 文件uri |
| 类型 | 说明 |
| --- | -- |
| Promise&lt;string&gt; | 文件uri |
**异常：**
- 异常
| 错误名称 | 错误类型 | 错误码 |说明 |
| --- | -- | --- | -- |
| 创建文件不允许 | Operation not permitted | 1 | 已有重名文件 |
......@@ -210,7 +210,7 @@ createFile(path : string, filename : string, options? : {dev? : DevInfo}) : P
| 获取FMS服务失败 | No such process | 3 | 获取FMS服务失败 |
| path对应uri不是相册、目录 | Not a directory | 20 | path对应uri不是相册、目录 |
- 示例
**示例：**
```js
// 创建文件，返回文件uri
......@@ -232,7 +232,7 @@ createFile(path : string, filename: string, options? : {dev? : DevInfo}, callbac
**系统能力**：SystemCapability.FileManagement.UserFileService
- 参数
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ------------------------- | ---- | ----------------------------- |
......@@ -241,7 +241,7 @@ createFile(path : string, filename: string, options? : {dev? : DevInfo}, callbac
| options | Object | 否 | 支持如下选项：<br/>-&nbsp;dev，[DevInfo](#devinfo)类型，不填默认dev = {name: "local"}, 当前仅支持设备'local' |
| callback | AsyncCallback&lt;[FileInfo](#fileinfo)[]&gt; | 是 | 异步获取文件的信息之后的回调 |
- 异常
**异常：**
| 错误名称 | 错误类型 | 错误码 | 说明 |
| ------------------------- | ------------------------- | ------ | ------------------------- |
......@@ -250,7 +250,7 @@ createFile(path : string, filename: string, options? : {dev? : DevInfo}, callbac
| 获取FMS服务失败 | No such process | 3 | 获取FMS服务失败 |
| path对应uri不是相册、目录 | Not a directory | 20 | path对应uri不是相册、目录 |
- 示例
**示例：**
```js
// 创建文件，返回文件uri
......@@ -258,11 +258,15 @@ createFile(path : string, filename: string, options? : {dev? : DevInfo}, callbac
let media_path = ""
// 待保存文件的后缀
let name = "xxx.jpg"
let dev = "";
filemanager.createFile(media_path, name, { DevInfo: dev }, function(err, uri) {
// 返回uri给应用
let options = {
"dev":{
"name":"local"
}
};
filemanager.createFile(media_path, name, options, function(err, uri) {
// 返回uri给应用
console.log("file uri:"+uri);
});
});
```
......
zh-cn/application-dev/reference/apis/js-apis-storage-statistics.md
浏览文件 @ f279d150
......@@ -13,7 +13,7 @@
import storageStatistics from "@ohos.storageStatistics";
```
## storagestatistics.getTotalSizeOfVolume
## storageStatistics.getTotalSizeOfVolume
getTotalSizeOfVolume(volumeUuid: string): Promise&lt;number&gt;
......@@ -23,32 +23,34 @@ getTotalSizeOfVolume(volumeUuid: string): Promise&lt;number&gt;
**系统能力**：SystemCapability.FileManagement.StorageService.SpatialStatistics
该接口为系统接口，三方应用不支持调用
- 参数
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| ---------- | ------ | ---- | ---- |
| volumeUuid | string | 是 | 卷id |
- 返回值
**返回值：**
| 类型 | 说明 |
| --------------------- | ---------------- |
| Promise&lt;number&gt; | 返回指定卷总空间 |
- 示例
**示例：**
```js
let uuid = "";
storagestatistics.getTotalSizeOfVolume(uuid).then(function(number){
storageStatistics.getTotalSizeOfVolume(uuid).then(function(number){
console.info("getTotalSizeOfVolume successfully:"+ number);
}).catch(function(err){
console.info("getTotalSizeOfVolume failed with error:"+ err);
});
```
## storagestatistics.getTotalSizeOfVolume
## storageStatistics.getTotalSizeOfVolume
getTotalSizeOfVolume(volumeUuid: string, callback:AsyncCallback&lt;number&gt;):void
......@@ -58,28 +60,28 @@ getTotalSizeOfVolume(volumeUuid: string, callback:AsyncCallback&lt;number&gt;):v
**系统能力**：SystemCapability.FileManagement.StorageService.SpatialStatistics
该接口为系统接口，三方应用不支持调用
- 参数
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| ---------- | ------------------------------------ | ---- | -------------------------- |
| volumeUuid | string | 是 | 卷id |
| callback | callback:AsyncCallback&lt;number&gt; | 是 | 获取指定卷总空间之后的回调 |
- 示例
**示例：**
```js
let uuid = "";
storagestatistics.getTotalSizeOfVolume(uuid, function(error, number){
storageStatistics.getTotalSizeOfVolume(uuid, function(error, number){
// do something
console.info("getTotalSizeOfVolume successfully:"+ number);
});
```
## storagestatistics.getFreeSizeOfVolume
## storageStatistics.getFreeSizeOfVolume
getFreeSizeOfVolume(volumeUuid: string): Promise&lt;number&gt;
......@@ -89,25 +91,27 @@ getFreeSizeOfVolume(volumeUuid: string): Promise&lt;number&gt;
**系统能力**：SystemCapability.FileManagement.StorageService.SpatialStatistics
该接口为系统接口，三方应用不支持调用
- 参数
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| ---------- | ------ | ---- | ---- |
| volumeUuid | string | 是 | 卷id |
- 返回值
**返回值：**
| 类型 | 说明 |
| --------------------- | ------------------ |
| Promise&lt;number&gt; | 返回指定卷可用空间 |
- 示例
**示例：**
```js
let uuid = "";
storagestatistics.getFreeSizeOfVolume(uuid).then(function(number){
storageStatistics.getFreeSizeOfVolume(uuid).then(function(number){
console.info("getFreeSizeOfVolume successfully:"+ number);
}).catch(function(err){
console.info("getFreeSizeOfVolume failed with error:"+ err);
......@@ -115,7 +119,7 @@ getFreeSizeOfVolume(volumeUuid: string): Promise&lt;number&gt;
```
## storagestatistics.getFreeSizeOfVolume
## storageStatistics.getFreeSizeOfVolume
getFreeSizeOfVolume(volumeUuid: string, callback:AsyncCallback&lt;number&gt;):void
......@@ -125,26 +129,28 @@ getFreeSizeOfVolume(volumeUuid: string, callback:AsyncCallback&lt;number&gt;):vo
**系统能力**：SystemCapability.FileManagement.StorageService.SpatialStatistics
该接口为系统接口，三方应用不支持调用
- 参数
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| ---------- | ------------------------------------ | ---- | ---------------------------- |
| volumeUuid | string | 是 | 卷id |
| callback | callback:AsyncCallback&lt;number&gt; | 是 | 获取指定卷可用空间之后的回调 |
- 示例
**示例：**
```js
let uuid = "";
storagestatistics.getFreeSizeOfVolume(uuid, function(error, number){
storageStatistics.getFreeSizeOfVolume(uuid, function(error, number){
// do something
console.info("getFreeSizeOfVolume successfully:"+ number);
});
```
## storagestatistics.getBundleStats<sup>9+</sup>
## storageStatistics.getBundleStats<sup>9+</sup>
getBundleStats(packageName: string): Promise&lt;BundleStats&gt;
......@@ -154,32 +160,34 @@ getBundleStats(packageName: string): Promise&lt;BundleStats&gt;
**系统能力**：SystemCapability.FileManagement.StorageService.SpatialStatistics
该接口为系统接口，三方应用不支持调用
- 参数
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| ----------- | ------ | ---- | -------- |
| packageName | string | 是 | 应用包名 |
- 返回值
**返回值：**
| 类型 | 说明 |
| ------------------------------------------ | -------------------------- |
| Promise&lt;[Bundlestats](#bundlestats)&gt; | 返回指定卷上的应用存储数据 |
- 示例
**示例：**
```js
let packageName = "";
storagestatistics.getBundleStats(packageName).then(function(BundleStats){
storageStatistics.getBundleStats(packageName).then(function(BundleStats){
console.info("getBundleStats successfully:"+ JSON.stringify(BundleStats));
}).catch(function(err){
console.info("getBundleStats failed with error:"+ err);
});
```
## storagestatistics.getBundleStats<sup>9+</sup>
## storageStatistics.getBundleStats<sup>9+</sup>
getBundleStats(packageName: string, callback: AsyncCallback&lt;BundleStats&gt;): void
......@@ -189,28 +197,28 @@ getBundleStats(packageName: string, callback: AsyncCallback&lt;BundleStats&gt;)
**系统能力**：SystemCapability.FileManagement.StorageService.SpatialStatistics
该接口为系统接口，三方应用不支持调用
- 参数
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | --------------------------------------------------------- | ---- | ------------------------------------ |
| packageName | string | 是 | 应用包名 |
| callback | callback:AsyncCallback&lt;[Bundlestats](#bundlestats)&gt; | 是 | 获取指定卷上的应用存储数据之后的回调 |
- 示例
**示例：**
```js
let packageName = "";
storagestatistics.getBundleStats(packageName, function(error, BundleStats){
storageStatistics.getBundleStats(packageName, function(error, BundleStats){
// do something
console.info("getBundleStats successfully:"+ JSON.stringify(BundleStats));
});
```
## storagestatistics.getCurrentBundleStats<sup>9+</sup>
## storageStatistics.getCurrentBundleStats<sup>9+</sup>
getCurrentBundleStats(): Promise&lt;BundleStats&gt;
......@@ -218,50 +226,51 @@ getCurrentBundleStats(): Promise&lt;BundleStats&gt;
**系统能力**：SystemCapability.FileManagement.StorageService.SpatialStatistics
- 返回值
**返回值：**
| 类型 | 说明 |
| ------------------------------------------ | -------------------------- |
| Promise&lt;[Bundlestats](#bundlestats)&gt; | 返回指定卷上的应用存储状态 |
- 示例
**示例：**
```js
let bundleStats = storageStatistics.getCurrentBundleStats();
console.info("getCurrentBundleStats successfully:"+ JSON.stringify(bundleStats));
let bundleStats = storageStatistics.getCurrentBundleStats();
console.info("getCurrentBundleStats successfully:"+ JSON.stringify(bundleStats));
```
## storagestatistics.getCurrentBundleStats<sup>9+</sup>
## storageStatistics.getCurrentBundleStats<sup>9+</sup>
getCurrentBundleStats(callback: AsyncCallback&lt;BundleStats&gt;): void
第三方应用异步获取占用空间，以callback方式返回。
**系统能力**：SystemCapability.FileManagement.StorageService.SpatialStatistics
- 参数
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | --------------------------------------------------------- | ---- | ------------------------------------ |
| callback | callback:AsyncCallback&lt;[BundleStats](#bundlestats)&gt; | 是 | 获取指定卷上的应用存储状态之后的回调 |
- 示例
**示例：**
```js
storagestatistics.getCurrentBundleStats(function(error, bundleStats){
storageStatistics.getCurrentBundleStats(function(error, bundleStats){
// do something
console.info("getCurrentBundleStats successfully:"+ JSON.stringify(bundleStats));
});
```
## BundleStats<sup>9+</sup>
**系统能力**：以下各项对应的系统能力均为SystemCapability.FileManagement.StorageService.SpatialStatistics。<br>
**系统能力**：以下各项对应的系统能力均为SystemCapability.FileManagement.StorageService.SpatialStatistics
该接口为系统接口，三方应用不支持调用
- 属性
### 属性
| 名称 | 类型 | 说明 |
| --------- | ------ | -------------- |
......@@ -270,9 +279,7 @@ getCurrentBundleStats(callback: AsyncCallback&lt;BundleStats&gt;): void
| dataSize | number | 应用总数据大小 |
## storagestatistics.getTotalSize<sup>9+</sup>
## storageStatistics.getTotalSize<sup>9+</sup>
getTotalSize(): Promise&lt;number&gt;
......@@ -282,22 +289,24 @@ getTotalSize(): Promise&lt;number&gt;
**系统能力**：SystemCapability.FileManagement.StorageService.SpatialStatistics
该接口为系统接口，三方应用不支持调用
- 返回值
**返回值：**
| 类型 | 说明 |
| --------------------- | ------------------ |
| Promise&lt;number&gt; | 返回内卡的总空间大小 |
- 示例
**示例：**
```js
let number = storageStatistics.getTotalSize();
console.info("getTotalSize successfully:"+ JSON.stringify(number));
let number = storageStatistics.getTotalSize();
console.info("getTotalSize successfully:"+ JSON.stringify(number));
```
## storagestatistics.getTotalSize<sup>9+</sup>
## storageStatistics.getTotalSize<sup>9+</sup>
getTotalSize(callback: AsyncCallback&lt;number&gt;): void
......@@ -307,25 +316,27 @@ getTotalSize(callback: AsyncCallback&lt;number&gt;): void
**系统能力**：SystemCapability.FileManagement.StorageService.SpatialStatistics
该接口为系统接口，三方应用不支持调用
- 参数
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ------------------------------------ | ---- | ------------------------ |
| callback | callback:AsyncCallback&lt;number&gt; | 是 | 获取内卡的总空间大小之后的回调 |
- 示例
**示例：**
```js
storagestatistics.getTotalSize(function(error, number){
storageStatistics.getTotalSize(function(error, number){
// do something
console.info("getTotalSize successfully:"+ JSON.stringify(number));
});
```
## storagestatistics.getFreeSize<sup>9+</sup>
## storageStatistics.getFreeSize<sup>9+</sup>
getFreeSize(): Promise&lt;number&gt;
......@@ -335,23 +346,25 @@ getFreeSize(): Promise&lt;number&gt;
**系统能力**：SystemCapability.FileManagement.StorageService.SpatialStatistics
该接口为系统接口，三方应用不支持调用
- 返回值
**返回值：**
| 类型 | 说明 |
| --------------------- | ------------------ |
| Promise&lt;number&gt; | 返回内卡的可用空间大小 |
- 示例
**示例：**
```js
let number = storageStatistics.getFreeSize();
console.info("getFreeSize successfully:"+ JSON.stringify(number));
let number = storageStatistics.getFreeSize();
console.info("getFreeSize successfully:"+ JSON.stringify(number));
```
## storagestatistics.getFreeSize<sup>9+</sup>
## storageStatistics.getFreeSize<sup>9+</sup>
getFreeSize(callback: AsyncCallback&lt;number&gt;): void
......@@ -361,26 +374,26 @@ getFreeSize(callback: AsyncCallback&lt;number&gt;): void
**系统能力**：SystemCapability.FileManagement.StorageService.SpatialStatistics
该接口为系统接口，三方应用不支持调用
- 参数
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ------------------------------------ | ---- | ------------------------- |
| callback | callback:AsyncCallback&lt;number&gt; | 是 | 获取内卡的可用空间大小之后的回调 |
- 示例
**示例：**
```js
storagestatistics.getFreeSize(function(error, number){
storageStatistics.getFreeSize(function(error, number){
// do something
console.info("getFreeSize successfully:"+ JSON.stringify(number));
});
```
## storagestatistics.getSystemSize<sup>9+</sup>
## storageStatistics.getSystemSize<sup>9+</sup>
getSystemSize(): Promise&lt;number&gt;
......@@ -390,25 +403,27 @@ getSystemSize(): Promise&lt;number&gt;
**系统能力**：SystemCapability.FileManagement.StorageService.SpatialStatistics
该接口为系统接口，三方应用不支持调用
- 返回值
**返回值：**
| 类型 | 说明 |
| --------------------- | ---------------- |
| Promise&lt;number&gt; | 返回系统空间大小 |
- 示例
**示例：**
```js
storagestatistics.getSystemSize().then(function(number){
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>
## storageStatistics.getSystemSize<sup>9+</sup>
getSystemSize(callback:AsyncCallback&lt;number&gt;):void
......@@ -418,28 +433,28 @@ getSystemSize(callback:AsyncCallback&lt;number&gt;):void
**系统能力**：SystemCapability.FileManagement.StorageService.SpatialStatistics
该接口为系统接口，三方应用不支持调用
- 参数
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| ---------- | ------------------------------------ | ---- | -------------------------- |
| callback | callback:AsyncCallback&lt;number&gt; | 是 | 获取系统空间大小之后的回调 |
- 示例
**示例：**
```js
storagestatistics.getSystemSize(function(error, number){
storageStatistics.getSystemSize(function(error, number){
// do something
console.info("getSystemSize successfully:"+ number);
});
```
## storagestatistics.getUserStorageStats<sup>9+</sup>
getUserStorageStats(userId: number): Promise&lt;StorageStats&gt;
## storageStatistics.getUserStorageStats<sup>9+</sup>
getUserStorageStats(userId? : number): Promise&lt;StorageStats&gt;
异步获取用户各类别数据大小，以promise方式返回。
......@@ -447,32 +462,34 @@ getUserStorageStats(userId: number): Promise&lt;StorageStats&gt;
**系统能力**：SystemCapability.FileManagement.StorageService.SpatialStatistics
该接口为系统接口，三方应用不支持调用
- 参数
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| ---------- | ------ | ---- | ---- |
| userId | string | 否 | 用户id <br/>确认当前用户：<br/>-&nbsp;有值：表示指定用户。<br/>-&nbsp;无值：表示当前用户。|
- 返回值
**返回值：**
| 类型 | 说明 |
| --------------------- | ---------------- |
| Promise&lt;[StorageStats](#StorageStats)&gt; | 返回各类别数据大小 |
- 示例
**示例：**
```js
let userId = "";
storagestatistics.getUserStorageStats(userId).then(function(StorageStats){
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>
## storageStatistics.getUserStorageStats<sup>9+</sup>
getUserStorageStats(userId: number, callback:AsyncCallback&lt;StorageStats&gt;):void
......@@ -482,32 +499,37 @@ getUserStorageStats(userId: number, callback:AsyncCallback&lt;StorageStats&gt;):
**系统能力**：SystemCapability.FileManagement.StorageService.SpatialStatistics
该接口为系统接口，三方应用不支持调用
- 参数
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| ---------- | ------------------------------------ | ---- | -------------------------- |
| userId | string | 否 | 用户id <br/>确认当前用户：<br/>-&nbsp;有值：表示指定用户。<br/>-&nbsp;无值：表示当前用户。 |
| callback | callback:AsyncCallback&lt;[StorageStats](#StorageStats)&gt; | 是 | 返回各类别数据大小之后的回调 |
- 示例
**示例：**
```js
let userId = "";
storagestatistics.getUserStorageStats(userId, function(error, StorageStats){
storageStatistics.getUserStorageStats(userId, function(error, StorageStats){
// do something
console.info("getUserStorageStats successfully:"+ JSON.stringify(StorageStats));
});
```
## StorageStats<sup>9+</sup>
**系统能力**：以下各项对应的系统能力均为SystemCapability.FileManagement.StorageService.SpatialStatistics。<br>
**系统能力**：以下各项对应的系统能力均为SystemCapability.FileManagement.StorageService.SpatialStatistics
该接口为系统接口，三方应用不支持调用
- 属性
### 属性
| 名称 | 类型 | 说明 |
| --------- | ------ | -------------- |
......
zh-cn/application-dev/reference/apis/js-apis-volumemanager.md
浏览文件 @ f279d150
......@@ -24,13 +24,13 @@ getAllVolumes(): Promise&lt;Array&lt;Volume&gt;&gt;
**系统能力**：SystemCapability.FileManagement.StorageService.Volume
- 返回值
**返回值：**
| 类型 | 说明 |
| ---------------------------------- | -------------------------- |
| Promise&lt;[Volume](#volume)[]&gt; | 返回当前所有可获得的卷信息 |
- 示例
**示例：**
```js
volumemanager.getAllVolumes().then(function(volumes){
......@@ -48,13 +48,13 @@ getAllVolumes(callback: AsyncCallback&lt;Array&lt;Volume&gt;&gt;): void
**系统能力**：SystemCapability.FileManagement.StorageService.Volume
- 参数
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ------------------------------------------------- | ---- | ------------------------------------ |
| callback | callback:AsyncCallback&lt;[Volume](#volume)[]&gt; | 是 | 获取当前所有可获得的卷信息之后的回调 |
- 示例
**示例：**
```js
let uuid = "";
......@@ -74,19 +74,19 @@ mount(volumeId: string): Promise&lt;boolean&gt;
**系统能力**：SystemCapability.FileManagement.StorageService.Volume
- 参数
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ------ | ---- | ---- |
| volumeId | string | 是 | 卷id |
- 返回值
**返回值：**
| 类型 | 说明 |
| ---------------------- | ---------- |
| Promise&lt;boolean&gt; | 挂载指定卷 |
- 示例
**示例：**
```js
let volumeId = "";
......@@ -105,14 +105,14 @@ mount(volumeId: string, callback:AsyncCallback&lt;boolean&gt;):void
**系统能力**：SystemCapability.FileManagement.StorageService.Volume
- 参数
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ------------------------------------- | ---- | -------------------- |
| volumeId | string | 是 | 卷id |
| callback | callback:AsyncCallback&lt;boolean&gt; | 是 | 挂载指定卷之后的回调 |
- 示例
**示例：**
```js
let volumeId = "";
......@@ -131,19 +131,19 @@ unmount(volumeId: string): Promise&lt;boolean&gt;
**系统能力**：SystemCapability.FileManagement.StorageService.Volume
- 参数
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ------ | ---- | ---- |
| volumeId | string | 是 | 卷id |
- 返回值
**返回值：**
| 类型 | 说明 |
| ---------------------- | ---------- |
| Promise&lt;boolean&gt; | 卸载指定卷 |
- 示例
**示例：**
```js
let volumeId = "";
......@@ -162,14 +162,14 @@ unmount(volumeId: string, callback:AsyncCallback&lt;boolean&gt;):void
**系统能力**：SystemCapability.FileManagement.StorageService.Volume
- 参数
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ------------------------------------- | ---- | -------------------- |
| volumeId | string | 是 | 卷id |
| callback | callback:AsyncCallback&lt;boolean&gt; | 是 | 卸载指定卷之后的回调 |
- 示例
**示例：**
```js
let volumeId = "";
......@@ -180,7 +180,7 @@ unmount(volumeId: string, callback:AsyncCallback&lt;boolean&gt;):void
## volumemanager.getVolumeByUuid
getVolumeByUuid(uuid: string): Promise<Volume>;
getVolumeByUuid(uuid: string): Promise&lt;Volume&gt;
异步通过uuid获得卷信息，以promise方式返回。
......@@ -188,19 +188,19 @@ getVolumeByUuid(uuid: string): Promise<Volume>;
**系统能力**：SystemCapability.FileManagement.StorageService.Volume
- 参数
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ------ | ---- | ---- |
| uuid | string | 是 | 卷uuid |
- 返回值
**返回值：**
| 类型 | 说明 |
| ---------------------------------- | -------------------------- |
| Promise&lt;[Volume](#volume)&gt; | 返回当前所有可获得的卷信息 |
- 示例
**示例：**
```js
let uuid = "";
......@@ -209,7 +209,7 @@ getVolumeByUuid(uuid: string): Promise<Volume>;
## volumemanager.getVolumeByUuid
getVolumeByUuid(uuid: string, callback: AsyncCallback<Volume>): void;
getVolumeByUuid(uuid: string, callback: AsyncCallback&lt;Volume&gt;): void
异步通过uuid获得卷信息，以callback方式返回。
......@@ -217,14 +217,14 @@ getVolumeByUuid(uuid: string, callback: AsyncCallback<Volume>): void;
**系统能力**：SystemCapability.FileManagement.StorageService.Volume
- 参数
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ------------------------------------------------ | ---- | -------------------- |
| uuid | string | 是 | 卷uuid |
| callback | callback:AsyncCallback&lt;[Volume](#volume)&gt; | 是 | 获取卷信息之后的回调 |
- 示例
**示例：**
```js
let uuid = "";
......@@ -235,7 +235,7 @@ getVolumeByUuid(uuid: string, callback: AsyncCallback<Volume>): void;
## volumemanager.getVolumeById
getVolumeById(id: string): Promise<Volume>;
getVolumeById(id: string): Promise&lt;Volume&gt;
异步通过卷id获得卷信息，以promise方式返回。
......@@ -243,19 +243,19 @@ getVolumeById(id: string): Promise<Volume>;
**系统能力**：SystemCapability.FileManagement.StorageService.Volume
- 参数
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ------ | ---- | ---- |
| id | string | 是 | 卷id |
- 返回值
**返回值：**
| 类型 | 说明 |
| ---------------------------------- | -------------------------- |
| Promise&lt;[Volume](#volume)&gt; | 返回当前所有可获得的卷信息 |
- 示例
**示例：**
```js
let id = "";
......@@ -264,7 +264,7 @@ getVolumeById(id: string): Promise<Volume>;
## volumemanager.getVolumeById
getVolumeById(id: string, callback: AsyncCallback<Volume>): void;
getVolumeById(id: string, callback: AsyncCallback&lt;Volume&gt;): void
异步通过卷id获得卷信息，以callback方式返回。
......@@ -272,14 +272,14 @@ getVolumeById(id: string, callback: AsyncCallback<Volume>): void;
**系统能力**：SystemCapability.FileManagement.StorageService.Volume
- 参数
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ------------------------------------------------ | ---- | -------------------- |
| id | string | 是 | 卷id |
| callback | callback:AsyncCallback&lt;[Volume](#volume)&gt; | 是 | 获取卷信息之后的回调 |
- 示例
**示例：**
```js
let id = "";
......@@ -290,7 +290,7 @@ getVolumeById(id: string, callback: AsyncCallback<Volume>): void;
## volumemanager.setVolumeDescription
setVolumeDescription(uuid: string, description: string): Promise<void>;
setVolumeDescription(uuid: string, description: string): Promise&lt;void&gt;
异步通过uuid设置卷描述，以promise方式返回。
......@@ -298,20 +298,20 @@ setVolumeDescription(uuid: string, description: string): Promise<void>;
**系统能力**：SystemCapability.FileManagement.StorageService.Volume
- 参数
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| --------- | ------ | ---- | ---- |
| uuid | string | 是 | 卷uuid |
| description | string | 是 | 卷描述 |
- 返回值
**返回值：**
| 类型 | 说明 |
| ---------------------- | -------------------------- |
| Promise&lt;void&gt; | 设置卷信息 |
- 示例
**示例：**
```js
let uuid = "";
......@@ -321,7 +321,7 @@ setVolumeDescription(uuid: string, description: string): Promise<void>;
## volumemanager.setVolumeDescription
function setVolumeDescription(uuid: string, description: string, callback: AsyncCallback<void>): void;
setVolumeDescription(uuid: string, description: string, callback: AsyncCallback&lt;void&gt;): void
异步通过uuid设置卷描述，以callback方式返回。
......@@ -329,7 +329,7 @@ function setVolumeDescription(uuid: string, description: string, callback: Async
**系统能力**：SystemCapability.FileManagement.StorageService.Volume
- 参数
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| ---------- | --------------------------------------- | ---- | ---------------- |
......@@ -337,7 +337,7 @@ function setVolumeDescription(uuid: string, description: string, callback: Async
| description | string | 是 | 卷描述 |
| callback | callback:AsyncCallback&lt;void&gt; | 是 | 设置卷描述之后的回调 |
- 示例
**示例：**
```js
let uuid = "";
......@@ -349,7 +349,7 @@ function setVolumeDescription(uuid: string, description: string, callback: Async
## volumemanager.format
format(volId: string): Promise<void>;
format(volId: string): Promise&lt;void&gt;
异步对指定卷进行格式化，以promise方式返回。
......@@ -357,19 +357,19 @@ format(volId: string): Promise<void>;
**系统能力**：SystemCapability.FileManagement.StorageService.Volume
- 参数
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| ----------- | ------ | ---- | ---- |
| volId | string | 是 | 卷id |
- 返回值
**返回值：**
| 类型 | 说明 |
| --------------------- | ----------------------- |
| Promise&lt;void&gt; | 对指定卷进行格式化 |
- 示例
**示例：**
```js
let volId = "";
......@@ -378,7 +378,7 @@ format(volId: string): Promise<void>;
## volumemanager.format
format(volId: string, callback: AsyncCallback<void>): void;
format(volId: string, callback: AsyncCallback&lt;void&gt;): void
异步对指定卷进行格式化，以callback方式返回。
......@@ -386,14 +386,14 @@ format(volId: string, callback: AsyncCallback<void>): void;
**系统能力**：SystemCapability.FileManagement.StorageService.Volume
- 参数
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | --------------------------------------- | ---- | ---------------- |
| volId | string | 是 | 卷id |
| callback | callback:AsyncCallback&lt;void&gt; | 是 | 对指定卷进行格式化 |
- 示例
**示例：**
```js
let volId = "";
......@@ -404,7 +404,7 @@ format(volId: string, callback: AsyncCallback<void>): void;
## volumemanager.partition
partition(volId: string, fstype: string): Promise<void>;
partition(volId: string, fstype: string): Promise&lt;void&gt;
异步对磁盘进行分区，以promise方式返回。
......@@ -412,20 +412,20 @@ partition(volId: string, fstype: string): Promise<void>;
**系统能力**：SystemCapability.FileManagement.StorageService.Volume
- 参数
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| ----------- | ------ | ---- | ---- |
| volId | string | 是 | 卷所属的磁盘id |
| fstype | string | 是 | 分区类型 |
- 返回值
**返回值：**
| 类型 | 说明 |
| --------------------- | ----------------------- |
| Promise&lt;void&gt; | 对磁盘进行分区 |
- 示例
**示例：**
```js
let volId = "";
......@@ -435,7 +435,7 @@ partition(volId: string, fstype: string): Promise<void>;
## volumemanager.partition
partition(volId: string, fstype : string, callback: AsyncCallback<void>): void;
partition(volId: string, fstype : string, callback: AsyncCallback&lt;void&gt;): void
异步对磁盘进行分区，以callback方式返回。
......@@ -443,9 +443,7 @@ partition(volId: string, fstype : string, callback: AsyncCallback<void>): void;
**系统能力**：SystemCapability.FileManagement.StorageService.Volume
- 参数
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | --------------------------------------- | ---- | ---------------- |
......@@ -453,7 +451,7 @@ partition(volId: string, fstype : string, callback: AsyncCallback<void>): void;
| fstype | string | 是 | 分区类型 |
| callback | callback:AsyncCallback&lt;void&gt; | 是 | 对磁盘进行分区 |
- 示例
**示例：**
```js
let volId = "";
......
Markdown is supported
0% 或 .
You are about to add 0 people to the discussion. Proceed with caution.
先完成此消息的编辑！
想要评论请 注册 或