提交 f019553e 编写于 作者: 张文迪

fix storage service js api desc

Signed-off-by: N张文迪 <zhangwendi3@huawei.com>
上级 b6b238d6
......@@ -34,7 +34,7 @@ getTotalSizeOfVolume(volumeUuid: string): Promise&lt;number&gt;
| 类型 | 说明 |
| --------------------- | ---------------- |
| Promise&lt;number&gt; | 返回指定卷设备的总空间大小(单位为Byte) |
| Promise&lt;number&gt; | Promise对象,返回指定卷设备的总空间大小(单位为Byte) |
**错误码:**
......@@ -124,7 +124,7 @@ getFreeSizeOfVolume(volumeUuid: string): Promise&lt;number&gt;
| 类型 | 说明 |
| --------------------- | ------------------ |
| Promise&lt;number&gt; | 返回指定卷的可用空间大小(单位为Byte) |
| Promise&lt;number&gt; | Promise对象,返回指定卷的可用空间大小(单位为Byte) |
**错误码:**
......@@ -215,7 +215,7 @@ getBundleStats(packageName: string): Promise&lt;BundleStats&gt;
| 类型 | 说明 |
| ------------------------------------------ | -------------------------- |
| Promise&lt;[Bundlestats](#bundlestats9)&gt; | 返回指定卷上的应用存储数据(单位为Byte) |
| Promise&lt;[Bundlestats](#bundlestats9)&gt; | Promise对象,返回指定卷上的应用存储数据(单位为Byte) |
**错误码:**
......@@ -295,7 +295,7 @@ getCurrentBundleStats(): Promise&lt;BundleStats&gt;
| 类型 | 说明 |
| ------------------------------------------ | -------------------------- |
| Promise&lt;[Bundlestats](#bundlestats9)&gt; | 返回指定卷上的应用存空间大小(单位为Byte) |
| Promise&lt;[Bundlestats](#bundlestats9)&gt; | Promise对象,返回指定卷上的应用存空间大小(单位为Byte) |
**错误码:**
......@@ -373,7 +373,7 @@ getTotalSize(): Promise&lt;number&gt;
| 类型 | 说明 |
| --------------------- | ------------------ |
| Promise&lt;number&gt; | 返回内置存储的总空间大小(单位为Byte) |
| Promise&lt;number&gt; | Promise对象,返回内置存储的总空间大小(单位为Byte) |
**错误码:**
......@@ -449,7 +449,7 @@ getFreeSize(): Promise&lt;number&gt;
| 类型 | 说明 |
| --------------------- | ------------------ |
| Promise&lt;number&gt; | 返回内置存储的可用空间大小(单位为Byte) |
| Promise&lt;number&gt; | Promise对象,返回内置存储的可用空间大小(单位为Byte) |
**错误码:**
......@@ -525,7 +525,7 @@ getSystemSize(): Promise&lt;number&gt;
| 类型 | 说明 |
| --------------------- | ---------------- |
| Promise&lt;number&gt; | 返回系统数据的空间大小(单位为Byte) |
| Promise&lt;number&gt; | Promise对象,返回系统数据的空间大小(单位为Byte) |
**错误码:**
......@@ -604,7 +604,7 @@ getUserStorageStats(): Promise&lt;StorageStats&gt;
| 类型 | 说明 |
| --------------------- | ---------------- |
| Promise&lt;[StorageStats](#storagestats9)&gt; | 返回当前用户各类别存储空间大小(单位为Byte) |
| Promise&lt;[StorageStats](#storagestats9)&gt; | Promise对象,返回当前用户各类别存储空间大小(单位为Byte) |
**错误码:**
......@@ -689,7 +689,7 @@ getUserStorageStats(userId: number): Promise&lt;StorageStats&gt;
| 类型 | 说明 |
| --------------------- | ---------------- |
| Promise&lt;[StorageStats](#storagestats9)&gt; | 返回指定用户各类别存储空间大小(单位为Byte) |
| Promise&lt;[StorageStats](#storagestats9)&gt; | Promise对象,返回指定用户各类别存储空间大小(单位为Byte) |
**错误码:**
......
......@@ -27,7 +27,7 @@ getAllVolumes(): Promise&lt;Array&lt;Volume&gt;&gt;
| 类型 | 说明 |
| ---------------------------------- | -------------------------- |
| Promise&lt;[Volume](#volume)[]&gt; | 返回当前所有可获得的卷设备信息 |
| Promise&lt;[Volume](#volume)[]&gt; | Promise对象,返回当前所有可获得的卷设备信息 |
**错误码:**
......@@ -92,7 +92,7 @@ getAllVolumes(callback: AsyncCallback&lt;Array&lt;Volume&gt;&gt;): void
mount(volumeId: string): Promise&lt;void&gt;
异步挂载指定卷设备,以promise方式返回。当前仅支持fat、exfat以及ntfs三中文件系统的卷设备挂载。
异步挂载指定卷设备,以promise方式返回。当前仅支持vfat、exfat以及ntfs三种文件系统的卷设备挂载。
**需要权限**:ohos.permission.MOUNT_UNMOUNT_MANAGER
......@@ -108,7 +108,7 @@ mount(volumeId: string): Promise&lt;void&gt;
| 类型 | 说明 |
| ---------------------- | ---------- |
| Promise&lt;void&gt; | 挂载指定卷设备 |
| Promise&lt;void&gt; | 无返回结果的Promise对象 |
**错误码:**
......@@ -141,7 +141,7 @@ mount(volumeId: string): Promise&lt;void&gt;
mount(volumeId: string, callback:AsyncCallback&lt;void&gt;):void
异步挂载指定卷设备,以callback方式返回。当前仅支持fat、exfat以及ntfs三中文件系统的卷设备挂载。
异步挂载指定卷设备,以callback方式返回。当前仅支持vfat、exfat以及ntfs三种文件系统的卷设备挂载。
**需要权限**:ohos.permission.MOUNT_UNMOUNT_MANAGER
......@@ -199,7 +199,7 @@ unmount(volumeId: string): Promise&lt;void&gt;
| 类型 | 说明 |
| ---------------------- | ---------- |
| Promise&lt;void&gt; | 卸载指定卷设备 |
| Promise&lt;void&gt; | 无返回结果的Promise对象 |
**错误码:**
......@@ -290,7 +290,7 @@ getVolumeByUuid(uuid: string): Promise&lt;Volume&gt;
| 类型 | 说明 |
| ---------------------------------- | -------------------------- |
| Promise&lt;[Volume](#volume)&gt; | 返回当前所有可获得的卷设备信息 |
| Promise&lt;[Volume](#volume)&gt; | Promise对象,返回当前所有可获得的卷设备信息 |
**错误码:**
......@@ -375,7 +375,7 @@ getVolumeById(volumeId: string): Promise&lt;Volume&gt;
| 类型 | 说明 |
| ---------------------------------- | -------------------------- |
| Promise&lt;[Volume](#volume)&gt; | 返回当前所有可获得的卷设备信息 |
| Promise&lt;[Volume](#volume)&gt; | Promise对象,返回当前所有可获得的卷设备信息 |
**错误码:**
......@@ -461,7 +461,7 @@ setVolumeDescription(uuid: string, description: string): Promise&lt;void&gt;
| 类型 | 说明 |
| ---------------------- | -------------------------- |
| Promise&lt;void&gt; | 设置卷设备信息 |
| Promise&lt;void&gt; | 无返回结果的Promise对象 |
**错误码:**
......@@ -554,7 +554,7 @@ format(volumeId: string, fsType: string): Promise&lt;void&gt;
| 类型 | 说明 |
| ---------------------- | ---------- |
| Promise&lt;void&gt; | 对指定卷设备进行格式化 |
| Promise&lt;void&gt; | 无返回结果的Promise对象 |
**错误码:**
......@@ -647,7 +647,7 @@ partition(diskId: string, type: number): Promise&lt;void&gt;
| 类型 | 说明 |
| --------------------- | ----------------------- |
| Promise&lt;void&gt; | 对磁盘进行分区 |
| Promise&lt;void&gt; | 无返回结果的Promise对象 |
**错误码:**
......@@ -724,9 +724,9 @@ partition(diskId: string, type: number, callback: AsyncCallback&lt;void&gt;): vo
| 名称 | 类型 | 可读 | 可写 | 说明 |
| ----------- | ------- | ------- | ----- | -------------------- |
| id | string | 是 | 否 | 卷设备ID的格式为vol-{主设备号}-{次设备号},主设备号用来区分不同种类的设备,次设备号用来区分同一类型的多个设备,卷设备ID会随着插卡顺序不同而变化。 |
| uuid | string | 是 | 否 | 卷设备uuid是卷设备的通用唯一识别码,不会随着插卡顺序变化而变化,但是卷设备的格式化会改变卷设备的uuid |
| diskId | string | 是 | 否 | 卷设备所属的磁盘ID,一个磁盘可以有一个或者多个卷设备。磁盘设备ID格式为disk-{主设备号}-{次设备号},与卷设备ID相似。 |
| description | string | 是 | 否 | 卷设备描述 |
| removable | boolean | 是 | 否 | 表示卷设备是否可移除,当前仅支持可移除存储设备 |
| uuid | string | 是 | 否 | 卷设备uuid是卷设备的通用唯一识别码,不会随着插卡顺序变化而变化,但是卷设备的格式化会改变卷设备的uuid |
| diskId | string | 是 | 否 | 卷设备所属的磁盘ID,一个磁盘可以有一个或者多个卷设备。磁盘设备ID格式为disk-{主设备号}-{次设备号},与卷设备ID相似。 |
| description | string | 是 | 否 | 卷设备描述 |
| removable | boolean | 是 | 否 | 表示卷设备是否可移除,当前仅支持可移除存储设备 |
| state | number | 是 | 否 | 卷设备状态标识:<br>0:卸载状态 UNMOUNTED<br> 1:检查状态 CHECKING<br> 2:挂载状态 MOUNTED<br> 3:正在弹出状态 EJECTING |
| path | string | 是 | 否 | 卷设备的挂载地址,一般为/mnt/external/{uuid} |
\ No newline at end of file
Markdown is supported
0% .
You are about to add 0 people to the discussion. Proceed with caution.
先完成此消息的编辑!
想要评论请 注册