提交 1e86b4be 编写于 作者: A Annie_wang

update docs

Signed-off-by: NAnnie_wang <annie.wangli@huawei.com>
上级 e52505dc
...@@ -2,7 +2,7 @@ ...@@ -2,7 +2,7 @@
> **NOTE**<br/> > **NOTE**<br/>
> - The initial APIs of this module are supported since API version 6. Newly added APIs will be marked with a superscript to indicate their earliest API version. > - The initial APIs of this module are supported since API version 6. Newly added APIs will be marked with a superscript to indicate their earliest API version.
> - The APIs of this module will be deprecated and are not recommended for use. An exception will be thrown if any of the APIs is called. > - The APIs of this module have been deprecated since API version 9 and are not recommended for use. An exception will be thrown if any of the APIs is called.
## Modules to Import ## Modules to Import
...@@ -10,7 +10,7 @@ ...@@ -10,7 +10,7 @@
import document from '@ohos.document'; import document from '@ohos.document';
``` ```
## document.choose ## document.choose<sup>(deprecated)</sup>
choose(types? : string[]): Promise&lt;string&gt; choose(types? : string[]): Promise&lt;string&gt;
...@@ -20,15 +20,15 @@ Chooses files of the specified types using the file manager. This API uses a pro ...@@ -20,15 +20,15 @@ Chooses files of the specified types using the file manager. This API uses a pro
**Parameters** **Parameters**
| Name| Type | Mandatory| Description | | Name| Type | Mandatory| Description |
| ------ | ------ | ---- | ---------------------------- | | ------ | ------ | ---- | ---------------------------- |
| types | string[] | No | Types of the files to choose. | | types | string[] | No | Types of the files to choose.|
**Return value** **Return value**
| Type | Description | | Type | Description |
| --------------------- | -------------- | | --------------------- | -------------- |
| Promise&lt;string&gt; | Promise used to return the result. An error code is returned.| | Promise&lt;string&gt; | Promise used to return the result. An error code is returned.|
**Example** **Example**
...@@ -36,7 +36,7 @@ Chooses files of the specified types using the file manager. This API uses a pro ...@@ -36,7 +36,7 @@ Chooses files of the specified types using the file manager. This API uses a pro
let types = []; let types = [];
document.choose(types); document.choose(types);
``` ```
## document.choose ## document.choose<sup>(deprecated)</sup>
choose(callback:AsyncCallback&lt;string&gt;): void choose(callback:AsyncCallback&lt;string&gt;): void
...@@ -46,9 +46,9 @@ Chooses a file using the file manager. This API uses an asynchronous callback to ...@@ -46,9 +46,9 @@ Chooses a file using the file manager. This API uses an asynchronous callback to
**Parameters** **Parameters**
| Name | Type | Mandatory| Description | | Name | Type | Mandatory| Description |
| -------- | --------------------------- | ---- | ---------------------------- | | -------- | --------------------------- | ---- | ---------------------------- |
| callback | AsyncCallback&lt;string&gt; | Yes | Callback used to return the result. An error code is returned.| | callback | AsyncCallback&lt;string&gt; | Yes | Callback used to return the result. An error code is returned.|
**Example** **Example**
...@@ -58,7 +58,7 @@ Chooses a file using the file manager. This API uses an asynchronous callback to ...@@ -58,7 +58,7 @@ Chooses a file using the file manager. This API uses an asynchronous callback to
// Do something with the URI. // Do something with the URI.
}); });
``` ```
## document.choose ## document.choose<sup>(deprecated)</sup>
choose(types:string[], callback:AsyncCallback&lt;string&gt;): void choose(types:string[], callback:AsyncCallback&lt;string&gt;): void
...@@ -68,10 +68,10 @@ Chooses files using the file manager. This API uses an asynchronous callback to ...@@ -68,10 +68,10 @@ Chooses files using the file manager. This API uses an asynchronous callback to
**Parameters** **Parameters**
| Name | Type | Mandatory| Description | | Name | Type | Mandatory| Description |
| -------- | --------------------------- | ---- | ---------------------------- | | -------- | --------------------------- | ---- | ---------------------------- |
| types | string[] | No | Types of the files to choose.| | types | string[] | No | Types of the files to choose.|
| callback | AsyncCallback&lt;string&gt; | Yes | Callback used to return the result. An error code is returned.| | callback | AsyncCallback&lt;string&gt; | Yes | Callback used to return the result. An error code is returned.|
**Example** **Example**
...@@ -83,7 +83,7 @@ Chooses files using the file manager. This API uses an asynchronous callback to ...@@ -83,7 +83,7 @@ Chooses files using the file manager. This API uses an asynchronous callback to
}); });
``` ```
## document.show ## document.show<sup>(deprecated)</sup>
show(uri:string, type:string):Promise&lt;void&gt; show(uri:string, type:string):Promise&lt;void&gt;
...@@ -93,16 +93,16 @@ Opens a file. This API uses a promise to return the result. ...@@ -93,16 +93,16 @@ Opens a file. This API uses a promise to return the result.
**Parameters** **Parameters**
| Name| Type | Mandatory| Description | | Name| Type | Mandatory| Description |
| ---- | ------ | ---- | ---------------------------- | | ---- | ------ | ---- | ---------------------------- |
| uri | string | Yes | URI of the file to open.| | uri | string | Yes | URI of the file to open.|
| type | string | Yes | Type of the file to open.| | type | string | Yes | Type of the file to open.|
**Return value** **Return value**
| Type | Description | | Type | Description |
| --------------------- | ------------ | | --------------------- | ------------ |
| Promise&lt;void&gt; | Promise used to return the result. An error code is returned.| | Promise&lt;void&gt; | Promise used to return the result. An error code is returned.|
**Example** **Example**
...@@ -112,7 +112,7 @@ Opens a file. This API uses a promise to return the result. ...@@ -112,7 +112,7 @@ Opens a file. This API uses a promise to return the result.
document.show(uri, type); document.show(uri, type);
``` ```
## document.show ## document.show<sup>(deprecated)</sup>
show(uri:string, type:string, callback:AsyncCallback&lt;void&gt;): void show(uri:string, type:string, callback:AsyncCallback&lt;void&gt;): void
...@@ -122,11 +122,11 @@ Opens a file. This API uses an asynchronous callback to return the result. ...@@ -122,11 +122,11 @@ Opens a file. This API uses an asynchronous callback to return the result.
**Parameters** **Parameters**
| Name | Type | Mandatory| Description | | Name | Type | Mandatory| Description |
| -------- | --------------------------- | ---- | ---------------------------- | | -------- | --------------------------- | ---- | ---------------------------- |
| uri | string | Yes | URI of the file to open.| | uri | string | Yes | URI of the file to open.|
| type | string | Yes | Type of the file to open.| | type | string | Yes | Type of the file to open.|
| callback | AsyncCallback&lt;void&gt; | Yes | Callback used to return the result. An error code is returned. | | callback | AsyncCallback&lt;void&gt; | Yes | Callback used to return the result. An error code is returned. |
**Example** **Example**
......
Markdown is supported
0% .
You are about to add 0 people to the discussion. Proceed with caution.
先完成此消息的编辑!
想要评论请 注册