Skip to content

D
Docs

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

通知 161
Star 293
Fork 28
D
Docs
未验证 提交 efc24c2e 编写于 作者: O openharmony_ci 提交者： Gitee
浏览文件
操作

!7168 update apis 

Merge pull request !7168 from zhangxingxia/OpenHarmony-3.1-Release
上级 928eb863 38b0633e
隐藏空白更改
内联 并排
Showing with 94 addition and 94 deletion
zh-cn/application-dev/reference/apis/js-apis-fileio.md
浏览文件 @ efc24c2e
......@@ -17,15 +17,31 @@ import fileio from '@ohos.fileio';
使用该功能模块对文件/目录进行操作前，需要先获取其应用沙箱路径，获取方式及其接口用法请参考：
**Stage模型**
```js
import Ability from '@ohos.application.Ability';
class MainAbility extends Ability {
onWindowStageCreate(windowStage) {
let context = this.context;
let path = context.filesDir;
}
}
```
Stage模型context的具体获取方法参见[Stage模型](https://gitee.com/openharmony/docs/blob/master/zh-cn/application-dev/reference/apis/js-apis-ability-context.md#abilitycontext)。
**FA模型**
```js
import featureAbility from '@ohos.ability.featureAbility';
let context = featureAbility.getContext();
let path = '';
context.getFilesDir().then((data) => {
path = data;
let path = data;
})
```
FA模型context的具体获取方法参见[FA模型](https://gitee.com/openharmony/docs/blob/master/zh-cn/application-dev/reference/apis/js-apis-Context.md#context%E6%A8%A1%E5%9D%97)。
## fileio.stat
......
zh-cn/application-dev/reference/apis/js-apis-filemanager.md
浏览文件 @ efc24c2e
......@@ -35,12 +35,10 @@ getRoot(options? : {dev? : DevInfo}) : Promise<FileInfo[]>
**示例：**
```js
filemanager.getRoot().then((fileInfo) => {
if(Array.isArray(fileInfo)) {
for (var i = 0; i < fileInfo.length; i++) {
console.log("file:"+JSON.stringify(fileInfo));
}
}
filemanager.getRoot().then((fileInfos) => {
for (var i = 0; i < fileInfos.length; i++) {
console.log("files:"+JSON.stringify(fileInfos));
}
}).catch((err) => {
console.log(err)
});
......@@ -69,14 +67,11 @@ getRoot(options? : {dev? : DevInfo}, callback : AsyncCallback&lt;FileInfo[]&gt;)
"name":"local"
}
};
filemanager.getRoot(options, (err, fileInfo)=>{
if(Array.isArray(fileInfo)) {
for (var i = 0; i < fileInfo.length; i++) {
console.log("file:"+JSON.stringify(fileInfo));
}
}
filemanager.getRoot(options, (err, fileInfos)=>{
for (var i = 0; i < fileInfos.length; i++) {
console.log("files:"+JSON.stringify(fileInfos));
}
});
```
## filemanager.listFile
......@@ -111,18 +106,17 @@ listFile(path : string, type : string, options? : {dev? : DevInfo, offset? : num
**示例：**
```js
// 获取目录下所有文件
// 通过listFile、getRoot获取的文件uri
let media_path = ""
filemanager.listFile(media_path, "file")
.then((fileInfo) => {
if(Array.isArray(fileInfo)) {
for (var i = 0; i < fileInfo.length; i++) {
console.log("file:"+JSON.stringify(fileInfo));
}
}
// 获取目录下所有文件，通过getRoot获取的目录uri
filemanager.getRoot().then((fileInfos) => {
let file = fileInfos.find(item => item.name == "file_folder");
let path = file.path;
filemanager.listFile(path, "file").then((files) => {
console.log("files:" + JSON.stringify(files));
}).catch((err) => {
console.log("failed to get files" + err);
});
}).catch((err) => {
console.log("failed to get file"+err);
console.log("failed to get root" + err);
});
```
......@@ -153,33 +147,18 @@ listFile(path : string, type : string, options? : {dev? : DevInfo, offset? : num
**示例：**
```js
// 通过listFile、getRoot获取的文件path
let fileInfos = filemanager.getRoot();
let media_path = "";
for (let i = 0; i < fileInfos.length; i++) {
if (fileInfos[i].name == "image_album") {
media_path = fileInfos[i].path;
} else if (fileInfos[i].name == "audio_album") {
media_path = fileInfos[i].path;
} else if (fileInfos[i].name == "video_album") {
media_path = fileInfos[i].path;
} else if (fileInfos[i].name == "file_folder") {
media_path = fileInfos[i].path;
}
}
filemanager.listFile(media_path, "file")
.then((fileInfo) => {
if(Array.isArray(fileInfo)) {
for (var i = 0; i < fileInfo.length; i++) {
console.log("file:"+JSON.stringify(fileInfo));
}
}
}).catch((err) => {
console.log("failed to get file"+err);
});
```
```js
// 获取目录下所有文件，通过getRoot获取的目录uri
filemanager.getRoot().then((fileInfos) => {
let file = fileInfos.find(item => item.name == "image_album");
let path = file.path;
filemanager.listFile(path, "image",function(err, files){
console.log("files:" + JSON.stringify(files));
})
}).catch((err) => {
console.log("failed to get root" + err);
});
```
## filemanager.createFile
......
zh-cn/application-dev/reference/apis/js-apis-volumemanager.md
浏览文件 @ efc24c2e
......@@ -191,13 +191,13 @@ getVolumeByUuid(uuid: string): Promise&lt;Volume&gt;
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ------ | ---- | ---- |
| -------- | ------ | ---- | ---- |
| uuid | string | 是 | 卷uuid |
**返回值：**
| 类型 | 说明 |
| ---------------------------------- | -------------------------- |
| ---------------------------------- | -------------------------- |
| Promise&lt;[Volume](#volume)&gt; | 返回当前所有可获得的卷信息 |
**示例：**
......@@ -239,7 +239,7 @@ getVolumeByUuid(uuid: string, callback: AsyncCallback&lt;Volume&gt;): void
## volumemanager.getVolumeById
getVolumeById(id: string): Promise&lt;Volume&gt;
getVolumeById(volumeId: string): Promise&lt;Volume&gt;
异步通过卷id获得卷信息，以promise方式返回。
......@@ -251,7 +251,7 @@ getVolumeById(id: string): Promise&lt;Volume&gt;
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ------ | ---- | ---- |
| id | string | 是 | 卷id |
| volumeId | string | 是 | 卷id |
**返回值：**
......@@ -262,8 +262,8 @@ getVolumeById(id: string): Promise&lt;Volume&gt;
**示例：**
```js
let id = "";
volumemanager.getVolumeById(id).then(function(volume) {
let volumeId = "";
volumemanager.getVolumeById(volumeId).then(function(volume) {
console.info("getVolumeById successfully:" + JSON.stringify(volume));
}).catch(function(error){
console.info("getVolumeById failed with error:"+ error);
......@@ -272,7 +272,7 @@ getVolumeById(id: string): Promise&lt;Volume&gt;
## volumemanager.getVolumeById
getVolumeById(id: string, callback: AsyncCallback&lt;Volume&gt;): void
getVolumeById(volumeId: string, callback: AsyncCallback&lt;Volume&gt;): void
异步通过卷id获得卷信息，以callback方式返回。
......@@ -282,16 +282,16 @@ getVolumeById(id: string, callback: AsyncCallback&lt;Volume&gt;): void
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ------------------------------------------------ | ---- | -------------------- |
| id | string | 是 | 卷id |
| callback | callback:AsyncCallback&lt;[Volume](#volume)&gt; | 是 | 获取卷信息之后的回调 |
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ------------------------- | ---- | ----------------------------- |
| volumeId | string | 是 | 卷id |
| callback | callback:AsyncCallback&lt;[Volume](#volume)&gt; | 是 | 获取卷信息之后的回调 |
**示例：**
```js
let id = "";
volumemanager.getVolumeById(id, (error, volume) => {
let volumeId = "";
volumemanager.getVolumeById(volumeId, (error, volume) => {
// do something
});
```
......@@ -361,7 +361,7 @@ setVolumeDescription(uuid: string, description: string, callback: AsyncCallback&
## volumemanager.format
format(volId: string): Promise&lt;void&gt;
format(volumeId: string, fsType: string): Promise&lt;void&gt;
异步对指定卷进行格式化，以promise方式返回。
......@@ -373,19 +373,21 @@ format(volId: string): Promise&lt;void&gt;
| 参数名 | 类型 | 必填 | 说明 |
| ----------- | ------ | ---- | ---- |
| volId | string | 是 | 卷id |
| volumeId | string | 是 | 卷id |
| fsType | string | 是 | 文件系统类型 |
**返回值：**
| 类型 | 说明 |
| --------------------- | ----------------------- |
| Promise&lt;void&gt; | 对指定卷进行格式化 |
| 类型 | 说明 |
| ---------------------- | ---------- |
| Promise&lt;void&gt; | 对指定卷进行格式化 |
**示例：**
```js
let volId = "";
volumemanager.format(volId).then(function() {
let volumeId = "";
let fsType = "";
volumemanager.format(volumeId, fsType).then(function() {
console.info("format successfully");
}).catch(function(error){
console.info("format failed with error:"+ error);
......@@ -394,7 +396,7 @@ format(volId: string): Promise&lt;void&gt;
## volumemanager.format
format(volId: string, callback: AsyncCallback&lt;void&gt;): void
format(volumeId: string, fsType: string, callback: AsyncCallback&lt;void&gt;): void
异步对指定卷进行格式化，以callback方式返回。
......@@ -404,23 +406,25 @@ format(volId: string, callback: AsyncCallback&lt;void&gt;): void
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | --------------------------------------- | ---- | ---------------- |
| volId | string | 是 | 卷id |
| callback | callback:AsyncCallback&lt;void&gt; | 是 | 对指定卷进行格式化 |
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ------------------------- | ---- | ----------------------------- |
| volumeId | string | 是 | 卷id |
| fsType | string | 是 | 文件系统类型 |
| callback | callback:AsyncCallback&lt;void&gt; | 是 | 对指定卷格式化后的回调 |
**示例：**
```js
let volId = "";
volumemanager.format(volId, (error, bool) => {
let volumeId = "";
let fsType = "";
volumemanager.format(volumeId, fsType, (error, bool) => {
// do something
});
```
## volumemanager.partition
partition(volId: string, fstype: string): Promise&lt;void&gt;
partition(diskId: string, type: number): Promise&lt;void&gt;
异步对磁盘进行分区，以promise方式返回。
......@@ -431,9 +435,9 @@ partition(volId: string, fstype: string): Promise&lt;void&gt;
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| ----------- | ------ | ---- | ---- |
| volId | string | 是 | 卷所属的磁盘id |
| fstype | string | 是 | 分区类型 |
| ----------- | ------ | ---- | ---- |
| diskId | string | 是 | 卷所属的磁盘id |
| type | number | 是 | 分区类型 |
**返回值：**
......@@ -444,9 +448,9 @@ partition(volId: string, fstype: string): Promise&lt;void&gt;
**示例：**
```js
let volId = "";
let fstype = "";
volumemanager.partition(volId, fstype).then(function() {
let diskId = "";
let type = 0;
volumemanager.partition(diskId, type).then(function() {
console.info("partition successfully");
}).catch(function(error){
console.info("partition failed with error:"+ error);
......@@ -455,7 +459,7 @@ partition(volId: string, fstype: string): Promise&lt;void&gt;
## volumemanager.partition
partition(volId: string, fstype : string, callback: AsyncCallback&lt;void&gt;): void
partition(diskId: string, type: number, callback: AsyncCallback&lt;void&gt;): void
异步对磁盘进行分区，以callback方式返回。
......@@ -467,16 +471,16 @@ partition(volId: string, fstype : string, callback: AsyncCallback&lt;void&gt;):
| 参数名 | 类型 | 必填 | 说明 |
| -------- | --------------------------------------- | ---- | ---------------- |
| volId | string | 是 | 卷所属的磁盘id |
| fstype | string | 是 | 分区类型 |
| diskId | string | 是 | 卷所属的磁盘id |
| type | number | 是 | 分区类型 |
| callback | callback:AsyncCallback&lt;void&gt; | 是 | 对磁盘进行分区 |
**示例：**
```js
let volId = "";
let fstype = "";
volumemanager.partition(volId, fstype, (error, bool) => {
let diskId = "";
let type = 0;
volumemanager.partition(diskId, type, (error, bool) => {
// do something
});
```
......@@ -491,6 +495,7 @@ partition(volId: string, fstype : string, callback: AsyncCallback&lt;void&gt;):
| ----------- | ------- | -------------------- |
| id | string | 卷id |
| uuid | string | 卷uuid |
| diskId | string | 卷所属的磁盘id |
| description | string | 卷相关描述 |
| removable | boolean | 是否为可移动存储设备 |
| state | number | 当前卷状态 |
......
Markdown is supported
0% 或 .
You are about to add 0 people to the discussion. Proceed with caution.
先完成此消息的编辑！
想要评论请 注册 或