js-apis-document.md 3.9 KB
Newer Older
Z
zhouzhichao 已提交
1 2 3
# document

> ![icon-note.gif](public_sys-resources/icon-note.gif) **说明:**
Z
zhouzhichao 已提交
4 5
- 本模块首批接口从API version 6开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。
- 本模块接口后续将废弃。不建议在OpenHarmony使用以下接口,调用以下接口将抛出异常。
Z
zhouzhichao 已提交
6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131
## 导入模块

```js
import document from '@ohos.document';
```

## document.choose

choose(type:string[]): Promise<string>

通过文件管理器选择文件,异步返回文件URI,使用promise形式返回结果。

**系统能力**:SystemCapability.FileManagement.File.FileIO

- 参数:

  | 参数名 | 类型   | 必填 | 说明                         |
  | ------ | ------ | ---- | ---------------------------- |
  | type   | string[] | 否   | 限定文件选择的类型 |

- 返回值:

  | 类型                  | 说明           |
  | --------------------- | -------------- |
  | Promise<string> | 异步返回文件URI(注:当前返回错误码) |

- 示例:

  ```js
  await document.choose(type);
  ```
## document.choose

choose(callback:AsyncCallback<string>): void

通过文件管理器选择文件,异步返回文件URI,使用callback形式返回结果。

**系统能力**:SystemCapability.FileManagement.File.FileIO

- 参数:

  | 参数名   | 类型                        | 必填 | 说明                         |
  | -------- | --------------------------- | ---- | ---------------------------- |
  | callback | AsyncCallback<string> | 是   | 异步获取对应文件URI(注:当前返回错误码) |

- 示例:

  ```js
  await document.choose(function(err, uri) {
        //do something with uri
  });
  ```
## document.choose

choose(type:string[], callback:AsyncCallback<string>): void

通过文件管理器选择文件,异步返回文件URI,使用callback形式返回结果。

**系统能力**:SystemCapability.FileManagement.File.FileIO

- 参数:

  | 参数名   | 类型                        | 必填 | 说明                         |
  | -------- | --------------------------- | ---- | ---------------------------- |
  | type     | string[]                      | 否   | 限定选择文件的类型 |
  | callback | AsyncCallback<string> | 是   | 异步获取对应文件URI(注:当前返回错误码) |

- 示例:

  ```js
  await document.choose(type, function(err, uri) {
        //do something with uri
  });
  ```

## document.show

show(url:string, type:string):Promise<number>

异步打开URI对应的文件,使用promise形式返回结果。

**系统能力**:SystemCapability.FileManagement.File.FileIO

- 参数:

  | 参数 | 类型   | 必填 | 说明                         |
  | ---- | ------ | ---- | ---------------------------- |
  | uri | string | 是   | 待打开的文件URI |
  | type | string | 是   | 待打开文件的类型 |

- 返回值:

  | 类型                  | 说明         |
  | --------------------- | ------------ |
  | Promise<void> | Promise回调返回void表示成功打开文件(注:当前返回错误码) |

- 示例:

  ```js
  await document.show(uri, type);
  ```

## document.show

show(url:string, type:string, callback:AsyncCallback<void>): void

异步打开URI对应的文件,使用callback形式返回结果。

**系统能力**:SystemCapability.FileManagement.File.FileIO

- 参数:

  | 参数名   | 类型                        | 必填 | 说明                         |
  | -------- | --------------------------- | ---- | ---------------------------- |
  | uri | string | 是   | 待打开的文件URI |
  | type | string | 是   | 待打开文件的类型 |
  | callback | AsyncCallback<void> | 是   | 异步打开uri对应文件(注:当前返回错误码)   |

- 示例:

  ```js
  await document.show(uri, type, function(err) {
        //do something
  });
  ```