Skip to content

D
Docs

OpenHarmony / Docs
大约 2 年 前同步成功

通知 161
Star 293
Fork 28
D
Docs
提交 33d27196 编写于 作者: A Annie_wang
浏览文件
操作

update docs 

Signed-off-by: NAnnie_wang <annie.wangli@huawei.com>
上级 56487141
隐藏空白更改
内联 并排
Showing with 76 addition and 76 deletion
en/application-dev/reference/apis/js-apis-storage-statistics.md
浏览文件 @ 33d27196
...@@ -29,15 +29,15 @@ This is a system API and cannot be called by third-party applications. ...@@ -29,15 +29,15 @@ This is a system API and cannot be called by third-party applications.
**Parameters** **Parameters**
| Name | Type | Mandatory| Description| | Name | Type | Mandatory| Description|
| ---------- | ------ | ---- | ---- | | ---------- | ------ | ---- | ---- |
| volumeUuid | string | Yes | UUID of the volume.| | volumeUuid | string | Yes | UUID of the volume.|
**Return value** **Return value**
| Type | Description | | Type | Description |
| --------------------- | ---------------- | | --------------------- | ---------------- |
| Promise&lt;number&gt; | Promise used to return the total size of the volume.| | Promise&lt;number&gt; | Promise used to return the total size of the volume.|
**Example** **Example**
...@@ -52,7 +52,7 @@ This is a system API and cannot be called by third-party applications. ...@@ -52,7 +52,7 @@ This is a system API and cannot be called by third-party applications.
## storageStatistics.getTotalSizeOfVolume ## storageStatistics.getTotalSizeOfVolume
getTotalSizeOfVolume(volumeUuid: string, callback:AsyncCallback&lt;number&gt;):void getTotalSizeOfVolume(volumeUuid: string, callback: AsyncCallback&lt;number&gt;): void
Asynchronously obtains the total size of the specified volume. This API uses a callback to return the result. Asynchronously obtains the total size of the specified volume. This API uses a callback to return the result.
...@@ -66,10 +66,10 @@ This is a system API and cannot be called by third-party applications. ...@@ -66,10 +66,10 @@ This is a system API and cannot be called by third-party applications.
**Parameters** **Parameters**
| Name | Type | Mandatory| Description | | Name | Type | Mandatory| Description |
| ---------- | ------------------------------------ | ---- | -------------------------- | | ---------- | ------------------------------------ | ---- | -------------------------- |
| volumeUuid | string | Yes | UUID of the volume. | | volumeUuid | string | Yes | UUID of the volume. |
| callback | callback:AsyncCallback&lt;number&gt; | Yes | Callback invoked to return the total size of the volume.| | callback | callback: AsyncCallback&lt;number&gt; | Yes | Callback invoked to return the total size of the volume.|
**Example** **Example**
...@@ -97,15 +97,15 @@ This is a system API and cannot be called by third-party applications. ...@@ -97,15 +97,15 @@ This is a system API and cannot be called by third-party applications.
**Parameters** **Parameters**
| Name | Type | Mandatory| Description| | Name | Type | Mandatory| Description|
| ---------- | ------ | ---- | ---- | | ---------- | ------ | ---- | ---- |
| volumeUuid | string | Yes | UUID of the volume.| | volumeUuid | string | Yes | UUID of the volume.|
**Return value** **Return value**
| Type | Description | | Type | Description |
| --------------------- | ------------------ | | --------------------- | ------------------ |
| Promise&lt;number&gt; | Promise used to return the available space of the volume.| | Promise&lt;number&gt; | Promise used to return the available space of the volume.|
**Example** **Example**
...@@ -121,7 +121,7 @@ This is a system API and cannot be called by third-party applications. ...@@ -121,7 +121,7 @@ This is a system API and cannot be called by third-party applications.
## storageStatistics.getFreeSizeOfVolume ## storageStatistics.getFreeSizeOfVolume
getFreeSizeOfVolume(volumeUuid: string, callback:AsyncCallback&lt;number&gt;):void getFreeSizeOfVolume(volumeUuid: string, callback: AsyncCallback&lt;number&gt;): void
Asynchronously obtains the available space of the specified volume. This API uses a callback to return the result. Asynchronously obtains the available space of the specified volume. This API uses a callback to return the result.
...@@ -135,10 +135,10 @@ This is a system API and cannot be called by third-party applications. ...@@ -135,10 +135,10 @@ This is a system API and cannot be called by third-party applications.
**Parameters** **Parameters**
| Name | Type | Mandatory| Description | | Name | Type | Mandatory| Description |
| ---------- | ------------------------------------ | ---- | ---------------------------- | | ---------- | ------------------------------------ | ---- | ---------------------------- |
| volumeUuid | string | Yes | UUID of the volume. | | volumeUuid | string | Yes | UUID of the volume. |
| callback | callback:AsyncCallback&lt;number&gt; | Yes | Callback invoked to return the available space of the volume.| | callback | callback: AsyncCallback&lt;number&gt; | Yes | Callback invoked to return the available space of the volume.|
**Example** **Example**
...@@ -166,15 +166,15 @@ This is a system API and cannot be called by third-party applications. ...@@ -166,15 +166,15 @@ This is a system API and cannot be called by third-party applications.
**Parameters** **Parameters**
| Name | Type | Mandatory| Description | | Name | Type | Mandatory| Description |
| ----------- | ------ | ---- | -------- | | ----------- | ------ | ---- | -------- |
| packageName | string | Yes | Bundle name of the application.| | packageName | string | Yes | Bundle name of the application.|
**Return value** **Return value**
| Type | Description | | Type | Description |
| ------------------------------------------ | -------------------------- | | ------------------------------------------ | -------------------------- |
| Promise&lt;[Bundlestats](#bundlestats)&gt; | Promise used to return the space information obtained.| | Promise&lt;[Bundlestats](#bundlestats)&gt; | Promise used to return the space information obtained.|
**Example** **Example**
...@@ -203,10 +203,10 @@ This is a system API and cannot be called by third-party applications. ...@@ -203,10 +203,10 @@ This is a system API and cannot be called by third-party applications.
**Parameters** **Parameters**
| Name | Type | Mandatory| Description | | Name | Type | Mandatory| Description |
| -------- | --------------------------------------------------------- | ---- | ------------------------------------ | | -------- | --------------------------------------------------------- | ---- | ------------------------------------ |
| packageName | string | Yes | Bundle name of the application.| | packageName | string | Yes | Bundle name of the application.|
| callback | callback:AsyncCallback&lt;[Bundlestats](#bundlestats)&gt; | Yes | Callback invoked to return the space information obtained.| | callback | callback: AsyncCallback&lt;[Bundlestats](#bundlestats)&gt; | Yes | Callback invoked to return the space information obtained.|
**Example** **Example**
...@@ -228,9 +228,9 @@ Asynchronously obtains space information of the current third-party application. ...@@ -228,9 +228,9 @@ Asynchronously obtains space information of the current third-party application.
**Return value** **Return value**
| Type | Description | | Type | Description |
| ------------------------------------------ | -------------------------- | | ------------------------------------------ | -------------------------- |
| Promise&lt;[Bundlestats](#bundlestats)&gt; | Promise used to return the space information obtained. | | Promise&lt;[Bundlestats](#bundlestats)&gt; | Promise used to return the space information obtained. |
**Example** **Example**
...@@ -249,9 +249,9 @@ Asynchronously obtains space information of the current third-party application. ...@@ -249,9 +249,9 @@ Asynchronously obtains space information of the current third-party application.
**Parameters** **Parameters**
| Name | Type | Mandatory | Description | | Name | Type | Mandatory | Description |
| -------- | --------------------------------------------------------- | ---- | ------------------------------------ | | -------- | --------------------------------------------------------- | ---- | ------------------------------------ |
| callback | callback:AsyncCallback&lt;[BundleStats](#bundlestats)&gt; | Yes | Callback invoked to return the space information obtained. | | callback | callback: AsyncCallback&lt;[BundleStats](#bundlestats)&gt; | Yes | Callback invoked to return the space information obtained. |
**Example** **Example**
...@@ -294,9 +294,9 @@ This is a system API and cannot be called by third-party applications. ...@@ -294,9 +294,9 @@ This is a system API and cannot be called by third-party applications.
**Return value** **Return value**
| Type | Description | | Type | Description |
| --------------------- | ------------------ | | --------------------- | ------------------ |
| Promise&lt;number&gt; | Promise used to return the total space of the built-in memory card. | | Promise&lt;number&gt; | Promise used to return the total space of the built-in memory card. |
**Example** **Example**
...@@ -321,9 +321,9 @@ This is a system API and cannot be called by third-party applications. ...@@ -321,9 +321,9 @@ This is a system API and cannot be called by third-party applications.
**Parameters** **Parameters**
| Name | Type | Mandatory | Description | | Name | Type | Mandatory | Description |
| -------- | ------------------------------------ | ---- | ------------------------ | | -------- | ------------------------------------ | ---- | ------------------------ |
| callback | callback:AsyncCallback&lt;number&gt; | Yes | Callback invoked to return the total space of the built-in memory card.| | callback | callback: AsyncCallback&lt;number&gt; | Yes | Callback invoked to return the total space of the built-in memory card.|
**Example** **Example**
...@@ -351,9 +351,9 @@ This is a system API and cannot be called by third-party applications. ...@@ -351,9 +351,9 @@ This is a system API and cannot be called by third-party applications.
**Return value** **Return value**
| Type | Description | | Type | Description |
| --------------------- | ------------------ | | --------------------- | ------------------ |
| Promise&lt;number&gt; | Promise used to return the available space of the built-in memory card.| | Promise&lt;number&gt; | Promise used to return the available space of the built-in memory card.|
**Example** **Example**
...@@ -379,9 +379,9 @@ This is a system API and cannot be called by third-party applications. ...@@ -379,9 +379,9 @@ This is a system API and cannot be called by third-party applications.
**Parameters** **Parameters**
| Name | Type | Mandatory| Description | | Name | Type | Mandatory| Description |
| -------- | ------------------------------------ | ---- | ------------------------- | | -------- | ------------------------------------ | ---- | ------------------------- |
| callback | callback:AsyncCallback&lt;number&gt; | Yes | Callback invoked to return the available space of the built-in memory card.| | callback | callback: AsyncCallback&lt;number&gt; | Yes | Callback invoked to return the available space of the built-in memory card.|
**Example** **Example**
...@@ -408,9 +408,9 @@ This is a system API and cannot be called by third-party applications. ...@@ -408,9 +408,9 @@ This is a system API and cannot be called by third-party applications.
**Return value** **Return value**
| Type | Description | | Type | Description |
| --------------------- | ---------------- | | --------------------- | ---------------- |
| Promise&lt;number&gt; | Promise used to return the system space obtained.| | Promise&lt;number&gt; | Promise used to return the system space obtained.|
**Example** **Example**
...@@ -424,7 +424,7 @@ This is a system API and cannot be called by third-party applications. ...@@ -424,7 +424,7 @@ This is a system API and cannot be called by third-party applications.
## storageStatistics.getSystemSize<sup>9+</sup> ## storageStatistics.getSystemSize<sup>9+</sup>
getSystemSize(callback:AsyncCallback&lt;number&gt;):void getSystemSize(callback: AsyncCallback&lt;number&gt;): void
Asynchronously obtains the system space. This API uses a callback to return the result. Asynchronously obtains the system space. This API uses a callback to return the result.
...@@ -438,9 +438,9 @@ This is a system API and cannot be called by third-party applications. ...@@ -438,9 +438,9 @@ This is a system API and cannot be called by third-party applications.
**Parameters** **Parameters**
| Name | Type | Mandatory| Description | | Name | Type | Mandatory| Description |
| ---------- | ------------------------------------ | ---- | -------------------------- | | ---------- | ------------------------------------ | ---- | -------------------------- |
| callback | callback:AsyncCallback&lt;number&gt; | Yes | Callback used to return the system space obtained.| | callback | callback: AsyncCallback&lt;number&gt; | Yes | Callback used to return the system space obtained.|
**Example** **Example**
...@@ -467,15 +467,15 @@ This is a system API and cannot be called by third-party applications. ...@@ -467,15 +467,15 @@ This is a system API and cannot be called by third-party applications.
**Parameters** **Parameters**
| Name | Type | Mandatory| Description| | Name | Type | Mandatory| Description|
| ---------- | ------ | ---- | ---- | | ---------- | ------ | ---- | ---- |
| userId | number | No | User ID.<br>Value:<br>-&nbsp; Set this parameter to the ID of the user to be queried.<br>-&nbsp; If no value is specified, information about the current user is queried.| | userId | number | No | User ID.<br>Value:<br>-&nbsp; Set this parameter to the ID of the user to be queried.<br>-&nbsp; If no value is specified, information about the current user is queried.|
**Return value** **Return value**
| Type | Description | | Type | Description |
| --------------------- | ---------------- | | --------------------- | ---------------- |
| Promise&lt;[StorageStats](#storagestats9)&gt; | Promise used to return the information obtained.| | Promise&lt;[StorageStats](#storagestats)&gt; | Promise used to return the information obtained.|
**Example** **Example**
...@@ -490,7 +490,7 @@ This is a system API and cannot be called by third-party applications. ...@@ -490,7 +490,7 @@ This is a system API and cannot be called by third-party applications.
## storageStatistics.getUserStorageStats<sup>9+</sup> ## storageStatistics.getUserStorageStats<sup>9+</sup>
getUserStorageStats(userId: number, callback:AsyncCallback&lt;StorageStats&gt;):void getUserStorageStats(userId: number, callback: AsyncCallback&lt;StorageStats&gt;): void
Asynchronously obtains the space occupied by each type of user data. This API uses a callback to return the result. Asynchronously obtains the space occupied by each type of user data. This API uses a callback to return the result.
...@@ -504,10 +504,10 @@ This is a system API and cannot be called by third-party applications. ...@@ -504,10 +504,10 @@ This is a system API and cannot be called by third-party applications.
**Parameters** **Parameters**
| Name | Type | Mandatory| Description | | Name | Type | Mandatory| Description |
| ---------- | ------------------------------------ | ---- | -------------------------- | | ---------- | ------------------------------------ | ---- | -------------------------- |
| userId | number | No | User ID.<br>Value:<br>-&nbsp; Set this parameter to the ID of the user to be queried.<br>-&nbsp; If no value is specified, information about the current user is queried. | | userId | number | No | User ID.<br>Value:<br>-&nbsp; Set this parameter to the ID of the user to be queried.<br>-&nbsp; If no value is specified, information about the current user is queried. |
| callback | callback:AsyncCallback&lt;[StorageStats](#storagestats9)&gt; | Yes | Callback invoked to return the information obtained.| | callback | callback: AsyncCallback&lt;[StorageStats](#storagestats)&gt; | Yes | Callback invoked to return the information obtained.|
**Example** **Example**
......
en/application-dev/reference/apis/js-apis-volumemanager.md
浏览文件 @ 33d27196
...@@ -52,7 +52,7 @@ Asynchronously obtains information about all available volumes. This API uses a ...@@ -52,7 +52,7 @@ Asynchronously obtains information about all available volumes. This API uses a
| Name | Type | Mandatory| Description | | Name | Type | Mandatory| Description |
| -------- | ------------------------------------------------- | ---- | ------------------------------------ | | -------- | ------------------------------------------------- | ---- | ------------------------------------ |
| callback | callback:AsyncCallback&lt;[Volume](#volume)[]&gt; | Yes | Callback invoked to return the volume information obtained.| | callback | callback: AsyncCallback&lt;[Volume](#volume)[]&gt; | Yes | Callback invoked to return the volume information obtained.|
**Example** **Example**
...@@ -110,7 +110,7 @@ Asynchronously obtains the available space of the specified volume. This API use ...@@ -110,7 +110,7 @@ Asynchronously obtains the available space of the specified volume. This API use
| Name | Type | Mandatory| Description | | Name | Type | Mandatory| Description |
| -------- | ------------------------------------- | ---- | -------------------- | | -------- | ------------------------------------- | ---- | -------------------- |
| volumeId | string | Yes | Volume ID. | | volumeId | string | Yes | Volume ID. |
| callback | callback:AsyncCallback&lt;boolean&gt; | Yes | Callback invoked to return the execution result.| | callback | callback: AsyncCallback&lt;boolean&gt; | Yes | Callback invoked to return the execution result.|
**Example** **Example**
...@@ -154,7 +154,7 @@ Asynchronously unmounts a volume. This API uses a promise to return the result. ...@@ -154,7 +154,7 @@ Asynchronously unmounts a volume. This API uses a promise to return the result.
## volumemanager.unmount ## volumemanager.unmount
unmount(volumeId: string, callback:AsyncCallback&lt;boolean&gt;):void unmount(volumeId: string, callback: AsyncCallback&lt;boolean&gt;): void
Asynchronously unmounts a volume. This API uses a callback to return the result. Asynchronously unmounts a volume. This API uses a callback to return the result.
...@@ -167,7 +167,7 @@ Asynchronously unmounts a volume. This API uses a callback to return the result. ...@@ -167,7 +167,7 @@ Asynchronously unmounts a volume. This API uses a callback to return the result.
| Name | Type | Mandatory| Description | | Name | Type | Mandatory| Description |
| -------- | ------------------------------------- | ---- | -------------------- | | -------- | ------------------------------------- | ---- | -------------------- |
| volumeId | string | Yes | Volume ID. | | volumeId | string | Yes | Volume ID. |
| callback | callback:AsyncCallback&lt;boolean&gt; | Yes | Callback invoked to return the execution result.| | callback | callback: AsyncCallback&lt;boolean&gt; | Yes | Callback invoked to return the execution result.|
**Example** **Example**
...@@ -226,7 +226,7 @@ Asynchronously obtains volume information based on the UUID. This API uses a cal ...@@ -226,7 +226,7 @@ Asynchronously obtains volume information based on the UUID. This API uses a cal
| Name | Type | Mandatory| Description | | Name | Type | Mandatory| Description |
| -------- | ------------------------------------------------ | ---- | -------------------- | | -------- | ------------------------------------------------ | ---- | -------------------- |
| uuid | string | Yes | UUID of the volume. | | uuid | string | Yes | UUID of the volume. |
| callback | callback:AsyncCallback&lt;[Volume](#volume)&gt; | Yes | Callback invoked to return the volume information obtained.| | callback | callback: AsyncCallback&lt;[Volume](#volume)&gt; | Yes | Callback invoked to return the volume information obtained.|
**Example** **Example**
...@@ -347,7 +347,7 @@ Asynchronously sets the volume description based on the UUID. This API uses a ca ...@@ -347,7 +347,7 @@ Asynchronously sets the volume description based on the UUID. This API uses a ca
| ---------- | --------------------------------------- | ---- | ---------------- | | ---------- | --------------------------------------- | ---- | ---------------- |
| uuid | string | Yes | UUID of the volume. | | uuid | string | Yes | UUID of the volume. |
| description | string | Yes | Volume description. | | description | string | Yes | Volume description. |
| callback | callback:AsyncCallback&lt;void&gt; | Yes | Callback invoked to return the result.| | callback | callback: AsyncCallback&lt;void&gt; | Yes | Callback invoked to return the result.|
**Example** **Example**
...@@ -410,7 +410,7 @@ Asynchronously formats a volume. This API uses a callback to return the result. ...@@ -410,7 +410,7 @@ Asynchronously formats a volume. This API uses a callback to return the result.
| -------- | ------------------------- | ---- | ----------------------------- | | -------- | ------------------------- | ---- | ----------------------------- |
| volumeId | string | Yes | Volume ID. | | volumeId | string | Yes | Volume ID. |
| fsType | string | Yes | File system type.| | fsType | string | Yes | File system type.|
| callback | callback:AsyncCallback&lt;void&gt; | Yes | Called after the volume is formatted. | | callback | callback: AsyncCallback&lt;void&gt; | Yes | Called after the volume is formatted. |
**Example** **Example**
...@@ -473,7 +473,7 @@ Asynchronously partitions a disk. This API uses a callback to return the result. ...@@ -473,7 +473,7 @@ Asynchronously partitions a disk. This API uses a callback to return the result.
| -------- | --------------------------------------- | ---- | ---------------- | | -------- | --------------------------------------- | ---- | ---------------- |
| diskId | string | Yes | ID of the disk to which the volume belongs. | | diskId | string | Yes | ID of the disk to which the volume belongs. |
| type | number | Yes | Partition type. | | type | number | Yes | Partition type. |
| callback | callback:AsyncCallback&lt;void&gt; | Yes | Callback invoked to return the result. | | callback | callback: AsyncCallback&lt;void&gt; | Yes | Callback invoked to return the result. |
**Example** **Example**
......
Markdown is supported
0% 或 .
You are about to add 0 people to the discussion. Proceed with caution.
先完成此消息的编辑！
想要评论请 注册 或