js-apis-document.md 4.0 KB
Newer Older
Z
zhouzhichao 已提交
1
# 文件交互
Z
zhouzhichao 已提交
2 3

> ![icon-note.gif](public_sys-resources/icon-note.gif) **说明:**
Z
zengyawen 已提交
4 5
> - 本模块首批接口从API version 6开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。
> - 本模块接口后续将废弃。不建议在OpenHarmony使用以下接口,调用以下接口将抛出异常。
6

Z
zhouzhichao 已提交
7 8 9 10 11 12 13 14
## 导入模块

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

## document.choose

W
wangbo 已提交
15
choose(types:string[]): Promise<string>
Z
zhouzhichao 已提交
16 17 18

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

W
wangbo 已提交
19
**系统能力**:SystemCapability.FileManagement.UserFileService
Z
zhouzhichao 已提交
20 21 22 23 24

- 参数:

  | 参数名 | 类型   | 必填 | 说明                         |
  | ------ | ------ | ---- | ---------------------------- |
W
wangbo 已提交
25
  | types   | string[] | 否   | 限定文件选择的类型 |
Z
zhouzhichao 已提交
26 27 28 29 30 31 32 33 34 35

- 返回值:

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

- 示例:

  ```js
W
wangbo 已提交
36 37
  let tpyes = [];
  document.choose(types);
Z
zhouzhichao 已提交
38 39 40 41 42 43 44
  ```
## document.choose

choose(callback:AsyncCallback<string>): void

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

W
wangbo 已提交
45
**系统能力**:SystemCapability.FileManagement.UserFileService
Z
zhouzhichao 已提交
46 47 48 49 50 51 52 53 54 55

- 参数:

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

- 示例:

  ```js
W
wangbo 已提交
56 57
  let uri = "";
  document.choose(function(err, uri) {
Z
zhouzhichao 已提交
58 59 60 61 62
        //do something with uri
  });
  ```
## document.choose

W
wangbo 已提交
63
choose(types:string[], callback:AsyncCallback<string>): void
Z
zhouzhichao 已提交
64 65 66

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

W
wangbo 已提交
67
**系统能力**:SystemCapability.FileManagement.UserFileService
Z
zhouzhichao 已提交
68 69 70 71 72

- 参数:

  | 参数名   | 类型                        | 必填 | 说明                         |
  | -------- | --------------------------- | ---- | ---------------------------- |
W
wangbo 已提交
73
  | types    | string[]                      | 否   | 限定选择文件的类型 |
Z
zhouzhichao 已提交
74 75 76 77 78
  | callback | AsyncCallback<string> | 是   | 异步获取对应文件URI(注:当前返回错误码) |

- 示例:

  ```js
W
wangbo 已提交
79 80 81
  let types = [];
  let uri = "";
  document.choose(types, function(err, uri) {
Z
zhouzhichao 已提交
82 83 84 85 86 87
        //do something with uri
  });
  ```

## document.show

W
wangbo 已提交
88
show(uri:string, types:string):Promise<void>
Z
zhouzhichao 已提交
89 90 91

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

W
wangbo 已提交
92
**系统能力**:SystemCapability.FileManagement.UserFileService
Z
zhouzhichao 已提交
93 94 95 96 97 98

- 参数:

  | 参数 | 类型   | 必填 | 说明                         |
  | ---- | ------ | ---- | ---------------------------- |
  | uri | string | 是   | 待打开的文件URI |
W
wangbo 已提交
99
  | types | string | 是   | 待打开文件的类型 |
Z
zhouzhichao 已提交
100 101 102 103 104 105 106 107 108 109

- 返回值:

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

- 示例:

  ```js
W
wangbo 已提交
110 111 112
  let types = "";
  let uri = "";
  document.show(uri, types);
Z
zhouzhichao 已提交
113 114 115 116
  ```

## document.show

W
wangbo 已提交
117
show(uri:string, types:string, callback:AsyncCallback<void>): void
Z
zhouzhichao 已提交
118 119 120

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

W
wangbo 已提交
121
**系统能力**:SystemCapability.FileManagement.UserFileService
Z
zhouzhichao 已提交
122 123 124 125 126 127

- 参数:

  | 参数名   | 类型                        | 必填 | 说明                         |
  | -------- | --------------------------- | ---- | ---------------------------- |
  | uri | string | 是   | 待打开的文件URI |
W
wangbo 已提交
128
  | types | string | 是   | 待打开文件的类型 |
Z
zhouzhichao 已提交
129 130 131 132 133
  | callback | AsyncCallback<void> | 是   | 异步打开uri对应文件(注:当前返回错误码)   |

- 示例:

  ```js
W
wangbo 已提交
134 135 136
  let types = "";
  let uri = "";
  document.show(uri, types, function(err) {
Z
zhouzhichao 已提交
137 138 139 140
        //do something
  });
  ```