File Interaction
NOTE
- 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.
Modules to Import
import document from '@ohos.document';
document.choose
choose(type:string[]): Promise<string>
Chooses a file of the specified type using the file manager. This API uses a promise to return the result.
System capability: SystemCapability.FileManagement.File.FileIO
- Parameters
Name | Type | Mandatory | Description |
---|---|---|---|
type | string[] | No | Type of the file to choose. |
- Return value
Type | Description |
---|---|
Promise<string> | Promise used to return the result. An error code is returned. |
-
Example
await document.choose(type);
document.choose
choose(callback:AsyncCallback<string>): void
Chooses a file using the file manager. This API uses an asynchronous callback to return the result.
System capability: SystemCapability.FileManagement.File.FileIO
- Parameters
Name | Type | Mandatory | Description |
---|---|---|---|
callback | AsyncCallback<string> | Yes | Callback used to return the result. An error code is returned. |
-
Example
await document.choose(function(err, uri) { // Do something with the URI. });
document.choose
choose(type:string[], callback:AsyncCallback<string>): void
Chooses a file of the specified type using the file manager. This API uses an asynchronous callback to return the result.
System capability: SystemCapability.FileManagement.File.FileIO
- Parameters
Name | Type | Mandatory | Description |
---|---|---|---|
type | string[] | No | Type of the file to choose. |
callback | AsyncCallback<string> | Yes | Callback used to return the result. An error code is returned. |
-
Example
await document.choose(type, function(err, uri) { // Do something with the URI. });
document.show
show(url:string, type:string):Promise<number>
Opens a file. This API uses a promise to return the result.
System capability: SystemCapability.FileManagement.File.FileIO
- Parameters
Name | Type | Mandatory | Description |
---|---|---|---|
uri | string | Yes | URI of the file to open. |
type | string | Yes | Type of the file to open. |
- Return value
Type | Description |
---|---|
Promise<void> | Promise used to return the result. An error code is returned. |
-
Example
await document.show(uri, type);
document.show
show(url:string, type:string, callback:AsyncCallback<void>): void
Opens a file. This API uses an asynchronous callback to return the result.
System capability: SystemCapability.FileManagement.File.FileIO
- Parameters
Name | Type | Mandatory | Description |
---|---|---|---|
uri | string | Yes | URI of the file to open. |
type | string | Yes | Type of the file to open. |
callback | AsyncCallback<void> | Yes | Callback used to return the result. An error code is returned. |
-
Example
await document.show(uri, type, function(err) { //do something });