Skip to content
体验新版
项目
组织
正在加载...
登录
切换导航
打开侧边栏
OpenHarmony
Docs
提交
aa635c25
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看板
未验证
提交
aa635c25
编写于
7月 05, 2023
作者:
O
openharmony_ci
提交者:
Gitee
7月 05, 2023
浏览文件
操作
浏览文件
下载
差异文件
!20196 新增PhotoAccessHelper开发指导文档和接口文档
Merge pull request !20196 from 胡伟奇/add_PhotoAccessHelpe
上级
d0a11f37
27e31409
变更
7
展开全部
隐藏空白更改
内联
并排
Showing
7 changed file
with
4924 addition
and
0 deletion
+4924
-0
zh-cn/application-dev/file-management/Readme-CN.md
zh-cn/application-dev/file-management/Readme-CN.md
+6
-0
zh-cn/application-dev/file-management/photoAccessHelper-notify-guidelines.md
...ev/file-management/photoAccessHelper-notify-guidelines.md
+200
-0
zh-cn/application-dev/file-management/photoAccessHelper-overview.md
...ication-dev/file-management/photoAccessHelper-overview.md
+122
-0
zh-cn/application-dev/file-management/photoAccessHelper-resource-guidelines.md
.../file-management/photoAccessHelper-resource-guidelines.md
+283
-0
zh-cn/application-dev/file-management/photoAccessHelper-systemAlbum-guidelines.md
...le-management/photoAccessHelper-systemAlbum-guidelines.md
+306
-0
zh-cn/application-dev/file-management/photoAccessHelper-userAlbum-guidelines.md
...file-management/photoAccessHelper-userAlbum-guidelines.md
+329
-0
zh-cn/application-dev/reference/apis/js-apis-photoAccessHelper.md
...plication-dev/reference/apis/js-apis-photoAccessHelper.md
+3678
-0
未找到文件。
zh-cn/application-dev/file-management/Readme-CN.md
浏览文件 @
aa635c25
...
...
@@ -19,6 +19,12 @@
-
选择与保存用户文件(FilePicker)
-
[
选择用户文件
](
select-user-file.md
)
-
[
保存用户文件
](
save-user-file.md
)
-
相册管理(photoAccessHelper)
-
[
相册管理模块开发概述
](
photoAccessHelper-overview.md
)
-
[
媒体资源(图片、视频)相关
](
photoAccessHelper-resource-guidelines.md
)
-
[
用户相册相关
](
photoAccessHelper-userAlbum-guidelines.md
)
-
[
系统相册相关
](
photoAccessHelper-systemAlbum-guidelines.md
)
-
[
媒体资源变更通知相关
](
photoAccessHelper-notify-guidelines.md
)
-
[
开发用户文件管理器(仅对系统应用开放)
](
dev-user-file-manager.md
)
-
[
管理外置存储设备(仅对系统应用开放)
](
manage-external-storage.md
)
-
分布式文件系统
...
...
zh-cn/application-dev/file-management/photoAccessHelper-notify-guidelines.md
0 → 100644
浏览文件 @
aa635c25
# 媒体资源变更通知相关
photoAccessHelper提供监听媒体资源变更的接口,供开发者对指定媒体资源变更进行监听。
> **说明:**
>
> 在进行功能开发前,请开发者查阅[相册管理模块开发概述](photoAccessHelper-overview.md),了解如何获取相册管理模块实例和如何申请相册管理模块功能开发相关权限。
> 文档中使用到photoAccessHelper的地方默认为使用相册管理模块开发概述中获取的对象,如未添加此段代码报photoAccessHelper未定义的错误请自行添加。
媒体资源变更通知相关接口的异步调用仅支持使用callback方式。以下只列出部分接口使用方式,其他使用方式可以查阅
[
API参考
](
../reference/apis/js-apis-photoAccessHelper.md
)
。
如无特别说明,文档中涉及的待获取的资源均视为已经预置且在数据库中存在相应数据。如出现按照示例代码执行出现获取资源为空的情况请确认文件是否已预置,数据库中是否存在该文件的数据。
## 监听指定URI
通过调用
[
registerChange
](
../reference/apis/js-apis-photoAccessHelper.md#registerchange
)
接口监听指定URI。当被监听对象发生变更时返回监听器回调函数的值。
### 打开对FileAsset的URI的监听
打开对FileAsset的URI的进行监听,当目的FileAsset发生变更时,返回监听器回调函数的值。
**前提条件:**
-
获取相册管理模块photoAccessHelper实例。
-
申请相册管理模块权限'ohos.permission.READ_IMAGEVIDEO'和'ohos.permission.WRITE_IMAGEVIDEO'。
下面以打开对一张图片的URI的监听,通过将这张图片设置为收藏触发监听回调为例。
**开发步骤:**
1.
[
获取指定媒体资源
](
photoAccessHelper-resource-guidelines.md#获取指定媒体资源
)
。
2.
打开对指定媒体资源URI的监听。
3.
将指定媒体资源设置为收藏。
```
ts
import
dataSharePredicates
from
'
@ohos.data.dataSharePredicates
'
;
let
predicates
=
new
dataSharePredicates
.
DataSharePredicates
();
predicates
.
equalTo
(
photoAccessHelper
.
ImageVideoKey
.
DISPLAY_NAME
,
'
test.jpg
'
);
let
fetchOptions
=
{
fetchColumns
:
[],
predicates
:
predicates
};
try
{
let
fetchResult
=
await
phAccessHelper
.
getAssets
(
fetchOptions
);
let
fileAsset
=
await
fetchResult
.
getFirstObject
();
console
.
info
(
'
getAssets fileAsset.uri :
'
+
fileAsset
.
uri
);
let
onCallback
=
(
changeData
)
=>
{
console
.
info
(
'
onCallback successfully, changData:
'
+
JSON
.
stringify
(
changeData
));
}
phAccessHelper
.
registerChange
(
fileAsset
.
uri
,
false
,
onCallback
);
await
fileAsset
.
favorite
(
true
);
fetchResult
.
close
();
}
catch
(
err
)
{
console
.
error
(
'
onCallback failed with err:
'
+
err
);
}
```
### 打开对Album的URI的监听
打开对Album的URI的进行监听,当目的Album发生变更时,返回监听器回调函数的值。
**前提条件:**
-
获取相册管理模块photoAccessHelper实例。
-
申请相册管理模块权限'ohos.permission.READ_IMAGEVIDEO'和'ohos.permission.WRITE_IMAGEVIDEO'。
下面以打开对一个用户相册的URI的监听,通过将重名名这个相册触发监听回调为例。
**开发步骤:**
1.
[
获取用户相册
](
photoAccessHelper-userAlbum-guidelines.md#获取用户相册
)
。
2.
打开对指定用户相册URI的监听。
3.
将指定用户相册重名名。
```
ts
import
dataSharePredicates
from
'
@ohos.data.dataSharePredicates
'
;
let
predicates
=
new
dataSharePredicates
.
DataSharePredicates
();
let
albumName
=
photoAccessHelper
.
AlbumKey
.
ALBUM_NAME
;
predicates
.
equalTo
(
albumName
,
'
albumName
'
);
let
fetchOptions
=
{
fetchColumns
:
[],
predicates
:
predicates
};
try
{
let
fetchResult
=
await
phAccessHelper
.
getAlbums
(
photoAccessHelper
.
AlbumType
.
USER
,
photoAccessHelper
.
AlbumSubtype
.
USER_GENERIC
,
fetchOptions
);
let
album
=
await
fetchResult
.
getFirstObject
();
console
.
info
(
'
getAlbums successfullyfully, albumName:
'
+
album
.
albumUri
);
let
onCallback
=
(
changeData
)
=>
{
console
.
info
(
'
onCallback successfully, changData:
'
+
JSON
.
stringify
(
changeData
));
}
phAccessHelper
.
registerChange
(
album
.
albumUri
,
false
,
onCallback
);
album
.
albumName
=
'
newAlbumName
'
+
Date
.
now
();
await
album
.
commitModify
();
fetchResult
.
close
();
}
catch
(
err
)
{
console
.
error
(
'
onCallback failed with err:
'
+
err
);
}
```
## 模糊监听
通过设置forChildUris值为true来打开模糊监听,URI为相册URI时,forChildUris为true能监听到相册中文件的变化,如果是false只能监听相册本身变化。URI为fileAsset时,forChildUris为true、false没有区别,URI为DefaultChangeUri时,forChildUris必须为true,如果为false将找不到该URI,收不到任何消息。
### 打开对所有FileAsset的URI的监听
打开对所有FileAsset的URI的进行监听,当有FileAsset发生变更时,返回监听器回调函数的值。
**前提条件:**
-
获取相册管理模块photoAccessHelper实例。
-
申请相册管理模块权限'ohos.permission.READ_IMAGEVIDEO'和'ohos.permission.WRITE_IMAGEVIDEO'。
下面以打开所有FileAsset的URI的监听,通过将一张图片进行设置和取消收藏触发监听回调为例。
**开发步骤:**
1.
打开对所有FileAsset的URI的监听。
2.
[
获取指定媒体资源
](
photoAccessHelper-resource-guidelines.md#获取指定媒体资源
)
。
3.
将指定媒体资源设置为收藏。
```
ts
import
dataSharePredicates
from
'
@ohos.data.dataSharePredicates
'
;
let
onCallback
=
(
changeData
)
=>
{
console
.
info
(
'
onCallback successfully, changData:
'
+
JSON
.
stringify
(
changeData
));
}
phAccessHelper
.
registerChange
(
photoAccessHelper
.
DefaultChangeUri
.
DEFAULT_PHOTO_URI
,
true
,
onCallback
);
let
predicates
=
new
dataSharePredicates
.
DataSharePredicates
();
let
fetchOptions
=
{
fetchColumns
:
[],
predicates
:
predicates
};
try
{
let
fetchResult
=
await
phAccessHelper
.
getAssets
(
fetchOptions
);
let
fileAsset
=
await
fetchResult
.
getFirstObject
();
console
.
info
(
'
getAssets fileAsset.uri :
'
+
fileAsset
.
uri
);
await
fileAsset
.
favorite
(
true
);
fetchResult
.
close
();
}
catch
(
err
)
{
console
.
error
(
'
onCallback failed with err:
'
+
err
);
}
```
## 关闭对指定URI的监听
关闭指定URI的监听,通过调用
[
unRegisterChange
](
../reference/apis/js-apis-photoAccessHelper.md#unregisterchange
)
接口关闭对指定URI的监听。一个URI可以注册多个监听,存在多个callback监听时,可以取消指定注册的callback的监听;不指定callback时解除该URI的所有监听。
**前提条件:**
-
获取相册管理模块photoAccessHelper实例。
-
申请相册管理模块权限'ohos.permission.READ_IMAGEVIDEO'和'ohos.permission.WRITE_IMAGEVIDEO'。
下面以一张图片的URI的监听中某一个callback监听进行关闭,通过将这张图片设置为收藏实现关闭的callback监听不再触发监听回调为例。
**开发步骤:**
1.
[
获取指定媒体资源
](
photoAccessHelper-resource-guidelines.md#获取指定媒体资源
)
。
2.
关闭对指定媒体资源URI的监听。
3.
将指定媒体资源设置为收藏。
```
ts
import
dataSharePredicates
from
'
@ohos.data.dataSharePredicates
'
;
let
predicates
=
new
dataSharePredicates
.
DataSharePredicates
();
predicates
.
equalTo
(
photoAccessHelper
.
ImageVideoKey
.
DISPLAY_NAME
,
'
test.jpg
'
);
let
fetchOptions
=
{
fetchColumns
:
[],
predicates
:
predicates
};
try
{
let
fetchResult
=
await
phAccessHelper
.
getAssets
(
fetchOptions
);
let
fileAsset
=
await
fetchResult
.
getFirstObject
();
console
.
info
(
'
getAssets fileAsset.uri :
'
+
fileAsset
.
uri
);
let
onCallback1
=
(
changeData
)
=>
{
console
.
info
(
'
onCallback1, changData:
'
+
JSON
.
stringify
(
changeData
));
}
let
onCallback2
=
(
changeData
)
=>
{
console
.
info
(
'
onCallback2, changData:
'
+
JSON
.
stringify
(
changeData
));
}
phAccessHelper
.
registerChange
(
fileAsset
.
uri
,
false
,
onCallback1
);
phAccessHelper
.
registerChange
(
fileAsset
.
uri
,
false
,
onCallback2
);
phAccessHelper
.
unRegisterChange
(
fileAsset
.
uri
,
onCallback1
);
await
fileAsset
.
favorite
(
true
);
fetchResult
.
close
();
}
catch
(
err
)
{
console
.
error
(
'
onCallback failed with err:
'
+
err
);
}
```
zh-cn/application-dev/file-management/photoAccessHelper-overview.md
0 → 100644
浏览文件 @
aa635c25
# 相册管理模块开发概述
PhotoAccessHelper提供相册管理模块相关能力,包括创建相册以及访问、修改相册中的媒体数据信息等,具体分为:
-
[
媒体资源(图片、视频)相关
](
photoAccessHelper-resource-guidelines.md
)
,包括:
-
获取指定媒体资源
-
获取图片和视频缩略图
-
创建媒体资源
-
重命名媒体资源
-
将媒体资源放入回收站
-
[
用户相册相关
](
photoAccessHelper-userAlbum-guidelines.md
)
,包括:
-
创建用户相册
-
获取用户相册
-
重命名用户相册
-
添加图片和视频到用户相册中
-
获取用户相册中的图片和视频
-
从用户相册中移除图片和视频
-
删除用户相册
-
[
系统相册相关
](
photoAccessHelper-systemAlbum-guidelines.md
)
,包括:
-
收藏夹
-
视频相册
-
截屏和录屏相册
-
[
媒体资源变更通知相关
](
photoAccessHelper-notify-guidelines.md
)
,包括:
-
打开对指定URI的监听
-
关闭指定URI的监听
> **说明:**
> 本开发指导基于API Version 10,仅适用于Stage模型。
应用需要先获取相册管理模块实例,才能访问和修改相册中的媒体数据信息。相册管理模块涉及用户个人数据信息,所以应用需要向用户申请相册管理模块读写操作权限才能保证功能的正常运行。在使用相册管理模块相关接口时如无其他注明则默认在工程代码的pages/index.ets或者其他自创的ets文件中使用。
开发者在使用PhotoAccessHelper进行功能开发前,请先掌握以下内容:
-
[
获取相册管理模块实例
](
#获取相册管理模块实例
)
-
[
申请相册管理模块功能相关权限
](
#申请相册管理模块功能相关权限
)
## 获取相册管理模块实例
应用需要使用应用上下文Context通过接口
[
getPhotoAccessHelper
](
../reference/apis/js-apis-photoAccessHelper.md#photoaccesshelpergetphotoaccesshelper
)
,获取相册管理模块实例,用于访问和修改相册中媒体数据信息(如图片、视频)。
**开发步骤:**
1.
导入photoAccessHelper模块以使用相册管理模块相关接口。
2.
通过getContext获取应用上下文。
3.
获取相册管理模块实例。
```
ts
import
photoAccessHelper
from
'
@ohos.file.photoAccessHelper
'
;
// 此处获取的phAccessHelper实例为全局对象,后续文档中使用到的地方默认为使用此处获取的对象,如未添加此段代码报未定义的错误请自行添加。
const
context
=
getContext
(
this
);
let
phAccessHelper
=
photoAccessHelper
.
getPhotoAccessHelper
(
context
);
```
## 申请相册管理模块功能相关权限
相册管理模块的读写操作需要相应权限,在申请权限前,请保证符合
[
权限使用的基本原则
](
../security/accesstoken-overview.md#权限使用的基本原则
)
。涉及的权限如下表。
| 权限名 | 说明 | 授权方式 |
| ------------------------------ | ------------------------------------------ | ---------- |
| ohos.permission.READ_IMAGEVIDEO | 允许应用读取用户外部存储中的图片和视频媒体文件信息。 | user_grant |
| ohos.permission.WRITE_IMAGEVIDEO | 允许应用读写用户外部存储中的图片和视频媒体文件信息。 | user_grant |
以上权限的授权方式均为user_grant(用户授权),即开发者在module.json5文件中配置对应的权限后,需要使用接口
[
abilityAccessCtrl.requestPermissionsFromUser
](
../reference/apis/js-apis-abilityAccessCtrl.md#requestpermissionsfromuser9
)
去校验当前用户是否已授权。如果是,应用可以直接访问/操作目标对象;否则需要弹框向用户申请授权。
> **说明:**<br/>即使用户曾经授予权限,应用在调用受此权限保护的接口前,也应该先检查是否有权限。不能把之前授予的状态持久化,因为用户在动态授予后还可以通过“设置”取消应用的权限。
**开发步骤:**
1.
在配置文件module.json5中声明权限。在配置文件的“module”标签内,增加“requestPermissions”标签,标签内容请根据实际情况填写。标签说明可参考
[
访问控制(权限)开发指导
](
../security/accesstoken-guidelines.md
)
。
```
json
{
"module"
:
{
"requestPermissions"
:
[
{
"name"
:
"ohos.permission.READ_IMAGEVIDEO"
,
"reason"
:
"Permissions required for photoAccessHelper related operations"
,
"usedScene"
:
{
"abilities"
:
[
"EntryAbility"
],
"when"
:
"always"
}
},
{
"name"
:
"ohos.permission.WRITE_IMAGEVIDEO"
,
"reason"
:
"Permissions required for photoAccessHelper related operations"
,
"usedScene"
:
{
"abilities"
:
[
"EntryAbility"
],
"when"
:
"always"
}
},
]
}
}
```
2.
在Ability.ts中onWindowStageCreate里调用requestPermissionsFromUser进行权限校验,可以选择需要动态申请获取的权限自行添加相应代码。
```
ts
import
UIAbility
from
'
@ohos.app.ability.UIAbility
'
;
import
abilityAccessCtrl
,
{
Permissions
}
from
'
@ohos.abilityAccessCtrl
'
;
export
default
class
EntryAbility
extends
UIAbility
{
onWindowStageCreate
(
windowStage
)
{
let
list
:
Array
<
Permissions
>
=
[
'
ohos.permission.READ_IMAGEVIDEO
'
,
'
ohos.permission.WRITE_IMAGEVIDEO
'
];
let
permissionRequestResult
;
let
atManager
=
abilityAccessCtrl
.
createAtManager
();
atManager
.
requestPermissionsFromUser
(
this
.
context
,
list
,
(
err
,
result
)
=>
{
if
(
err
)
{
console
.
error
(
'
requestPermissionsFromUserError:
'
+
JSON
.
stringify
(
err
));
}
else
{
permissionRequestResult
=
result
;
console
.
info
(
'
permissionRequestResult:
'
+
JSON
.
stringify
(
permissionRequestResult
));
}
});
}
}
```
zh-cn/application-dev/file-management/photoAccessHelper-resource-guidelines.md
0 → 100644
浏览文件 @
aa635c25
# 媒体资源使用指导
应用可以通过photoAccessHelper的接口,对媒体资源(图片、视频)进行相关操作。
> **说明:**
>
> 在进行功能开发前,请开发者查阅[相册管理模块开发概述](photoAccessHelper-overview.md),了解如何获取相册管理模块实例和如何申请相册管理模块功能开发相关权限。
> 文档中使用到photoAccessHelper的地方默认为使用相册管理模块开发概述中获取的对象,如未添加此段代码报photoAccessHelper未定义的错误请自行添加。
为了保证应用的运行效率,大部分PhotoAccessHelper调用都是异步的,对于异步调用的API均提供了callback和Promise两种方式,以下示例均采用Promise函数,更多方式可以查阅
[
API参考
](
../reference/apis/js-apis-photoAccessHelper.md
)
。
## 获取指定媒体资源
开发者可以根据特定的条件查询媒体资源,如指定类型、指定日期、指定相册等。
应用通过调用
[
PhotoAccessHelper.getAssets
](
../reference/apis/js-apis-photoAccessHelper.md#getassets
)
获取媒体资源,并传入
[
FetchOptions
](
../reference/apis/js-apis-photoAccessHelper.md#fetchoptions
)
对象指定检索条件。如无特别说明,文档中涉及的待获取的资源均视为已经预置且在数据库中存在相应数据。如出现按照示例代码执行出现获取资源为空的情况请确认文件是否已预置,数据库中是否存在该文件的数据。
如果只想获取某个位置的对象(如第一个、最后一个、指定索引等),可以通过
[
FetchFileResult
](
../reference/apis/js-apis-photoAccessHelper.md#fetchresult
)
中的接口获取对应位置的媒体资源对象。
**前提条件:**
-
获取相册管理模块photoAccessHelper实例。
-
申请相册管理模块读权限'ohos.permission.READ_IMAGEVIDEO'。
-
导入
[
dataSharePredicates
](
../reference/apis/js-apis-data-dataSharePredicates.md
)
模块。
### 指定媒体文件名获取图片或视频资源
下面以查询文件名为'test.jpg'的图片资源为例。
**开发步骤:**
创建FetchOptions对象指定检索条件为检索文件名为'test.jpg'的图片。
```
ts
import
dataSharePredicates
from
'
@ohos.data.dataSharePredicates
'
;
let
predicates
=
new
dataSharePredicates
.
DataSharePredicates
();
predicates
.
equalTo
(
photoAccessHelper
.
PhotoKeys
.
DISPLAY_NAME
,
'
test.jpg
'
);
let
fetchOptions
=
{
fetchColumns
:
[],
predicates
:
predicates
};
```
调用PhotoAccessHelper.getAssets接口获取图片资源。
```
ts
try
{
let
fetchResult
=
await
phAccessHelper
.
getAssets
(
fetchOptions
);
let
fileAsset
=
await
fetchResult
.
getFirstObject
();
console
.
info
(
'
getAssets fileAsset.displayName :
'
+
fileAsset
.
displayName
);
fetchResult
.
close
();
}
catch
(
err
)
{
console
.
error
(
'
getAssets failed with err:
'
+
err
);
}
```
### 指定URI获取图片或视频资源
下面以查询指定URI为'file://media/Photo/1'为例。
```
ts
import
dataSharePredicates
from
'
@ohos.data.dataSharePredicates
'
;
let
predicates
=
new
dataSharePredicates
.
DataSharePredicates
();
predicates
.
equalTo
(
photoAccessHelper
.
PhotoKeys
.
URI
,
'
file://media/Photo/1
'
);
let
fetchOptions
=
{
fetchColumns
:
[],
predicates
:
predicates
};
```
调用PhotoAccessHelper.getAssets接口获取图片资源。
```
ts
try
{
let
fetchResult
=
await
phAccessHelper
.
getAssets
(
fetchOptions
);
let
fileAsset
=
await
fetchResult
.
getFirstObject
();
console
.
info
(
'
getAssets fileAsset.uri :
'
+
fileAsset
.
uri
);
fetchResult
.
close
();
}
catch
(
err
)
{
console
.
error
(
'
getAssets failed with err:
'
+
err
);
}
```
### 指定文件添加的时间获取图片或视频资源
下面以查询指定添加时间为'2022-06-01'至'2023-06-01'这一年内为例。
```
ts
import
dataSharePredicates
from
'
@ohos.data.dataSharePredicates
'
;
let
predicates
=
new
dataSharePredicates
.
DataSharePredicates
();
let
startTime
=
Date
.
parse
(
new
Date
(
'
2022-06-01
'
).
toString
())
/
1000
;
// 查询起始时间距1970年1月1日的秒数值。
let
endTime
=
Date
.
parse
(
new
Date
(
'
2023-06-01
'
).
toString
())
/
1000
;
// 查询结束时间距1970年1月1日的秒数值。
let
date_added
=
photoAccessHelper
.
PhotoKeys
.
DATE_ADDED
;
predicates
.
between
(
date_added
,
startTime
,
endTime
);
predicates
.
orderByDesc
(
date_added
);
// 查询结果按照降序排序。
let
fetchOptions
=
{
fetchColumns
:
[
date_added
],
// date_added属性不属于默认查询列,需要自行添加。
predicates
:
predicates
};
```
调用PhotoAccessHelper.getAssets接口获取图片资源。
```
ts
try
{
let
fetchResult
=
await
phAccessHelper
.
getAssets
(
fetchOptions
);
console
.
info
(
'
getAssets count:
'
+
fetchResult
.
getCount
());
let
fileAsset
=
await
fetchResult
.
getFirstObject
();
console
.
info
(
'
getAssets fileAsset.displayName :
'
+
fileAsset
.
displayName
);
fetchResult
.
close
();
}
catch
(
err
)
{
console
.
error
(
'
getAssets failed with err:
'
+
err
);
}
```
## 获取图片和视频缩略图
通过接口
[
FileAsset.getThumbnail
](
../reference/apis/js-apis-photoAccessHelper.md#getthumbnail
)
,传入缩略图尺寸,可以获取图片和视频缩略图。缩略图常用于UI界面展示。
**前提条件:**
-
获取相册管理模块photoAccessHelper实例。
-
申请相册管理模块读权限'ohos.permission.READ_IMAGEVIDEO'。
-
导入
[
dataSharePredicates
](
../reference/apis/js-apis-data-dataSharePredicates.md
)
模块。
### 获取某张图片的缩略图
当需要在相册展示图片和视频、编辑预览,应用需要获取某张图片的缩略图。
下面以获取一张图片的缩略图为例,缩略图尺寸为720
*
720。
**开发步骤:**
1.
建立检索条件,用于获取图片资源。
2.
调用PhotoAccessHelper.getAssets接口获取图片资源。
3.
调用
[
FetchResult.getFirstObject
](
../reference/apis/js-apis-photoAccessHelper.md#getfirstobject
)
接口获取第一张图片。
4.
调用getThumbnail获取图片的缩略图的
[
PixelMap
](
../reference/apis/js-apis-image.md#pixelmap7
)
。
```
ts
import
dataSharePredicates
from
'
@ohos.data.dataSharePredicates
'
;
let
predicates
=
new
dataSharePredicates
.
DataSharePredicates
();
let
fetchOptions
=
{
fetchColumns
:
[],
predicates
:
predicates
};
try
{
let
fetchResult
=
await
phAccessHelper
.
getAssets
(
fetchOptions
);
let
fileAsset
=
await
fetchResult
.
getFirstObject
();
console
.
info
(
'
getAssets fileAsset.displayName :
'
+
fileAsset
.
displayName
);
let
size
=
{
width
:
720
,
height
:
720
};
let
pixelMap
=
await
fileAsset
.
getThumbnail
(
size
);
let
imageInfo
=
await
pixelMap
.
getImageInfo
()
console
.
info
(
'
getThumbnail successful, pixelMap ImageInfo size:
'
+
JSON
.
stringify
(
imageInfo
.
size
));
fetchResult
.
close
();
}
catch
(
err
)
{
console
.
error
(
'
getThumbnail failed with err:
'
+
err
);
}
```
## 创建媒体资源
通过接口
[
createAsset
](
../reference/apis/js-apis-photoAccessHelper.md#createasset
)
创建媒体资源。
**前提条件:**
-
获取相册管理模块photoAccessHelper实例。
-
申请相册管理模块权限'ohos.permission.WRITE_IMAGEVIDEO'。
### 创建图片或视频资源
下面以创建一张图片资源为例。
**开发步骤:**
1.
设置文件名并建立创建选项,用于创建图片资源时设置属性。
2.
调用createAsset接口创建图片资源。
```
ts
try
{
let
displayName
=
'
testPhoto
'
+
Date
.
now
()
+
'
.jpg
'
;
let
createOption
=
{
subType
:
photoAccessHelper
.
PhotoSubtype
.
DEFAULT
};
let
fileAsset
=
await
phAccessHelper
.
createAsset
(
displayName
,
createOption
);
console
.
info
(
'
createAsset successfully, file displayName:
'
+
fileAsset
.
displayName
);
}
catch
(
err
)
{
console
.
error
(
'
createAsset failed, message =
'
,
err
);
}
```
## 重命名媒体资源
重命名修改的是文件的FileAsset.displayName属性,即文件的显示文件名,包含文件后缀。
修改后再通过
[
FileAsset.commitModify
](
../reference/apis/js-apis-photoAccessHelper.md#commitmodify
)
更新到数据库中完成修改。
在重命名文件之前,需要先获取文件对象,可以通过
[
FetchResult
](
../reference/apis/js-apis-photoAccessHelper.md#fetchresult
)
中的接口获取对应位置的文件。
**前提条件:**
-
获取相册管理模块photoAccessHelper实例。
-
申请相册管理模块权限'ohos.permission.WRITE_IMAGEVIDEO'和'ohos.permission.READ_IMAGEVIDEO'。
下面以将获取的图片资源中第一个文件重命名为例。
**开发步骤:**
1.
建立检索条件,用于获取图片资源。
2.
调用getFileAssets接口获取目标图片资源。
3.
调用
[
FetchResult.getFirstObject
](
../reference/apis/js-apis-photoAccessHelper.md#getfirstobject
)
接口获取第一张图片,即要重命名的图片对象。
4.
调用FileAsset.set接口将图片重命名为新的名字。
5.
调用FileAsset.commitModify接口将修改的图片属性更新到数据库中完成修改。
```
ts
import
dataSharePredicates
from
'
@ohos.data.dataSharePredicates
'
;
let
predicates
=
new
dataSharePredicates
.
DataSharePredicates
();
let
fetchOptions
=
{
fetchColumns
:
[
'
title
'
],
predicates
:
predicates
};
let
newTitle
=
'
newTestPhoto
'
;
try
{
let
fetchResult
=
await
phAccessHelper
.
getAssets
(
fetchOptions
);
let
fileAsset
=
await
fetchResult
.
getFirstObject
();
let
title
=
photoAccessHelper
.
PhotoKeys
.
TITLE
;
let
fileAssetTitle
=
fileAsset
.
get
(
title
);
console
.
info
(
'
getAssets fileAsset.title :
'
+
fileAssetTitle
);
fileAsset
.
set
(
title
,
newTitle
);
await
fileAsset
.
commitModify
();
fetchResult
.
close
();
}
catch
(
err
)
{
console
.
error
(
'
commitModify failed with err:
'
+
err
);
}
```
## 将文件放入回收站
通过
[
deleteAssets
](
../reference/apis/js-apis-photoAccessHelper.md#deleteassets
)
可以将文件放入回收站。
放入回收站的文件将会保存30天,30天后会自动彻底删除。在此期间,应用用户可以通过系统应用“文件管理”或“图库”恢复文件。
**前提条件:**
-
获取相册管理模块photoAccessHelper实例。
-
申请相册管理模块权限'ohos.permission.WRITE_IMAGEVIDEO'和'ohos.permission.READ_IMAGEVIDEO'。
下面以将文件检索结果中第一个文件放入回收站为例。
**开发步骤:**
1.
建立检索条件,用于获取图片资源。
2.
调用PhotoAccessHelper.getFileAssets接口获取目标图片资源。
3.
调用
[
FetchResult.getFirstObject
](
../reference/apis/js-apis-photoAccessHelper.md#getfirstobject
)
接口获取第一张图片,即要放入回收站的图片对象。
4.
调用deleteAssets接口将文件放入回收站。
```
ts
import
dataSharePredicates
from
'
@ohos.data.dataSharePredicates
'
;
let
predicates
=
new
dataSharePredicates
.
DataSharePredicates
();
let
fetchOptions
=
{
fetchColumns
:
[],
predicates
:
predicates
};
try
{
let
fetchResult
=
await
phAccessHelper
.
getAssets
(
fetchOptions
);
let
fileAsset
=
await
fetchResult
.
getFirstObject
();
console
.
info
(
'
getAssets fileAsset.uri :
'
+
fileAsset
.
uri
);
await
phAccessHelper
.
deleteAssets
([
fileAsset
.
uri
]);
fetchResult
.
close
();
}
catch
(
err
)
{
console
.
error
(
'
deleteAssets failed with err:
'
+
err
);
}
```
zh-cn/application-dev/file-management/photoAccessHelper-systemAlbum-guidelines.md
0 → 100644
浏览文件 @
aa635c25
# 系统相册资源使用指导
photoAccessHelper仅提供开发者对收藏夹、视频相册、截屏和录屏相册进行相关操作。
> **说明:**
>
> 在进行功能开发前,请开发者查阅[相册管理模块开发概述](photoAccessHelper-overview.md),了解如何获取相册管理模块实例和如何申请相册管理模块功能开发相关权限。
> 文档中使用到mgr的地方默认为使用相册管理模块开发概述中获取的对象,如未添加此段代码报mgr未定义的错误请自行添加。
为了保证应用的运行效率,大部分photoAccessHelper调用都是异步的,对于异步调用的API均提供了callback和Promise两种方式,以下示例均采用Promise函数,更多方式可以查阅
[
API参考
](
../reference/apis/js-apis-photoAccessHelper.md
)
。
如无特别说明,文档中涉及的待获取的资源均视为已经预置且在数据库中存在相应数据。如出现按照示例代码执行出现获取资源为空的情况请确认文件是否已预置,数据库中是否存在该文件的数据。
## 收藏夹
收藏夹属于系统相册,对图片或视频设置收藏时会自动将其加入到收藏夹中,取消收藏则会从收藏夹中移除。
### 获取收藏夹对象
通过
[
getAlbums
](
../reference/apis/js-apis-photoAccessHelper.md#getalbums
)
接口获取收藏夹对象。
**前提条件:**
-
获取相册管理模块photoAccessHelper实例。
-
申请相册管理模块权限'ohos.permission.READ_IMAGEVIDEO'。
**开发步骤:**
1.
设置获取收藏夹的参数为photoAccessHelper.AlbumType.SYSTEM和photoAccessHelper.AlbumSubtype.FAVORITE。
2.
调用getAlbums接口获取收藏夹对象。
```
ts
try
{
let
fetchResult
=
await
phAccessHelper
.
getAlbums
(
photoAccessHelper
.
AlbumType
.
SYSTEM
,
photoAccessHelper
.
AlbumSubtype
.
FAVORITE
);
let
album
=
await
fetchResult
.
getFirstObject
();
console
.
info
(
'
get favorite Album successfully, albumUri:
'
+
album
.
albumUri
);
fetchResult
.
close
();
}
catch
(
err
)
{
console
.
error
(
'
get favorite Album failed with err:
'
+
err
);
}
```
### 收藏图片和视频
通过
[
favorite
](
../reference/apis/js-apis-photoAccessHelper.md#favorite
)
接口将图片或者视频设置收藏。
**前提条件:**
-
获取相册管理模块photoAccessHelper实例。
-
申请相册管理模块权限'ohos.permission.READ_IMAGEVIDEO'和'ohos.permission.WRITE_IMAGEVIDEO'。
下面将以收藏一张图片为例。
**开发步骤:**
1.
[
获取指定媒体资源
](
photoAccessHelper-resource-guidelines.md#获取指定媒体资源
)
。
2.
isFavorite参数设置为true,表示将会设置为收藏。
3.
调用FileAsset.favorite接口设置收藏。
```
ts
import
dataSharePredicates
from
'
@ohos.data.dataSharePredicates
'
;
let
predicates
=
new
dataSharePredicates
.
DataSharePredicates
();
predicates
.
equalTo
(
photoAccessHelper
.
ImageVideoKey
.
DISPLAY_NAME
,
'
test.jpg
'
);
let
fetchOptions
=
{
fetchColumns
:
[],
predicates
:
predicates
};
try
{
let
photoFetchResult
=
await
phAccessHelper
.
getAssets
(
fetchOptions
);
let
fileAsset
=
await
photoFetchResult
.
getFirstObject
();
console
.
info
(
'
getAssets fileAsset.displayName :
'
+
fileAsset
.
displayName
);
let
isFavorite
=
true
;
await
fileAsset
.
favorite
(
isFavorite
);
}
catch
(
err
)
{
console
.
error
(
'
favorite failed with err:
'
+
err
);
}
```
### 获取收藏夹中的图片和视频
先
[
获取收藏夹对象
](
#获取收藏夹对象
)
。然后调用
[
Album.getAssets
](
../reference/apis/js-apis-photoAccessHelper.md#getassets-2
)
接口获取收藏夹中的资源。
**前提条件:**
-
获取相册管理模块photoAccessHelper实例。
-
申请相册管理模块权限'ohos.permission.READ_IMAGEVIDEO'。
下面以获取收藏夹中的一张图片为例。
**开发步骤:**
1.
[
获取收藏夹对象
](
#获取收藏夹对象
)
。
2.
建立图片检索条件,用于获取图片。
3.
调用Album.getAssets接口获取图片资源。
4.
调用
[
FetchResult.getFirstObject
](
../reference/apis/js-apis-photoAccessHelper.md#getfirstobject
)
接口获取第一张图片。
```
ts
import
dataSharePredicates
from
'
@ohos.data.dataSharePredicates
'
;
let
predicates
=
new
dataSharePredicates
.
DataSharePredicates
();
let
fetchOptions
=
{
fetchColumns
:
[],
predicates
:
predicates
};
try
{
let
albumFetchResult
=
await
phAccessHelper
.
getAlbums
(
photoAccessHelper
.
AlbumType
.
SYSTEM
,
photoAccessHelper
.
AlbumSubtype
.
FAVORITE
);
let
album
=
await
albumFetchResult
.
getFirstObject
();
console
.
info
(
'
get favorite Album successfully, albumUri:
'
+
album
.
albumUri
);
let
photoFetchResult
=
await
album
.
getAssets
(
fetchOptions
);
let
fileAsset
=
await
photoFetchResult
.
getFirstObject
();
console
.
info
(
'
favorite album getAssets successfully, albumName:
'
+
fileAsset
.
displayName
);
photoFetchResult
.
close
();
albumFetchResult
.
close
();
}
catch
(
err
)
{
console
.
error
(
'
favorite failed with err:
'
+
err
);
}
```
### 取消收藏图片或视频
通过
[
favorite
](
../reference/apis/js-apis-photoAccessHelper.md#favorite
)
接口将图片或者视频取消收藏。
**前提条件:**
-
获取相册管理模块photoAccessHelper实例。
-
申请相册管理模块权限'ohos.permission.READ_IMAGEVIDEO'和'ohos.permission.WRITE_IMAGEVIDEO'。
下面以将一张图片取消收藏为例。
**开发步骤:**
1.
[
获取收藏夹中的图片和视频
](
#获取收藏夹中的图片和视频
)
。
2.
isFavorite参数设置为false。
3.
调用FileAsset.favorite接口设置收藏。
```
ts
import
dataSharePredicates
from
'
@ohos.data.dataSharePredicates
'
;
let
predicates
=
new
dataSharePredicates
.
DataSharePredicates
();
let
fetchOptions
=
{
fetchColumns
:
[],
predicates
:
predicates
};
try
{
let
albumFetchResult
=
await
phAccessHelper
.
getAlbums
(
photoAccessHelper
.
AlbumType
.
SYSTEM
,
photoAccessHelper
.
AlbumSubtype
.
FAVORITE
);
let
album
=
await
albumFetchResult
.
getFirstObject
();
console
.
info
(
'
get favorite Album successfully, albumUri:
'
+
album
.
albumUri
);
let
photoFetchResult
=
await
album
.
getAssets
(
fetchOptions
);
let
fileAsset
=
await
photoFetchResult
.
getFirstObject
();
console
.
info
(
'
favorite album getAssets successfully, albumName:
'
+
fileAsset
.
displayName
);
let
isFavorite
=
false
;
await
fileAsset
.
favorite
(
isFavorite
);
photoFetchResult
.
close
();
albumFetchResult
.
close
();
}
catch
(
err
)
{
console
.
error
(
'
favorite failed with err:
'
+
err
);
}
```
## 视频相册
视频相册属于系统相册,用户文件中属于视频类型的媒体文件会自动加入到视频相册中。
### 获取视频相册对象
通过
[
getAlbums
](
../reference/apis/js-apis-photoAccessHelper.md#getalbums
)
接口获取视频相册对象。
**前提条件:**
-
获取相册管理模块photoAccessHelper实例。
-
申请相册管理模块权限'ohos.permission.READ_IMAGEVIDEO'。
**开发步骤:**
1.
设置获取视频相册的参数为photoAccessHelper.AlbumType.SYSTEM和photoAccessHelper.AlbumSubtype.VIDEO。
2.
调用getAlbums接口获取视频相册。
```
ts
try
{
let
fetchResult
=
await
phAccessHelper
.
getAlbums
(
photoAccessHelper
.
AlbumType
.
SYSTEM
,
photoAccessHelper
.
AlbumSubtype
.
VIDEO
);
let
album
=
await
fetchResult
.
getFirstObject
();
console
.
info
(
'
get video Album successfully, albumUri:
'
+
album
.
albumUri
);
fetchResult
.
close
();
}
catch
(
err
)
{
console
.
error
(
'
get video Album failed with err:
'
+
err
);
}
```
### 获取视频相册中的视频
先
[
获取视频相册对象
](
#获取视频相册对象
)
。然后调用
[
Album.getAssets
](
../reference/apis/js-apis-photoAccessHelper.md#getassets-2
)
接口获取视频相册对象中的视频资源。
**前提条件:**
-
获取相册管理模块photoAccessHelper实例。
-
申请相册管理模块权限'ohos.permission.READ_IMAGEVIDEO'。
下面以获取视频相册中的一个视频为例。
**开发步骤:**
1.
先
[
获取视频相册对象
](
#获取视频相册对象
)
。
2.
建立视频检索条件,用于获取视频。
3.
调用Album.getAssets接口获取视频资源。
4.
调用
[
FetchResult.getFirstObject
](
../reference/apis/js-apis-photoAccessHelper.md#getfirstobject
)
接口获取第一个视频。
```
ts
import
dataSharePredicates
from
'
@ohos.data.dataSharePredicates
'
;
let
predicates
=
new
dataSharePredicates
.
DataSharePredicates
();
let
fetchOptions
=
{
fetchColumns
:
[],
predicates
:
predicates
};
try
{
let
albumFetchResult
=
await
phAccessHelper
.
getAlbums
(
photoAccessHelper
.
AlbumType
.
SYSTEM
,
photoAccessHelper
.
AlbumSubtype
.
VIDEO
);
let
album
=
await
albumFetchResult
.
getFirstObject
();
console
.
info
(
'
get video Album successfully, albumUri:
'
+
album
.
albumUri
);
let
videoFetchResult
=
await
album
.
getAssets
(
fetchOptions
);
let
fileAsset
=
await
videoFetchResult
.
getFirstObject
();
console
.
info
(
'
video album getAssets successfully, albumName:
'
+
fileAsset
.
displayName
);
videoFetchResult
.
close
();
albumFetchResult
.
close
();
}
catch
(
err
)
{
console
.
error
(
'
video failed with err:
'
+
err
);
}
```
## 截屏和录屏相册
截屏和录屏相册属于系统相册,用户文件中属于截屏和录屏的媒体文件会自动加入到截屏和录屏相册中。
### 获取截屏和录屏相册对象
通过
[
getAlbums
](
../reference/apis/js-apis-photoAccessHelper.md#getalbums
)
接口获取截屏和录屏相册。
**前提条件:**
-
获取相册管理模块photoAccessHelper实例。
-
申请相册管理模块权限'ohos.permission.READ_IMAGEVIDEO'。
**开发步骤:**
1.
设置获取截屏和录屏相册的参数为photoAccessHelper.AlbumType.SYSTEM和photoAccessHelper.AlbumSubtype.SCREENSHOT。
2.
调用getAlbums接口获取截屏和录屏相册。
```
ts
try
{
let
fetchResult
=
await
phAccessHelper
.
getAlbums
(
photoAccessHelper
.
AlbumType
.
SYSTEM
,
photoAccessHelper
.
AlbumSubtype
.
SCREENSHOT
);
let
album
=
await
fetchResult
.
getFirstObject
();
console
.
info
(
'
get screenshot Album successfully, albumUri:
'
+
album
.
albumUri
);
fetchResult
.
close
();
}
catch
(
err
)
{
console
.
error
(
'
get screenshot Album failed with err:
'
+
err
);
}
```
### 获取截屏和录屏相册中的媒体资源
先
[
获取截屏和录屏相册对象
](
#获取截屏和录屏相册对象
)
。然后调用
[
Album.getAssets
](
../reference/apis/js-apis-photoAccessHelper.md#getassets-2
)
接口获取截屏和录屏相册对象中的媒体资源。
**前提条件:**
-
获取相册管理模块photoAccessHelper实例。
-
申请相册管理模块权限'ohos.permission.READ_IMAGEVIDEO'。
下面以获取截屏和录屏相册中的一个媒体资源为例。
**开发步骤:**
1.
先
[
获取截屏和录屏相册对象
](
#获取截屏和录屏相册对象
)
。
2.
建立检索条件,用于获取媒体资源。
3.
调用Album.getAssets接口获取媒体资源。
4.
调用
[
FetchResult.getFirstObject
](
../reference/apis/js-apis-photoAccessHelper.md#getfirstobject
)
接口获取第一个媒体资源。
```
ts
import
dataSharePredicates
from
'
@ohos.data.dataSharePredicates
'
;
let
predicates
=
new
dataSharePredicates
.
DataSharePredicates
();
let
fetchOptions
=
{
fetchColumns
:
[],
predicates
:
predicates
};
try
{
let
albumFetchResult
=
await
phAccessHelper
.
getAlbums
(
photoAccessHelper
.
AlbumType
.
SYSTEM
,
photoAccessHelper
.
AlbumSubtype
.
SCREENSHOT
);
let
album
=
await
albumFetchResult
.
getFirstObject
();
console
.
info
(
'
get screenshot album successfully, albumUri:
'
+
album
.
albumUri
);
let
screenshotFetchResult
=
await
album
.
getAssets
(
fetchOptions
);
let
fileAsset
=
await
screenshotFetchResult
.
getFirstObject
();
console
.
info
(
'
screenshot album getAssets successfully, albumName:
'
+
fileAsset
.
displayName
);
screenshotFetchResult
.
close
();
albumFetchResult
.
close
();
}
catch
(
err
)
{
console
.
error
(
'
screenshot album failed with err:
'
+
err
);
}
```
zh-cn/application-dev/file-management/photoAccessHelper-userAlbum-guidelines.md
0 → 100644
浏览文件 @
aa635c25
# 用户相册资源使用指导
photoAccessHelper提供用户相册相关的接口,供开发者创建、删除用户相册,往用户相册中添加和删除图片和视频资源等。
> **说明:**
>
> 在进行功能开发前,请开发者查阅[相册管理模块开发概述](photoAccessHelper-overview.md),了解如何获取相册管理模块实例和如何申请相册管理模块功能开发相关权限。
> 文档中使用到photoAccessHelper的地方默认为使用相册管理模块开发概述中获取的对象,如未添加此段代码报photoAccessHelper未定义的错误请自行添加。
为了保证应用的运行效率,大部分PhotoAccessHelper接口调用都是异步的,对于异步调用的API均提供了callback和Promise两种方式,以下示例均采用Promise函数,更多方式可以查阅
[
API参考
](
../reference/apis/js-apis-photoAccessHelper.md
)
。
如无特别说明,文档中涉及的待获取的资源均视为已经预置且在数据库中存在相应数据。如出现按照示例代码执行出现获取资源为空的情况请确认文件是否已预置,数据库中是否存在该文件的数据。
## 创建用户相册
通过
[
createAlbum
](
../reference/apis/js-apis-photoAccessHelper.md#createalbum
)
接口创建用户相册。
待创建的相册名参数规格为:
-
相册名字符串长度为1~255。
-
不允许出现的非法英文字符,包括:
<br>
.
\
/ :
*
? " '
` < > | { } [ ]
- 英文字符大小写不敏感。
- 相册名不允许重名。
**前提条件:**
- 获取相册管理模块photoAccessHelper实例。
- 申请相册管理模块权限'ohos.permission.WRITE_IMAGEVIDEO'。
下面以创建一个用户相册为例。
**开发步骤:**
1. 设置相册名。
2. 调用createAlbum接口创建相册。
```ts
try {
let albumName = 'albumName';
let album = await phAccessHelper.createAlbum(albumName);
console.info('createAlbum successfully, album: ' + album.albumName + ' album uri: ' + album.albumUri);
} catch (err) {
console.error('createAlbum failed with err: ' + err);
}
```
## 获取用户相册
通过[getAlbums](../reference/apis/js-apis-photoAccessHelper.md#getalbums)接口获取用户相册。
**前提条件:**
- 获取相册管理模块photoAccessHelper实例。
- 申请相册管理模块权限'ohos.permission.READ_IMAGEVIDEO'。
下面以获取一个相册名为'albumName'的用户相册为例。
**开发步骤:**
1. 建立检索条件,用于获取用户相册。
2. 调用getAlbums接口获取用户相册资源。
3. 调用[FetchResult.getFirstObject](../reference/apis/js-apis-photoAccessHelper.md#getfirstobject)接口获取第一个用户相册。
```ts
import dataSharePredicates from '@ohos.data.dataSharePredicates';
let predicates = new dataSharePredicates.DataSharePredicates();
let albumName = photoAccessHelper.AlbumKey.ALBUM_NAME;
predicates.equalTo(albumName, 'albumName');
let fetchOptions = {
fetchColumns: [],
predicates: predicates
};
try {
let fetchResult = await phAccessHelper.getAlbums(photoAccessHelper.AlbumType.USER, photoAccessHelper.AlbumSubtype.USER_GENERIC, fetchOptions);
let album = await fetchResult.getFirstObject();
console.info('getAlbums successfully, albumName: ' + album.albumName);
fetchResult.close();
} catch (err) {
console.error('getAlbums failed with err: ' + err);
}
```
## 重命名用户相册
重命名用户相册修改的是相册的Albums.albumName属性。
修改后再通过[Album.commitModify](../reference/apis/js-apis-photoAccessHelper.md#commitmodify-2)更新到数据库中完成修改。
在重命名用户相册之前,需要先获取相册对象,可以通过[FetchResult](../reference/apis/js-apis-photoAccessHelper.md#fetchresult)中的接口获取对应位置的用户相册。
重名名用户相册的相册名同样遵循[创建用户相册](#创建用户相册)的参数规格。
**前提条件:**
- 获取相册管理模块photoAccessHelper实例。
- 申请相册管理模块权限'ohos.permission.READ_IMAGEVIDEO'和'ohos.permission.WRITE_IMAGEVIDEO'。
下面以将一个相册名为'albumName'的用户相册重命名为例。
**开发步骤:**
1. 建立检索条件,用于获取用户相册。
2. 调用getAlbums接口获取用户相册资源。
3. 调用[FetchResult.getFirstObject](../reference/apis/js-apis-photoAccessHelper.md#getfirstobject)接口获取第一个用户相册。
4. 设置新的相册名。
5. 调用Album.commitModify接口将修改的相册属性更新到数据中完成修改。
```ts
import dataSharePredicates from '@ohos.data.dataSharePredicates';
let predicates = new dataSharePredicates.DataSharePredicates();
let albumName = photoAccessHelper.AlbumKey.ALBUM_NAME;
predicates.equalTo(albumName, 'albumName');
let fetchOptions = {
fetchColumns: [],
predicates: predicates
};
try {
let fetchResult = await phAccessHelper.getAlbums(photoAccessHelper.AlbumType.USER, photoAccessHelper.AlbumSubtype.USER_GENERIC, fetchOptions);
let album = await fetchResult.getFirstObject();
console.info('getAlbums successfully, albumName: ' + album.albumName);
album.albumName = 'newAlbumName';
await album.commitModify();
fetchResult.close();
} catch (err) {
console.error('commitModify failed with err: ' + err);
}
```
## 添加图片和视频到用户相册中
先[获取用户相册](#获取用户相册)对象和需要添加到相册中的图片或视频的对象数组,然后调用[Album.addAssets](../reference/apis/js-apis-photoAccessHelper.md#addassets)接口往用户相册中添加图片或视频。
**前提条件:**
- 获取相册管理模块photoAccessHelper实例。
- 申请相册管理模块权限'ohos.permission.READ_IMAGEVIDEO'和'ohos.permission.WRITE_IMAGEVIDEO'。
下面以将往相册名为'albumName'的用户相册中添加一张图片为例。
**开发步骤:**
1. 建立相册检索条件,用于获取用户相册。
2. 建立图片检索条件,用于获取图片。
3. 调用getAlbums接口获取用户相册资源。
4. 调用[FetchResult.getFirstObject](../reference/apis/js-apis-photoAccessHelper.md#getfirstobject)接口获取第一个用户相册。
5. 调用[PhotoAccessHelper.getAssets](../reference/apis/js-apis-photoAccessHelper.md#getassets)接口获取图片资源。
6. 调用[FetchResult.getFirstObject](../reference/apis/js-apis-photoAccessHelper.md#getfirstobject)接口获取第一张图片。
7. 调用Album.addAssets接口往用户相册中添加图片。
```ts
import dataSharePredicates from '@ohos.data.dataSharePredicates';
let albumPredicates = new dataSharePredicates.DataSharePredicates();
let albumName = photoAccessHelper.AlbumKey.ALBUM_NAME;
albumPredicates.equalTo(albumName, 'albumName');
let albumFetchOptions = {
fetchColumns: [],
predicates: albumPredicates
};
let photoPredicates = new dataSharePredicates.DataSharePredicates();
let photoFetchOptions = {
fetchColumns: [],
predicates: photoPredicates
};
try {
let albumFetchResult = await phAccessHelper.getAlbums(photoAccessHelper.AlbumType.USER, photoAccessHelper.AlbumSubtype.USER_GENERIC, albumFetchOptions);
let album = await albumFetchResult.getFirstObject();
console.info('getAlbums successfully, albumName: ' + album.albumName);
let photoFetchResult = await phAccessHelper.getAssets(photoFetchOptions);
let fileAsset = await photoFetchResult.getFirstObject();
console.info('getAssets successfully, albumName: ' + fileAsset.displayName);
await album.addAssets([fileAsset]);
albumFetchResult.close();
photoFetchResult.close();
} catch (err) {
console.error('addAssets failed with err: ' + err);
}
```
## 获取用户相册中的图片和视频
先[获取用户相册](#获取用户相册)对象,然后调用[Album.getAssets](../reference/apis/js-apis-photoAccessHelper.md#getassets-2)接口获取用户相册中的图片资源。
**前提条件:**
- 获取相册管理模块photoAccessHelper实例。
- 申请相册管理模块权限'ohos.permission.READ_IMAGEVIDEO'和'ohos.permission.WRITE_IMAGEVIDEO'。
下面以获取相册名为'albumName'的用户相册中的一张图片为例。
**开发步骤:**
1. 建立相册检索条件,用于获取用户相册。
2. 建立图片检索条件,用于获取图片。
3. 调用getAlbums接口获取用户相册资源。
4. 调用[FetchResult.getFirstObject](../reference/apis/js-apis-photoAccessHelper.md#getfirstobject)接口获取第一个用户相册。
5. 调用Album.getAssets接口获取用户相册中的图片资源。
6. 调用[FetchResult.getFirstObject](../reference/apis/js-apis-photoAccessHelper.md#getfirstobject)接口获取第一张图片。
```ts
import dataSharePredicates from '@ohos.data.dataSharePredicates';
let albumPredicates = new dataSharePredicates.DataSharePredicates();
let albumName = photoAccessHelper.AlbumKey.ALBUM_NAME;
albumPredicates.equalTo(albumName, 'albumName');
let albumFetchOptions = {
fetchColumns: [],
predicates: albumPredicates
};
let photoPredicates = new dataSharePredicates.DataSharePredicates();
let photoFetchOptions = {
fetchColumns: [],
predicates: photoPredicates
};
try {
let albumFetchResult = await phAccessHelper.getAlbums(photoAccessHelper.AlbumType.USER, photoAccessHelper.AlbumSubtype.USER_GENERIC, albumFetchOptions);
let album = await albumFetchResult.getFirstObject();
console.info('getAlbums successfully, albumName: ' + album.albumName);
let photoFetchResult = await album.getAssets(photoFetchOptions);
let fileAsset = await photoFetchResult.getFirstObject();
console.info('album getAssets successfully, albumName: ' + fileAsset.displayName);
albumFetchResult.close();
photoFetchResult.close();
} catch (err) {
console.error('album getAssets failed with err: ' + err);
}
```
## 从用户相册中移除图片和视频
先[获取用户相册](#获取用户相册)对象,然后调用[Album.getAssets](../reference/apis/js-apis-photoAccessHelper.md#getassets-2)接口获取用户相册中的资源。
选择其中要移除的图片调用[Album.removeAssets](../reference/apis/js-apis-photoAccessHelper.md#removeassets)接口移除。
**前提条件:**
- 获取相册管理模块photoAccessHelper实例。
- 申请相册管理模块权限'ohos.permission.READ_IMAGEVIDEO'和'ohos.permission.WRITE_IMAGEVIDEO'。
下面以将往相册名为'albumName'的用户相册中移除一张图片为例。
**开发步骤:**
1. 建立相册检索条件,用于获取用户相册。
2. 建立图片检索条件,用于获取图片。
3. 调用getAlbums接口获取用户相册资源。
4. 调用[FetchResult.getFirstObject](../reference/apis/js-apis-photoAccessHelper.md#getfirstobject)接口获取第一个用户相册。
5. 调用Album.getAssets接口获取图片资源。
6. 调用[FetchResult.getFirstObject](../reference/apis/js-apis-photoAccessHelper.md#getfirstobject)接口获取第一张图片。
7. 调用Album.removeAssets接口从用户相册中移除图片。
```ts
import dataSharePredicates from '@ohos.data.dataSharePredicates';
let albumPredicates = new dataSharePredicates.DataSharePredicates();
let albumName = photoAccessHelper.AlbumKey.ALBUM_NAME;
albumPredicates.equalTo(albumName, 'albumName');
let albumFetchOptions = {
fetchColumns: [],
predicates: albumPredicates
};
let photoPredicates = new dataSharePredicates.DataSharePredicates();
let photoFetchOptions = {
fetchColumns: [],
predicates: photoPredicates
};
try {
let albumFetchResult = await phAccessHelper.getAlbums(photoAccessHelper.AlbumType.USER, photoAccessHelper.AlbumSubtype.USER_GENERIC, albumFetchOptions);
let album = await albumFetchResult.getFirstObject();
console.info('getAlbums successfully, albumName: ' + album.albumName);
let photoFetchResult = await album.getAssets(photoFetchOptions);
let fileAsset = await photoFetchResult.getFirstObject();
console.info('album getAssets successfully, albumName: ' + fileAsset.displayName);
await album.removeAssets([fileAsset]);
albumFetchResult.close();
photoFetchResult.close();
} catch (err) {
console.error('removeAssets failed with err: ' + err);
}
```
## 删除用户相册
先[获取用户相册](#获取用户相册)对象,然后调用[deleteAlbums](../reference/apis/js-apis-photoAccessHelper.md#deletealbums)删除用户相册。
**前提条件:**
- 获取相册管理模块photoAccessHelper实例。
- 申请相册管理模块权限'ohos.permission.READ_IMAGEVIDEO'和'ohos.permission.WRITE_IMAGEVIDEO'。
下面以删除一个相册名为'albumName'的用户相册为例。
**开发步骤:**
1. 建立检索条件,用于获取用户相册。
2. 调用getAlbums接口获取用户相册资源。
3. 调用FetchResult.getFirstObject接口获取第一个用户相册。
4. 调用deleteAlbums接口删除第一个用户相册。
```ts
import dataSharePredicates from '@ohos.data.dataSharePredicates';
let predicates = new dataSharePredicates.DataSharePredicates();
let albumName = photoAccessHelper.AlbumKey.ALBUM_NAME;
predicates.equalTo(albumName, '%albumName%');
let fetchOptions = {
fetchColumns: [],
predicates: predicates
};
try {
let fetchResult = await phAccessHelper.getAlbums(photoAccessHelper.AlbumType.USER, photoAccessHelper.AlbumSubtype.USER_GENERIC, fetchOptions);
let album = await fetchResult.getFirstObject();
console.info('getAlbums successfully, albumName: ' + album.albumName);
phAccessHelper.deleteAlbums([album]);
fetchResult.close();
} catch (err) {
console.error('deleteAlbums failed with err: ' + err);
}
``
`
zh-cn/application-dev/reference/apis/js-apis-photoAccessHelper.md
0 → 100644
浏览文件 @
aa635c25
此差异已折叠。
点击以展开。
编辑
预览
Markdown
is supported
0%
请重试
或
添加新附件
.
添加附件
取消
You are about to add
0
people
to the discussion. Proceed with caution.
先完成此消息的编辑!
取消
想要评论请
注册
或
登录