提交 8595a4c3 编写于 作者: 张文迪

fix docs

Signed-off-by: N张文迪 <zhangwendi3@huawei.com>
上级 d190b8de
...@@ -69,7 +69,7 @@ getTotalSizeOfVolume(volumeUuid: string, callback: AsyncCallback&lt;number&gt;): ...@@ -69,7 +69,7 @@ getTotalSizeOfVolume(volumeUuid: string, callback: AsyncCallback&lt;number&gt;):
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| ---------- | ------------------------------------ | ---- | -------------------------- | | ---------- | ------------------------------------ | ---- | -------------------------- |
| volumeUuid | string | 是 | 卷id | | volumeUuid | string | 是 | 卷id |
| callback | callback: AsyncCallback&lt;number&gt; | 是 | 获取指定卷总空间之后的回调 | | callback | AsyncCallback&lt;number&gt; | 是 | 获取指定卷总空间之后的回调 |
**示例:** **示例:**
...@@ -138,7 +138,7 @@ getFreeSizeOfVolume(volumeUuid: string, callback: AsyncCallback&lt;number&gt;): ...@@ -138,7 +138,7 @@ getFreeSizeOfVolume(volumeUuid: string, callback: AsyncCallback&lt;number&gt;):
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| ---------- | ------------------------------------ | ---- | ---------------------------- | | ---------- | ------------------------------------ | ---- | ---------------------------- |
| volumeUuid | string | 是 | 卷id | | volumeUuid | string | 是 | 卷id |
| callback | callback: AsyncCallback&lt;number&gt; | 是 | 获取指定卷可用空间之后的回调 | | callback | AsyncCallback&lt;number&gt; | 是 | 获取指定卷可用空间之后的回调 |
**示例:** **示例:**
...@@ -174,7 +174,7 @@ getBundleStats(packageName: string): Promise&lt;BundleStats&gt; ...@@ -174,7 +174,7 @@ getBundleStats(packageName: string): Promise&lt;BundleStats&gt;
| 类型 | 说明 | | 类型 | 说明 |
| ------------------------------------------ | -------------------------- | | ------------------------------------------ | -------------------------- |
| Promise&lt;[Bundlestats](#bundlestats)&gt; | 返回指定卷上的应用存储数据 | | Promise&lt;[Bundlestats](#bundlestats9)&gt; | 返回指定卷上的应用存储数据 |
**示例:** **示例:**
...@@ -206,7 +206,7 @@ getBundleStats(packageName: string, callback: AsyncCallback&lt;BundleStats&gt;) ...@@ -206,7 +206,7 @@ getBundleStats(packageName: string, callback: AsyncCallback&lt;BundleStats&gt;)
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | --------------------------------------------------------- | ---- | ------------------------------------ | | -------- | --------------------------------------------------------- | ---- | ------------------------------------ |
| packageName | string | 是 | 应用包名 | | packageName | string | 是 | 应用包名 |
| callback | callback: AsyncCallback&lt;[Bundlestats](#bundlestats)&gt; | 是 | 获取指定卷上的应用存储数据之后的回调 | | callback | AsyncCallback&lt;[Bundlestats](#bundlestats9)&gt; | 是 | 获取指定卷上的应用存储数据之后的回调 |
**示例:** **示例:**
...@@ -230,7 +230,7 @@ getCurrentBundleStats(): Promise&lt;BundleStats&gt; ...@@ -230,7 +230,7 @@ getCurrentBundleStats(): Promise&lt;BundleStats&gt;
| 类型 | 说明 | | 类型 | 说明 |
| ------------------------------------------ | -------------------------- | | ------------------------------------------ | -------------------------- |
| Promise&lt;[Bundlestats](#bundlestats)&gt; | 返回指定卷上的应用存储状态 | | Promise&lt;[Bundlestats](#bundlestats9)&gt; | 返回指定卷上的应用存储状态 |
**示例:** **示例:**
...@@ -251,7 +251,7 @@ getCurrentBundleStats(callback: AsyncCallback&lt;BundleStats&gt;): void ...@@ -251,7 +251,7 @@ getCurrentBundleStats(callback: AsyncCallback&lt;BundleStats&gt;): void
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | --------------------------------------------------------- | ---- | ------------------------------------ | | -------- | --------------------------------------------------------- | ---- | ------------------------------------ |
| callback | callback: AsyncCallback&lt;[BundleStats](#bundlestats)&gt; | 是 | 获取指定卷上的应用存储状态之后的回调 | | callback | AsyncCallback&lt;[BundleStats](#bundlestats9)&gt; | 是 | 获取指定卷上的应用存储状态之后的回调 |
**示例:** **示例:**
...@@ -271,11 +271,11 @@ getCurrentBundleStats(callback: AsyncCallback&lt;BundleStats&gt;): void ...@@ -271,11 +271,11 @@ getCurrentBundleStats(callback: AsyncCallback&lt;BundleStats&gt;): void
该接口为系统接口,三方应用不支持调用 该接口为系统接口,三方应用不支持调用
| 名称 | 类型 | 说明 | | 名称 | 类型 | 可读 | 可写 | 说明 |
| --------- | ------ | -------------- | | --------- | ------ | --- | ---- | -------------- |
| appSize | number | app数据大小 | | appSize | number | 是 | 否 | app数据大小 |
| cacheSize | number | 缓存数据大小 | | cacheSize | number | 是 | 否 | 缓存数据大小 |
| dataSize | number | 应用总数据大小 | | dataSize | number | 是 | 否 | 应用总数据大小 |
## storageStatistics.getTotalSize<sup>9+</sup> ## storageStatistics.getTotalSize<sup>9+</sup>
...@@ -323,7 +323,7 @@ getTotalSize(callback: AsyncCallback&lt;number&gt;): void ...@@ -323,7 +323,7 @@ getTotalSize(callback: AsyncCallback&lt;number&gt;): void
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | ------------------------------------ | ---- | ------------------------ | | -------- | ------------------------------------ | ---- | ------------------------ |
| callback | callback: AsyncCallback&lt;number&gt; | 是 | 获取内卡的总空间大小之后的回调 | | callback | AsyncCallback&lt;number&gt; | 是 | 获取内卡的总空间大小之后的回调 |
**示例:** **示例:**
...@@ -381,7 +381,7 @@ getFreeSize(callback: AsyncCallback&lt;number&gt;): void ...@@ -381,7 +381,7 @@ getFreeSize(callback: AsyncCallback&lt;number&gt;): void
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | ------------------------------------ | ---- | ------------------------- | | -------- | ------------------------------------ | ---- | ------------------------- |
| callback | callback: AsyncCallback&lt;number&gt; | 是 | 获取内卡的可用空间大小之后的回调 | | callback | AsyncCallback&lt;number&gt; | 是 | 获取内卡的可用空间大小之后的回调 |
**示例:** **示例:**
...@@ -440,7 +440,7 @@ getSystemSize(callback: AsyncCallback&lt;number&gt;): void ...@@ -440,7 +440,7 @@ getSystemSize(callback: AsyncCallback&lt;number&gt;): void
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| ---------- | ------------------------------------ | ---- | -------------------------- | | ---------- | ------------------------------------ | ---- | -------------------------- |
| callback | callback: AsyncCallback&lt;number&gt; | 是 | 获取系统空间大小之后的回调 | | callback | AsyncCallback&lt;number&gt; | 是 | 获取系统空间大小之后的回调 |
**示例:** **示例:**
...@@ -475,7 +475,7 @@ getUserStorageStats(userId? : number): Promise&lt;StorageStats&gt; ...@@ -475,7 +475,7 @@ getUserStorageStats(userId? : number): Promise&lt;StorageStats&gt;
| 类型 | 说明 | | 类型 | 说明 |
| --------------------- | ---------------- | | --------------------- | ---------------- |
| Promise&lt;[StorageStats](#storagestats)&gt; | 返回各类别数据大小 | | Promise&lt;[StorageStats](#storagestats9)&gt; | 返回各类别数据大小 |
**示例:** **示例:**
...@@ -507,7 +507,7 @@ getUserStorageStats(userId: number, callback: AsyncCallback&lt;StorageStats&gt;) ...@@ -507,7 +507,7 @@ getUserStorageStats(userId: number, callback: AsyncCallback&lt;StorageStats&gt;)
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| ---------- | ------------------------------------ | ---- | -------------------------- | | ---------- | ------------------------------------ | ---- | -------------------------- |
| userId | number | 否 | 用户id <br/>确认当前用户:<br/>-&nbsp;有值:表示指定用户。<br/>-&nbsp;无值:表示当前用户。 | | userId | number | 否 | 用户id <br/>确认当前用户:<br/>-&nbsp;有值:表示指定用户。<br/>-&nbsp;无值:表示当前用户。 |
| callback | callback: AsyncCallback&lt;[StorageStats](#storagestats)&gt; | 是 | 返回各类别数据大小之后的回调 | | callback | AsyncCallback&lt;[StorageStats](#storagestats9)&gt; | 是 | 返回各类别数据大小之后的回调 |
**示例:** **示例:**
...@@ -529,11 +529,11 @@ getUserStorageStats(userId: number, callback: AsyncCallback&lt;StorageStats&gt;) ...@@ -529,11 +529,11 @@ getUserStorageStats(userId: number, callback: AsyncCallback&lt;StorageStats&gt;)
该接口为系统接口,三方应用不支持调用 该接口为系统接口,三方应用不支持调用
| 名称 | 类型 | 说明 | | 名称 | 类型 | 可读 | 可写 | 说明 |
| --------- | ------ | -------------- | | --------- | ------ | ---- | ----- | -------------- |
| total | number | 内卡总空间大小 | | total | number | 是 | 否 | 内卡总空间大小 |
| audio | number | 音频数据大小 | | audio | number |是 | 否 | 音频数据大小 |
| video | number | 视频数据大小 | | video | number | 是 | 否 | 视频数据大小 |
| image | number | 图像数据大小 | | image | number | 是 | 否 | 图像数据大小 |
| file | number | 文件数据大小 | | file | number | 是 | 否 | 文件数据大小 |
| app | number | 应用数据大小 | | app | number | 是 | 否 | 应用数据大小 |
...@@ -52,7 +52,7 @@ getAllVolumes(callback: AsyncCallback&lt;Array&lt;Volume&gt;&gt;): void ...@@ -52,7 +52,7 @@ getAllVolumes(callback: AsyncCallback&lt;Array&lt;Volume&gt;&gt;): void
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | ------------------------------------------------- | ---- | ------------------------------------ | | -------- | ------------------------------------------------- | ---- | ------------------------------------ |
| callback | callback: AsyncCallback&lt;[Volume](#volume)[]&gt; | 是 | 获取当前所有可获得的卷信息之后的回调 | | callback | AsyncCallback&lt;[Volume](#volume)[]&gt; | 是 | 获取当前所有可获得的卷信息之后的回调 |
**示例:** **示例:**
...@@ -110,7 +110,7 @@ mount(volumeId: string, callback:AsyncCallback&lt;boolean&gt;):void ...@@ -110,7 +110,7 @@ mount(volumeId: string, callback:AsyncCallback&lt;boolean&gt;):void
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | ------------------------------------- | ---- | -------------------- | | -------- | ------------------------------------- | ---- | -------------------- |
| volumeId | string | 是 | 卷id | | volumeId | string | 是 | 卷id |
| callback | callback: AsyncCallback&lt;boolean&gt; | 是 | 挂载指定卷之后的回调 | | callback | AsyncCallback&lt;boolean&gt; | 是 | 挂载指定卷之后的回调 |
**示例:** **示例:**
...@@ -167,7 +167,7 @@ unmount(volumeId: string, callback: AsyncCallback&lt;boolean&gt;): void ...@@ -167,7 +167,7 @@ unmount(volumeId: string, callback: AsyncCallback&lt;boolean&gt;): void
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | ------------------------------------- | ---- | -------------------- | | -------- | ------------------------------------- | ---- | -------------------- |
| volumeId | string | 是 | 卷id | | volumeId | string | 是 | 卷id |
| callback | callback: AsyncCallback&lt;boolean&gt; | 是 | 卸载指定卷之后的回调 | | callback | AsyncCallback&lt;boolean&gt; | 是 | 卸载指定卷之后的回调 |
**示例:** **示例:**
...@@ -226,7 +226,7 @@ getVolumeByUuid(uuid: string, callback: AsyncCallback&lt;Volume&gt;): void ...@@ -226,7 +226,7 @@ getVolumeByUuid(uuid: string, callback: AsyncCallback&lt;Volume&gt;): void
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | ------------------------------------------------ | ---- | -------------------- | | -------- | ------------------------------------------------ | ---- | -------------------- |
| uuid | string | 是 | 卷uuid | | uuid | string | 是 | 卷uuid |
| callback | callback: AsyncCallback&lt;[Volume](#volume)&gt; | 是 | 获取卷信息之后的回调 | | callback | AsyncCallback&lt;[Volume](#volume)&gt; | 是 | 获取卷信息之后的回调 |
**示例:** **示例:**
...@@ -285,7 +285,7 @@ getVolumeById(volumeId: string, callback: AsyncCallback&lt;Volume&gt;): void ...@@ -285,7 +285,7 @@ getVolumeById(volumeId: string, callback: AsyncCallback&lt;Volume&gt;): void
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | ------------------------- | ---- | ----------------------------- | | -------- | ------------------------- | ---- | ----------------------------- |
| volumeId | string | 是 | 卷id | | volumeId | string | 是 | 卷id |
| callback | callback:AsyncCallback&lt;[Volume](#volume)&gt; | 是 | 获取卷信息之后的回调 | | callback | AsyncCallback&lt;[Volume](#volume)&gt; | 是 | 获取卷信息之后的回调 |
**示例:** **示例:**
...@@ -347,7 +347,7 @@ setVolumeDescription(uuid: string, description: string, callback: AsyncCallback& ...@@ -347,7 +347,7 @@ setVolumeDescription(uuid: string, description: string, callback: AsyncCallback&
| ---------- | --------------------------------------- | ---- | ---------------- | | ---------- | --------------------------------------- | ---- | ---------------- |
| uuid | string | 是 | 卷uuid | | uuid | string | 是 | 卷uuid |
| description | string | 是 | 卷描述 | | description | string | 是 | 卷描述 |
| callback | callback: AsyncCallback&lt;void&gt; | 是 | 设置卷描述之后的回调 | | callback | AsyncCallback&lt;void&gt; | 是 | 设置卷描述之后的回调 |
**示例:** **示例:**
...@@ -410,7 +410,7 @@ format(volumeId: string, fsType: string, callback: AsyncCallback&lt;void&gt;): v ...@@ -410,7 +410,7 @@ format(volumeId: string, fsType: string, callback: AsyncCallback&lt;void&gt;): v
| -------- | ------------------------- | ---- | ----------------------------- | | -------- | ------------------------- | ---- | ----------------------------- |
| volumeId | string | 是 | 卷id | | volumeId | string | 是 | 卷id |
| fsType | string | 是 | 文件系统类型 | | fsType | string | 是 | 文件系统类型 |
| callback | callback: AsyncCallback&lt;void&gt; | 是 | 对指定卷格式化后的回调 | | callback | AsyncCallback&lt;void&gt; | 是 | 对指定卷格式化后的回调 |
**示例:** **示例:**
...@@ -473,7 +473,7 @@ partition(diskId: string, type: number, callback: AsyncCallback&lt;void&gt;): vo ...@@ -473,7 +473,7 @@ partition(diskId: string, type: number, callback: AsyncCallback&lt;void&gt;): vo
| -------- | --------------------------------------- | ---- | ---------------- | | -------- | --------------------------------------- | ---- | ---------------- |
| diskId | string | 是 | 卷所属的磁盘id | | diskId | string | 是 | 卷所属的磁盘id |
| type | number | 是 | 分区类型 | | type | number | 是 | 分区类型 |
| callback | callback: AsyncCallback&lt;void&gt; | 是 | 对磁盘进行分区 | | callback | AsyncCallback&lt;void&gt; | 是 | 对磁盘进行分区 |
**示例:** **示例:**
...@@ -491,12 +491,12 @@ partition(diskId: string, type: number, callback: AsyncCallback&lt;void&gt;): vo ...@@ -491,12 +491,12 @@ partition(diskId: string, type: number, callback: AsyncCallback&lt;void&gt;): vo
### 属性 ### 属性
| 名称 | 类型 | 说明 | | 名称 | 类型 | 可读 | 可写 | 说明 |
| ----------- | ------- | -------------------- | | ----------- | ------- | ------- | ----- | -------------------- |
| id | string | 卷id | | id | string | 是 | 否 | 卷id |
| uuid | string | 卷uuid | | uuid | string | 是 | 否 | 卷uuid |
| diskId | string | 卷所属的磁盘id | | diskId | string | 是 | 否 | 卷所属的磁盘id |
| description | string | 卷相关描述 | | description | string | 是 | 否 | 卷相关描述 |
| removable | boolean | 是否为可移动存储设备 | | removable | boolean | 是 | 否 | 是否为可移动存储设备 |
| state | number | 当前卷状态 | | state | number | 是 | 否 | 当前卷状态 |
| path | string | 卷的挂载地址 | | path | string | 是 | 否 | 卷的挂载地址 |
\ No newline at end of file \ No newline at end of file
Markdown is supported
0% .
You are about to add 0 people to the discussion. Proceed with caution.
先完成此消息的编辑!
想要评论请 注册