Skip to content
体验新版
项目
组织
正在加载...
登录
切换导航
打开侧边栏
OpenHarmony
Docs
提交
63211bb4
D
Docs
项目概览
OpenHarmony
/
Docs
12 个月 前同步成功
通知
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看板
体验新版 GitCode,发现更多精彩内容 >>
未验证
提交
63211bb4
编写于
3月 28, 2023
作者:
O
openharmony_ci
提交者:
Gitee
3月 28, 2023
浏览文件
操作
浏览文件
下载
差异文件
!16509 添加fileShare和fileUri的接口文档
Merge pull request !16509 from 张凯祥/zkx_master
上级
24c2a50d
4363f24b
变更
3
隐藏空白更改
内联
并排
Showing
3 changed file
with
181 addition
and
0 deletion
+181
-0
zh-cn/application-dev/reference/apis/Readme-CN.md
zh-cn/application-dev/reference/apis/Readme-CN.md
+2
-0
zh-cn/application-dev/reference/apis/js-apis-file-fileUri.md
zh-cn/application-dev/reference/apis/js-apis-file-fileUri.md
+60
-0
zh-cn/application-dev/reference/apis/js-apis-fileShare.md
zh-cn/application-dev/reference/apis/js-apis-fileShare.md
+119
-0
未找到文件。
zh-cn/application-dev/reference/apis/Readme-CN.md
浏览文件 @
63211bb4
...
...
@@ -236,6 +236,7 @@
-
[
@ohos.file.environment (目录环境能力)
](
js-apis-file-environment.md
)
-
[
@ohos.file.fileAccess (公共文件访问与管理)
](
js-apis-fileAccess.md
)
-
[
@ohos.file.fileExtensionInfo (公共文件访问与管理属性信息)
](
js-apis-fileExtensionInfo.md
)
-
[
@ohos.file.fileUri (文件URI)
](
js-apis-file-fileUri.md
)
-
[
@ohos.file.fs (文件管理)
](
js-apis-file-fs.md
)
-
[
@ohos.file.hash (文件哈希处理)
](
js-apis-file-hash.md
)
-
[
@ohos.file.picker (选择器)
](
js-apis-file-picker.md
)
...
...
@@ -244,6 +245,7 @@
-
[
@ohos.file.storageStatistics (应用空间统计)
](
js-apis-file-storage-statistics.md
)
-
[
@ohos.file.volumeManager (卷管理)
](
js-apis-file-volumemanager.md
)
-
[
@ohos.filemanagement.userFileManager (用户数据管理)
](
js-apis-userFileManager.md
)
-
[
@ohos.fileShare (文件分享)
](
js-apis-fileShare.md
)
-
电话服务
-
[
@ohos.contact (联系人)
](
js-apis-contact.md
)
...
...
zh-cn/application-dev/reference/apis/js-apis-file-fileUri.md
0 → 100644
浏览文件 @
63211bb4
# @ohos.file.fileUri (文件URI)
该模块提供通过PATH获取文件统一资源标志符(Uniform Resource Identifier,URI),后续可通过使用
[
@ohos.file.fs
](
js-apis-file-fs.md
)
进行相关open、read、write等操作,实现文件分享。
> **说明:**
> - 本模块首批接口从API version 9开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。
## 导入模块
```
js
import
fileUri
from
"
@ohos.file.fileUri
"
;
```
使用该功能模块前,需要先获取其应用沙箱路径,开发示例如下:
```
js
import
UIAbility
from
'
@ohos.app.ability.UIAbility
'
;
export
default
class
EntryAbility
extends
UIAbility
{
onWindowStageCreate
(
windowStage
)
{
let
context
=
this
.
context
;
let
pathDir
=
context
.
filesDir
;
}
}
```
## fileUri.getUriFromPath
getUriFromPath(path: string): string
以同步方法获取文件URI。
**系统能力**
:SystemCapability.FileManagement.AppFileService
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| ------ | ------ | ---- | -------------------------- |
| path | string | 是 | 文件的沙箱路径 |
**返回值:**
| 类型 | 说明 |
| ---------------------------- | ---------- |
| string | 返回文件URI |
**错误码:**
以下错误码的详细介绍请参见
[
文件管理子系统错误码
](
../errorcodes/errorcode-filemanagement.md#错误码适配指导
)
| 错误码ID | 错误信息 |
| ---------------------------- | ---------- |
| 401 | The input parameter is invalid |
**示例:**
```
js
let
filePath
=
pathDir
+
"
test.txt
"
;
let
uri
=
fileUri
.
getUriFromPath
(
filePath
);
```
zh-cn/application-dev/reference/apis/js-apis-fileShare.md
0 → 100644
浏览文件 @
63211bb4
# @ohos.fileShare (文件分享)
该模块提供文件分享能力,提供系统应用将公共目录文件统一资源标志符(Uniform Resource Identifier,URI)以读写权限授权给其他应用的接口,授权后应用可通过
[
@ohos.file.fs
](
js-apis-file-fs.md
)
的相关接口进行相关open、read、write等操作,实现文件分享。
> **说明:**
> - 本模块首批接口从API version 9开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。
## 导入模块
```
js
import
fileShare
from
'
@ohos.fileShare
'
;
```
## fileShare.grantUriPermission
grantUriPermission(uri: string, bundleName: string, mode: number, callback: AsyncCallback
<
void
>
): void
对公共目录文件URI进行授权操作,使用callback异步回调。
**需要权限**
:ohos.permission.WRITE_MEDIA
**系统接口**
:此接口为系统接口
**系统能力**
:SystemCapability.FileManagement.AppFileService
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| ------ | ------ | ---- | -------------------------- |
| uri | string | 是 | 公共目录文件URI |
| bundleName | string | 是 | 分享目标的包名 |
| mode | number | 是 | 授权的权限,参考
[
wantConstant.Flags
](
js-apis-app-ability-wantConstant.md#wantconstantflags
)
<br/>
wantConstant.Flags.FLAG_AUTH_READ_URI_PERMISSION:读授权
<br/>
wantConstant.Flags.FLAG_AUTH_WRITE_URI_PERMISSION:写授权|
| callback | AsyncCallback
<
void
>
| 是 | 异步授权之后的回调 |
**错误码:**
以下错误码的详细介绍请参见
[
文件管理子系统错误码
](
../errorcodes/errorcode-filemanagement.md#错误码适配指导
)
| 错误码ID | 错误信息 |
| ---------------------------- | ---------- |
| 201 | Permission verification failed |
| 202 | The caller is not a system application |
| 401 | The input parameter is invalid |
| 143000001 | IPC error |
**示例:**
```
js
import
wantConstant
from
'
@ohos.app.ability.wantConstant
'
;
let
uri
=
'
datashare:///media/image/8
'
;
let
bundleName
=
'
com.demo.test
'
;
try
{
fileShare
.
grantUriPermission
(
uri
,
bundleName
,
wantConstant
.
Flags
.
FLAG_AUTH_READ_URI_PERMISSION
|
wantConstant
.
Flags
.
FLAG_AUTH_WRITE_URI_PERMISSION
,
(
err
)
=>
{
if
(
err
)
{
console
.
error
(
"
grantUriPermission failed with error:
"
+
err
);
return
;
}
console
.
info
(
"
grantUriPermission success!
"
);
});
}
catch
(
error
)
{
console
.
error
(
"
grantUriPermission failed with error:
"
+
error
);
}
```
## fileShare.grantUriPermission
grantUriPermission(uri: string, bundleName: string, mode: number): Promise
<
void
>
将公共目录文件URI进行授权操作,使用Promise异步回调。
**需要权限**
:ohos.permission.WRITE_MEDIA
**系统接口**
:此接口为系统接口
**系统能力**
:SystemCapability.FileManagement.AppFileService
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| ------ | ------ | ---- | -------------------------- |
| uri | string | 是 | 公共目录文件URI |
| bundleName | string | 是 | 分享目标的包名 |
| mode | number | 是 | 授权的权限,参考
[
wantConstant.Flags
](
js-apis-app-ability-wantConstant.md#wantconstantflags
)
<br/>
wantConstant.Flags.FLAG_AUTH_READ_URI_PERMISSION:读授权
<br/>
wantConstant.Flags.FLAG_AUTH_WRITE_URI_PERMISSION:写授权|
**返回值:**
| 类型 | 说明 |
| ---------------------------- | ---------- |
| Promise
<
void
>
| Promise对象,无返回值 |
**错误码:**
以下错误码的详细介绍请参见
[
文件管理子系统错误码
](
../errorcodes/errorcode-filemanagement.md#错误码适配指导
)
| 错误码ID | 错误信息 |
| ---------------------------- | ---------- |
| 201 | Permission verification failed |
| 202 | The caller is not a system application |
| 401 | The input parameter is invalid |
| 143000001 | IPC error |
**示例:**
```
js
import
wantConstant
from
'
@ohos.app.ability.wantConstant
'
;
let
uri
=
'
datashare:///media/image/8
'
;
let
bundleName
=
'
com.demo.test
'
;
try
{
fileShare
.
grantUriPermission
(
uri
,
bundleName
,
wantConstant
.
Flags
.
FLAG_AUTH_READ_URI_PERMISSION
|
wantConstant
.
Flags
.
FLAG_AUTH_WRITE_URI_PERMISSION
).
then
(
function
()
{
console
.
info
(
"
grantUriPermission success!
"
);
}).
catch
(
function
(
error
)
{
console
.
error
(
"
grantUriPermission failed with error:
"
+
error
);
});
}
catch
(
error
)
{
console
.
error
(
"
grantUriPermission failed with error:
"
+
error
);
}
```
\ No newline at end of file
编辑
预览
Markdown
is supported
0%
请重试
或
添加新附件
.
添加附件
取消
You are about to add
0
people
to the discussion. Proceed with caution.
先完成此消息的编辑!
取消
想要评论请
注册
或
登录