Skip to content
体验新版
项目
组织
正在加载...
登录
切换导航
打开侧边栏
OpenHarmony
Docs
提交
1154f218
D
Docs
项目概览
OpenHarmony
/
Docs
大约 1 年 前同步成功
通知
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看板
体验新版 GitCode,发现更多精彩内容 >>
提交
1154f218
编写于
1月 27, 2022
作者:
P
panqiangbiao
浏览文件
操作
浏览文件
下载
电子邮件补丁
差异文件
update filemanager
Signed-off-by:
N
panqiangbiao
<
panqiangbiao@huawei.com
>
上级
90314f03
变更
1
隐藏空白更改
内联
并排
Showing
1 changed file
with
31 addition
and
33 deletion
+31
-33
zh-cn/application-dev/reference/apis/js-apis-filemanager.md
zh-cn/application-dev/reference/apis/js-apis-filemanager.md
+31
-33
未找到文件。
zh-cn/application-dev/reference/apis/js-apis-filemanager.md
浏览文件 @
1154f218
...
@@ -11,14 +11,14 @@ import filemanager from 'ohos.filemanager'
...
@@ -11,14 +11,14 @@ import filemanager from 'ohos.filemanager'
应用需要拥有SystemCapability.FileManagement.FileManagerService权限
应用需要拥有SystemCapability.FileManagement.FileManagerService权限
## filemanager.getRoot
## filemanager.getRoot
getRoot(
dev : DevInfo
) : Promise
<
FileInfo[]
>
getRoot(
options? : {dev? : DevInfo}
) : Promise
<
FileInfo[]
>
以异步方法获取第一层相册,目录信息。使用promise形式返回结果。
以异步方法获取第一层相册,目录信息。使用promise形式返回结果。
-
参数
-
参数
| 参数名 | 类型 | 必填 | 说明 |
| 参数名 | 类型 | 必填 | 说明 |
| --- | --- | --- | -- |
| --- | --- | --- | -- |
| dev | DevInfo |
是
| 设备名, 当前仅支持设备'local' |
| dev | DevInfo |
否
| 设备名, 当前仅支持设备'local' |
-
返回值
-
返回值
...
@@ -29,8 +29,7 @@ getRoot(dev : DevInfo) : Promise<FileInfo[]>
...
@@ -29,8 +29,7 @@ getRoot(dev : DevInfo) : Promise<FileInfo[]>
-
示例
-
示例
```
js
```
js
let
dev
=
{
name
:
"
local
"
};
filemanager
.
getRoot
()
filemanager
.
getRoot
(
dev
)
.
then
((
fileInfo
)
=>
{
.
then
((
fileInfo
)
=>
{
if
(
Array
.
isArray
(
fileInfo
))
{
if
(
Array
.
isArray
(
fileInfo
))
{
for
(
var
i
=
0
;
i
<
fileInfo
.
length
;
i
++
)
{
for
(
var
i
=
0
;
i
<
fileInfo
.
length
;
i
++
)
{
...
@@ -45,7 +44,7 @@ filemanager.getRoot(dev)
...
@@ -45,7 +44,7 @@ filemanager.getRoot(dev)
## filemanager.getRoot
## filemanager.getRoot
getRoot(
dev : DevInfo
, callback : AsyncCallback
<
FileInfo[]
>
) : void
getRoot(
options? : {dev? : DevInfo}
, callback : AsyncCallback
<
FileInfo[]
>
) : void
以异步方法获取第一层相册,目录信息。使用callback形式返回结果。
以异步方法获取第一层相册,目录信息。使用callback形式返回结果。
...
@@ -53,14 +52,13 @@ getRoot(dev : DevInfo, callback : AsyncCallback<FileInfo[]>) : void
...
@@ -53,14 +52,13 @@ getRoot(dev : DevInfo, callback : AsyncCallback<FileInfo[]>) : void
| 参数名 | 类型 | 必填 | 说明 |
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ------------------------- | ---- | ----------------------------- |
| -------- | ------------------------- | ---- | ----------------------------- |
| dev | DevInfo |
是
| 设备名, 当前仅支持设备'local' |
| dev | DevInfo |
否
| 设备名, 当前仅支持设备'local' |
| callback | AsyncCallback
<
FileInfo[]
>
| 是 | 异步获取文件的信息之后的回调 |
| callback | AsyncCallback
<
FileInfo[]
>
| 是 | 异步获取文件的信息之后的回调 |
-
示例
-
示例
```
js
```
js
let
dev
=
{
name
:
"
local
"
};
filemanager
.
getRoot
((
err
,
fileInfo
)
=>
{
filemanager
.
getRoot
(
dev
,
(
err
,
fileInfo
)
=>
{
if
(
Array
.
isArray
(
fileInfo
))
{
if
(
Array
.
isArray
(
fileInfo
))
{
for
(
var
i
=
0
;
i
<
fileInfo
.
length
;
i
++
)
{
for
(
var
i
=
0
;
i
<
fileInfo
.
length
;
i
++
)
{
console
.
log
(
JSON
.
Stringify
(
fileInfo
))
console
.
log
(
JSON
.
Stringify
(
fileInfo
))
...
@@ -71,17 +69,19 @@ filemanager.getRoot(dev, (err, fileInfo) => {
...
@@ -71,17 +69,19 @@ filemanager.getRoot(dev, (err, fileInfo) => {
## filemanager.listFile
## filemanager.listFile
listFile(
dev : DevInfo, type : string, path : string, option? : {offset? : number, count?
: number}) : Promise
<
FileInfo[]
>
listFile(
path : string, type : string, options? : {dev? : DevInfo, offset? : number, count?
: number}) : Promise
<
FileInfo[]
>
以异步方法获取获取第二层相册,文件信息。使用promise形式返回结果。
以异步方法获取获取第二层相册,文件信息。使用promise形式返回结果。
-
参数
-
参数
| 参数名 | 类型 | 必填 | 说明 |
| 参数名 | 类型 | 必填 | 说明 |
| --- | --- | --- | -- |
| --- | --- | --- | -- |
| dev | DevInfo | 是 | 设备名, 当前仅支持设备'local' |
| type | string | 是 | 待查询文件类型, 支持以下类型 "file", "image", "audio", "video" |
| type | string | 是 | 待查询文件类型, 支持以下类型 "file", "image", "audio", "video" |
| path | string | 是 | 待查询目录uri |
| path | string | 是 | 待查询目录uri |
| dev | DevInfo | 是 | 设备名, 当前仅支持设备'local' |
| offset | number | 否 | 待查询文件偏移 |
| count | number | 否 | 待查询文件个数 |
-
返回值
-
返回值
| 类型 | 说明 |
| 类型 | 说明 |
...
@@ -99,8 +99,7 @@ listFile(dev : DevInfo, type : string, path : string, option? : {offset? : numbe
...
@@ -99,8 +99,7 @@ listFile(dev : DevInfo, type : string, path : string, option? : {offset? : numbe
// 获取目录下所有文件
// 获取目录下所有文件
// 通过listFile、getRoot获取的文件uri
// 通过listFile、getRoot获取的文件uri
let
media_path
=
file
.
uri
let
media_path
=
file
.
uri
let
dev
=
{
name
:
"
local
"
};
filemanager
.
listFile
(
media_path
,
"
file
"
)
filemanager
.
listFile
(
dev
,
"
file
"
,
media_path
)
.
then
((
fileInfo
)
=>
{
.
then
((
fileInfo
)
=>
{
if
(
Array
.
isArray
(
fileInfo
))
{
if
(
Array
.
isArray
(
fileInfo
))
{
for
(
var
i
=
0
;
i
<
fileInfo
.
length
;
i
++
)
{
for
(
var
i
=
0
;
i
<
fileInfo
.
length
;
i
++
)
{
...
@@ -114,7 +113,7 @@ filemanager.listFile(dev, "file", media_path)
...
@@ -114,7 +113,7 @@ filemanager.listFile(dev, "file", media_path)
```
```
## filemanager.listFile
## filemanager.listFile
listFile(
dev : DevInfo, type : string, path : string, option? : {offset? : number, count?
: number}, callback : AsyncCallback
<
FileInfo[]
>
) : void
listFile(
path : string, type : string, options? : {dev? : DevInfo, offset? : number, count?
: number}, callback : AsyncCallback
<
FileInfo[]
>
) : void
以异步方法获取获取第二层相册,文件信息。使用callback形式返回结果。
以异步方法获取获取第二层相册,文件信息。使用callback形式返回结果。
...
@@ -122,9 +121,11 @@ listFile(dev : DevInfo, type : string, path : string, option? : {offset? : numbe
...
@@ -122,9 +121,11 @@ listFile(dev : DevInfo, type : string, path : string, option? : {offset? : numbe
| 参数名 | 类型 | 必填 | 说明 |
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ------------------------- | ---- | ------------------------------------------------------------ |
| -------- | ------------------------- | ---- | ------------------------------------------------------------ |
| dev | DevInfo | 是 | 设备名, 当前仅支持设备'local' |
| type | string | 是 | 待查询文件类型, 支持以下类型 "file", "image", "audio", "video" |
| type | string | 是 | 待查询文件类型, 支持以下类型 "file", "image", "audio", "video" |
| path | string | 是 | 待查询目录uri |
| path | string | 是 | 待查询目录uri |
| dev | DevInfo | 否 | 设备名, 当前仅支持设备'local' |
| offset | number | 否 | 待查询文件偏移 |
| count | number | 否 | 待查询文件个数 |
| callback | AsyncCallback
<
FileInfo[]
>
| 是 | 异步获取文件的信息之后的回调 |
| callback | AsyncCallback
<
FileInfo[]
>
| 是 | 异步获取文件的信息之后的回调 |
-
异常
-
异常
...
@@ -137,8 +138,7 @@ listFile(dev : DevInfo, type : string, path : string, option? : {offset? : numbe
...
@@ -137,8 +138,7 @@ listFile(dev : DevInfo, type : string, path : string, option? : {offset? : numbe
```
js
```
js
// 通过listFile、getRoot获取的文件uri
// 通过listFile、getRoot获取的文件uri
let
media_path
=
file
.
uri
let
media_path
=
file
.
uri
let
dev
=
{
name
:
"
local
"
};
filemanager
.
listFile
(
media_path
,
"
file
"
,
(
err
,
fileInfo
)
=>
{
filemanager
.
listFile
(
dev
,
"
file
"
,
media_path
,
(
err
,
fileInfo
)
=>
{
if
(
Array
.
isArray
(
fileInfo
))
{
if
(
Array
.
isArray
(
fileInfo
))
{
for
(
var
i
=
0
;
i
<
fileInfo
.
length
;
i
++
)
{
for
(
var
i
=
0
;
i
<
fileInfo
.
length
;
i
++
)
{
console
.
log
(
JSON
.
Stringify
(
fileInfo
))
console
.
log
(
JSON
.
Stringify
(
fileInfo
))
...
@@ -149,16 +149,16 @@ filemanager.listFile(dev, "file", media_path, (err, fileInfo) => {
...
@@ -149,16 +149,16 @@ filemanager.listFile(dev, "file", media_path, (err, fileInfo) => {
## filemanager.createFile
## filemanager.createFile
filemanager.createFile(
dev : DevInfo, filename: string, path : string
) : promise
<
string
>
filemanager.createFile(
path : string, filename : string, options? : {dev? : DevInfo}
) : promise
<
string
>
以异步方法创建文件到指定路径,返回文件uri。使用promise形式返回结果。
以异步方法创建文件到指定路径,返回文件uri。使用promise形式返回结果。
-
参数
-
参数
| 参数名 | 类型 | 必填 | 说明 |
| 参数名 | 类型 | 必填 | 说明 |
| --- | --- | --- | -- |
| --- | --- | --- | -- |
| dev | DevInfo | 是 | 设备名, 当前仅支持设备'local' |
| filename | string | 是 | 待创建的文件名 |
| filename | string | 是 | 待创建的文件名 |
| path | string | 是 | 待保存目的相册uri |
| path | string | 是 | 待保存目的相册uri |
| dev | DevInfo | 否 | 设备名, 当前仅支持设备'local' |
-
返回值
-
返回值
...
@@ -178,8 +178,7 @@ filemanager.createFile(dev : DevInfo, filename: string, path : string) : prom
...
@@ -178,8 +178,7 @@ filemanager.createFile(dev : DevInfo, filename: string, path : string) : prom
// 创建文件,返回文件uri
// 创建文件,返回文件uri
let
media_path
=
file
.
uri
// 通过listFile、getRoot获取的文件uri
let
media_path
=
file
.
uri
// 通过listFile、getRoot获取的文件uri
let
name
=
"
xxx.jpg
"
// 待保存文件的后缀
let
name
=
"
xxx.jpg
"
// 待保存文件的后缀
let
dev
=
{
name
:
"
local
"
};
filemanager
.
createFile
(
media_path
,
name
)
filemanager
.
createFile
(
dev
,
name
,
media_path
)
.
then
((
uri
)
=>
{
.
then
((
uri
)
=>
{
// 返回uri给应用
// 返回uri给应用
})
})
...
@@ -190,7 +189,7 @@ filemanager.createFile(dev, name, media_path)
...
@@ -190,7 +189,7 @@ filemanager.createFile(dev, name, media_path)
## filemanager.createFile
## filemanager.createFile
createFile(
dev : DevInfo, filename: string, path : string
, callback : AsyncCallback
<
string
>
) : void
createFile(
path : string, filename: string, options? : {dev? : DevInfo}
, callback : AsyncCallback
<
string
>
) : void
以异步方法创建文件到指定路径,返回文件uri。使用callback形式返回结果。
以异步方法创建文件到指定路径,返回文件uri。使用callback形式返回结果。
...
@@ -198,9 +197,9 @@ createFile(dev : DevInfo, filename: string, path : string, callback : AsyncCallb
...
@@ -198,9 +197,9 @@ createFile(dev : DevInfo, filename: string, path : string, callback : AsyncCallb
| 参数名 | 类型 | 必填 | 说明 |
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ------------------------- | ---- | ----------------------------- |
| -------- | ------------------------- | ---- | ----------------------------- |
| dev | DevInfo | 是 | 设备名, 当前仅支持设备'local' |
| filename | string | 是 | 待创建的文件名 |
| filename | string | 是 | 待创建的文件名 |
| path | string | 是 | 待保存目的相册uri |
| path | string | 是 | 待保存目的相册uri |
| dev | DevInfo | 否 | 设备名, 当前仅支持设备'local' |
| callback | AsyncCallback
<
FileInfo[]
>
| 是 | 异步获取文件的信息之后的回调 |
| callback | AsyncCallback
<
FileInfo[]
>
| 是 | 异步获取文件的信息之后的回调 |
-
异常
-
异常
...
@@ -218,8 +217,7 @@ createFile(dev : DevInfo, filename: string, path : string, callback : AsyncCallb
...
@@ -218,8 +217,7 @@ createFile(dev : DevInfo, filename: string, path : string, callback : AsyncCallb
let
media_path
=
file
.
uri
let
media_path
=
file
.
uri
// 待保存文件的后缀
// 待保存文件的后缀
let
name
=
"
xxx.jpg
"
let
name
=
"
xxx.jpg
"
let
dev
=
{
name
:
"
local
"
};
filemanager
.
createFile
(
media_path
,
name
,
(
err
,
uri
)
=>
{
filemanager
.
createFile
(
dev
,
name
,
media_path
,
(
err
,
uri
)
=>
{
// 返回uri给应用
// 返回uri给应用
})
})
```
```
...
@@ -228,14 +226,14 @@ filemanager.createFile(dev, name, media_path, (err, uri) => {
...
@@ -228,14 +226,14 @@ filemanager.createFile(dev, name, media_path, (err, uri) => {
文件信息类型,通过getRoot, listFile等接口返回的类型。
文件信息类型,通过getRoot, listFile等接口返回的类型。
### 属性
### 属性
| 参数名 | 类型 | 可读 | 可写 | 说明 |
| 参数名 | 类型 | 可读 | 可写 | 说明 |
| --- | -- | -- | -- | -- |
| --- | -- | -- | -- | -- |
| name | string | 是 | 否 | 文件名称 |
| name | string | 是 | 否 | 文件名称 |
| path | string | 是 | 否 | 文件Uri |
| path | string | 是 | 否 | 文件Uri |
| type | string | 是 | 否 | 文件类型 |
| type | string | 是 | 否 | 文件类型 |
| size | number | 是 | 否 | 文件大小 |
| size | number | 是 | 否 | 文件大小 |
| added_t
ime | number | 是 | 否 | 媒体插入时间 |
| addedT
ime | number | 是 | 否 | 媒体插入时间 |
| modified_t
ime | number | 是 | 否 | 媒体修改时间 |
| modifiedT
ime | number | 是 | 否 | 媒体修改时间 |
## DevInfo
## DevInfo
设备类型,配置接口访问的设备类型。
设备类型,配置接口访问的设备类型。
...
...
编辑
预览
Markdown
is supported
0%
请重试
或
添加新附件
.
添加附件
取消
You are about to add
0
people
to the discussion. Proceed with caution.
先完成此消息的编辑!
取消
想要评论请
注册
或
登录