Skip to content
体验新版
项目
组织
正在加载...
登录
切换导航
打开侧边栏
OpenHarmony
Docs
提交
7bd66ad0
D
Docs
项目概览
OpenHarmony
/
Docs
接近 2 年 前同步成功
通知
159
Star
292
Fork
28
代码
文件
提交
分支
Tags
贡献者
分支图
Diff
Issue
0
列表
看板
标记
里程碑
合并请求
0
Wiki
0
Wiki
分析
仓库
DevOps
项目成员
Pages
D
Docs
项目概览
项目概览
详情
发布
仓库
仓库
文件
提交
分支
标签
贡献者
分支图
比较
Issue
0
Issue
0
列表
看板
标记
里程碑
合并请求
0
合并请求
0
Pages
分析
分析
仓库分析
DevOps
Wiki
0
Wiki
成员
成员
收起侧边栏
关闭侧边栏
动态
分支图
创建新Issue
提交
Issue看板
提交
7bd66ad0
编写于
2月 21, 2022
作者:
A
annie_wangli
浏览文件
操作
浏览文件
下载
电子邮件补丁
差异文件
update docs
Signed-off-by:
N
annie_wangli
<
annie.wangli@huawei.com
>
上级
4c0d8e83
变更
1
隐藏空白更改
内联
并排
Showing
1 changed file
with
246 addition
and
0 deletion
+246
-0
en/application-dev/reference/apis/js-apis-filemanager.md
en/application-dev/reference/apis/js-apis-filemanager.md
+246
-0
未找到文件。
en/application-dev/reference/apis/js-apis-filemanager.md
0 → 100644
浏览文件 @
7bd66ad0
# Public File Access and Management
> **NOTE:**
>The initial APIs of this module are supported since API version 8. Newly added APIs will be marked with a superscript to indicate their earliest API version.
## Modules to Import
```
js
import
filemanager
from
'
ohos.filemanager
'
;
```
## System Capabilities
SystemCapability.FileManagement.FileManagerService
## filemanager.getRoot
getRoot(options? : {dev? : DevInfo}) : Promise
<
FileInfo[]
>
Obtains information about the files in the first-level directory in asynchronous mode. This method uses a promise to return the result.
-
Parameters
| Name| Type| Mandatory| Description|
| --- | --- | --- | -- |
| dev |
[
DevInfo
](
#devinfo
)
| No| Device name. The default value is
**local**
, which is the only value supported.|
-
Return value
| Type| Description|
| --- | -- |
| Promise
<
[FileInfo](#fileinfo)[]
>
| Promise used to return the file information obtained.|
-
Example
```
js
filemanager
.
getRoot
().
then
((
fileInfo
)
=>
{
if
(
Array
.
isArray
(
fileInfo
))
{
for
(
var
i
=
0
;
i
<
fileInfo
.
length
;
i
++
)
{
console
.
log
(
JSON
.
Stringify
(
fileInfo
))
}
}
}).
catch
((
err
)
=>
{
console
.
log
(
err
)
});
```
## filemanager.getRoot
getRoot(options? : {dev? : DevInfo}, callback : AsyncCallback
<
FileInfo[]
>
) : void
Obtains information about the files in the first-level directory in asynchronous mode. This method uses a callback to return the result.
-
Parameters
| Name| Type| Mandatory| Description|
| -------- | ------------------------- | ---- | ----------------------------- |
| dev |
[
DevInfo
](
#devinfo
)
| No| Device name. The default value is
**local**
, which is the only value supported.|
| callback | AsyncCallback
<
[FileInfo](#fileinfo)[]
>
| Yes| Callback invoked to return the file information obtained.|
-
Example
```
js
filemanager
.
getRoot
((
err
,
fileInfo
)
=>
{
if
(
Array
.
isArray
(
fileInfo
))
{
for
(
var
i
=
0
;
i
<
fileInfo
.
length
;
i
++
)
{
console
.
log
(
JSON
.
Stringify
(
fileInfo
))
}
}
})
```
## filemanager.listFile
listFile(path : string, type : string, options? : {dev? : DevInfo, offset? : number, count? : number}) : Promise
<
FileInfo[]
>
Obtains information about the files in the second-level directory in asynchronous mode. This method uses a promise to return the result.
-
Parameters
| Name| Type| Mandatory| Description|
| --- | --- | --- | -- |
| type | string | Yes| Type of the files to query. The file type can be
**file**
,
**image**
,
**audio**
, or
**video**
.|
| path | string | Yes| URI of the directory to query.|
| dev |
[
DevInfo
](
#devinfo
)
| Yes| Device name. The default value is
**local**
, which is the only value supported.|
| offset | number | No| Start position from which the files are to query.|
| count | number | No| Number of files to query.|
-
Return value
| Type| Description|
| --- | -- |
| Promise
<
FileInfo[]
>
| Promise used to return the file information obtained.|
-
Error
| | Error Info| Error Code|Description|
| --- | -- | --- | -- |
| | No such file or directory | 2 | The directory or file of the specified URI does not exist.|
| | No such process | 3 | Failed to obtain the FMS service.|
| | Not a directory | 20 | The object specified by the URI is not a directory.|
```
js
// Obtain all files in the directory.
// Call listFile() and getRoot() to obtain file URIs.
let
media_path
=
file
.
uri
filemanager
.
listFile
(
media_path
,
"
file
"
)
.
then
((
fileInfo
)
=>
{
if
(
Array
.
isArray
(
fileInfo
))
{
for
(
var
i
=
0
;
i
<
fileInfo
.
length
;
i
++
)
{
console
.
log
(
JSON
.
Stringify
(
fileInfo
))
}
}
})
.
catch
((
err
)
=>
{
console
.
log
(
err
)
})
```
## filemanager.listFile
listFile(path : string, type : string, options? : {dev? : DevInfo, offset? : number, count? : number}, callback : AsyncCallback
<
FileInfo[]
>
) : void
Obtains information about the files in the second-level directory in asynchronous mode. This method uses a callback to return the result.
-
Parameters
| Name| Type| Mandatory| Description|
| -------- | ------------------------- | ---- | ------------------------------------------------------------ |
| type | string | Yes| Type of the files to query. The file type can be
**file**
,
**image**
,
**audio**
, or
**video**
.|
| path | string | Yes| URI of the directory to query.|
| dev |
[
DevInfo
](
#devinfo
)
| No| Device name. The default value is
**local**
, which is the only value supported.|
| offset | number | No| Start position from which the files are to query.|
| count | number | No| Number of files to query.|
| callback | AsyncCallback
<
[FileInfo](#fileinfo)[]
>
| Yes| Callback invoked to return the file information obtained.|
-
Error
| | Error Info| Error Code| Description|
| ------------------------- | ------------------------- | ------ | ------------------------- |
| | No such file or directory | 2 | The directory or file of the specified URI does not exist.|
| | No such process | 3 | Failed to obtain the FMS service.|
| | Not a directory | 20 | The object specified by the URI is not a directory.|
```
js
// Call listFile() and getRoot() to obtain the file UIRs.
let
media_path
=
file
.
uri
filemanager
.
listFile
(
media_path
,
"
file
"
,
(
err
,
fileInfo
)
=>
{
if
(
Array
.
isArray
(
fileInfo
))
{
for
(
var
i
=
0
;
i
<
fileInfo
.
length
;
i
++
)
{
console
.
log
(
JSON
.
Stringify
(
fileInfo
))
}
}
})
```
## filemanager.createFile
filemanager.createFile(path : string, filename : string, options? : {dev? : DevInfo}) : promise
<
string
>
Creates a file in the specified path in asynchronous mode. This method uses a promise to return the result.
-
Parameters
| Name| Type| Mandatory| Description|
| --- | --- | --- | -- |
| filename | string | Yes| Name of the file to create.|
| path | string | Yes| URI of the file to create.|
| dev |
[
DevInfo
](
#devinfo
)
| No| Device name. The default value is
**local**
, which is the only value supported.|
-
Return value
| Type| Description|
| --- | -- |
| promise
<string>
| Promise used to return the URI of the file created.|
-
Error
| | Error Info| Error Code|Description|
| --- | -- | --- | -- |
| | Operation not permitted | 1 | A file with the same name already exists.|
| | No such file or directory | 2 | The directory or file of the specified URI does not exist.|
| | No such process | 3 | Failed to obtain the FMS service.|
| | Not a directory | 20 | The object specified by the URI is not a directory.|
```
js
// Create a file.
let
media_path
=
file
.
uri
// Obtain the file URI using listFile() and getRoot().
let
name
=
"
xxx.jpg
"
// File name extension of the file to be saved.
filemanager
.
createFile
(
media_path
,
name
)
.
then
((
uri
)
=>
{
// The URI of the file created is returned.
})
.
catch
((
err
)
=>
{
console
.
log
(
err
)
})
```
## filemanager.createFile
createFile(path : string, filename: string, options? : {dev? : DevInfo}, callback : AsyncCallback
<
string
>
) : void
Creates a file in the specified path in asynchronous mode. This method uses a callback to return the result.
-
Parameters
| Name| Type| Mandatory| Description|
| -------- | ------------------------- | ---- | ----------------------------- |
| filename | string | Yes| Name of the file to create.|
| path | string | Yes| URI of the file to create.|
| dev |
[
DevInfo
](
#devinfo
)
| No| Device name. The default value is
**local**
, which is the only value supported.|
| callback | AsyncCallback
<
[FileInfo](#fileinfo)[]
>
| Yes| Callback invoked to return the URI of the file created.|
-
Error
| | Error Info| Error Code| Description|
| ------------------------- | ------------------------- | ------ | ------------------------- |
| | Operation not permitted | 1 | A file with the same name already exists.|
| | No such file or directory | 2 | The directory or file of the specified URI does not exist.|
| | No such process | 3 | Failed to obtain the FMS service.|
| | Not a directory | 20 | The object specified by the URI is not a directory.|
```
js
// Create a file.
// Call listFile() and getRoot() to obtain the file URI.
let
media_path
=
file
.
uri
// File name extension of file to be saved.
let
name
=
"
xxx.jpg
"
filemanager
.
createFile
(
media_path
,
name
,
(
err
,
uri
)
=>
{
// The URI of the file created is returned.
})
```
## FileInfo
Defines the file information returned by
**getRoot()**
or
**listFile()**
.
### Attributes
| Name| Type| Readable| Writable| Description|
| --- | -- | -- | -- | -- |
| name | string | Yes| No| File name.|
| path | string | Yes| No| URI of the file.|
| type | string | Yes| No| File type.|
| size | number | Yes| No| File size.|
| addedTime | number | Yes| No| Time when the file was scanned to the database.|
| modifiedTime | number | Yes| No| Time when the file was modified.|
## DevInfo
Defines the device type.
### Attributes
| Name| Type| Readable| Writable| Description|
| --- | -- | -- | -- | -- |
| name | string | Yes| Yes| Device name.|
编辑
预览
Markdown
is supported
0%
请重试
或
添加新附件
.
添加附件
取消
You are about to add
0
people
to the discussion. Proceed with caution.
先完成此消息的编辑!
取消
想要评论请
注册
或
登录