Skip to content
体验新版
项目
组织
正在加载...
登录
切换导航
打开侧边栏
OpenHarmony
Docs
提交
a6ad86cb
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看板
未验证
提交
a6ad86cb
编写于
7月 14, 2023
作者:
O
openharmony_ci
提交者:
Gitee
7月 14, 2023
浏览文件
操作
浏览文件
下载
差异文件
!20672 photoAccessHelper接口文档描述修改,保证描述准确性
Merge pull request !20672 from 胡伟奇/api_update
上级
5e12bb6c
0fe9fba4
变更
4
展开全部
隐藏空白更改
内联
并排
Showing
4 changed file
with
261 addition
and
238 deletion
+261
-238
zh-cn/application-dev/file-management/photoAccessHelper-notify-guidelines.md
...ev/file-management/photoAccessHelper-notify-guidelines.md
+20
-20
zh-cn/application-dev/file-management/photoAccessHelper-overview.md
...ication-dev/file-management/photoAccessHelper-overview.md
+3
-3
zh-cn/application-dev/reference/apis/js-apis-photoAccessHelper.md
...plication-dev/reference/apis/js-apis-photoAccessHelper.md
+9
-9
zh-cn/application-dev/reference/apis/js-apis-userFileManager.md
...application-dev/reference/apis/js-apis-userFileManager.md
+229
-206
未找到文件。
zh-cn/application-dev/file-management/photoAccessHelper-notify-guidelines.md
浏览文件 @
a6ad86cb
# 媒体资源变更通知相关
# 媒体资源
(图片、视频和相册)
变更通知相关
photoAccessHelper提供监听媒体资源变更的接口,供开发者对指定媒体资源变更进行监听。
photoAccessHelper提供监听媒体资源变更的接口,供开发者对指定媒体资源变更进行监听。
...
@@ -12,23 +12,23 @@ photoAccessHelper提供监听媒体资源变更的接口,供开发者对指定
...
@@ -12,23 +12,23 @@ photoAccessHelper提供监听媒体资源变更的接口,供开发者对指定
## 监听指定URI
## 监听指定URI
通过调用
[
registerChange
](
../reference/apis/js-apis-photoAccessHelper.md#registerchange
)
接口监听指定
URI
。当被监听对象发生变更时返回监听器回调函数的值。
通过调用
[
registerChange
](
../reference/apis/js-apis-photoAccessHelper.md#registerchange
)
接口监听指定
uri
。当被监听对象发生变更时返回监听器回调函数的值。
###
打开对FileAsset的URI的
监听
###
对指定FileAsset注册
监听
打开对FileAsset的URI的进行监听,当目的FileAsset发生变更时,返回监听器回调函数的值
。
对指定FileAsset注册监听,当被监听的FileAsset发生变更时,返回监听回调
。
**前提条件:**
**前提条件:**
-
获取相册管理模块photoAccessHelper实例。
-
获取相册管理模块photoAccessHelper实例。
-
申请相册管理模块权限'ohos.permission.READ_IMAGEVIDEO'和'ohos.permission.WRITE_IMAGEVIDEO'。
-
申请相册管理模块权限'ohos.permission.READ_IMAGEVIDEO'和'ohos.permission.WRITE_IMAGEVIDEO'。
下面以
打开对一张图片的URI的
监听,通过将这张图片设置为收藏触发监听回调为例。
下面以
对一张图片注册
监听,通过将这张图片设置为收藏触发监听回调为例。
**开发步骤:**
**开发步骤:**
1.
[
获取指定媒体资源
](
photoAccessHelper-resource-guidelines.md#获取指定媒体资源
)
。
1.
[
获取指定媒体资源
](
photoAccessHelper-resource-guidelines.md#获取指定媒体资源
)
。
2.
打开对指定媒体资源URI的
监听。
2.
对指定FileAsset注册
监听。
3.
将指定媒体资源设置为收藏。
3.
将指定媒体资源设置为收藏。
```
ts
```
ts
...
@@ -58,22 +58,22 @@ try {
...
@@ -58,22 +58,22 @@ try {
}
}
```
```
###
打开对Album的URI的
监听
###
对指定Album注册
监听
打开对Album的URI的进行监听,当目的Album发生变更时,返回监听器回调函数的值
。
对指定Album注册监听,当被监听的Album发生变更时,返回监听回调
。
**前提条件:**
**前提条件:**
-
获取相册管理模块photoAccessHelper实例。
-
获取相册管理模块photoAccessHelper实例。
-
申请相册管理模块权限'ohos.permission.READ_IMAGEVIDEO'和'ohos.permission.WRITE_IMAGEVIDEO'。
-
申请相册管理模块权限'ohos.permission.READ_IMAGEVIDEO'和'ohos.permission.WRITE_IMAGEVIDEO'。
下面以
打开对一个用户相册的URI的监听,通过将重名名这个
相册触发监听回调为例。
下面以
对一个用户相册注册监听,通过重命名
相册触发监听回调为例。
**开发步骤:**
**开发步骤:**
1.
[
获取用户相册
](
photoAccessHelper-userAlbum-guidelines.md#获取用户相册
)
。
1.
[
获取用户相册
](
photoAccessHelper-userAlbum-guidelines.md#获取用户相册
)
。
2.
打开对指定用户相册URI的
监听。
2.
对指定Album注册
监听。
3.
将指定用户相册重
名
名。
3.
将指定用户相册重
命
名。
```
ts
```
ts
import
dataSharePredicates
from
'
@ohos.data.dataSharePredicates
'
;
import
dataSharePredicates
from
'
@ohos.data.dataSharePredicates
'
;
...
@@ -106,22 +106,22 @@ try {
...
@@ -106,22 +106,22 @@ try {
## 模糊监听
## 模糊监听
通过设置forChildUris值为true来
打开模糊监听,URI为相册URI时,forChildUris为true能监听到相册中文件的变化,如果是false只能监听相册本身变化。URI为fileAsset时,forChildUris为true、false没有区别,URI为DefaultChangeUri时,forChildUris必须为true,如果为false将找不到该URI
,收不到任何消息。
通过设置forChildUris值为true来
注册模糊监听,uri为相册uri时,forChildUris为true能监听到相册中文件的变化,如果是false只能监听相册本身变化。uri为fileAsset时,forChildUris为true、false没有区别,uri为DefaultChangeUri时,forChildUris必须为true,如果为false将找不到该uri
,收不到任何消息。
###
打开对所有FileAsset的URI的
监听
###
对所有FileAsset注册
监听
打开对所有FileAsset的URI的进行监听,当有FileAsset发生变更时,返回监听器回调函数的值
。
对所有FileAsset注册监听,当有被监听的FileAsset发生变更时,返回监听回调
。
**前提条件:**
**前提条件:**
-
获取相册管理模块photoAccessHelper实例。
-
获取相册管理模块photoAccessHelper实例。
-
申请相册管理模块权限'ohos.permission.READ_IMAGEVIDEO'和'ohos.permission.WRITE_IMAGEVIDEO'。
-
申请相册管理模块权限'ohos.permission.READ_IMAGEVIDEO'和'ohos.permission.WRITE_IMAGEVIDEO'。
下面以
打开所有FileAsset的URI的监听,通过将一张图片进行设置和取消
收藏触发监听回调为例。
下面以
对所有FileAsset注册监听,对被监听的FileAsset设置为
收藏触发监听回调为例。
**开发步骤:**
**开发步骤:**
1.
打开对所有FileAsset的URI的
监听。
1.
对所有FileAsset注册
监听。
2.
[
获取指定媒体资源
](
photoAccessHelper-resource-guidelines.md#获取指定媒体资源
)
。
2.
[
获取指定媒体资源
](
photoAccessHelper-resource-guidelines.md#获取指定媒体资源
)
。
3.
将指定媒体资源设置为收藏。
3.
将指定媒体资源设置为收藏。
...
@@ -150,21 +150,21 @@ try {
...
@@ -150,21 +150,21 @@ try {
}
}
```
```
##
关闭
对指定URI的监听
##
取消
对指定URI的监听
关闭指定URI的监听,通过调用
[
unRegisterChange
](
../reference/apis/js-apis-photoAccessHelper.md#unregisterchange
)
接口关闭对指定URI的监听。一个URI可以注册多个监听,存在多个callback监听时,可以取消指定注册的callback的监听;不指定callback时解除该URI
的所有监听。
取消对指定uri的监听,通过调用
[
unRegisterChange
](
../reference/apis/js-apis-photoAccessHelper.md#unregisterchange
)
接口取消对指定uri的监听。一个uri可以注册多个监听,存在多个callback监听时,可以取消指定注册的callback的监听;不指定callback时取消该uri
的所有监听。
**前提条件:**
**前提条件:**
-
获取相册管理模块photoAccessHelper实例。
-
获取相册管理模块photoAccessHelper实例。
-
申请相册管理模块权限'ohos.permission.READ_IMAGEVIDEO'和'ohos.permission.WRITE_IMAGEVIDEO'。
-
申请相册管理模块权限'ohos.permission.READ_IMAGEVIDEO'和'ohos.permission.WRITE_IMAGEVIDEO'。
下面以
一张图片的URI的监听中某一个callback监听进行关闭,通过将这张图片设置为收藏实现关闭的callback监听不再触发监听回调为例
。
下面以
取消对一张图片指定的监听为例,取消监听后,改变图片的收藏状态不再触发对应的监听回调
。
**开发步骤:**
**开发步骤:**
1.
[
获取指定媒体资源
](
photoAccessHelper-resource-guidelines.md#获取指定媒体资源
)
。
1.
[
获取指定媒体资源
](
photoAccessHelper-resource-guidelines.md#获取指定媒体资源
)
。
2.
关闭对指定媒体资源URI
的监听。
2.
取消对指定媒体资源uri
的监听。
3.
将指定媒体资源设置为收藏。
3.
将指定媒体资源设置为收藏。
```
ts
```
ts
...
...
zh-cn/application-dev/file-management/photoAccessHelper-overview.md
浏览文件 @
a6ad86cb
...
@@ -20,9 +20,9 @@ PhotoAccessHelper提供相册管理模块相关能力,包括创建相册以及
...
@@ -20,9 +20,9 @@ PhotoAccessHelper提供相册管理模块相关能力,包括创建相册以及
-
收藏夹
-
收藏夹
-
视频相册
-
视频相册
-
截屏和录屏相册
-
截屏和录屏相册
-
[
媒体资源变更通知相关
](
photoAccessHelper-notify-guidelines.md
)
,包括:
-
[
媒体资源
(图片、视频和相册)
变更通知相关
](
photoAccessHelper-notify-guidelines.md
)
,包括:
-
打开
对指定URI的监听
-
注册
对指定URI的监听
-
关闭
指定URI的监听
-
取消
指定URI的监听
> **说明:**
> **说明:**
> 本开发指导基于API Version 10,仅适用于Stage模型。
> 本开发指导基于API Version 10,仅适用于Stage模型。
...
...
zh-cn/application-dev/reference/apis/js-apis-photoAccessHelper.md
浏览文件 @
a6ad86cb
...
@@ -185,7 +185,7 @@ createAsset(displayName: string, callback: AsyncCallback<PhotoAsset>): voi
...
@@ -185,7 +185,7 @@ createAsset(displayName: string, callback: AsyncCallback<PhotoAsset>): voi
**错误码:**
**错误码:**
接口抛出错误码的详细介绍请参见
[
通用错误码
](
../errorcodes/errorcode-universal
.md
)
和
[
通用错误码
](
../errorcodes/errorcode-universal.md
)
。
接口抛出错误码的详细介绍请参见
[
文件管理错误码
](
../errorcodes/errorcode-filemanagement
.md
)
和
[
通用错误码
](
../errorcodes/errorcode-universal.md
)
。
| 错误码ID | 错误信息 |
| 错误码ID | 错误信息 |
| -------- | ---------------------------------------- |
| -------- | ---------------------------------------- |
...
@@ -236,7 +236,7 @@ createAsset(displayName: string): Promise<PhotoAsset>;
...
@@ -236,7 +236,7 @@ createAsset(displayName: string): Promise<PhotoAsset>;
**错误码:**
**错误码:**
接口抛出错误码的详细介绍请参见
[
通用错误码
](
../errorcodes/errorcode-universal.md
)
。
接口抛出错误码的详细介绍请参见
[
文件管理错误码
](
../errorcodes/errorcode-filemanagement.md
)
和
[
通用错误码
](
../errorcodes/errorcode-universal.md
)
。
| 错误码ID | 错误信息 |
| 错误码ID | 错误信息 |
| -------- | ---------------------------------------- |
| -------- | ---------------------------------------- |
...
@@ -337,7 +337,7 @@ createAsset(displayName: string, options: PhotoCreateOptions): Promise<PhotoA
...
@@ -337,7 +337,7 @@ createAsset(displayName: string, options: PhotoCreateOptions): Promise<PhotoA
**错误码:**
**错误码:**
接口抛出错误码的详细介绍请参见
[
通用错误码
](
../errorcodes/errorcode-universal.md
)
。
接口抛出错误码的详细介绍请参见
[
文件管理错误码
](
../errorcodes/errorcode-filemanagement.md
)
和
[
通用错误码
](
../errorcodes/errorcode-universal.md
)
。
| 错误码ID | 错误信息 |
| 错误码ID | 错误信息 |
| -------- | ---------------------------------------- |
| -------- | ---------------------------------------- |
...
@@ -1029,7 +1029,7 @@ async function example() {
...
@@ -1029,7 +1029,7 @@ async function example() {
registerChange(uri: string, forChildUris: boolean, callback: Callback
<
ChangeData
>
) : void
registerChange(uri: string, forChildUris: boolean, callback: Callback
<
ChangeData
>
) : void
打开
对指定uri的监听,使用callback方式返回异步结果。
注册
对指定uri的监听,使用callback方式返回异步结果。
**需要权限**
:ohos.permission.READ_IMAGEVIDEO
**需要权限**
:ohos.permission.READ_IMAGEVIDEO
...
@@ -1095,7 +1095,7 @@ async function example() {
...
@@ -1095,7 +1095,7 @@ async function example() {
unRegisterChange(uri: string, callback?: Callback
<
ChangeData
>
): void
unRegisterChange(uri: string, callback?: Callback
<
ChangeData
>
): void
关闭指定uri的监听,一个uri可以注册多个监听,存在多个callback监听时,可以取消指定注册的callback的监听;不指定callback时解除
该uri的所有监听。
取消指定uri的监听,一个uri可以注册多个监听,存在多个callback监听时,可以取消指定注册的callback的监听;不指定callback时取消
该uri的所有监听。
**需要权限**
:ohos.permission.READ_IMAGEVIDEO
**需要权限**
:ohos.permission.READ_IMAGEVIDEO
...
@@ -1106,7 +1106,7 @@ unRegisterChange(uri: string, callback?: Callback<ChangeData>): void
...
@@ -1106,7 +1106,7 @@ unRegisterChange(uri: string, callback?: Callback<ChangeData>): void
| 参数名 | 类型 | 必填 | 说明 |
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ------------------------------------------- | ---- | ------------------------------------------------------------ |
| -------- | ------------------------------------------- | ---- | ------------------------------------------------------------ |
| uri | string | 是 | PhotoAsset的uri, Album的uri或
[
DefaultChangeUri
](
#defaultchangeuri
)
的值。 |
| uri | string | 是 | PhotoAsset的uri, Album的uri或
[
DefaultChangeUri
](
#defaultchangeuri
)
的值。 |
| callback | Callback
<
[ChangeData](#changedata)
>
| 否 |
解除
[
registerChange
](
#registerchange
)
注册时的callback的监听,不填时,解除
该uri的所有监听。注:off指定注册的callback后不会进入此回调。 |
| callback | Callback
<
[ChangeData](#changedata)
>
| 否 |
取消
[
registerChange
](
#registerchange
)
注册时的callback的监听,不填时,取消
该uri的所有监听。注:off指定注册的callback后不会进入此回调。 |
**错误码:**
**错误码:**
...
@@ -1376,7 +1376,7 @@ get(member: string): MemberType;
...
@@ -1376,7 +1376,7 @@ get(member: string): MemberType;
| 参数名 | 类型 | 必填 | 说明 |
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ------------------------- | ---- | ----- |
| -------- | ------------------------- | ---- | ----- |
| member | string | 是 | 成员参数名称
例如:PhotoKeys.URI
。 |
| member | string | 是 | 成员参数名称
,在get时,除了uri、photoType和displayName三个属性之外,其他的属性都需要在fetchColumns中填入需要get的
[
PhotoKeys
](
#photokeys
)
,例如:get title属性fetchColumns: ['title']
。 |
**返回值:**
**返回值:**
...
@@ -1428,8 +1428,8 @@ set(member: string, value: string): void;
...
@@ -1428,8 +1428,8 @@ set(member: string, value: string): void;
| 参数名 | 类型 | 必填 | 说明 |
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ------------------------- | ---- | ----- |
| -------- | ------------------------- | ---- | ----- |
| member | string | 是 | 成员参数名称例如:
PhotoKeys.URI
。 |
| member | string | 是 | 成员参数名称例如:
[
PhotoKeys
](
#photokeys
)
.TITLE
。 |
| value | string | 是 | 设置成员参数名称,只能修改
PhotoKeys
.TITLE的值。 |
| value | string | 是 | 设置成员参数名称,只能修改
[
PhotoKeys
](
#photokeys
)
.TITLE的值。 |
**错误码:**
**错误码:**
...
...
zh-cn/application-dev/reference/apis/js-apis-userFileManager.md
浏览文件 @
a6ad86cb
此差异已折叠。
点击以展开。
编辑
预览
Markdown
is supported
0%
请重试
或
添加新附件
.
添加附件
取消
You are about to add
0
people
to the discussion. Proceed with caution.
先完成此消息的编辑!
取消
想要评论请
注册
或
登录