• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1# @ohos.document (文件交互)
2
3> ![icon-note.gif](public_sys-resources/icon-note.gif) **说明:**
4> - 本模块首批接口从API version 6开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。
5> - 本模块接口从API9开始废弃。不建议使用以下接口,调用以下接口将抛出异常。
6
7## 导入模块
8
9```js
10import document from '@ohos.document';
11```
12
13## document.choose<sup>(deprecated)</sup>
14
15choose(types?: string[]): Promise&lt;string&gt;
16
17通过文件管理器选择文件,异步返回文件URI,使用promise形式返回结果。
18
19**系统能力**:SystemCapability.FileManagement.UserFileService
20
21**参数:**
22
23  | 参数名 | 类型   | 必填 | 说明                         |
24  | ------ | ------ | ---- | ---------------------------- |
25  | types   | string[] | 否   | 限定文件选择的类型 |
26
27**返回值:**
28
29  | 类型                  | 说明           |
30  | --------------------- | -------------- |
31  | Promise&lt;string&gt; | 异步返回文件URI(注:当前返回错误码) |
32
33**示例:**
34
35  ```js
36  let types = [];
37  document.choose(types);
38  ```
39## document.choose<sup>(deprecated)</sup>
40
41choose(callback:AsyncCallback&lt;string&gt;): void
42
43通过文件管理器选择文件,异步返回文件URI,使用callback形式返回结果。
44
45**系统能力**:SystemCapability.FileManagement.UserFileService
46
47**参数:**
48
49  | 参数名   | 类型                        | 必填 | 说明                         |
50  | -------- | --------------------------- | ---- | ---------------------------- |
51  | callback | AsyncCallback&lt;string&gt; | 是   | 异步获取对应文件URI(注:当前返回错误码) |
52
53**示例:**
54
55  ```js
56  let uri = "";
57  document.choose(function(err, uri) {
58        //do something with uri
59  });
60  ```
61## document.choose<sup>(deprecated)</sup>
62
63choose(types:string[], callback:AsyncCallback&lt;string&gt;): void
64
65通过文件管理器选择文件,异步返回文件URI,使用callback形式返回结果。
66
67**系统能力**:SystemCapability.FileManagement.UserFileService
68
69**参数:**
70
71  | 参数名   | 类型                        | 必填 | 说明                         |
72  | -------- | --------------------------- | ---- | ---------------------------- |
73  | types    | string[]                      | 是   | 限定选择文件的类型 |
74  | callback | AsyncCallback&lt;string&gt; | 是   | 异步获取对应文件URI(注:当前返回错误码) |
75
76**示例:**
77
78  ```js
79  let types = [];
80  let uri = "";
81  document.choose(types, function(err, uri) {
82        //do something with uri
83  });
84  ```
85
86## document.show<sup>(deprecated)</sup>
87
88show(uri:string, type:string):Promise&lt;void&gt;
89
90异步打开URI对应的文件,使用promise形式返回结果。
91
92**系统能力**:SystemCapability.FileManagement.UserFileService
93
94**参数:**
95
96  | 参数名 | 类型   | 必填 | 说明                         |
97  | ---- | ------ | ---- | ---------------------------- |
98  | uri | string | 是   | 待打开的文件URI |
99  | type | string | 是   | 待打开文件的类型 |
100
101**返回值:**
102
103  | 类型                  | 说明         |
104  | --------------------- | ------------ |
105  | Promise&lt;void&gt; | Promise回调返回void表示成功打开文件(注:当前返回错误码) |
106
107**示例:**
108
109  ```js
110  let type = "";
111  let uri = "";
112  document.show(uri, type);
113  ```
114
115## document.show<sup>(deprecated)</sup>
116
117show(uri:string, type:string, callback:AsyncCallback&lt;void&gt;): void
118
119异步打开URI对应的文件,使用callback形式返回结果。
120
121**系统能力**:SystemCapability.FileManagement.UserFileService
122
123**参数:**
124
125  | 参数名   | 类型                        | 必填 | 说明                         |
126  | -------- | --------------------------- | ---- | ---------------------------- |
127  | uri | string | 是   | 待打开的文件URI |
128  | type | string | 是   | 待打开文件的类型 |
129  | callback | AsyncCallback&lt;void&gt; | 是   | 异步打开uri对应文件(注:当前返回错误码)   |
130
131**示例:**
132
133  ```js
134  let type = "";
135  let uri = "";
136  document.show(uri, type, function(err) {
137        //do something
138  });
139  ```
140
141