Skip to content
体验新版
项目
组织
正在加载...
登录
切换导航
打开侧边栏
OpenHarmony
Docs
提交
30d0955f
D
Docs
项目概览
OpenHarmony
/
Docs
大约 1 年 前同步成功
通知
159
Star
292
Fork
28
代码
文件
提交
分支
Tags
贡献者
分支图
Diff
Issue
0
列表
看板
标记
里程碑
合并请求
0
Wiki
0
Wiki
分析
仓库
DevOps
项目成员
Pages
D
Docs
项目概览
项目概览
详情
发布
仓库
仓库
文件
提交
分支
标签
贡献者
分支图
比较
Issue
0
Issue
0
列表
看板
标记
里程碑
合并请求
0
合并请求
0
Pages
分析
分析
仓库分析
DevOps
Wiki
0
Wiki
成员
成员
收起侧边栏
关闭侧边栏
动态
分支图
创建新Issue
提交
Issue看板
提交
30d0955f
编写于
4月 16, 2022
作者:
Z
zhouzhichao
浏览文件
操作
浏览文件
下载
电子邮件补丁
差异文件
add js-apis-document.md
Signed-off-by:
N
zhouzhichao
<
zhouzhichao3@huawei.com
>
上级
67332246
变更
4
显示空白变更内容
内联
并排
Showing
4 changed file
with
272 addition
and
0 deletion
+272
-0
en/application-dev/reference/apis/Readme-EN.md
en/application-dev/reference/apis/Readme-EN.md
+1
-0
en/application-dev/reference/apis/js-apis-document.md
en/application-dev/reference/apis/js-apis-document.md
+135
-0
zh-cn/application-dev/reference/apis/Readme-CN.md
zh-cn/application-dev/reference/apis/Readme-CN.md
+1
-0
zh-cn/application-dev/reference/apis/js-apis-document.md
zh-cn/application-dev/reference/apis/js-apis-document.md
+135
-0
未找到文件。
en/application-dev/reference/apis/Readme-EN.md
浏览文件 @
30d0955f
...
...
@@ -118,6 +118,7 @@
-
File Management
-
[
@ohos.document
](
js-apis-document.md
)
-
[
@ohos.environment
](
js-apis-environment.md
)
-
[
@ohos.fileio
](
js-apis-fileio.md
)
-
[
@ohos.fileManager
](
js-apis-filemanager.md
)
...
...
en/application-dev/reference/apis/js-apis-document.md
0 → 100644
浏览文件 @
30d0955f
# document
> ![icon-note.gif](public_sys-resources/icon-note.gif) **NOTE:**<br/>
> The interface of this module will be discarded later.
## Modules to Import
```
js
import
document
from
'
@ohos.document
'
;
```
## Guidelines
Using this function module will throw an error code.
## document.choose
choose(type:string[]): Promise
<
string
>
Selects a file using the file manager and returns the file URI asynchronously using a promise.
**System capability**
:SystemCapability.FileManagement.File.FileIO
-
**Parameters**
| Name | Type | Mandatory| Description |
| ------ | ------ | ---- | ---------------------------- |
| type | string[] | No | Type of the file selected. |
-
Return value
| Type | Description |
| --------------------- | -------------- |
| Promise
<
string
>
| URI of the file(Note: the current returned error code) |
-
Example
```
js
await
document
.
choose
(
type
);
```
## document.choose
choose(callback:AsyncCallback
<
string
>
): void
Selects a file using the file manager and returns the file URI using an asynchronous callback.
**System capability**
:SystemCapability.FileManagement.File.FileIO
-
**Parameters**
| Name | Type | Mandatory| Description |
| -------- | --------------------------- | ---- | ---------------------------- |
| callback | AsyncCallback
<
string
>
| Yes | Callback used to obtain the URI of the file asynchronously(Note: the current returned error code) |
-
Example
```
js
await
document
.
choose
(
function
(
err
,
uri
)
{
//do something with uri
});
```
## document.choose
choose(type:string[], callback:AsyncCallback
<
string
>
): void
Selects a file using the file manager and returns the file URI using an asynchronous callback.
**System capability**
:SystemCapability.FileManagement.File.FileIO
-
**Parameters**
| Name | Type | Mandatory| Description |
| -------- | --------------------------- | ---- | ---------------------------- |
| type | string[] | No | Type of the file selected. |
| callback | AsyncCallback
<
string
>
| Yes | Callback used to obtain the URI of the file asynchronously(Note: the current returned error code) |
-
Example
```
js
await
document
.
choose
(
type
,
function
(
err
,
uri
)
{
//do something with uri
});
```
## document.show
show(url:string, type:string):Promise
<
number
>
Asynchronously opens the file corresponding to the URI and returns the result using a promise.
**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. Currently |
-
Return value
| Type | Description |
| --------------------- | ------------ |
| Promise
<
void
>
| Returns void if the file is open successfully(Note: the current returned error code) |
-
Example
```
js
await
document
.
show
(
uri
,
type
);
```
## document.show
show(url:string, type:string, callback:AsyncCallback
<
void
>
): void
Asynchronously opens the file corresponding to the URI and returns the result using a callback.
**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. Currently |
| callback | AsyncCallback
<
void
>
| Yes | Asynchronous callback used to open the file corresponding to the URI(Note: the current returned error code) |
-
Example
```
js
await
document
.
show
(
uri
,
type
,
function
(
err
)
{
//do something
});
```
zh-cn/application-dev/reference/apis/Readme-CN.md
浏览文件 @
30d0955f
...
...
@@ -118,6 +118,7 @@
-
文件管理
-
[
@ohos.document (文件交互)
](
js-apis-document.md
)
-
[
@ohos.environment (目录环境能力)
](
js-apis-environment.md
)
-
[
@ohos.fileio (文件管理)
](
js-apis-fileio.md
)
-
[
@ohos.fileManager (公共文件访问与管理)
](
js-apis-filemanager.md
)
...
...
zh-cn/application-dev/reference/apis/js-apis-document.md
0 → 100644
浏览文件 @
30d0955f
# document
> ![icon-note.gif](public_sys-resources/icon-note.gif) **说明:**
> 本模块接口后续将废弃。
## 导入模块
```
js
import
document
from
'
@ohos.document
'
;
```
## 使用说明
调用以下接口抛出异常,不建议在OpenHarmony使用以下接口。
## 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
});
```
编辑
预览
Markdown
is supported
0%
请重试
或
添加新附件
.
添加附件
取消
You are about to add
0
people
to the discussion. Proceed with caution.
先完成此消息的编辑!
取消
想要评论请
注册
或
登录