Skip to content
体验新版
项目
组织
正在加载...
登录
切换导航
打开侧边栏
OpenHarmony
Docs
提交
8b82f221
D
Docs
项目概览
OpenHarmony
/
Docs
大约 2 年 前同步成功
通知
161
Star
293
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看板
未验证
提交
8b82f221
编写于
3月 29, 2022
作者:
O
openharmony_ci
提交者:
Gitee
3月 29, 2022
浏览文件
操作
浏览文件
下载
差异文件
!2718 delete api9
Merge pull request !2718 from zhangxingxia/OpenHarmony-3.1-Release
上级
84b83d7a
4c88bd39
变更
5
隐藏空白更改
内联
并排
Showing
5 changed file
with
104 addition
and
347 deletion
+104
-347
zh-cn/application-dev/reference/apis/Readme-CN.md
zh-cn/application-dev/reference/apis/Readme-CN.md
+0
-1
zh-cn/application-dev/reference/apis/js-apis-fileio.md
zh-cn/application-dev/reference/apis/js-apis-fileio.md
+13
-13
zh-cn/application-dev/reference/apis/js-apis-filemanager.md
zh-cn/application-dev/reference/apis/js-apis-filemanager.md
+91
-85
zh-cn/application-dev/reference/apis/js-apis-storage-statistics.md
...lication-dev/reference/apis/js-apis-storage-statistics.md
+0
-69
zh-cn/application-dev/reference/apis/js-apis-volumemanager.md
...n/application-dev/reference/apis/js-apis-volumemanager.md
+0
-179
未找到文件。
zh-cn/application-dev/reference/apis/Readme-CN.md
浏览文件 @
8b82f221
...
@@ -111,7 +111,6 @@
...
@@ -111,7 +111,6 @@
-
[
@ohos.fileManager (公共文件访问与管理)
](
js-apis-filemanager.md
)
-
[
@ohos.fileManager (公共文件访问与管理)
](
js-apis-filemanager.md
)
-
[
@ohos.statfs (statfs)
](
js-apis-statfs.md
)
-
[
@ohos.statfs (statfs)
](
js-apis-statfs.md
)
-
[
@ohos.storageStatistics (应用空间统计)
](
js-apis-storage-statistics.md
)
-
[
@ohos.storageStatistics (应用空间统计)
](
js-apis-storage-statistics.md
)
-
[
@ohos.volumeManager (卷管理)
](
js-apis-volumemanager.md
)
-
电话服务
-
电话服务
-
[
@ohos.contact (联系人)
](
js-apis-contact.md
)
-
[
@ohos.contact (联系人)
](
js-apis-contact.md
)
...
...
zh-cn/application-dev/reference/apis/js-apis-fileio.md
浏览文件 @
8b82f221
...
@@ -1376,9 +1376,9 @@ readTextSync(filePath: string, options?: {
...
@@ -1376,9 +1376,9 @@ readTextSync(filePath: string, options?: {
| options | Object | 否 | 支持如下选项:
<br/>
-
position,number类型,表示期望读取文件的位置。可选,默认从当前位置开始读取。
<br/>
-
length,number类型,表示期望读取数据的长度。可选,默认缓冲区长度减去偏移长度。
<br/>
-
encoding,string类型,当数据是
string
类型时有效,表示数据的编码方式,默认
'utf-8',仅支持
'utf-8'。 |
| options | Object | 否 | 支持如下选项:
<br/>
-
position,number类型,表示期望读取文件的位置。可选,默认从当前位置开始读取。
<br/>
-
length,number类型,表示期望读取数据的长度。可选,默认缓冲区长度减去偏移长度。
<br/>
-
encoding,string类型,当数据是
string
类型时有效,表示数据的编码方式,默认
'utf-8',仅支持
'utf-8'。 |
-
返回值:
-
返回值:
| 类型
| 说明
|
| 类型
| 说明
|
| ------
--------------- |
---------- |
| ------
| ----------
---------- |
|
Promise
<
string
>
| 返回读取文件的内容。 |
|
string
| 返回读取文件的内容。 |
-
示例:
-
示例:
```
js
```
js
...
@@ -1532,10 +1532,10 @@ rename(oldPath: string, newPath: string): Promise<void>
...
@@ -1532,10 +1532,10 @@ rename(oldPath: string, newPath: string): Promise<void>
**系统能力**
:SystemCapability.FileManagement.File.FileIO
**系统能力**
:SystemCapability.FileManagement.File.FileIO
-
参数:
-
参数:
| 参数名
| 类型 | 必填 | 说明
|
| 参数名
| 类型 | 必填 | 说明
|
| ------- | ------ | ---- | ------------ |
| ------- | ------ | ---- | ------------
------------
|
| oldPath | string | 是
| 目标文件的当前绝对路径。 |
| oldPath | string | 是 | 目标文件的当前绝对路径。 |
|
Newpath | String | 是 | 目标文件的新绝对路径。
|
|
newPath | String | 是 | 目标文件的新绝对路径。
|
-
返回值:
-
返回值:
| 类型 | 说明 |
| 类型 | 说明 |
...
@@ -1544,7 +1544,7 @@ rename(oldPath: string, newPath: string): Promise<void>
...
@@ -1544,7 +1544,7 @@ rename(oldPath: string, newPath: string): Promise<void>
-
示例:
-
示例:
```
js
```
js
fileio
.
rename
(
oldPath
,
Newp
ath
).
then
(
function
()
{
fileio
.
rename
(
oldPath
,
newP
ath
).
then
(
function
()
{
console
.
info
(
"
rename successfully
"
);
console
.
info
(
"
rename successfully
"
);
}).
catch
(
function
(
err
){
}).
catch
(
function
(
err
){
console
.
info
(
"
rename failed with error:
"
+
err
);
console
.
info
(
"
rename failed with error:
"
+
err
);
...
@@ -1563,13 +1563,13 @@ rename(oldPath: string, newPath: string, callback: AsyncCallback<void>): v
...
@@ -1563,13 +1563,13 @@ rename(oldPath: string, newPath: string, callback: AsyncCallback<void>): v
-
参数:
-
参数:
| 参数名 | 类型 | 必填 | 说明 |
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ------------------------- | ---- | ------------- |
| -------- | ------------------------- | ---- | ------------- |
| old
p
ath | string | 是 | 目标文件的当前绝对路径。 |
| old
P
ath | string | 是 | 目标文件的当前绝对路径。 |
|
Newp
ath | String | 是 | 目标文件的新绝对路径。 |
|
newP
ath | String | 是 | 目标文件的新绝对路径。 |
| Callback | AsyncCallback
<
void
>
| 是 | 异步重命名文件之后的回调。 |
| Callback | AsyncCallback
<
void
>
| 是 | 异步重命名文件之后的回调。 |
-
示例:
-
示例:
```
js
```
js
fileio
.
rename
(
old
path
,
Newp
ath
,
function
(
err
){
fileio
.
rename
(
old
Path
,
newP
ath
,
function
(
err
){
});
});
```
```
...
@@ -1586,11 +1586,11 @@ renameSync(oldPath: string, newPath: string): void
...
@@ -1586,11 +1586,11 @@ renameSync(oldPath: string, newPath: string): void
| 参数名 | 类型 | 必填 | 说明 |
| 参数名 | 类型 | 必填 | 说明 |
| ------- | ------ | ---- | ------------ |
| ------- | ------ | ---- | ------------ |
| oldPath | string | 是 | 目标文件的当前绝对路径。 |
| oldPath | string | 是 | 目标文件的当前绝对路径。 |
|
Newp
ath | String | 是 | 目标文件的新绝对路径。 |
|
newP
ath | String | 是 | 目标文件的新绝对路径。 |
-
示例:
-
示例:
```
js
```
js
fileio
.
renameSync
(
old
path
,
newp
ath
);
fileio
.
renameSync
(
old
Path
,
newP
ath
);
```
```
...
...
zh-cn/application-dev/reference/apis/js-apis-filemanager.md
浏览文件 @
8b82f221
...
@@ -21,7 +21,7 @@ getRoot(options? : {dev? : DevInfo}) : Promise<FileInfo[]>
...
@@ -21,7 +21,7 @@ getRoot(options? : {dev? : DevInfo}) : Promise<FileInfo[]>
-
参数
-
参数
| 参数名 | 类型 | 必填 | 说明 |
| 参数名 | 类型 | 必填 | 说明 |
| --- | --- | --- | -- |
| --- | --- | --- | -- |
|
dev |
[
DevInfo
](
#devinfo
)
| 否 | 设备名, 不填为默认值
dev = {name: "local"}, 当前仅支持设备'local' |
|
options | Object | 否 | 支持如下选项:
<br/>
-
dev,
[
DevInfo
](
#devinfo
)
类型,不填默认
dev = {name: "local"}, 当前仅支持设备'local' |
-
返回值
-
返回值
...
@@ -31,17 +31,17 @@ getRoot(options? : {dev? : DevInfo}) : Promise<FileInfo[]>
...
@@ -31,17 +31,17 @@ getRoot(options? : {dev? : DevInfo}) : Promise<FileInfo[]>
-
示例
-
示例
```
js
```
js
filemanager
.
getRoot
().
then
((
fileInfo
)
=>
{
filemanager
.
getRoot
().
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
++
)
{
console
.
log
(
JSON
.
Stringify
(
fileInfo
))
console
.
log
(
JSON
.
Stringify
(
fileInfo
))
}
}
}
}
}).
catch
((
err
)
=>
{
}).
catch
((
err
)
=>
{
console
.
log
(
err
)
console
.
log
(
err
)
});
});
```
```
## filemanager.getRoot
## filemanager.getRoot
...
@@ -55,20 +55,20 @@ getRoot(options? : {dev? : DevInfo}, callback : AsyncCallback<FileInfo[]>)
...
@@ -55,20 +55,20 @@ getRoot(options? : {dev? : DevInfo}, callback : AsyncCallback<FileInfo[]>)
| 参数名 | 类型 | 必填 | 说明 |
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ------------------------- | ---- | ----------------------------- |
| -------- | ------------------------- | ---- | ----------------------------- |
|
dev |
[
DevInfo
](
#devinfo
)
| 否 | 设备名, 不填为默认值
dev = {name: "local"}, 当前仅支持设备'local' |
|
options | Object | 否 | 支持如下选项:
<br/>
-
dev,
[
DevInfo
](
#devinfo
)
类型,不填默认
dev = {name: "local"}, 当前仅支持设备'local' |
| callback | AsyncCallback
<
[FileInfo](#fileinfo)[]
>
| 是 | 异步获取文件的信息之后的回调 |
| callback | AsyncCallback
<
[FileInfo](#fileinfo)[]
>
| 是 | 异步获取文件的信息之后的回调 |
-
示例
-
示例
```
js
```
js
filemanager
.
getRoot
((
err
,
fileInfo
)
=>
{
filemanager
.
getRoot
((
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
))
}
}
}
}
})
});
```
```
## filemanager.listFile
## filemanager.listFile
...
@@ -81,12 +81,10 @@ listFile(path : string, type : string, options? : {dev? : DevInfo, offset? : num
...
@@ -81,12 +81,10 @@ listFile(path : string, type : string, options? : {dev? : DevInfo, offset? : num
-
参数
-
参数
| 参数名 | 类型 | 必填 | 说明 |
| 参数名 | 类型 | 必填 | 说明 |
| --- | --- | --- | -- |
| --- | --- | --- | -- |
| type | string | 是 | 待查询文件类型, 支持以下类型 "file", "image", "audio", "video" |
| path | string | 是 | 待查询目录uri |
| path | string | 是 | 待查询目录uri |
| dev |
[
DevInfo
](
#devinfo
)
| 是 | 设备名, 不填为默认值dev = {name: "local"}, 当前仅支持设备'local' |
| type | string | 是 | 待查询文件类型, 支持以下类型 "file", "image", "audio", "video" |
| offset | number | 否 | 待查询文件偏移 |
| options | Object | 否 | 支持如下选项:
<br/>
-
dev,
[
DevInfo
](
#devinfo
)
类型,不填默认dev = {name: "local"}, 当前仅支持设备'local'。
<br/>
-
offset,number类型,待查询文件偏移个数。
<br/>
-
count,number类型,待查询文件个数。 |
| count | number | 否 | 待查询文件个数 |
-
返回值
-
返回值
| 类型 | 说明 |
| 类型 | 说明 |
...
@@ -100,21 +98,24 @@ listFile(path : string, type : string, options? : {dev? : DevInfo, offset? : num
...
@@ -100,21 +98,24 @@ listFile(path : string, type : string, options? : {dev? : DevInfo, offset? : num
| 获取FMS服务失败 | No such process | 3 | 获取FMS服务失败 |
| 获取FMS服务失败 | No such process | 3 | 获取FMS服务失败 |
| path对应uri不是相册、目录 | Not a directory | 20 | path对应uri不是相册、目录 |
| path对应uri不是相册、目录 | Not a directory | 20 | path对应uri不是相册、目录 |
```
js
-
示例
// 获取目录下所有文件
// 通过listFile、getRoot获取的文件uri
```
js
let
media_path
=
file
.
uri
// 获取目录下所有文件
filemanager
.
listFile
(
media_path
,
"
file
"
)
// 通过listFile、getRoot获取的文件uri
.
then
((
fileInfo
)
=>
{
let
media_path
=
file
.
uri
if
(
Array
.
isArray
(
fileInfo
))
{
filemanager
.
listFile
(
media_path
,
"
file
"
)
for
(
var
i
=
0
;
i
<
fileInfo
.
length
;
i
++
)
{
.
then
((
fileInfo
)
=>
{
console
.
log
(
JSON
.
Stringify
(
fileInfo
))
if
(
Array
.
isArray
(
fileInfo
))
{
}
for
(
var
i
=
0
;
i
<
fileInfo
.
length
;
i
++
)
{
}
console
.
log
(
JSON
.
Stringify
(
fileInfo
))
}).
catch
((
err
)
=>
{
}
console
.
log
(
err
)
}
})
}).
catch
((
err
)
=>
{
```
console
.
log
(
err
)
});
```
## filemanager.listFile
## filemanager.listFile
listFile(path : string, type : string, options? : {dev? : DevInfo, offset? : number, count? : number}, callback : AsyncCallback
<
FileInfo[]
>
) : void
listFile(path : string, type : string, options? : {dev? : DevInfo, offset? : number, count? : number}, callback : AsyncCallback
<
FileInfo[]
>
) : void
...
@@ -127,11 +128,9 @@ listFile(path : string, type : string, options? : {dev? : DevInfo, offset? : num
...
@@ -127,11 +128,9 @@ listFile(path : string, type : string, options? : {dev? : DevInfo, offset? : num
| 参数名 | 类型 | 必填 | 说明 |
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ------------------------- | ---- | ------------------------------------------------------------ |
| -------- | ------------------------- | ---- | ------------------------------------------------------------ |
| type | string | 是 | 待查询文件类型, 支持以下类型 "file", "image", "audio", "video" |
| path | string | 是 | 待查询目录uri |
| path | string | 是 | 待查询目录uri |
| dev |
[
DevInfo
](
#devinfo
)
| 否 | 设备名, 不填为默认值dev = {name: "local"}, 当前仅支持设备'local' |
| type | string | 是 | 待查询文件类型, 支持以下类型 "file", "image", "audio", "video" |
| offset | number | 否 | 待查询文件偏移 |
| options | Object | 否 | 支持如下选项:
<br/>
-
dev,
[
DevInfo
](
#devinfo
)
类型,不填默认dev = {name: "local"}, 当前仅支持设备'local'。
<br/>
-
offset,number类型,待查询文件偏移个数。
<br/>
-
count,number类型,待查询文件个数。 |
| count | number | 否 | 待查询文件个数 |
| callback | AsyncCallback
<
[FileInfo](#fileinfo)[]
>
| 是 | 异步获取文件的信息之后的回调 |
| callback | AsyncCallback
<
[FileInfo](#fileinfo)[]
>
| 是 | 异步获取文件的信息之后的回调 |
-
异常
-
异常
...
@@ -141,21 +140,23 @@ listFile(path : string, type : string, options? : {dev? : DevInfo, offset? : num
...
@@ -141,21 +140,23 @@ listFile(path : string, type : string, options? : {dev? : DevInfo, offset? : num
| 获取FMS服务失败 | No such process | 3 | 获取FMS服务失败 |
| 获取FMS服务失败 | No such process | 3 | 获取FMS服务失败 |
| path对应uri不是相册、目录 | Not a directory | 20 | path对应uri不是相册、目录 |
| path对应uri不是相册、目录 | Not a directory | 20 | path对应uri不是相册、目录 |
```
js
-
示例
// 通过listFile、getRoot获取的文件uri
let
media_path
=
file
.
uri
```
js
filemanager
.
listFile
(
media_path
,
"
file
"
,
(
err
,
fileInfo
)
=>
{
// 通过listFile、getRoot获取的文件uri
if
(
Array
.
isArray
(
fileInfo
))
{
let
media_path
=
file
.
uri
for
(
var
i
=
0
;
i
<
fileInfo
.
length
;
i
++
)
{
filemanager
.
listFile
(
media_path
,
"
file
"
,
(
err
,
fileInfo
)
=>
{
console
.
log
(
JSON
.
Stringify
(
fileInfo
))
if
(
Array
.
isArray
(
fileInfo
))
{
}
for
(
var
i
=
0
;
i
<
fileInfo
.
length
;
i
++
)
{
}
console
.
log
(
JSON
.
Stringify
(
fileInfo
))
})
}
```
}
});
```
## filemanager.createFile
## filemanager.createFile
filemanager.createFile(path : string, filename : string, options? : {dev? : DevInfo}) :
p
romise
<
string
>
filemanager.createFile(path : string, filename : string, options? : {dev? : DevInfo}) :
P
romise
<
string
>
以异步方法创建文件到指定路径,返回文件uri。使用promise形式返回结果。
以异步方法创建文件到指定路径,返回文件uri。使用promise形式返回结果。
...
@@ -166,7 +167,7 @@ filemanager.createFile(path : string, filename : string, options? : {dev? : DevI
...
@@ -166,7 +167,7 @@ filemanager.createFile(path : string, filename : string, options? : {dev? : DevI
| --- | --- | --- | -- |
| --- | --- | --- | -- |
| filename | string | 是 | 待创建的文件名 |
| filename | string | 是 | 待创建的文件名 |
| path | string | 是 | 待保存目的相册uri |
| path | string | 是 | 待保存目的相册uri |
|
dev |
[
DevInfo
](
#devinfo
)
| 否 | 设备名, 不填为默认值
dev = {name: "local"}, 当前仅支持设备'local' |
|
options | Object | 否 | 支持如下选项:
<br/>
-
dev,
[
DevInfo
](
#devinfo
)
类型,不填默认
dev = {name: "local"}, 当前仅支持设备'local' |
-
返回值
-
返回值
...
@@ -182,18 +183,20 @@ filemanager.createFile(path : string, filename : string, options? : {dev? : DevI
...
@@ -182,18 +183,20 @@ filemanager.createFile(path : string, filename : string, options? : {dev? : DevI
| 获取FMS服务失败 | No such process | 3 | 获取FMS服务失败 |
| 获取FMS服务失败 | No such process | 3 | 获取FMS服务失败 |
| path对应uri不是相册、目录 | Not a directory | 20 | path对应uri不是相册、目录 |
| path对应uri不是相册、目录 | Not a directory | 20 | path对应uri不是相册、目录 |
```
js
-
示例
// 创建文件,返回文件uri
let
media_path
=
file
.
uri
// 通过listFile、getRoot获取的文件uri
```
js
let
name
=
"
xxx.jpg
"
// 待保存文件的后缀
// 创建文件,返回文件uri
filemanager
.
createFile
(
media_path
,
name
)
let
media_path
=
file
.
uri
// 通过listFile、getRoot获取的文件uri
.
then
((
uri
)
=>
{
let
name
=
"
xxx.jpg
"
// 待保存文件的后缀
// 返回uri给应用
filemanager
.
createFile
(
media_path
,
name
)
})
.
then
((
uri
)
=>
{
.
catch
((
err
)
=>
{
// 返回uri给应用
console
.
log
(
err
)
})
})
.
catch
((
err
)
=>
{
```
console
.
log
(
err
)
});
```
## filemanager.createFile
## filemanager.createFile
...
@@ -209,7 +212,7 @@ createFile(path : string, filename: string, options? : {dev? : DevInfo}, callbac
...
@@ -209,7 +212,7 @@ createFile(path : string, filename: string, options? : {dev? : DevInfo}, callbac
| -------- | ------------------------- | ---- | ----------------------------- |
| -------- | ------------------------- | ---- | ----------------------------- |
| filename | string | 是 | 待创建的文件名 |
| filename | string | 是 | 待创建的文件名 |
| path | string | 是 | 待保存目的相册uri |
| path | string | 是 | 待保存目的相册uri |
|
dev |
[
DevInfo
](
#devinfo
)
| 否 | 设备名, 不填为默认值
dev = {name: "local"}, 当前仅支持设备'local' |
|
options | Object | 否 | 支持如下选项:
<br/>
-
dev,
[
DevInfo
](
#devinfo
)
类型,不填默认
dev = {name: "local"}, 当前仅支持设备'local' |
| callback | AsyncCallback
<
[FileInfo](#fileinfo)[]
>
| 是 | 异步获取文件的信息之后的回调 |
| callback | AsyncCallback
<
[FileInfo](#fileinfo)[]
>
| 是 | 异步获取文件的信息之后的回调 |
-
异常
-
异常
...
@@ -221,16 +224,18 @@ createFile(path : string, filename: string, options? : {dev? : DevInfo}, callbac
...
@@ -221,16 +224,18 @@ createFile(path : string, filename: string, options? : {dev? : DevInfo}, callbac
| 获取FMS服务失败 | No such process | 3 | 获取FMS服务失败 |
| 获取FMS服务失败 | No such process | 3 | 获取FMS服务失败 |
| path对应uri不是相册、目录 | Not a directory | 20 | path对应uri不是相册、目录 |
| path对应uri不是相册、目录 | Not a directory | 20 | path对应uri不是相册、目录 |
```
js
-
示例
// 创建文件,返回文件uri
// 通过listFile、getRoot获取的文件uri
```
js
let
media_path
=
file
.
uri
// 创建文件,返回文件uri
// 待保存文件的后缀
// 通过listFile、getRoot获取的文件uri
let
name
=
"
xxx.jpg
"
let
media_path
=
file
.
uri
filemanager
.
createFile
(
media_path
,
name
,
(
err
,
uri
)
=>
{
// 待保存文件的后缀
// 返回uri给应用
let
name
=
"
xxx.jpg
"
})
filemanager
.
createFile
(
media_path
,
name
,
(
err
,
uri
)
=>
{
```
// 返回uri给应用
});
```
## FileInfo
## FileInfo
文件信息类型,通过getRoot, listFile等接口返回的类型。
文件信息类型,通过getRoot, listFile等接口返回的类型。
...
@@ -249,12 +254,13 @@ filemanager.createFile(media_path, name, (err, uri) => {
...
@@ -249,12 +254,13 @@ filemanager.createFile(media_path, name, (err, uri) => {
| modifiedTime | number | 是 | 否 | 媒体修改时间 |
| modifiedTime | number | 是 | 否 | 媒体修改时间 |
## DevInfo
## DevInfo
设备类型,配置接口访问的设备类型。
设备类型,配置接口访问的设备类型。
**系统能力**
:以下各项对应的系统能力均为SystemCapability.FileManagement.FileManagerService。
**系统能力**
:以下各项对应的系统能力均为SystemCapability.FileManagement.FileManagerService。
### 属性
### 属性
| 参数名 | 类型 | 可读 | 可写 | 说明 |
| 参数名 | 类型 | 可读 | 可写 | 说明 |
| --- | -- | -- | -- | -- |
| ------ | ------ | ---- | ---- | -------- |
| name | string | 是 | 是 | 设备名称 |
| name | string | 是 | 是 | 设备名称 |
\ No newline at end of file
\ No newline at end of file
zh-cn/application-dev/reference/apis/js-apis-storage-statistics.md
浏览文件 @
8b82f221
...
@@ -67,7 +67,6 @@ getTotalSizeOfVolume(volumeUuid: string, callback:AsyncCallback<number>):v
...
@@ -67,7 +67,6 @@ getTotalSizeOfVolume(volumeUuid: string, callback:AsyncCallback<number>):v
});
});
```
```
## storagestatistics.getFreeSizeOfVolume
## storagestatistics.getFreeSizeOfVolume
...
@@ -125,71 +124,3 @@ getFreeSizeOfVolume(volumeUuid: string, callback:AsyncCallback<number>):vo
...
@@ -125,71 +124,3 @@ getFreeSizeOfVolume(volumeUuid: string, callback:AsyncCallback<number>):vo
console
.
info
(
"
getFreeSizeOfVolume successfully:
"
+
number
);
console
.
info
(
"
getFreeSizeOfVolume successfully:
"
+
number
);
});
});
```
```
## storagestatistics.getBundleStats<sup>9+</sup>
getBundleStats(packageName: string): Promise
<
BundleStats
>
异步获取应用存储状态,以promise方式返回。
**系统能力**
:SystemCapability.FileManagement.StorageService.SpatialStatistics
-
参数
| 参数名 | 类型 | 必填 | 说明 |
| ----------- | ------ | ---- | -------- |
| packageName | string | 是 | 应用包名 |
-
返回值
| 类型 | 说明 |
| ------------------------------------------ | -------------------------- |
| Promise
<
[Bundlestats](#bundlestats)
>
| 返回指定卷上的应用存储状态 |
-
示例
```
js
let
packageName
=
""
;
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>
getBundleStats(packageName: string, callback: AsyncCallback
<
BundleStats
>
): void
异步获取应用存储状态,以callback方式返回。
**系统能力**
:SystemCapability.FileManagement.StorageService.SpatialStatistics
-
参数
| 参数名 | 类型 | 必填 | 说明 |
| -------- | --------------------------------------------------------- | ---- | ------------------------------------ |
| packageName | string | 是 | 应用包名 |
| callback | callback:AsyncCallback
<
[Bundlestats](#bundlestats)
>
| 是 | 获取指定卷上的应用存储状态之后的回调 |
-
示例
```
js
let
packageName
=
""
;
storagestatistics
.
getBundleStats
(
packageName
,
function
(
error
,
BundleStats
){
// do something
console
.
info
(
"
getBundleStats successfully:
"
+
JSON
.
stringify
(
BundleStats
));
});
```
## BundleStats<sup>9+</sup>
**系统能力**
:以下各项对应的系统能力均为SystemCapability.FileManagement.StorageService.SpatialStatistics。
### 属性
| 名称 | 类型 | 说明 |
| --------- | ------ | -------------- |
| appSize
<sup>
9+
</sup>
| number | app数据大小 |
| cacheSize
<sup>
9+
</sup>
| number | 缓存数据大小 |
| dataSize
<sup>
9+
</sup>
| number | 应用总数据大小 |
\ No newline at end of file
zh-cn/application-dev/reference/apis/js-apis-volumemanager.md
已删除
100644 → 0
浏览文件 @
84b83d7a
# 卷管理
>  **说明:**
>
> - 本模块首批接口从API version 8开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。
> - 此接口为系统接口,三方应用不支持调用。
## 导入模块
```
js
import
volumemanager
from
"
@ohos.volumeManager
"
;
```
## volumemanager.getAllVolumes<sup>9+</sup>
getAllVolumes(): Promise
<
Array
<
Volume
>>
异步获取当前所有可获得的卷信息,以promise方式返回。
**系统能力**
:SystemCapability.FileManagement.StorageService.Volume
-
返回值
| 类型 | 说明 |
| ---------------------------------- | -------------------------- |
| Promise
<
[Volume](#volume)[]
>
| 返回当前所有可获得的卷信息 |
-
示例
```
js
volumemanager
.
getAllVolumes
().
then
(
function
(
volumes
){
// do something
});
```
## volumemanager.getAllVolumes<sup>9+</sup>
getAllVolumes(callback: AsyncCallback
<
Array
<
Volume
>>
): void
异步获取当前所有可获得的卷信息,以callback方式返回。
**系统能力**
:SystemCapability.FileManagement.StorageService.Volume
-
参数
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ------------------------------------------------- | ---- | ------------------------------------ |
| callback | callback:AsyncCallback
<
[Volume](#volume)[]
>
| 是 | 获取当前所有可获得的卷信息之后的回调 |
-
示例
```
js
let
uuid
=
""
;
volumemanager
.
getAllVolumes
(
uuid
,
function
(
error
,
volumes
){
// do something
});
```
## volumemanager.mount<sup>9+</sup>
mount(volumeId: string): Promise
<
boolean
>
异步挂载指定卷,以promise方式返回。
**系统能力**
:SystemCapability.FileManagement.StorageService.Volume
-
参数
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ------ | ---- | ---- |
| volumeId | string | 是 | 卷id |
-
返回值
| 类型 | 说明 |
| ---------------------- | ---------- |
| Promise
<
boolean
>
| 挂载指定卷 |
-
示例
```
js
let
volumeId
=
""
;
volumemanager
.
mount
(
volumeId
).
then
(
function
(
flag
){
// do something
});
```
## volumemanager.mount<sup>9+</sup>
mount(volumeId: string, callback:AsyncCallback
<
boolean
>
):void
异步获取指定卷的可用空间大小,以callback方式返回。
**系统能力**
:SystemCapability.FileManagement.StorageService.Volume
-
参数
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ------------------------------------- | ---- | -------------------- |
| volumeId | string | 是 | 卷id |
| callback | callback:AsyncCallback
<
boolean
>
| 是 | 挂载指定卷之后的回调 |
-
示例
```
js
let
volumeId
=
""
;
volumemanager
.
mount
(
volumeId
,
function
(
error
,
flag
){
// do something
});
```
## volumemanager.unmount<sup>9+</sup>
unmount(volumeId: string): Promise
<
boolean
>
异步卸载指定卷,以promise方式返回。
**系统能力**
:SystemCapability.FileManagement.StorageService.Volume
-
参数
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ------ | ---- | ---- |
| volumeId | string | 是 | 卷id |
-
返回值
| 类型 | 说明 |
| ---------------------- | ---------- |
| Promise
<
boolean
>
| 卸载指定卷 |
-
示例
```
js
let
volumeId
=
""
;
volumemanager
.
unmount
(
volumeId
).
then
(
function
(
flag
){
// do something
});
```
## volumemanager.unmount<sup>9+</sup>
unmount(volumeId: string, callback:AsyncCallback
<
boolean
>
):void
异步卸载指定卷,以callback方式返回。
**系统能力**
:SystemCapability.FileManagement.StorageService.Volume
-
参数
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ------------------------------------- | ---- | -------------------- |
| volumeId | string | 是 | 卷id |
| callback | callback:AsyncCallback
<
boolean
>
| 是 | 卸载指定卷之后的回调 |
-
示例
```
js
let
volumeId
=
""
;
volumemanager
.
unmount
(
volumeId
,
function
(
error
,
flag
){
// do something
});
```
## Volume<sup>9+</sup>
**系统能力**
:以下各项对应的系统能力均为SystemCapability.FileManagement.StorageService.Volume。
### 属性
| 名称 | 类型 | 说明 |
| ----------- | ------- | -------------------- |
| id
<sup>
9+
</sup>
| number | 卷id |
| uuid
<sup>
9+
</sup>
| string | 卷uuid |
| description
<sup>
9+
</sup>
| string | 卷相关描述 |
| removable
<sup>
9+
</sup>
| boolean | 是否为可移动存储设备 |
| state
<sup>
9+
</sup>
| int | 当前卷状态 |
| path
<sup>
9+
</sup>
| string | 卷的挂载地址 |
\ No newline at end of file
编辑
预览
Markdown
is supported
0%
请重试
或
添加新附件
.
添加附件
取消
You are about to add
0
people
to the discussion. Proceed with caution.
先完成此消息的编辑!
取消
想要评论请
注册
或
登录