# @ohos.file.photoAccessHelper (相册管理模块)(系统接口)
该模块提供相册管理模块能力，包括创建相册以及访问、修改相册中的媒体数据信息等。
> **说明：**
>
> - 本模块首批接口从API version 10开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。
> - 当前页面仅包含本模块的系统接口，其他公开接口参见[@ohos.file.photoAccessHelper (相册管理模块)](js-apis-photoAccessHelper.md)。
## 导入模块
```ts
import { photoAccessHelper } from '@kit.MediaLibraryKit';
```
## PhotoAccessHelper
### createAsset
createAsset(displayName: string, callback: AsyncCallback<PhotoAsset>): void
指定待创建的图片或者视频的文件名，创建图片或视频资源，使用callback方式返回结果。
待创建的文件名参数规格为：
- 应包含有效文件主名和图片或视频扩展名。
- 文件名字符串长度为1~255。
- 文件主名中不允许出现的非法英文字符，包括：
. .. \ / : * ? " ' ` < > | { } [ ]
**系统接口**：此接口为系统接口。
**系统能力**：SystemCapability.FileManagement.PhotoAccessHelper.Core
**需要权限**：ohos.permission.WRITE_IMAGEVIDEO
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ------------------------ | ---- | ------------------------- |
| displayName | string | 是 | 创建的图片或者视频文件名。 |
| callback | AsyncCallback<[PhotoAsset](#photoasset)> | 是 | callback返回创建的图片和视频结果。 |
**错误码：**
接口抛出错误码的详细介绍请参见[通用错误码](../errorcode-universal.md)和[文件管理错误码](../apis-core-file-kit/errorcode-filemanagement.md)。
| 错误码ID | 错误信息 |
| -------- | ---------------------------------------- |
| 202 | Called by non-system application. |
| 401 | Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types; 3. Parameter verification failed. |
| 13900012 | Permission denied. |
| 13900020 | Invalid argument. |
| 14000001 | Invalid display name. |
| 14000011 | System inner fail. |
**示例：**
```ts
async function example() {
console.info('createAssetDemo');
let testFileName: string = 'testFile' + Date.now() + '.jpg';
phAccessHelper.createAsset(testFileName, (err, photoAsset) => {
if (photoAsset !== undefined) {
console.info('createAsset file displayName' + photoAsset.displayName);
console.info('createAsset successfully');
} else {
console.error(`createAsset failed, error: ${err.code}, ${err.message}`);
}
});
}
```
### createAsset
createAsset(displayName: string): Promise<PhotoAsset>
指定待创建的图片或者视频的文件名，创建图片或视频资源，使用Promise方式返回结果。
待创建的文件名参数规格为：
- 应包含有效文件主名和图片或视频扩展名。
- 文件名字符串长度为1~255。
- 文件主名中不允许出现的非法英文字符，包括：
. .. \ / : * ? " ' ` < > | { } [ ]
**系统接口**：此接口为系统接口。
**系统能力**：SystemCapability.FileManagement.PhotoAccessHelper.Core
**需要权限**：ohos.permission.WRITE_IMAGEVIDEO
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ------------------------ | ---- | ------------------------- |
| displayName | string | 是 | 创建的图片或者视频文件名。 |
**返回值：**
| 类型 | 说明 |
| --------------------------- | -------------- |
| Promise<[PhotoAsset](#photoasset)> | Promise对象，返回创建的图片和视频结果。 |
**错误码：**
接口抛出错误码的详细介绍请参见[通用错误码](../errorcode-universal.md)和[文件管理错误码](../apis-core-file-kit/errorcode-filemanagement.md)。
| 错误码ID | 错误信息 |
| -------- | ---------------------------------------- |
| 202 | Called by non-system application. |
| 401 | Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types; 3. Parameter verification failed. |
| 13900012 | Permission denied. |
| 13900020 | Invalid argument. |
| 14000001 | Invalid display name. |
| 14000011 | System inner fail. |
**示例：**
```ts
async function example() {
console.info('createAssetDemo');
try {
let testFileName: string = 'testFile' + Date.now() + '.jpg';
let photoAsset: photoAccessHelper.PhotoAsset = await phAccessHelper.createAsset(testFileName);
console.info('createAsset file displayName' + photoAsset.displayName);
console.info('createAsset successfully');
} catch (err) {
console.error(`createAsset failed, error: ${err.code}, ${err.message}`);
}
}
```
### createAsset
createAsset(displayName: string, options: PhotoCreateOptions, callback: AsyncCallback<PhotoAsset>): void
指定待创建的图片或者视频的文件名和创建选项，创建图片或视频资源，使用callback方式返回结果。
待创建的文件名参数规格为：
- 应包含有效文件主名和图片或视频扩展名。
- 文件名字符串长度为1~255。
- 文件主名中不允许出现的非法英文字符，包括：
. .. \ / : * ? " ' ` < > | { } [ ]
**系统接口**：此接口为系统接口。
**系统能力**：SystemCapability.FileManagement.PhotoAccessHelper.Core
**需要权限**：ohos.permission.WRITE_IMAGEVIDEO
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ------------------------ | ---- | ------------------------- |
| displayName | string | 是 | 创建的图片或者视频文件名。 |
| options | [PhotoCreateOptions](#photocreateoptions) | 是 | 图片或视频的创建选项。 |
| callback | AsyncCallback<[PhotoAsset](#photoasset)> | 是 | callback返回创建的图片和视频结果。 |
**错误码：**
接口抛出错误码的详细介绍请参见[通用错误码](../errorcode-universal.md)和[文件管理错误码](../apis-core-file-kit/errorcode-filemanagement.md)。
| 错误码ID | 错误信息 |
| -------- | ---------------------------------------- |
| 202 | Called by non-system application. |
| 401 | Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types; 3. Parameter verification failed. |
| 13900012 | Permission denied. |
| 13900020 | Invalid argument. |
| 14000001 | Invalid display name. |
| 14000011 | System inner fail. |
**示例：**
```ts
async function example() {
console.info('createAssetDemo');
let testFileName: string = 'testFile' + Date.now() + '.jpg';
let createOption: photoAccessHelper.PhotoCreateOptions = {
subtype: photoAccessHelper.PhotoSubtype.DEFAULT
}
phAccessHelper.createAsset(testFileName, createOption, (err, photoAsset) => {
if (photoAsset !== undefined) {
console.info('createAsset file displayName' + photoAsset.displayName);
console.info('createAsset successfully');
} else {
console.error(`createAsset failed, error: ${err.code}, ${err.message}`);
}
});
}
```
### createAsset
createAsset(displayName: string, options: PhotoCreateOptions): Promise<PhotoAsset>
指定待创建的图片或者视频的文件名和创建选项，创建图片或视频资源，使用Promise方式返回结果。
待创建的文件名参数规格为：
- 应包含有效文件主名和图片或视频扩展名。
- 文件名字符串长度为1~255。
- 文件主名中不允许出现的非法英文字符，包括：
. .. \ / : * ? " ' ` < > | { } [ ]
**系统接口**：此接口为系统接口。
**系统能力**：SystemCapability.FileManagement.PhotoAccessHelper.Core
**需要权限**：ohos.permission.WRITE_IMAGEVIDEO
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ------------------------ | ---- | ------------------------- |
| displayName | string | 是 | 创建的图片或者视频文件名。 |
| options | [PhotoCreateOptions](#photocreateoptions) | 是 | 图片或视频的创建选项。 |
**返回值：**
| 类型 | 说明 |
| --------------------------- | -------------- |
| Promise<[PhotoAsset](#photoasset)> | Promise对象，返回创建的图片和视频结果。 |
**错误码：**
接口抛出错误码的详细介绍请参见[通用错误码](../errorcode-universal.md)和[文件管理错误码](../apis-core-file-kit/errorcode-filemanagement.md)。
| 错误码ID | 错误信息 |
| -------- | ---------------------------------------- |
| 202 | Called by non-system application. |
| 401 | Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types; 3. Parameter verification failed. |
| 13900012 | Permission denied. |
| 13900020 | Invalid argument. |
| 14000001 | Invalid display name. |
| 14000011 | System inner fail. |
**示例：**
```ts
async function example() {
console.info('createAssetDemo');
try {
let testFileName:string = 'testFile' + Date.now() + '.jpg';
let createOption: photoAccessHelper.PhotoCreateOptions = {
subtype: photoAccessHelper.PhotoSubtype.DEFAULT
}
let photoAsset: photoAccessHelper.PhotoAsset = await phAccessHelper.createAsset(testFileName, createOption);
console.info('createAsset file displayName' + photoAsset.displayName);
console.info('createAsset successfully');
} catch (err) {
console.error(`createAsset failed, error: ${err.code}, ${err.message}`);
}
}
```
### createAlbum(deprecated)
createAlbum(name: string, callback: AsyncCallback<Album>): void
创建相册，使用callback方式返回结果。
待创建的相册名参数规格为：
- 相册名字符串长度为1~255。
- 不允许出现的非法英文字符，包括：
. .. \ / : * ? " ' ` < > | { } [ ]
- 英文字符大小写不敏感。
- 相册名不允许重名。
> **说明：**
>
> 从API version 10开始支持，从API version 11开始废弃。建议使用[MediaAlbumChangeRequest.createAlbumRequest](#createalbumrequest11)替代。
**系统接口**：此接口为系统接口。
**系统能力**：SystemCapability.FileManagement.PhotoAccessHelper.Core
**需要权限**：ohos.permission.WRITE_IMAGEVIDEO
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ------------------------ | ---- | ------------------------- |
| name | string | 是 | 待创建相册的相册名。 |
| callback | AsyncCallback<[Album](#album)> | 是 | callback返回创建的相册实例。 |
**错误码：**
接口抛出错误码的详细介绍请参见[通用错误码](../errorcode-universal.md)和[文件管理错误码](../apis-core-file-kit/errorcode-filemanagement.md)。
| 错误码ID | 错误信息 |
| -------- | ---------------------------------------- |
| 202 | Called by non-system application. |
| 401 | Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types; 3. Parameter verification failed. |
| 13900012 | Permission denied. |
| 13900015 | File exists. |
| 13900020 | Invalid argument. |
| 14000011 | System inner fail. |
**示例：**
```ts
async function example() {
console.info('createAlbumDemo');
let albumName: string = 'newAlbumName' + new Date().getTime();
phAccessHelper.createAlbum(albumName, (err, album) => {
if (err) {
console.error(`createAlbumCallback failed with err: ${err.code}, ${err.message}`);
return;
}
console.info('createAlbumCallback successfully, album: ' + album.albumName + ' album uri: ' + album.albumUri);
});
}
```
### createAlbum(deprecated)
createAlbum(name: string): Promise<Album>
创建相册，使用Promise方式返回结果。
待创建的相册名参数规格为：
- 相册名字符串长度为1~255。
- 不允许出现的非法英文字符，包括：
. .. \ / : * ? " ' ` < > | { } [ ]
- 英文字符大小写不敏感。
- 相册名不允许重名。
> **说明：**
>
> 从API version 10开始支持，从API version 11开始废弃。建议使用[MediaAlbumChangeRequest.createAlbumRequest](#createalbumrequest11)替代。
**系统接口**：此接口为系统接口。
**系统能力**：SystemCapability.FileManagement.PhotoAccessHelper.Core
**需要权限**：ohos.permission.WRITE_IMAGEVIDEO
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ------------------------ | ---- | ------------------------- |
| name | string | 是 | 待创建相册的相册名。 |
**返回值：**
| 类型 | 说明 |
| --------------------------- | -------------- |
| Promise<[Album](#album)> | Promise对象，返回创建的相册实例。 |
**错误码：**
接口抛出错误码的详细介绍请参见[通用错误码](../errorcode-universal.md)和[文件管理错误码](../apis-core-file-kit/errorcode-filemanagement.md)。
| 错误码ID | 错误信息 |
| -------- | ---------------------------------------- |
| 202 | Called by non-system application. |
| 401 | Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types; 3. Parameter verification failed. |
| 13900012 | Permission denied. |
| 13900015 | File exists. |
| 13900020 | Invalid argument. |
| 14000011 | System inner fail. |
**示例：**
```ts
import { BusinessError } from '@kit.BasicServicesKit';
async function example() {
console.info('createAlbumDemo');
let albumName: string = 'newAlbumName' + new Date().getTime();
phAccessHelper.createAlbum(albumName).then((album) => {
console.info('createAlbumPromise successfully, album: ' + album.albumName + ' album uri: ' + album.albumUri);
}).catch((err: BusinessError) => {
console.error(`createAlbumPromise failed with err: ${err.code}, ${err.message}`);
});
}
```
### deleteAlbums(deprecated)
deleteAlbums(albums: Array<Album>, callback: AsyncCallback<void>): void
删除相册，使用callback方式返回结果。
删除相册前需先确保相册存在，只能删除用户相册。
> **说明：**
>
> 从API version 10开始支持，从API version 11开始废弃。建议使用[MediaAlbumChangeRequest.deleteAlbums](#deletealbums11)替代。
**系统接口**：此接口为系统接口。
**系统能力**：SystemCapability.FileManagement.PhotoAccessHelper.Core
**需要权限**：ohos.permission.WRITE_IMAGEVIDEO
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ------------------------ | ---- | ------------------------- |
| albums | Array<[Album](#album)> | 是 | 待删除相册的数组。 |
| callback | AsyncCallback<void> | 是 | callback返回void。 |
**错误码：**
接口抛出错误码的详细介绍请参见[通用错误码](../errorcode-universal.md)和[文件管理错误码](../apis-core-file-kit/errorcode-filemanagement.md)。
| 错误码ID | 错误信息 |
| -------- | ---------------------------------------- |
| 202 | Called by non-system application. |
| 401 | Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types; 3. Parameter verification failed. |
| 13900012 | Permission denied. |
| 13900020 | Invalid argument. |
| 14000011 | System inner fail. |
**示例：**
```ts
import { dataSharePredicates } from '@kit.ArkData';
async function example() {
// 示例代码为删除相册名为newAlbumName的相册。
console.info('deleteAlbumsDemo');
let predicates: dataSharePredicates.DataSharePredicates = new dataSharePredicates.DataSharePredicates();
predicates.equalTo('album_name', 'newAlbumName');
let fetchOptions: photoAccessHelper.FetchOptions = {
fetchColumns: [],
predicates: predicates
};
let fetchResult: photoAccessHelper.FetchResult = await phAccessHelper.getAlbums(photoAccessHelper.AlbumType.USER, photoAccessHelper.AlbumSubtype.USER_GENERIC, fetchOptions);
let album: photoAccessHelper.Album = await fetchResult.getFirstObject();
phAccessHelper.deleteAlbums([album], (err) => {
if (err) {
console.error(`deletePhotoAlbumsCallback failed with err: ${err.code}, ${err.message}`);
return;
}
console.info('deletePhotoAlbumsCallback successfully');
});
fetchResult.close();
}
```
### deleteAlbums(deprecated)
deleteAlbums(albums: Array<Album>): Promise<void>
删除相册，使用Promise方式返回结果。
删除相册前需先确保相册存在，只能删除用户相册。
> **说明：**
>
> 从API version 10开始支持，从API version 11开始废弃。建议使用[MediaAlbumChangeRequest.deleteAlbums](#deletealbums11)替代。
**系统接口**：此接口为系统接口。
**系统能力**：SystemCapability.FileManagement.PhotoAccessHelper.Core
**需要权限**：ohos.permission.WRITE_IMAGEVIDEO
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ------------------------ | ---- | ------------------------- |
| albums | Array<[Album](#album)> | 是 | 待删除相册的数组。 |
**返回值：**
| 类型 | 说明 |
| --------------------------- | -------------- |
| Promise<void> | Promise对象，返回void。 |
**错误码：**
接口抛出错误码的详细介绍请参见[通用错误码](../errorcode-universal.md)和[文件管理错误码](../apis-core-file-kit/errorcode-filemanagement.md)。
| 错误码ID | 错误信息 |
| -------- | ---------------------------------------- |
| 202 | Called by non-system application. |
| 401 | Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types; 3. Parameter verification failed. |
| 13900012 | Permission denied. |
| 13900020 | Invalid argument. |
| 14000011 | System inner fail. |
**示例：**
```ts
import { dataSharePredicates } from '@kit.ArkData';
import { BusinessError } from '@kit.BasicServicesKit';
async function example() {
// 示例代码为删除相册名为newAlbumName的相册。
console.info('deleteAlbumsDemo');
let predicates: dataSharePredicates.DataSharePredicates = new dataSharePredicates.DataSharePredicates();
predicates.equalTo('album_name', 'newAlbumName');
let fetchOptions: photoAccessHelper.FetchOptions = {
fetchColumns: [],
predicates: predicates
};
let fetchResult: photoAccessHelper.FetchResult = await phAccessHelper.getAlbums(photoAccessHelper.AlbumType.USER, photoAccessHelper.AlbumSubtype.USER_GENERIC, fetchOptions);
let album: photoAccessHelper.Album = await fetchResult.getFirstObject();
phAccessHelper.deleteAlbums([album]).then(() => {
console.info('deletePhotoAlbumsPromise successfully');
}).catch((err: BusinessError) => {
console.error(`deletePhotoAlbumsPromise failed with err: ${err.code}, ${err.message}`);
});
fetchResult.close();
}
```
### getHiddenAlbums11+
getHiddenAlbums(mode: HiddenPhotosDisplayMode, options: FetchOptions, callback: AsyncCallback<FetchResult<Album>>): void
根据隐藏文件显示模式和检索选项获取系统中的隐藏相册，使用callback方式返回结果。
**系统接口**：此接口为系统接口。
**需要权限**：ohos.permission.READ_IMAGEVIDEO 和 ohos.permission.MANAGE_PRIVATE_PHOTOS
**系统能力**：SystemCapability.FileManagement.PhotoAccessHelper.Core
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ------------------------ | ---- | ------------------------- |
| mode | [HiddenPhotosDisplayMode](#hiddenphotosdisplaymode11) | 是 | 隐藏文件显示模式 |
| options | [FetchOptions](js-apis-photoAccessHelper.md#fetchoptions) | 是 | 检索选项 |
| callback | AsyncCallback<[FetchResult](js-apis-photoAccessHelper.md#fetchresult)<[Album](#album)>> | 是 | callback返回获取相册的结果集。 |
**错误码：**
接口抛出错误码的详细介绍请参见[通用错误码](../errorcode-universal.md)和[文件管理错误码](../apis-core-file-kit/errorcode-filemanagement.md)。
| 错误码ID | 错误信息 |
| -------- | ---------------------------------------- |
| 201 | Permission verification failed, usually the result returned by VerifyAccessToken. |
| 202 | Permission verification failed, application which is not a system application uses system API. |
| 401 | Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types; 3. Parameter verification failed. |
| 14000011 | System inner fail. |
**示例：**
```ts
import { dataSharePredicates } from '@kit.ArkData';
// 获取系统中包含隐藏文件且相册名为'newAlbumName'的相册
async function getHiddenAlbumsView() {
console.info('getHiddenAlbumsViewDemo');
let predicates: dataSharePredicates.DataSharePredicates = new dataSharePredicates.DataSharePredicates();
predicates.equalTo('album_name', 'newAlbumName');
let fetchOptions: photoAccessHelper.FetchOptions = {
fetchColumns: [],
predicates: predicates
};
phAccessHelper.getHiddenAlbums(photoAccessHelper.HiddenPhotosDisplayMode.ALBUMS_MODE, fetchOptions,
async (err, fetchResult) => {
if (fetchResult === undefined) {
console.error('getHiddenAlbumsViewCallback fetchResult is undefined');
return;
}
let album = await fetchResult.getFirstObject();
console.info('getHiddenAlbumsViewCallback successfully, album name: ' + album.albumName);
fetchResult.close();
});
}
```
### getHiddenAlbums11+
getHiddenAlbums(mode: HiddenPhotosDisplayMode, callback: AsyncCallback<FetchResult<Album>>): void
根据隐藏文件显示模式获取系统中的隐藏相册，使用callback方式返回结果
**系统接口**：此接口为系统接口。
**需要权限**：ohos.permission.READ_IMAGEVIDEO 和 ohos.permission.MANAGE_PRIVATE_PHOTOS
**系统能力**：SystemCapability.FileManagement.PhotoAccessHelper.Core
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ------------------------ | ---- | ------------------------- |
| mode | [HiddenPhotosDisplayMode](#hiddenphotosdisplaymode11) | 是 | 隐藏文件显示模式 |
| callback | AsyncCallback<[FetchResult](js-apis-photoAccessHelper.md#fetchresult)<[Album](#album)>> | 是 | callback返回获取相册的结果集。 |
**错误码：**
接口抛出错误码的详细介绍请参见[通用错误码](../errorcode-universal.md)和[文件管理错误码](../apis-core-file-kit/errorcode-filemanagement.md)。
| 错误码ID | 错误信息 |
| -------- | ---------------------------------------- |
| 201 | Permission verification failed, usually the result returned by VerifyAccessToken. |
| 202 | Permission verification failed, application which is not a system application uses system API. |
| 401 | Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types; 3. Parameter verification failed. |
| 14000011 | System inner fail. |
**示例：**
```ts
import { dataSharePredicates } from '@kit.ArkData';
// 获取系统预置的隐藏相册
async function getSysHiddenAlbum() {
console.info('getSysHiddenAlbumDemo');
phAccessHelper.getHiddenAlbums(photoAccessHelper.HiddenPhotosDisplayMode.ASSETS_MODE, async (err, fetchResult) => {
if (fetchResult === undefined) {
console.error('getSysHiddenAlbumCallback fetchResult is undefined');
return;
}
let hiddenAlbum: photoAccessHelper.Album = await fetchResult.getFirstObject();
console.info('getSysHiddenAlbumCallback successfully, albumUri: ' + hiddenAlbum.albumUri);
fetchResult.close();
});
}
// 获取隐藏相册-相册视图，即系统中包含隐藏文件的相册（不包含系统预置的隐藏相册本身和回收站相册）
async function getHiddenAlbumsView() {
console.info('getHiddenAlbumsViewDemo');
phAccessHelper.getHiddenAlbums(photoAccessHelper.HiddenPhotosDisplayMode.ALBUMS_MODE, async (err, fetchResult) => {
if (fetchResult === undefined) {
console.error('getHiddenAlbumsViewCallback fetchResult is undefined');
return;
}
let albums: Array = await fetchResult.getAllObjects();
console.info('getHiddenAlbumsViewCallback successfully, albums size: ' + albums.length);
let predicates: dataSharePredicates.DataSharePredicates = new dataSharePredicates.DataSharePredicates();
let fetchOption: photoAccessHelper.FetchOptions = {
fetchColumns: [],
predicates: predicates
};
for (let i = 0; i < albums.length; i++) {
// 获取相册中的隐藏文件
albums[i].getAssets(fetchOption, (err, assetFetchResult) => {
console.info('album get hidden assets successfully, getCount: ' + assetFetchResult.getCount());
});
}
fetchResult.close();
});
}
```
### getHiddenAlbums11+
getHiddenAlbums(mode: HiddenPhotosDisplayMode, options?: FetchOptions): Promise<FetchResult<Album>>
根据隐藏文件显示模式和检索选项获取系统中的隐藏相册，使用Promise方式返回结果。
**系统接口**：此接口为系统接口。
**需要权限**：ohos.permission.READ_IMAGEVIDEO 和 ohos.permission.MANAGE_PRIVATE_PHOTOS
**系统能力**：SystemCapability.FileManagement.PhotoAccessHelper.Core
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ------------------------ | ---- | ------------------------- |
| mode | [HiddenPhotosDisplayMode](#hiddenphotosdisplaymode11) | 是 | 隐藏文件显示模式 |
| options | [FetchOptions](js-apis-photoAccessHelper.md#fetchoptions) | 否 | 检索选项，不填时默认根据隐藏文件显示模式检索。 |
**返回值：**
| 类型 | 说明 |
| --------------------------- | -------------- |
| Promise<[FetchResult](js-apis-photoAccessHelper.md#fetchresult)<[Album](#album)>> | Promise对象，返回获取相册的结果集。
**错误码：**
接口抛出错误码的详细介绍请参见[通用错误码](../errorcode-universal.md)和[文件管理错误码](../apis-core-file-kit/errorcode-filemanagement.md)。
| 错误码ID | 错误信息 |
| -------- | ---------------------------------------- |
| 201 | Permission verification failed, usually the result returned by VerifyAccessToken. |
| 202 | Permission verification failed, application which is not a system application uses system API. |
| 401 | Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types; 3. Parameter verification failed. |
| 14000011 | System inner fail. |
**示例：**
```ts
import { dataSharePredicates } from '@kit.ArkData';
import { BusinessError } from '@kit.BasicServicesKit';
// 获取系统预置的隐藏相册
async function getSysHiddenAlbum() {
console.info('getSysHiddenAlbumDemo');
phAccessHelper.getHiddenAlbums(photoAccessHelper.HiddenPhotosDisplayMode.ASSETS_MODE)
.then( async (fetchResult) => {
if (fetchResult === undefined) {
console.error('getSysHiddenAlbumPromise fetchResult is undefined');
return;
}
let hiddenAlbum: photoAccessHelper.Album = await fetchResult.getFirstObject();
console.info('getAlbumsPromise successfully, albumUri: ' + hiddenAlbum.albumUri);
fetchResult.close();
}).catch((err: BusinessError) => {
console.error(`getSysHiddenAlbumPromise failed with err: ${err.code}, ${err.message}`);
});
}
// 获取隐藏相册-相册视图，即系统中包含隐藏文件的相册（不包含系统预置的隐藏相册本身和回收站相册）
async function getHiddenAlbumsView() {
console.info('getHiddenAlbumsViewDemo');
phAccessHelper.getHiddenAlbums(photoAccessHelper.HiddenPhotosDisplayMode.ALBUMS_MODE).then( async (fetchResult) => {
if (fetchResult === undefined) {
console.error('getHiddenAlbumsViewPromise fetchResult is undefined');
return;
}
let albums: Array = await fetchResult.getAllObjects();
console.info('getHiddenAlbumsViewPromise successfully, albums size: ' + albums.length);
let predicates: dataSharePredicates.DataSharePredicates = new dataSharePredicates.DataSharePredicates();
let fetchOption: photoAccessHelper.FetchOptions = {
fetchColumns: [],
predicates: predicates
};
for (let i = 0; i < albums.length; i++) {
// 获取相册中的隐藏文件
albums[i].getAssets(fetchOption).then((assetFetchResult) => {
console.info('album get hidden assets successfully, getCount: ' + assetFetchResult.getCount());
}).catch((err: BusinessError) => {
console.error(`album get hidden assets failed with error: ${err.code}, ${err.message}`);
});
}
fetchResult.close();
}).catch((err: BusinessError) => {
console.error(`getHiddenAlbumsViewPromise failed with err: ${err.code}, ${err.message}`);
});
}
```
### deleteAssets(deprecated)
deleteAssets(uriList: Array<string>, callback: AsyncCallback<void>): void
删除媒体文件，删除的文件进入到回收站，使用callback方式返回结果。
> **说明：**
>
> 从API version 10开始支持，从API version 11开始废弃。建议使用[MediaAssetChangeRequest.deleteAssets](js-apis-photoAccessHelper.md#deleteassets11)替代。
**系统接口**：此接口为系统接口。
**需要权限**：ohos.permission.WRITE_IMAGEVIDEO
**系统能力**：SystemCapability.FileManagement.PhotoAccessHelper.Core
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ------------------------- | ---- | ---------- |
| uriList | Array<string> | 是 | 待删除的媒体文件uri数组。 |
| callback | AsyncCallback<void> | 是 | callback返回void。 |
**错误码：**
接口抛出错误码的详细介绍请参见[通用错误码](../errorcode-universal.md)和[文件管理错误码](../apis-core-file-kit/errorcode-filemanagement.md)。
| 错误码ID | 错误信息 |
| -------- | ---------------------------------------- |
| 202 | Called by non-system application. |
| 401 | Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types; 3. Parameter verification failed. |
| 13900012 | Permission denied. |
| 13900020 | Invalid argument. |
| 14000002 | Invalid uri. |
| 14000011 | System inner fail. |
**示例：**
```ts
import { dataSharePredicates } from '@kit.ArkData';
async function example() {
console.info('deleteAssetDemo');
let predicates: dataSharePredicates.DataSharePredicates = new dataSharePredicates.DataSharePredicates();
let fetchOptions: photoAccessHelper.FetchOptions = {
fetchColumns: [],
predicates: predicates
};
try {
let fetchResult: photoAccessHelper.FetchResult = await phAccessHelper.getAssets(fetchOptions);
let asset: photoAccessHelper.PhotoAsset = await fetchResult.getFirstObject();
if (asset === undefined) {
console.error('asset not exist');
return;
}
phAccessHelper.deleteAssets([asset.uri], (err) => {
if (err === undefined) {
console.info('deleteAssets successfully');
} else {
console.error(`deleteAssets failed with error: ${err.code}, ${err.message}`);
}
});
} catch (err) {
console.error(`fetch failed, error: ${err.code}, ${err.message}`);
}
}
```
### deleteAssets(deprecated)
deleteAssets(uriList: Array<string>): Promise<void>
删除媒体文件，删除的文件进入到回收站，使用Promise方式返回结果。
> **说明：**
>
> 从API version 10开始支持，从API version 11开始废弃。建议使用[MediaAssetChangeRequest.deleteAssets](js-apis-photoAccessHelper.md#deleteassets11)替代。
**系统接口**：此接口为系统接口。
**需要权限**：ohos.permission.WRITE_IMAGEVIDEO
**系统能力**：SystemCapability.FileManagement.PhotoAccessHelper.Core
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ------------------------- | ---- | ---------- |
| uriList | Array<string> | 是 | 待删除的媒体文件uri数组。 |
**返回值：**
| 类型 | 说明 |
| --------------------------------------- | ----------------- |
| Promise<void>| Promise对象，返回void。 |
**错误码：**
接口抛出错误码的详细介绍请参见[通用错误码](../errorcode-universal.md)和[文件管理错误码](../apis-core-file-kit/errorcode-filemanagement.md)。
| 错误码ID | 错误信息 |
| -------- | ---------------------------------------- |
| 202 | Called by non-system application. |
| 401 | Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types; 3. Parameter verification failed. |
| 13900012 | Permission denied. |
| 13900020 | Invalid argument. |
| 14000002 | Invalid uri. |
| 14000011 | System inner fail. |
**示例：**
```ts
import { dataSharePredicates } from '@kit.ArkData';
async function example() {
console.info('deleteDemo');
let predicates: dataSharePredicates.DataSharePredicates = new dataSharePredicates.DataSharePredicates();
let fetchOptions: photoAccessHelper.FetchOptions = {
fetchColumns: [],
predicates: predicates
};
try {
let fetchResult: photoAccessHelper.FetchResult = await phAccessHelper.getAssets(fetchOptions);
let asset: photoAccessHelper.PhotoAsset = await fetchResult.getFirstObject();
if (asset === undefined) {
console.error('asset not exist');
return;
}
await phAccessHelper.deleteAssets([asset.uri]);
console.info('deleteAssets successfully');
} catch (err) {
console.error(`deleteAssets failed with error: ${err.code}, ${err.message}`);
}
}
```
### getPhotoIndex
getPhotoIndex(photoUri: string, albumUri: string, options: FetchOptions, callback: AsyncCallback<number>): void
获取相册中图片或视频的位置，使用callback方式返回结果。
**系统接口**：此接口为系统接口。
**需要权限**：ohos.permission.READ_IMAGEVIDEO
**系统能力**：SystemCapability.FileManagement.PhotoAccessHelper.Core
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ------------------------- | ---- | ---------- |
| photoUri | string | 是 | 所查询的图库资源的uri。 |
| albumUri | string | 是 | 相册uri，可以为空字符串，为空字符串时默认查询全部图库资源。 |
| options | [FetchOptions](js-apis-photoAccessHelper.md#fetchoptions) | 是 | 检索选项，predicates中必须设置一种检索排序方式，不设置或多设置均会导致接口调用异常。 |
| callback | AsyncCallback<number>| 是 | callback返回相册中资源的索引。 |
**错误码：**
接口抛出错误码的详细介绍请参见[通用错误码](../errorcode-universal.md)和[文件管理错误码](../apis-core-file-kit/errorcode-filemanagement.md)。
| 错误码ID | 错误信息 |
| -------- | ---------------------------------------- |
| 202 | Called by non-system application. |
| 401 | Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types; 3. Parameter verification failed. |
| 13900012 | Permission denied. |
| 13900020 | Invalid argument. |
| 14000011 | System inner fail. |
**示例：**
```ts
import { dataSharePredicates } from '@kit.ArkData';
async function example() {
try {
console.info('getPhotoIndexDemo');
let predicatesForGetAsset: dataSharePredicates.DataSharePredicates = new dataSharePredicates.DataSharePredicates();
let fetchOp: photoAccessHelper.FetchOptions = {
fetchColumns: [],
predicates: predicatesForGetAsset
};
// Obtain the uri of the album
let albumFetchResult: photoAccessHelper.FetchResult = await phAccessHelper.getAlbums(photoAccessHelper.AlbumType.SYSTEM, photoAccessHelper.AlbumSubtype.FAVORITE, fetchOp);
let album: photoAccessHelper.Album = await albumFetchResult.getFirstObject();
let predicates: dataSharePredicates.DataSharePredicates = new dataSharePredicates.DataSharePredicates();
predicates.orderByAsc(photoAccessHelper.PhotoKeys.DATE_MODIFIED);
let fetchOptions: photoAccessHelper.FetchOptions = {
fetchColumns: [photoAccessHelper.PhotoKeys.DATE_MODIFIED],
predicates: predicates
};
let photoFetchResult: photoAccessHelper.FetchResult = await album.getAssets(fetchOptions);
let expectIndex = 1;
// Obtain the uri of the second file
let photoAsset: photoAccessHelper.PhotoAsset = await photoFetchResult.getObjectByPosition(expectIndex);
phAccessHelper.getPhotoIndex(photoAsset.uri, album.albumUri, fetchOptions, (err, index) => {
if (err === undefined) {
console.info(`getPhotoIndex successfully and index is : ${index}`);
} else {
console.error(`getPhotoIndex failed; error: ${err.code}, ${err.message}`);
}
});
} catch (error) {
console.error(`getPhotoIndex failed; error: ${error.code}, ${error.message}`);
}
}
```
### getPhotoIndex
getPhotoIndex(photoUri: string, albumUri: string, options: FetchOptions): Promise<number>
获取相册中图片或视频的位置，使用Promise方式返回结果。
**系统接口**：此接口为系统接口。
**需要权限**：ohos.permission.READ_IMAGEVIDEO
**系统能力**：SystemCapability.FileManagement.PhotoAccessHelper.Core
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ------------------------- | ---- | ---------- |
| photoUri | string | 是 | 所查询的图库资源的uri。 |
| albumUri | string | 是 | 相册uri，可以为空字符串，为空字符串时默认查询全部图库资源。 |
| options | [FetchOptions](js-apis-photoAccessHelper.md#fetchoptions) | 是 | 检索选项，predicates中必须设置一种检索排序方式，不设置或多设置均会导致接口调用异常。 |
**返回值：**
| 类型 | 说明 |
| --------------------------------------- | ----------------- |
| Promise<number>| 返回相册中资源的索引。 |
**错误码：**
接口抛出错误码的详细介绍请参见[通用错误码](../errorcode-universal.md)和[文件管理错误码](../apis-core-file-kit/errorcode-filemanagement.md)。
| 错误码ID | 错误信息 |
| -------- | ---------------------------------------- |
| 202 | Called by non-system application. |
| 401 | Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types; 3. Parameter verification failed. |
| 13900012 | Permission denied. |
| 13900020 | Invalid argument. |
| 14000011 | System inner fail. |
**示例：**
```ts
import { dataSharePredicates } from '@kit.ArkData';
import { BusinessError } from '@kit.BasicServicesKit';
async function example() {
try {
console.info('getPhotoIndexDemo');
let predicatesForGetAsset: dataSharePredicates.DataSharePredicates = new dataSharePredicates.DataSharePredicates();
let fetchOp: photoAccessHelper.FetchOptions = {
fetchColumns: [],
predicates: predicatesForGetAsset
};
// Obtain the uri of the album
let albumFetchResult: photoAccessHelper.FetchResult = await phAccessHelper.getAlbums(photoAccessHelper.AlbumType.SYSTEM, photoAccessHelper.AlbumSubtype.FAVORITE, fetchOp);
let album: photoAccessHelper.Album = await albumFetchResult.getFirstObject();
let predicates: dataSharePredicates.DataSharePredicates = new dataSharePredicates.DataSharePredicates();
predicates.orderByAsc(photoAccessHelper.PhotoKeys.DATE_MODIFIED);
let fetchOptions: photoAccessHelper.FetchOptions = {
fetchColumns: [photoAccessHelper.PhotoKeys.DATE_MODIFIED],
predicates: predicates
};
let photoFetchResult: photoAccessHelper.FetchResult = await album.getAssets(fetchOptions);
let expectIndex = 1;
// Obtain the uri of the second file
let photoAsset: photoAccessHelper.PhotoAsset = await photoFetchResult.getObjectByPosition(expectIndex);
phAccessHelper.getPhotoIndex(photoAsset.uri, album.albumUri, fetchOptions).then((index) => {
console.info(`getPhotoIndex successfully and index is : ${index}`);
}).catch((err: BusinessError) => {
console.error(`getPhotoIndex failed; error: ${err.code}, ${err.message}`);
});
} catch (error) {
console.error(`getPhotoIndex failed; error: ${error.code}, ${error.message}`);
}
}
```
### saveFormInfo11+
saveFormInfo(info:FormInfo, callback: AsyncCallback<void>):void
将图库卡片相关信息保存到数据库中，使用callback方式返回结果。
**系统接口**：此接口为系统接口。
**需要权限**：ohos.permission.WRITE_IMAGEVIDEO
**系统能力**：SystemCapability.FileManagement.PhotoAccessHelper.Core
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ------------------------ | ---- | ------------------------- |
| info | [FormInfo](#forminfo11) | 是 | 图库卡片信息，包括图库卡片的id和卡片绑定的图片的uri。 |
| callback | AsyncCallback<void> | 是 | callback返回void。 |
**错误码：**
接口抛出错误码的详细介绍请参见[通用错误码](../errorcode-universal.md)和[文件管理错误码](../apis-core-file-kit/errorcode-filemanagement.md)。
| 错误码ID | 错误信息 |
| -------- | ---------------------------------------- |
| 201 | Permission verification failed, usually the result returned by VerifyAccessToken. |
| 202 | Permission verification failed, application which is not a system application uses system API. |
| 401 | Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types; 3. Parameter verification failed. |
| 14000011 | System inner fail. |
**示例：**
```ts
import { dataSharePredicates } from '@kit.ArkData';
import { BusinessError } from '@kit.BasicServicesKit';
async function example() {
console.info('saveFormInfoDemo');
let predicates: dataSharePredicates.DataSharePredicates = new dataSharePredicates.DataSharePredicates();
let fetchOptions: photoAccessHelper.FetchOptions = {
fetchColumns: [],
predicates: predicates
};
let fetchResult: photoAccessHelper.FetchResult = await phAccessHelper.getAssets(fetchOptions);
let photoAsset: photoAccessHelper.PhotoAsset = await fetchResult.getFirstObject();
let info: photoAccessHelper.FormInfo = {
//formId是一个由纯数字组成的字符串，uri为图库中存在的图片的uri信息，图库中无图片创建卡片时uri需为空字符串
formId : "20230116123",
uri: photoAsset.uri,
}
phAccessHelper.saveFormInfo(info, async (err: BusinessError) => {
if (err == undefined) {
console.info('saveFormInfo success');
} else {
console.error(`saveFormInfo fail with error: ${err.code}, ${err.message}`);
}
});
}
```
### saveFormInfo11+
saveFormInfo(info:FormInfo):Promise<void>
将图库卡片相关信息保存到数据库中，使用Promise方式返回结果。
**系统接口**：此接口为系统接口。
**需要权限**：ohos.permission.WRITE_IMAGEVIDEO
**系统能力**：SystemCapability.FileManagement.PhotoAccessHelper.Core
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ------------------------ | ---- | ------------------------- |
| info | [FormInfo](#forminfo11) | 是 | 图库卡片信息，包括图库卡片的id和卡片绑定的图片的uri。 |
**返回值：**
| 类型 | 说明 |
| --------------------------------------- | ----------------- |
| Promise<void>| Promise对象，返回void。 |
**错误码：**
接口抛出错误码的详细介绍请参见[通用错误码](../errorcode-universal.md)和[文件管理错误码](../apis-core-file-kit/errorcode-filemanagement.md)。
| 错误码ID | 错误信息 |
| -------- | ---------------------------------------- |
| 201 | Permission verification failed, usually the result returned by VerifyAccessToken. |
| 202 | Permission verification failed, application which is not a system application uses system API. |
| 401 | Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types; 3. Parameter verification failed. |
| 14000011 | System inner fail. |
**示例：**
```ts
import { dataSharePredicates } from '@kit.ArkData';
import { BusinessError } from '@kit.BasicServicesKit';
async function example() {
console.info('saveFormInfoDemo');
let predicates: dataSharePredicates.DataSharePredicates = new dataSharePredicates.DataSharePredicates();
let fetchOptions: photoAccessHelper.FetchOptions = {
fetchColumns: [],
predicates: predicates
};
let fetchResult: photoAccessHelper.FetchResult = await phAccessHelper.getAssets(fetchOptions);
let photoAsset: photoAccessHelper.PhotoAsset = await fetchResult.getFirstObject();
let info: photoAccessHelper.FormInfo = {
//formId是一个由纯数字组成的字符串，uri为图库中存在的图片的uri信息，图库中无图片创建卡片时uri需为空字符串
formId: "20230116123",
uri: photoAsset.uri,
}
phAccessHelper.saveFormInfo(info).then(() => {
console.info('saveFormInfo successfully');
}).catch((err: BusinessError) => {
console.error(`saveFormInfo failed with error: ${err.code}, ${err.message}`);
});
}
```
### removeFormInfo11+
removeFormInfo(info:FormInfo, callback: AsyncCallback<void>):void
从数据库中删除图库卡片信息，使用callback方式返回结果。
**系统接口**：此接口为系统接口。
**需要权限**：ohos.permission.WRITE_IMAGEVIDEO
**系统能力**：SystemCapability.FileManagement.PhotoAccessHelper.Core
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ------------------------ | ---- | ------------------------- |
| info | [FormInfo](#forminfo11) | 是 | 图库卡片信息，包括图库卡片的id和卡片绑定的图片的uri。 |
| callback | AsyncCallback<void> | 是 | callback返回void。 |
**错误码：**
接口抛出错误码的详细介绍请参见[通用错误码](../errorcode-universal.md)和[文件管理错误码](../apis-core-file-kit/errorcode-filemanagement.md)。
| 错误码ID | 错误信息 |
| -------- | ---------------------------------------- |
| 201 | Permission verification failed, usually the result returned by VerifyAccessToken. |
| 202 | Permission verification failed, application which is not a system application uses system API. |
| 401 | Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types; 3. Parameter verification failed. |
| 14000011 | System inner fail. |
**示例：**
```ts
import { BusinessError } from '@kit.BasicServicesKit';
async function example() {
console.info('removeFormInfoDemo');
let info: photoAccessHelper.FormInfo = {
//formId是一个由纯数字组成的字符串，移除卡片的时候uri填空即可
formId: "20230116123",
uri: "",
}
phAccessHelper.removeFormInfo(info, async (err: BusinessError) => {
if (err == undefined) {
console.info('removeFormInfo success');
} else {
console.error(`removeFormInfo fail with error: ${err.code}, ${err.message}`);
}
});
}
```
### removeFormInfo11+
removeFormInfo(info:FormInfo):Promise<void>
从数据库中删除图库卡片信息，使用Promise方式返回结果。
**系统接口**：此接口为系统接口。
**需要权限**：ohos.permission.WRITE_IMAGEVIDEO
**系统能力**：SystemCapability.FileManagement.PhotoAccessHelper.Core
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ------------------------ | ---- | ------------------------- |
| info | [FormInfo](#forminfo11) | 是 | 图库卡片信息，包括图库卡片的id和卡片绑定的图片的uri。 |
**返回值：**
| 类型 | 说明 |
| --------------------------------------- | ----------------- |
| Promise<void>| Promise对象，返回void。 |
**错误码：**
接口抛出错误码的详细介绍请参见[通用错误码](../errorcode-universal.md)和[文件管理错误码](../apis-core-file-kit/errorcode-filemanagement.md)。
| 错误码ID | 错误信息 |
| -------- | ---------------------------------------- |
| 201 | Permission verification failed, usually the result returned by VerifyAccessToken. |
| 202 | Permission verification failed, application which is not a system application uses system API. |
| 401 | Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types; 3. Parameter verification failed. |
| 14000011 | System inner fail. |
**示例：**
```ts
import { BusinessError } from '@kit.BasicServicesKit';
async function example() {
console.info('removeFormInfoDemo');
let info: photoAccessHelper.FormInfo = {
//formId是一个由纯数字组成的字符串，移除卡片的时候uri填空即可
formId: "20230116123",
uri: "",
}
phAccessHelper.removeFormInfo(info).then(() => {
console.info('removeFormInfo successfully');
}).catch((err: BusinessError) => {
console.error(`removeFormInfo failed with error: ${err.code}, ${err.message}`);
});
}
```
### createAssetsForApp12+
createAssetsForApp(bundleName: string, appName: string, appId: string, photoCreationConfigs: Array<PhotoCreationConfig>): Promise<Array<string>>
调用接口代替应用创建媒体库uri列表。Uri已对appId对应的应用授权，支持应用使用uri写入图片/视频。
**系统接口**：此接口为系统接口。
**需要权限**：ohos.permission.WRITE_IMAGEVIDEO
**系统能力**：SystemCapability.FileManagement.PhotoAccessHelper.Core
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- |----------------------------------------------------------------------| ---- | ------------------------- |
| bundleName | string | 是 | 需保存图片/视频文件的应用bundle name。 |
| appName | string | 是 | 需保存图片/视频文件的应用app name。 |
| appId | string | 是 | 需保存图片/视频文件的应用app id。 |
| photoCreationConfigs | Array<[PhotoCreationConfig](./js-apis-photoAccessHelper.md#photocreationconfig12)> | 是 | 保存图片/视频到媒体库的配置。 |
**返回值：**
| 类型 | 说明 |
| --------------------------------------- | ----------------- |
| Promise<Array<string>> | Promise对象，返回给接口调用方的的媒体库文件uri列表。Uri已对appId对应的应用授权，支持应用写入数据。 |
**错误码：**
接口抛出错误码的详细介绍请参见[通用错误码](../errorcode-universal.md)和[文件管理错误码](../apis-core-file-kit/errorcode-filemanagement.md)。
| 错误码ID | 错误信息 |
| -------- | ---------------------------------------- |
| 201 | Permission denied. |
| 202 | Called by non-system application. |
| 401 | Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameters types; 3. Parameter verification failed. |
| 14000011 | Internal system error. |
**示例：**
```ts
async function example() {
console.info('createAssetsForAppDemo.');
try {
let bundleName: string = 'testBundleName';
let appName: string = 'testAppName';
let appId: string = 'testAppId';
let photoCreationConfigs: Array = [
{
title: 'test',
fileNameExtension: 'jpg',
photoType: photoAccessHelper.PhotoType.IMAGE,
subtype: photoAccessHelper.PhotoSubtype.DEFAULT,
}
];
let desFileUris: Array = await phAccessHelper.createAssetsForApp(bundleName, appName, appId, photoCreationConfigs);
console.info('createAssetsForApp success, data is ' + desFileUris);
} catch (err) {
console.error(`createAssetsForApp failed with error: ${err.code}, ${err.message}`);
}
}
```
### grantPhotoUriPermission12+
grantPhotoUriPermission(appid: string, uri: string, photoPermissionType: PhotoPermissionType, hideSensitiveType: HideSensitiveType): Promise<number>
给应用授予uri的访问权限，使用Promise方式返回结果。
**系统接口**：此接口为系统接口。
**系统能力**：SystemCapability.FileManagement.PhotoAccessHelper.Core
**需要权限：** ohos.permission.WRITE_IMAGEVIDEO
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- |----------------------------------------------------------------------| ---- | ------------------------- |
| appid | string | 是 | 应用标识，将访问权限授予给appid标识的应用。 |
| uri | string | 是 | 媒体资源的uri，uri表示的资源的访问权限将授予给应用。|
| photoPermissionType | [PhotoPermissionType](#photopermissiontype12) | 是 | 权限类型，将photoPermissionType表示的权限授予给应用。权限的覆盖规则参考枚举类。|
| hideSensitiveType | [HideSensitiveType](#hidesensitivetype12) | 是 | 脱敏类型，预留参数，目前可传枚举类中任一值。|
**返回值：**
| 类型 | 说明 |
| --------------------------------------- | ----------------- |
| Promise<number> | Promise对象，0:授权成功。 1:已有权限。-1:授权失败。|
**错误码：**
接口抛出错误码的详细介绍请参见[通用错误码](../errorcode-universal.md)和[文件管理错误码](../apis-core-file-kit/errorcode-filemanagement.md)。
| 错误码ID | 错误信息 |
| -------- | ---------------------------------------- |
| 201 | Permission denied. |
| 202 | Called by non-system application. |
| 401 | Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameters types; 3. Parameter verification failed. |
| 14000011 | Internal system error. |
**示例：**
```ts
async function example() {
console.info('grantPhotoUriPermissionDemo');
try {
let result = await phAccessHelper.grantPhotoUriPermission('com.example.myapplication01',
'file://media/Photo/1/IMG_datetime_0001/displayName.jpg',
photoAccessHelper.PhotoPermissionType.TEMPORARY_READ_IMAGEVIDEO,
photoAccessHelper.HideSensitiveType.HIDE_LOCATION_AND_SHOTING_PARM);
console.info('grantPhotoUriPermission success, result=' + result);
} catch (err) {
console.error('grantPhotoUriPermission failed, error=' + err);
}
}
```
### grantPhotoUrisPermission12+
grantPhotoUrisPermission(appid: string, uriList: Array<string>, photoPermissionType: PhotoPermissionType, hideSensitiveType: HideSensitiveType): Promise<number>
给应用授予uri列表的访问权限，使用Promise方式返回结果。
**系统接口**：此接口为系统接口。
**系统能力**：SystemCapability.FileManagement.PhotoAccessHelper.Core
**需要权限：** ohos.permission.WRITE_IMAGEVIDEO
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- |----------------------------------------------------------------------| ---- | ------------------------- |
| appid | string | 是 | 应用标识，将访问权限授予给appid标识的应用。 |
| uriList | Array<string> | 是 | 媒体资源的uri列表，uri列表中的资源的访问权限将授予给应用。uri列表最多容纳 1000 条uri。|
| photoPermissionType | [PhotoPermissionType](#photopermissiontype12) | 是 | 权限类型，将photoPermissionType表示的权限授予给应用。权限的覆盖规则参考枚举类。|
| hideSensitiveType | [HideSensitiveType](#hidesensitivetype12) | 是 | 脱敏类型，预留参数，目前可传枚举类中任一值。|
**返回值：**
| 类型 | 说明 |
| --------------------------------------- | ----------------- |
| Promise<number> | Promise对象，0: 授权成功。 -1:授权失败。|
**错误码：**
接口抛出错误码的详细介绍请参见[通用错误码](../errorcode-universal.md)和[文件管理错误码](../apis-core-file-kit/errorcode-filemanagement.md)。
| 错误码ID | 错误信息 |
| -------- | ---------------------------------------- |
| 201 | Permission denied. |
| 202 | Called by non-system application. |
| 401 | Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameters types; 3. Parameter verification failed. |
| 14000011 | Internal system error. |
**示例：**
```ts
async function example() {
console.info('grantPhotoUrisPermissionDemo');
try {
// 媒体资源的uri列表
let uris: Array = [
'file://media/Photo/11/IMG_datetime_0001/displayName1.jpg',
'file://media/Photo/22/IMG_datetime_0002/displayName2.jpg'];
let result = await phAccessHelper.grantPhotoUrisPermission('com.example.myapplication01', uris,
photoAccessHelper.PhotoPermissionType.TEMPORARY_READ_IMAGEVIDEO,
photoAccessHelper.HideSensitiveType.HIDE_LOCATION_AND_SHOTING_PARM);
console.info('grantPhotoUrisPermission success, result=' + result);
} catch (err) {
console.error('grantPhotoUrisPermission failed, error=' + err);
}
}
```
### cancelPhotoUriPermission12+
cancelPhotoUriPermission(appid: string, uri: string, photoPermissionType: PhotoPermissionType): Promise<number>
取消应用对uri的访问权限，使用Promise方式返回结果。
**系统接口**：此接口为系统接口。
**系统能力**：SystemCapability.FileManagement.PhotoAccessHelper.Core
**需要权限：** ohos.permission.WRITE_IMAGEVIDEO
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- |----------------------------------------------------------------------| ---- | ------------------------- |
| appid | string | 是 | 应用标识，将取消appid标识应用对媒体资源的访问权限。 |
| uri | string | 是 | 媒体资源的uri，取消应用对uri表示的资源的访问权限。|
| photoPermissionType | [PhotoPermissionType](#photopermissiontype12) | 是 | 权限类型，取消应用对媒体资源的访问权限为photoPermissionType。|
**返回值：**
| 类型 | 说明 |
| --------------------------------------- | ----------------- |
| Promise<number> | Promise对象，0:取消成功。-1:取消失败。|
**错误码：**
接口抛出错误码的详细介绍请参见[通用错误码](../errorcode-universal.md)和[文件管理错误码](../apis-core-file-kit/errorcode-filemanagement.md)。
| 错误码ID | 错误信息 |
| -------- | ---------------------------------------- |
| 201 | Permission denied. |
| 202 | Called by non-system application. |
| 401 | Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameters types; 3. Parameter verification failed. |
| 14000011 | Internal system error. |
**示例：**
```ts
async function example() {
console.info('cancelPhotoUriPermissionDemo');
try {
let result = await phAccessHelper.cancelPhotoUriPermission('com.example.myapplication01',
'file://media/Photo/11/IMG_datetime_0001/displayName.jpg',
photoAccessHelper.PhotoPermissionType.TEMPORARY_READ_IMAGEVIDEO);
console.info('cancelPhotoUriPermission success, result=' + result);
} catch (err) {
console.error('cancelPhotoUriPermission failed, error=' + err);
}
}
```
### createAssetsForAppWithMode12+
createAssetsForAppWithMode(boundleName: string, appName: string, appId: string, tokenId: number, authorizationMode: AuthorizationMode, photoCreationConfigs:Array\): Promise\>
提供给应用保存短时授权，使用Promise方式返回结果。
**系统接口**：此接口为系统接口。
**系统能力**：SystemCapability.FileManagement.PhotoAccessHelper.Core
**需要权限：** ohos.permission.WRITE_IMAGEVIDEO
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- |----------------------------------------------------------------------| ---- | ------------------------- |
| boundleName| string | 是 | 需要保存图片/视频文件的应用boundleName。 |
| appName| string | 是 | 需要保存图片/视频文件的应用appName。|
| appId| string | 是 | 需要保存图片/视频文件的应用app id。 |
| tokenId| number| 是 | 需要短时授权应用的唯一标识。 |
| authorizationMode| [AuthorizationMode](#authorizationmode12)| 是 | 授权模式。授予应用短期内再次保存无需重复弹框确认。 |
| PhotoCreationConfig| Array\<[PhotoCreationConfig](js-apis-photoAccessHelper.md#photocreationconfig12)> | 是 | 保存图片/视频到媒体库的配置。|
**返回值：**
| 类型 | 说明 |
| --------------------------------------- | ----------------- |
| Promise\> | Promise对象，返回给接口调用方的媒体库文件uri列表。Uri已对appId对应的应用授权，支持应用写入数据。|
**错误码：**
接口抛出错误码的详细介绍请参见[通用错误码](../errorcode-universal.md)和[文件管理错误码](../apis-core-file-kit/errorcode-filemanagement.md)。
| 错误码ID | 错误信息 |
| -------- | ---------------------------------------- |
| 201 | Permission denied. |
| 202 | Called by non-system application. |
| 401 | Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameters types; 3. Parameter verification failed. |
| 14000011 | Internal system error. |
**示例：**
```ts
async function example() {
console.info('createAssetsForAppWithModeDemo.');
try {
let photoCreationConfigs: Array = [
{
title: '123456',
fileNameExtension: 'jpg',
photoType: photoAccessHelper.PhotoType.IMAGE,
subtype: photoAccessHelper.PhotoSubtype.DEFAULT,
}
];
let bundleName: string = 'testBundleName';
let appName: string = 'testAppName';
let appId: string = 'testAppId';
let tokenId: number = 537197950;
let authorizationMode: photoAccessHelper.AuthorizationMode = photoAccessHelper.AuthorizationMode.SHORT_TIME_AUTHORIZATION;
let result: Array = await phAccessHelper.createAssetsForAppWithMode(bundleName, appName, appId, tokenId, authorizationMode, photoCreationConfigs);
console.info(`result: ${JSON.stringify(result)}`);
console.info('Photo createAssetsForAppWithMode success.');
} catch (err) {
console.error(`createAssetsForAppWithMode failed with error: ${err.code}, ${err.message}`);
}
}
```
### getKeyFrameThumbnail14+
getKeyFrameThumbnail(beginFrameTimeMs: number, type: ThumbnailType): Promise;
获取视频中关键视频帧位置的指定类型缩略图，使用promise方式返回异步结果。
**系统接口**：此接口为系统接口。
**系统能力**：SystemCapability.FileManagement.PhotoAccessHelper.Core
**需要权限**：ohos.permission.READ_IMAGEVIDEO
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| ---- | -------------- | ---- | ----- |
| beginFrameTimeMs | number | 是 | 获取视频帧的时间位置，单位ms，0：封面帧 |
| type | [ThumbnailType](#thumbnailtype13)| 是 | 缩略图类型 |
**返回值：**
| 类型 | 说明 |
| ----------------------------- | --------------------- |
| Promise<[image.PixelMap](../apis-image-kit/js-apis-image.md#pixelmap7)> | Promise对象，返回缩略图的PixelMap。若获取不到，默认返回封面帧 |
**错误码：**
接口抛出错误码的详细介绍请参见[通用错误码](../errorcode-universal.md)和[文件管理错误码](../apis-core-file-kit/errorcode-filemanagement.md)。
| 错误码ID | 错误信息 |
| -------- | ---------------------------------------- |
| 201 | Permission denied. |
| 202 | Called by non-system application. |
| 401 | Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types; 3. Parameter verification failed. |
| 14000011 | Internal system error.
**示例：**
```ts
import { common } from '@kit.AbilityKit';
import photoAccessHelper from '@ohos.file.photoAccessHelper';
import dataSharePredicates from '@ohos.data.dataSharePredicates';
import image from '@ohos.multimedia.image';
async function example() {
try{
console.info('getKeyFrameThumbnail demo');
let context = getContext(this) as common.UIAbilityContext;
let phAccessHelper:photoAccessHelper.PhotoAccessHelper = photoAccessHelper.getPhotoAccessHelper(context);
let predicates: dataSharePredicates.DataSharePredicates = new dataSharePredicates.DataSharePredicates();
predicates.equalTo(photoAccessHelper.PhotoKeys.PHOTO_TYPE, photoAccessHelper.PhotoType.VIDEO);
let fetchOption: photoAccessHelper.FetchOptions = {
fetchColumns: [],
predicates: predicates
};
let fetchResult: photoAccessHelper.FetchResult = await phAccessHelper.getAssets(fetchOption);
let asset: photoAccessHelper.PhotoAsset = await fetchResult.getLastObject();
let pixelMap: image.PixelMap = await asset.getKeyFrameThumbnail(0, photoAccessHelper.ThumbnailType.LCD);
console.info('getKeyFrameThumbnail success');
} catch (error) {
console.error('getKeyFrameThumbnail failed, error: ' + JSON.stringify(error));
}
}
```
## PhotoAsset
提供封装文件属性的方法。
### open(deprecated)
open(mode: string, callback: AsyncCallback<number>): void
打开当前文件，使用callback方式返回异步结果。
> **说明：**
>
> 从API version 10开始支持，从API version 11开始废弃。出于安全考量，不再提供获取正式媒体文件句柄的接口。
**注意**：当前此（写）操作是互斥的操作，返回的文件描述符在使用完毕后需要调用close进行释放。
**系统接口**：此接口为系统接口。
**需要权限**：ohos.permission.READ_IMAGEVIDEO 或 ohos.permission.WRITE_IMAGEVIDEO
**系统能力**：SystemCapability.FileManagement.PhotoAccessHelper.Core
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | --------------------------- | ---- | ----------------------------------- |
| mode | string | 是 | 打开文件方式，分别为：'r'（只读）, 'w'（只写）, 'rw'（读写）。 |
| callback | AsyncCallback<number> | 是 | callback返回文件描述符。 |
**错误码：**
接口抛出错误码的详细介绍请参见[通用错误码](../errorcode-universal.md)和[文件管理错误码](../apis-core-file-kit/errorcode-filemanagement.md)。
| 错误码ID | 错误信息 |
| -------- | ---------------------------------------- |
| 202 | Called by non-system application. |
| 401 | Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types; 3. Parameter verification failed. |
| 13900012 | Permission denied. |
| 13900020 | Invalid argument. |
| 14000011 | System inner fail. |
**示例：**
```ts
async function example() {
console.info('Open demo');
let testFileName: string = 'testFile' + Date.now() + '.jpg';
let photoAsset: photoAccessHelper.PhotoAsset = await phAccessHelper.createAsset(testFileName);
photoAsset.open('rw', (err, fd) => {
if (fd !== undefined) {
console.info('File fd' + fd);
photoAsset.close(fd);
} else {
console.error(`Open file err: ${err.code}, ${err.message}`);
}
});
}
```
### open(deprecated)
open(mode: string): Promise<number>
打开当前文件，使用promise方式返回异步结果。
> **说明：**
>
> 从API version 10开始支持，从API version 11开始废弃。出于安全考量，不再提供获取正式媒体文件句柄的接口。
**注意**：当前此（写）操作是互斥的操作，返回的文件描述符在使用完毕后需要调用close进行释放。
**系统接口**：此接口为系统接口。
**需要权限**：ohos.permission.READ_IMAGEVIDEO 或 ohos.permission.WRITE_IMAGEVIDEO
**系统能力**：SystemCapability.FileManagement.PhotoAccessHelper.Core
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| ---- | ------ | ---- | ----------------------------------- |
| mode | string | 是 | 打开文件方式，分别为：'r'（只读）, 'w'（只写）, 'rw'（读写）。 |
**返回值：**
| 类型 | 说明 |
| --------------------- | ------------- |
| Promise<number> | Promise对象，返回文件描述符。 |
**错误码：**
接口抛出错误码的详细介绍请参见[通用错误码](../errorcode-universal.md)和[文件管理错误码](../apis-core-file-kit/errorcode-filemanagement.md)。
| 错误码ID | 错误信息 |
| -------- | ---------------------------------------- |
| 202 | Called by non-system application. |
| 401 | Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types; 3. Parameter verification failed. |
| 13900012 | Permission denied. |
| 13900020 | Invalid argument. |
| 14000011 | System inner fail. |
**示例：**
```ts
async function example() {
console.info('Open demo');
try {
let testFileName: string = 'testFile' + Date.now() + '.jpg';
let photoAsset: photoAccessHelper.PhotoAsset = await phAccessHelper.createAsset(testFileName);
let fd: number = await photoAsset.open('rw');
if (fd !== undefined) {
console.info('File fd' + fd);
photoAsset.close(fd);
} else {
console.error('Open file fail');
}
} catch (err) {
console.error(`Open demo err: ${err.code}, ${err.message}`);
}
}
```
### setFavorite(deprecated)
setFavorite(favoriteState: boolean, callback: AsyncCallback<void>): void
将文件设置为收藏文件，使用callback方式返回异步结果。
> **说明：**
>
> 从API version 10开始支持，从API version 11开始废弃。建议使用[MediaAssetChangeRequest.setFavorite](#setfavorite11)替代。
**系统接口**：此接口为系统接口。
**需要权限**：ohos.permission.WRITE_IMAGEVIDEO
**系统能力**：SystemCapability.FileManagement.PhotoAccessHelper.Core
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| ---------- | ------------------------- | ---- | ---------------------------------- |
| favoriteState | boolean | 是 | 是否设置为收藏文件， true：设置为收藏文件，false：取消收藏。 |
| callback | AsyncCallback<void> | 是 | callback返回void。 |
**错误码：**
接口抛出错误码的详细介绍请参见[通用错误码](../errorcode-universal.md)和[文件管理错误码](../apis-core-file-kit/errorcode-filemanagement.md)。
| 错误码ID | 错误信息 |
| -------- | ---------------------------------------- |
| 202 | Called by non-system application. |
| 401 | Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types; 3. Parameter verification failed. |
| 13900012 | Permission denied. |
| 13900020 | Invalid argument. |
| 14000011 | System inner fail. |
**示例：**
```ts
import { dataSharePredicates } from '@kit.ArkData';
async function example() {
console.info('setFavoriteDemo');
let predicates: dataSharePredicates.DataSharePredicates = new dataSharePredicates.DataSharePredicates();
let fetchOption: photoAccessHelper.FetchOptions = {
fetchColumns: [],
predicates: predicates
};
let fetchResult: photoAccessHelper.FetchResult = await phAccessHelper.getAssets(fetchOption);
let asset = await fetchResult.getFirstObject();
asset.setFavorite(true, (err) => {
if (err === undefined) {
console.info('favorite successfully');
} else {
console.error(`favorite failed with error: ${err.code}, ${err.message}`);
}
});
}
```
### setFavorite(deprecated)
setFavorite(favoriteState: boolean): Promise<void>
将文件设置为收藏文件，使用promise方式返回异步结果。
> **说明：**
>
> 从API version 10开始支持，从API version 11开始废弃。建议使用[MediaAssetChangeRequest.setFavorite](#setfavorite11)替代。
**系统接口**：此接口为系统接口。
**需要权限**：ohos.permission.WRITE_IMAGEVIDEO
**系统能力**：SystemCapability.FileManagement.PhotoAccessHelper.Core
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| ---------- | ------- | ---- | ---------------------------------- |
| favoriteState | boolean | 是 | 是否设置为收藏文件， true：设置为收藏文件，false：取消收藏。 |
**返回值：**
| 类型 | 说明 |
| ------------------- | ---------- |
| Promise<void> | Promise对象，返回void。 |
**错误码：**
接口抛出错误码的详细介绍请参见[通用错误码](../errorcode-universal.md)和[文件管理错误码](../apis-core-file-kit/errorcode-filemanagement.md)。
| 错误码ID | 错误信息 |
| -------- | ---------------------------------------- |
| 202 | Called by non-system application. |
| 401 | Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types; 3. Parameter verification failed. |
| 13900012 | Permission denied. |
| 13900020 | Invalid argument. |
| 14000011 | System inner fail. |
**示例：**
```ts
import { dataSharePredicates } from '@kit.ArkData';
import { BusinessError } from '@kit.BasicServicesKit';
async function example() {
console.info('setFavoriteDemo');
let predicates: dataSharePredicates.DataSharePredicates = new dataSharePredicates.DataSharePredicates();
let fetchOption: photoAccessHelper.FetchOptions = {
fetchColumns: [],
predicates: predicates
};
let fetchResult: photoAccessHelper.FetchResult = await phAccessHelper.getAssets(fetchOption);
let asset = await fetchResult.getFirstObject();
asset.setFavorite(true).then(() => {
console.info('setFavorite successfully');
}).catch((err: BusinessError) => {
console.error(`setFavorite failed with error: ${err.code}, ${err.message}`);
});
}
```
### setHidden(deprecated)
setHidden(hiddenState: boolean, callback: AsyncCallback<void>): void
将文件设置为隐私文件，使用callback方式返回异步结果。
隐私文件存在隐私相册中，用户通过隐私相册去获取隐私文件后可以通过设置hiddenState为false来从隐私相册中移除。
> **说明：**
>
> 从API version 10开始支持，从API version 11开始废弃。建议使用[MediaAssetChangeRequest.setHidden](#sethidden11)替代。
**系统接口**：此接口为系统接口。
**需要权限**：ohos.permission.WRITE_IMAGEVIDEO
**系统能力**：SystemCapability.FileManagement.PhotoAccessHelper.Core
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| ---------- | ------------------------- | ---- | ---------------------------------- |
| hiddenState | boolean | 是 | 是否设置为隐藏文件，true:将文件资产放入隐藏相册;false:从隐藏相册中恢复。 |
| callback | AsyncCallback<void> | 是 | callback返回void。 |
**错误码：**
接口抛出错误码的详细介绍请参见[通用错误码](../errorcode-universal.md)和[文件管理错误码](../apis-core-file-kit/errorcode-filemanagement.md)。
| 错误码ID | 错误信息 |
| -------- | ---------------------------------------- |
| 202 | Called by non-system application. |
| 401 | Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types; 3. Parameter verification failed. |
| 13900012 | Permission denied. |
| 13900020 | Invalid argument. |
| 14000011 | System inner fail. |
**示例：**
```ts
import { dataSharePredicates } from '@kit.ArkData';
async function example() {
console.info('setHiddenDemo');
let predicates: dataSharePredicates.DataSharePredicates = new dataSharePredicates.DataSharePredicates();
let fetchOption: photoAccessHelper.FetchOptions = {
fetchColumns: [],
predicates: predicates
};
let fetchResult: photoAccessHelper.FetchResult = await phAccessHelper.getAssets(fetchOption);
let asset = await fetchResult.getFirstObject();
asset.setHidden(true, (err) => {
if (err === undefined) {
console.info('setHidden successfully');
} else {
console.error(`setHidden failed with error: ${err.code}, ${err.message}`);
}
});
}
```
### setHidden(deprecated)
setHidden(hiddenState: boolean): Promise<void>
将文件设置为隐私文件，使用promise方式返回异步结果。
隐私文件存在隐私相册中，用户通过隐私相册去获取隐私文件后可以通过设置hiddenState为false来从隐私相册中移除。
> **说明：**
>
> 从API version 10开始支持，从API version 11开始废弃。建议使用[MediaAssetChangeRequest.setHidden](#sethidden11)替代。
**系统接口**：此接口为系统接口。
**需要权限**：ohos.permission.WRITE_IMAGEVIDEO
**系统能力**：SystemCapability.FileManagement.PhotoAccessHelper.Core
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| ---------- | ------- | ---- | ---------------------------------- |
| hiddenState | boolean | 是 | 是否设置为隐藏文件，true:将文件资产放入隐藏相册;false:从隐藏相册中恢复。 |
**返回值：**
| 类型 | 说明 |
| ------------------- | ---------- |
| Promise<void> | Promise对象，返回void。 |
**错误码：**
接口抛出错误码的详细介绍请参见[通用错误码](../errorcode-universal.md)和[文件管理错误码](../apis-core-file-kit/errorcode-filemanagement.md)。
| 错误码ID | 错误信息 |
| -------- | ---------------------------------------- |
| 202 | Called by non-system application. |
| 401 | Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types; 3. Parameter verification failed. |
| 13900012 | Permission denied. |
| 13900020 | Invalid argument. |
| 14000011 | System inner fail. |
**示例：**
```ts
import { dataSharePredicates } from '@kit.ArkData';
import { BusinessError } from '@kit.BasicServicesKit';
async function example() {
// 示例代码为将文件从隐藏相册中恢复，需要先在隐藏相册预置资源
console.info('setHiddenDemo');
let predicates: dataSharePredicates.DataSharePredicates = new dataSharePredicates.DataSharePredicates();
let fetchOption: photoAccessHelper.FetchOptions = {
fetchColumns: [],
predicates: predicates
};
let albumList: photoAccessHelper.FetchResult = await phAccessHelper.getAlbums(photoAccessHelper.AlbumType.SYSTEM, photoAccessHelper.AlbumSubtype.HIDDEN);
let album = await albumList.getFirstObject();
let fetchResult: photoAccessHelper.FetchResult = await album.getAssets(fetchOption);
let asset = await fetchResult.getFirstObject();
asset.setHidden(false).then(() => {
console.info('setHidden successfully');
}).catch((err: BusinessError) => {
console.error(`setHidden failed with error: ${err.code}, ${err.message}`);
});
}
```
### getExif
getExif(): Promise<string>
返回jpg格式图片Exif标签组成的json格式的字符串，该方法使用Promise方式返回结果。
此接口中获取的Exif标签信息是由[image](../apis-image-kit/js-apis-image.md)模块提供。Exif标签详细信息请参考[image.PropertyKey](../apis-image-kit/js-apis-image.md#propertykey7)。
**注意**：此接口返回的是Exif标签组成的json格式的字符串，完整Exif信息由all_exif与[PhotoKeys.USER_COMMENT](#photokeys)组成，fetchColumns需要传入这两个字段。
**系统接口**：此接口为系统接口。
**需要权限**：ohos.permission.READ_IMAGEVIDEO
**系统能力**：SystemCapability.FileManagement.PhotoAccessHelper.Core
**返回值：**
| 类型 | 说明 |
| --------------------------------------- | ----------------- |
| Promise<string> | 返回Exif标签组成的json格式的字符串。 |
**错误码：**
接口抛出错误码的详细介绍请参见[通用错误码](../errorcode-universal.md)和[文件管理错误码](../apis-core-file-kit/errorcode-filemanagement.md)。
| 错误码ID | 错误信息 |
| -------- | ---------------------------------------- |
| 202 | Called by non-system application. |
| 401 | Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types. |
| 13900012 | Permission denied. |
| 13900020 | Invalid argument. |
| 14000011 | System inner fail. |
**示例：**
```ts
import { dataSharePredicates } from '@kit.ArkData';
async function example() {
try {
console.info('getExifDemo');
let predicates: dataSharePredicates.DataSharePredicates = new dataSharePredicates.DataSharePredicates();
let fetchOptions: photoAccessHelper.FetchOptions = {
fetchColumns: [ 'all_exif', photoAccessHelper.PhotoKeys.USER_COMMENT],
predicates: predicates
};
let fetchResult: photoAccessHelper.FetchResult = await phAccessHelper.getAssets(fetchOptions);
let photoAsset: photoAccessHelper.PhotoAsset = await fetchResult.getFirstObject();
let exifMessage = await photoAsset.getExif();
let userCommentKey = 'UserComment';
let userComment = JSON.stringify(JSON.parse(exifMessage), [userCommentKey]);
console.info('getExifDemo userComment: ' + JSON.stringify(userComment));
fetchResult.close();
} catch (err) {
console.error(`getExifDemoCallback failed with error: ${err.code}, ${err.message}`);
}
}
```
### getExif
getExif(callback: AsyncCallback<string>): void
返回jpg格式图片Exif标签组成的json格式的字符串，使用callback方式返回异步结果。
此接口中获取的Exif标签信息是由[image](../apis-image-kit/js-apis-image.md)模块提供。Exif标签详细信息请参考[image.PropertyKey](../apis-image-kit/js-apis-image.md#propertykey7)。
**注意**：此接口返回的是Exif标签组成的json格式的字符串，完整Exif信息由all_exif与[PhotoKeys.USER_COMMENT](#photokeys)组成，fetchColumns需要传入这两个字段。
**系统接口**：此接口为系统接口。
**需要权限**：ohos.permission.READ_IMAGEVIDEO
**系统能力**：SystemCapability.FileManagement.PhotoAccessHelper.Core
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ------------------------- | ---- | ---------- |
| callback | AsyncCallback<string> | 是 | 返回Exif字段组成的json格式的字符串。 |
**错误码：**
接口抛出错误码的详细介绍请参见[通用错误码](../errorcode-universal.md)和[文件管理错误码](../apis-core-file-kit/errorcode-filemanagement.md)。
| 错误码ID | 错误信息 |
| -------- | ---------------------------------------- |
| 202 | Called by non-system application. |
| 401 | Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types. |
| 13900012 | Permission denied. |
| 13900020 | Invalid argument. |
| 14000011 | System inner fail. |
**示例：**
```ts
import { dataSharePredicates } from '@kit.ArkData';
async function example() {
try {
console.info('getExifDemo');
let predicates: dataSharePredicates.DataSharePredicates = new dataSharePredicates.DataSharePredicates();
predicates.isNotNull('all_exif')
let fetchOptions: photoAccessHelper.FetchOptions = {
fetchColumns: ['all_exif', photoAccessHelper.PhotoKeys.USER_COMMENT],
predicates: predicates
};
let fetchResult: photoAccessHelper.FetchResult = await phAccessHelper.getAssets(fetchOptions);
let photoAsset: photoAccessHelper.PhotoAsset = await fetchResult.getFirstObject();
console.info('getExifDemo photoAsset displayName: ' + JSON.stringify(photoAsset.displayName));
let userCommentKey = 'UserComment';
photoAsset.getExif((err, exifMessage) => {
if (exifMessage !== undefined) {
let userComment = JSON.stringify(JSON.parse(exifMessage), [userCommentKey]);
console.info('getExifDemo userComment: ' + JSON.stringify(userComment));
} else {
console.error(`getExif failed, error: ${err.code}, ${err.message}`);
}
});
fetchResult.close();
} catch (err) {
console.error(`getExifDemoCallback failed with error: ${err.code}, ${err.message}`);
}
}
```
### setUserComment(deprecated)
setUserComment(userComment: string): Promise<void>
修改图片或者视频的备注信息，该方法使用Promise来返回结果。
> **说明：**
>
> 从API version 10开始支持，从API version 11开始废弃。建议使用[MediaAssetChangeRequest.setUserComment](#setusercomment11)替代。
**注意**：此接口只可修改图片或者视频的备注信息。
**系统接口**：此接口为系统接口。
**需要权限**：ohos.permission.WRITE_IMAGEVIDEO
**系统能力**：SystemCapability.FileManagement.PhotoAccessHelper.Core
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ------------------------- | ---- | ---------- |
| userComment | string | 是 | 待修改的图片或视频的备注信息，备注信息最长为420字符。 |
**返回值：**
| 类型 | 说明 |
| --------------------------------------- | ----------------- |
|Promise<void> | Promise对象，返回void。 |
**错误码：**
接口抛出错误码的详细介绍请参见[通用错误码](../errorcode-universal.md)和[文件管理错误码](../apis-core-file-kit/errorcode-filemanagement.md)。
| 错误码ID | 错误信息 |
| -------- | ---------------------------------------- |
| 202 | Called by non-system application. |
| 401 | Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types; 3. Parameter verification failed. |
| 13900012 | Permission denied. |
| 13900020 | Invalid argument. |
| 14000011 | System inner fail. |
**示例：**
```ts
import { dataSharePredicates } from '@kit.ArkData';
async function example() {
try {
console.info('setUserCommentDemo')
let predicates: dataSharePredicates.DataSharePredicates = new dataSharePredicates.DataSharePredicates();
let fetchOptions: photoAccessHelper.FetchOptions = {
fetchColumns: [],
predicates: predicates
};
let fetchResult: photoAccessHelper.FetchResult = await phAccessHelper.getAssets(fetchOptions);
let photoAsset: photoAccessHelper.PhotoAsset = await fetchResult.getFirstObject();
let userComment = 'test_set_user_comment';
await photoAsset.setUserComment(userComment);
} catch (err) {
console.error(`setUserCommentDemoPromise failed with error: ${err.code}, ${err.message}`);
}
}
```
### setUserComment(deprecated)
setUserComment(userComment: string, callback: AsyncCallback<void>): void
修改图片或者视频的备注信息，该方法使用callback形式来返回结果。
> **说明：**
>
> 从API version 10开始支持，从API version 11开始废弃。建议使用[MediaAssetChangeRequest.setUserComment](#setusercomment11)替代。
**注意**：此接口只可修改图片或者视频的备注信息。
**系统接口**：此接口为系统接口。
**需要权限**：ohos.permission.WRITE_IMAGEVIDEO
**系统能力**：SystemCapability.FileManagement.PhotoAccessHelper.Core
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ------------------------- | ---- | ---------- |
| userComment | string | 是 | 待修改的图片或视频的备注信息，备注信息最长为420字符。 |
| callback | AsyncCallback<void> | 是 | callback返回void。 |
**错误码：**
接口抛出错误码的详细介绍请参见[通用错误码](../errorcode-universal.md)和[文件管理错误码](../apis-core-file-kit/errorcode-filemanagement.md)。
| 错误码ID | 错误信息 |
| -------- | ---------------------------------------- |
| 202 | Called by non-system application. |
| 401 | Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types; 3. Parameter verification failed. |
| 13900012 | Permission denied. |
| 13900020 | Invalid argument. |
| 14000011 | System inner fail. |
**示例：**
```ts
import { dataSharePredicates } from '@kit.ArkData';
async function example() {
try {
console.info('setUserCommentDemo')
let predicates: dataSharePredicates.DataSharePredicates = new dataSharePredicates.DataSharePredicates();
let fetchOptions: photoAccessHelper.FetchOptions = {
fetchColumns: [],
predicates: predicates
};
let fetchResult: photoAccessHelper.FetchResult = await phAccessHelper.getAssets(fetchOptions);
let photoAsset: photoAccessHelper.PhotoAsset = await fetchResult.getFirstObject();
let userComment = 'test_set_user_comment';
photoAsset.setUserComment(userComment, (err) => {
if (err === undefined) {
console.info('setUserComment successfully');
} else {
console.error(`setUserComment failed with error: ${err.code}, ${err.message}`);
}
});
} catch (err) {
console.error(`setUserCommentDemoCallback failed with error: ${err.code}, ${err.message}`);
}
}
```
### setPending11+
setPending(pendingState: boolean, callback: AsyncCallback<void>): void
为图片或视频资源设置pending状态，该方法使用callback形式来返回结果。
将文件通过`setPending(true)`设置为pending状态后，只能通过`setPending(false)`解除pending状态。可以通过`photoAsset.get(photoAccessHelper.PhotoKeys.PENDING)`的方式获取是否为pending状态，pending状态下返回true，否则返回false。
**注意**：setPending只能在文件的创建期使用，在文件的首次创建流程的close之后，无法通过setPending(true)将文件设置为pending状态。
**系统接口**：此接口为系统接口。
**需要权限**：ohos.permission.WRITE_IMAGEVIDEO
**系统能力**：SystemCapability.FileManagement.PhotoAccessHelper.Core
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| ---------- | ------- | ---- | ---------------------------------- |
| pendingState | boolean | 是 | 设置的pending状态，true为设置pending状态，false为解除pending状态 |
| callback | AsyncCallback<void> | 是 | Callback对象，返回void |
**错误码：**
接口抛出错误码的详细介绍请参见[通用错误码](../errorcode-universal.md)和[文件管理错误码](../apis-core-file-kit/errorcode-filemanagement.md)。
| 错误码ID | 错误信息 |
| -------- | ---------------------------------------- |
| 201 | Permission denied. |
| 202 | Called by non-system application. |
| 401 | Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types; 3. Parameter verification failed. |
| 14000011 | System inner fail. |
**示例：**
```ts
async function example() {
try {
console.info('setPendingCallbackDemo');
let testFileName: string = 'testFile' + Date.now() + '.jpg';
let photoAsset = await phAccessHelper.createAsset(testFileName);
let fd = await photoAsset.open('rw');
photoAsset.setPending(true, async (err) => {
if (err !== undefined) {
console.error(`setPending(true) failed with error: ${err.code}, ${err.message}`);
return;
}
// write photo buffer in fd
photoAsset.setPending(false, async (err) => {
if (err !== undefined) {
console.error(`setPending(false) failed with error: ${err.code}, ${err.message}`);
return;
}
await photoAsset.close(fd);
});
});
} catch (err) {
console.error(`setPendingCallbackDemo failed with error: ${err.code}, ${err.message}`);
}
}
```
### setPending11+
setPending(pendingState: boolean): Promise<void>
为图片或视频资源设置pending状态，该方法使用promise形式来返回结果。
将文件通过`setPending(true)`设置为pending状态后，只能通过`setPending(false)`解除pending状态。可以通过`photoAsset.get(photoAccessHelper.PhotoKeys.PENDING)`的方式获取是否为pending状态，pending状态下返回true，否则返回false。
**注意**：setPending只能在文件的创建期使用，在文件的首次创建流程的close之后，无法通过setPending(true)将文件设置为pending状态。
**系统接口**：此接口为系统接口。
**需要权限**：ohos.permission.WRITE_IMAGEVIDEO
**系统能力**：SystemCapability.FileManagement.PhotoAccessHelper.Core
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| ---------- | ------- | ---- | ---------------------------------- |
| pendingState | boolean | 是 | 设置的pending状态，true为设置pending状态，false为解除pending状态。 |
**返回值：**
| 类型 | 说明 |
| --------------------------------------- | ----------------- |
|Promise<boolean> | Promise对象，返回void。 |
**错误码：**
接口抛出错误码的详细介绍请参见[通用错误码](../errorcode-universal.md)和[文件管理错误码](../apis-core-file-kit/errorcode-filemanagement.md)。
| 错误码ID | 错误信息 |
| -------- | ---------------------------------------- |
| 201 | Permission denied. |
| 202 | Called by non-system application. |
| 401 | Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types; 3. Parameter verification failed. |
| 14000011 | System inner fail. |
**示例：**
```ts
async function example() {
try {
console.info('setPendingPromiseDemo');
let testFileName: string = 'testFile' + Date.now() + '.jpg';
let photoAsset = await phAccessHelper.createAsset(testFileName);
let fd = await photoAsset.open('rw');
await photoAsset.setPending(true);
// write photo buffer in fd
photoAsset.setPending(false);
await photoAsset.close(fd);
} catch (err) {
console.error(`setPendingPromiseDemo failed with error: ${err.code}, ${err.message}`);
}
}
```
### isEdited11+
isEdited(callback: AsyncCallback<boolean>): void
查询图片或视频资源是否被编辑过，该方法使用callback形式来返回结果。
**系统接口**：此接口为系统接口。
**需要权限**：ohos.permission.READ_IMAGEVIDEO
**系统能力**：SystemCapability.FileManagement.PhotoAccessHelper.Core
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| ---------- | ------- | ---- | ---------------------------------- |
| callback | AsyncCallback<boolean> | 是 | Callback对象，返回图片或视频资源是否被编辑过 |
**错误码：**
接口抛出错误码的详细介绍请参见[通用错误码](../errorcode-universal.md)和[文件管理错误码](../apis-core-file-kit/errorcode-filemanagement.md)。
| 错误码ID | 错误信息 |
| -------- | ---------------------------------------- |
| 201 | Permission denied. |
| 202 | Called by non-system application. |
| 401 | Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types. |
| 14000011 | System inner fail. |
**示例：**
```ts
import { dataSharePredicates } from '@kit.ArkData';
async function example() {
try {
console.info('isEditedCallbackDemo')
let predicates: dataSharePredicates.DataSharePredicates = new dataSharePredicates.DataSharePredicates();
let fetchOptions: photoAccessHelper.FetchOptions = {
fetchColumns: [],
predicates: predicates
};
let fetchResult: photoAccessHelper.FetchResult = await phAccessHelper.getAssets(fetchOptions);
let photoAsset: photoAccessHelper.PhotoAsset = await fetchResult.getFirstObject();
photoAsset.isEdited((err, isEdited) => {
if (err === undefined) {
if (isEdited === true) {
console.info('Photo is edited');
} else {
console.info('Photo is not edited');
}
} else {
console.error(`isEdited failed with error: ${err.code}, ${err.message}`);
}
});
} catch (err) {
console.error(`isEditedDemoCallback failed with error: ${err.code}, ${err.message}`);
}
}
```
### isEdited11+
isEdited(): Promise<boolean>
查询图片或视频资源是否被编辑过，该方法使用promise形式来返回结果。
**系统接口**：此接口为系统接口。
**需要权限**：ohos.permission.READ_IMAGEVIDEO
**系统能力**：SystemCapability.FileManagement.PhotoAccessHelper.Core
**返回值：**
| 类型 | 说明 |
| --------------------------------------- | ----------------- |
|Promise<boolean> | Promise对象，返回图片或视频资源是否被编辑过。 |
**错误码：**
接口抛出错误码的详细介绍请参见[通用错误码](../errorcode-universal.md)和[文件管理错误码](../apis-core-file-kit/errorcode-filemanagement.md)。
| 错误码ID | 错误信息 |
| -------- | ---------------------------------------- |
| 201 | Permission denied. |
| 202 | Called by non-system application. |
| 401 | Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types. |
| 14000011 | System inner fail. |
**示例：**
```ts
import { dataSharePredicates } from '@kit.ArkData';
async function example() {
try {
console.info('isEditedPromiseDemo')
let predicates: dataSharePredicates.DataSharePredicates = new dataSharePredicates.DataSharePredicates();
let fetchOptions: photoAccessHelper.FetchOptions = {
fetchColumns: [],
predicates: predicates
};
let fetchResult: photoAccessHelper.FetchResult = await phAccessHelper.getAssets(fetchOptions);
let photoAsset: photoAccessHelper.PhotoAsset = await fetchResult.getFirstObject();
let isEdited = await photoAsset.isEdited();
if (isEdited === true) {
console.info('Photo is edited');
} else {
console.info('Photo is not edited');
}
} catch (err) {
console.error(`isEditedDemoCallback failed with error: ${err.code}, ${err.message}`);
}
}
```
### requestEditData11+
requestEditData(callback: AsyncCallback<string>): void
获得图片或视频资源的编辑数据，该方法使用callback形式来返回结果。
如果资源未编辑过，则返回一个空字符串。
**系统接口**：此接口为系统接口。
**需要权限**：ohos.permission.READ_IMAGEVIDEO
**系统能力**：SystemCapability.FileManagement.PhotoAccessHelper.Core
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| ---------- | ------- | ---- | ---------------------------------- |
| callback | AsyncCallback<string> | 是 | Callback对象，返回图片或视频资源的编辑数据 |
**错误码：**
接口抛出错误码的详细介绍请参见[通用错误码](../errorcode-universal.md)和[文件管理错误码](../apis-core-file-kit/errorcode-filemanagement.md)。
| 错误码ID | 错误信息 |
| -------- | ---------------------------------------- |
| 201 | Permission denied. |
| 202 | Called by non-system application. |
| 401 | Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types. |
| 14000011 | System inner fail. |
**示例：**
```ts
import { dataSharePredicates } from '@kit.ArkData';
async function example() {
try {
console.info('requestEditDataCallbackDemo')
let predicates: dataSharePredicates.DataSharePredicates = new dataSharePredicates.DataSharePredicates();
let fetchOptions: photoAccessHelper.FetchOptions = {
fetchColumns: [],
predicates: predicates
};
let fetchResult: photoAccessHelper.FetchResult = await phAccessHelper.getAssets(fetchOptions);
let photoAsset: photoAccessHelper.PhotoAsset = await fetchResult.getFirstObject();
photoAsset.requestEditData((err, editdata) => {
if (err === undefined) {
console.info('Editdata is ' + editdata);
} else {
console.error(`requestEditData failed with error: ${err.code}, ${err.message}`);
}
});
} catch (err) {
console.error(`requestEditDataCallbackDemo failed with error: ${err.code}, ${err.message}`);
}
}
```
### requestEditData11+
requestEditData(): Promise<string>
获得图片或视频资源的编辑数据，该方法使用promise形式来返回结果。
如果资源未编辑过，则返回一个空字符串。
**系统接口**：此接口为系统接口。
**需要权限**：ohos.permission.READ_IMAGEVIDEO
**系统能力**：SystemCapability.FileManagement.PhotoAccessHelper.Core
**返回值：**
| 类型 | 说明 |
| --------------------------------------- | ----------------- |
|Promise<string> | Promise对象，返回图片或视频资源的编辑数据。 |
**错误码：**
接口抛出错误码的详细介绍请参见[通用错误码](../errorcode-universal.md)和[文件管理错误码](../apis-core-file-kit/errorcode-filemanagement.md)。
| 错误码ID | 错误信息 |
| -------- | ---------------------------------------- |
| 201 | Permission denied. |
| 202 | Called by non-system application. |
| 401 | Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types. |
| 14000011 | System inner fail. |
**示例：**
```ts
import { dataSharePredicates } from '@kit.ArkData';
async function example() {
try {
console.info('requestEditDataPromiseDemo')
let predicates: dataSharePredicates.DataSharePredicates = new dataSharePredicates.DataSharePredicates();
let fetchOptions: photoAccessHelper.FetchOptions = {
fetchColumns: [],
predicates: predicates
};
let fetchResult: photoAccessHelper.FetchResult = await phAccessHelper.getAssets(fetchOptions);
let photoAsset: photoAccessHelper.PhotoAsset = await fetchResult.getFirstObject();
let editdata: string = await photoAsset.requestEditData();
console.info('Editdata is ' + editdata);
} catch (err) {
console.error(`requestEditDataPromiseDemo failed with error: ${err.code}, ${err.message}`);
}
}
```
### getEditData11+
getEditData(): Promise<MediaAssetEditData>
获得资产编辑数据，该方法使用promise形式来返回结果。
如果资源未编辑过，则返回的编辑数据的内容为空字符串。
**系统接口**：此接口为系统接口。
**需要权限**：ohos.permission.READ_IMAGEVIDEO
**系统能力**：SystemCapability.FileManagement.PhotoAccessHelper.Core
**返回值：**
| 类型 | 说明 |
| --------------------------------------- | ----------------- |
|Promise<[MediaAssetEditData](#mediaasseteditdata11)> | Promise对象，返回资产编辑数据。 |
**错误码：**
接口抛出错误码的详细介绍请参见[通用错误码](../errorcode-universal.md)和[文件管理错误码](../apis-core-file-kit/errorcode-filemanagement.md)。
| 错误码ID | 错误信息 |
| -------- | ---------------------------------------- |
| 201 | Permission denied. |
| 202 | Called by non-system application. |
| 401 | Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types. |
| 14000011 | System inner fail. |
**示例：**
```ts
import { dataSharePredicates } from '@kit.ArkData';
async function example() {
try {
console.info('getEditDataDemo')
let predicates: dataSharePredicates.DataSharePredicates = new dataSharePredicates.DataSharePredicates();
let fetchOptions: photoAccessHelper.FetchOptions = {
fetchColumns: [],
predicates: predicates
};
let fetchResult: photoAccessHelper.FetchResult = await phAccessHelper.getAssets(fetchOptions);
let photoAsset: photoAccessHelper.PhotoAsset = await fetchResult.getFirstObject();
let assetEditData: photoAccessHelper.MediaAssetEditData = await photoAsset.getEditData();
let data: string = assetEditData.data;
console.info('edit data is ' + data);
} catch (err) {
console.error(`getEditDataDemo failed with error: ${err.code}, ${err.message}`);
}
}
```
### requestSource11+
requestSource(callback: AsyncCallback<number>): void
打开源文件并返回fd，该方法使用callback形式来返回结果。
**系统接口**：此接口为系统接口。
**需要权限**：ohos.permission.READ_IMAGEVIDEO
**系统能力**：SystemCapability.FileManagement.PhotoAccessHelper.Core
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| ---------- | ------- | ---- | ---------------------------------- |
| callback | AsyncCallback<number> | 是 | Callback对象，返回源文件fd。 |
**错误码：**
接口抛出错误码的详细介绍请参见[通用错误码](../errorcode-universal.md)和[文件管理错误码](../apis-core-file-kit/errorcode-filemanagement.md)。
| 错误码ID | 错误信息 |
| -------- | ---------------------------------------- |
| 201 | Permission denied. |
| 202 | Called by non-system application. |
| 401 | Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types. |
| 14000011 | System inner fail. |
**示例：**
```ts
import { dataSharePredicates } from '@kit.ArkData';
async function example() {
try {
console.info('requsetSourceCallbackDemo')
let predicates: dataSharePredicates.DataSharePredicates = new dataSharePredicates.DataSharePredicates();
let fetchOptions: photoAccessHelper.FetchOptions = {
fetchColumns: [],
predicates: predicates
};
let fetchResult: photoAccessHelper.FetchResult = await phAccessHelper.getAssets(fetchOptions);
let photoAsset: photoAccessHelper.PhotoAsset = await fetchResult.getFirstObject();
photoAsset.requestSource((err, fd) => {
if (err === undefined) {
console.info('Source fd is ' + fd);
} else {
console.error(`requestSource failed with error: ${err.code}, ${err.message}`);
}
});
} catch (err) {
console.error(`requsetSourceCallbackDemo failed with error: ${err.code}, ${err.message}`);
}
}
```
### requestSource11+
requestSource(): Promise<number>
打开源文件并返回fd，该方法使用promise形式来返回结果。
**系统接口**：此接口为系统接口。
**需要权限**：ohos.permission.READ_IMAGEVIDEO
**系统能力**：SystemCapability.FileManagement.PhotoAccessHelper.Core
**返回值：**
| 类型 | 说明 |
| --------------------------------------- | ----------------- |
|Promise<number> | Promise对象，返回源文件fd。 |
**错误码：**
接口抛出错误码的详细介绍请参见[通用错误码](../errorcode-universal.md)和[文件管理错误码](../apis-core-file-kit/errorcode-filemanagement.md)。
| 错误码ID | 错误信息 |
| -------- | ---------------------------------------- |
| 201 | Permission denied. |
| 202 | Called by non-system application. |
| 401 | Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types. |
| 14000011 | System inner fail. |
**示例：**
```ts
import { dataSharePredicates } from '@kit.ArkData';
async function example() {
try {
console.info('requsetSourcePromiseDemo')
let predicates: dataSharePredicates.DataSharePredicates = new dataSharePredicates.DataSharePredicates();
let fetchOptions: photoAccessHelper.FetchOptions = {
fetchColumns: [],
predicates: predicates
};
let fetchResult: photoAccessHelper.FetchResult = await phAccessHelper.getAssets(fetchOptions);
let photoAsset: photoAccessHelper.PhotoAsset = await fetchResult.getFirstObject();
let fd = await photoAsset.requestSource();
console.info('Source fd is ' + fd);
} catch (err) {
console.error(`requsetSourcePromiseDemo failed with error: ${err.code}, ${err.message}`);
}
}
```
### commitEditedAsset11+
commitEditedAsset(editData: string, uri: string, callback: AsyncCallback<void>)
提交编辑数据以及编辑后的图片或视频，该方法使用callback形式来返回结果。
通过uri将编辑后的文件传递给媒体库，uri是编辑后的文件在应用沙箱下的FileUri，可参考[FileUri](../apis-core-file-kit/js-apis-file-fileuri.md)。
**注意**：新的编辑数据提交后，将覆盖掉原来的编辑数据。
**系统接口**：此接口为系统接口。
**需要权限**：ohos.permission.WRITE_IMAGEVIDEO
**系统能力**：SystemCapability.FileManagement.PhotoAccessHelper.Core
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| ---------- | ------- | ---- | ---------------------------------- |
| editData | string | 是 | 提交的编辑数据。 |
| uri | string | 是 | 提交的编辑后的图片或视频，在应用沙箱下的uri。 |
| callback | AsyncCallback<void> | 是 | Callback对象，返回void。 |
**错误码：**
接口抛出错误码的详细介绍请参见[通用错误码](../errorcode-universal.md)和[文件管理错误码](../apis-core-file-kit/errorcode-filemanagement.md)。
| 错误码ID | 错误信息 |
| -------- | ---------------------------------------- |
| 201 | Permission denied. |
| 202 | Called by non-system application. |
| 401 | Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types; 3. Parameter verification failed. |
| 14000011 | System inner fail. |
**示例：**
```ts
import { dataSharePredicates } from '@kit.ArkData';
async function example() {
try {
console.info('commitEditedAssetCallbackDemo')
let predicates: dataSharePredicates.DataSharePredicates = new dataSharePredicates.DataSharePredicates();
let fetchOptions: photoAccessHelper.FetchOptions = {
fetchColumns: [],
predicates: predicates
};
let fetchResult: photoAccessHelper.FetchResult = await phAccessHelper.getAssets(fetchOptions);
let photoAsset: photoAccessHelper.PhotoAsset = await fetchResult.getFirstObject();
let editData = '123456';
let uri = 'file://com.example.temptest/data/storage/el2/base/haps/entry/files/test.jpg';
photoAsset.commitEditedAsset(editData, uri, (err) => {
if (err === undefined) {
console.info('commitEditedAsset is successful');
} else {
console.error(`commitEditedAsset failed with error: ${err.code}, ${err.message}`);
}
});
} catch (err) {
console.error(`commitEditedAssetCallbackDemo failed with error: ${err.code}, ${err.message}`);
}
}
```
### commitEditedAsset11+
commitEditedAsset(editData: string, uri: string): Promise<void>
提交编辑数据以及编辑后的图片或视频，该方法使用promise形式来返回结果。
通过uri将编辑后的文件传递给媒体库，uri是编辑后的文件在应用沙箱下的FileUri，可参考[FileUri](../apis-core-file-kit/js-apis-file-fileuri.md)。
**注意**：新的编辑数据提交后，将覆盖掉原来的编辑数据。
**系统接口**：此接口为系统接口。
**需要权限**：ohos.permission.WRITE_IMAGEVIDEO
**系统能力**：SystemCapability.FileManagement.PhotoAccessHelper.Core
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| ---------- | ------- | ---- | ---------------------------------- |
| editData | string | 是 | 提交的编辑数据。 |
| uri | string | 是 | 提交的编辑后的图片或视频，在应用沙箱下的uri。 |
**返回值：**
| 类型 | 说明 |
| --------------------------------------- | ----------------- |
|Promise<void> | Promise对象，返回void。 |
**错误码：**
接口抛出错误码的详细介绍请参见[通用错误码](../errorcode-universal.md)和[文件管理错误码](../apis-core-file-kit/errorcode-filemanagement.md)。
| 错误码ID | 错误信息 |
| -------- | ---------------------------------------- |
| 201 | Permission denied. |
| 202 | Called by non-system application. |
| 401 | Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types; 3. Parameter verification failed. |
| 14000011 | System inner fail. |
**示例：**
```ts
import { dataSharePredicates } from '@kit.ArkData';
async function example() {
try {
console.info('commitEditedAssetPromiseDemo')
let predicates: dataSharePredicates.DataSharePredicates = new dataSharePredicates.DataSharePredicates();
let fetchOptions: photoAccessHelper.FetchOptions = {
fetchColumns: [],
predicates: predicates
};
let fetchResult: photoAccessHelper.FetchResult = await phAccessHelper.getAssets(fetchOptions);
let photoAsset: photoAccessHelper.PhotoAsset = await fetchResult.getFirstObject();
let editData = '123456';
let uri = 'file://com.example.temptest/data/storage/el2/base/haps/entry/files/test.jpg';
await photoAsset.commitEditedAsset(editData, uri);
console.info('commitEditedAsset is successful');
} catch (err) {
console.error(`commitEditedAssetPromiseDemo failed with error: ${err.code}, ${err.message}`);
}
}
```
### revertToOriginal11+
revertToOriginal(callback: AsyncCallback<void>)
回退到编辑前的状态，该方法使用callback形式来返回结果。
**注意**：调用该接口后，编辑数据和编辑后的图片或视频资源都将被删除，无法恢复，请谨慎调用。
**系统接口**：此接口为系统接口。
**需要权限**：ohos.permission.WRITE_IMAGEVIDEO
**系统能力**：SystemCapability.FileManagement.PhotoAccessHelper.Core
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| ---------- | ------- | ---- | ---------------------------------- |
| callback | AsyncCallback<void> | 是 | Callback对象，返回void。 |
**错误码：**
接口抛出错误码的详细介绍请参见[通用错误码](../errorcode-universal.md)和[文件管理错误码](../apis-core-file-kit/errorcode-filemanagement.md)。
| 错误码ID | 错误信息 |
| -------- | ---------------------------------------- |
| 201 | Permission denied. |
| 202 | Called by non-system application. |
| 401 | Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types. |
| 14000011 | System inner fail. |
**示例：**
```ts
import { dataSharePredicates } from '@kit.ArkData';
async function example() {
try {
console.info('revertToOriginalCallbackDemo')
let predicates: dataSharePredicates.DataSharePredicates = new dataSharePredicates.DataSharePredicates();
let fetchOptions: photoAccessHelper.FetchOptions = {
fetchColumns: [],
predicates: predicates
};
let fetchResult: photoAccessHelper.FetchResult = await phAccessHelper.getAssets(fetchOptions);
let photoAsset: photoAccessHelper.PhotoAsset = await fetchResult.getFirstObject();
photoAsset.revertToOriginal((err) => {
if (err === undefined) {
console.info('revertToOriginal is successful');
} else {
console.error(`revertToOriginal failed with error: ${err.code}, ${err.message}`);
}
});
} catch (err) {
console.error(`revertToOriginalCallbackDemo failed with error: ${err.code}, ${err.message}`);
}
}
```
### revertToOriginal11+
revertToOriginal(): Promise<void>
回退到编辑前的状态，该方法使用promise形式来返回结果。
**注意**：调用该接口后，编辑数据和编辑后的图片或视频资源都将被删除，无法恢复，请谨慎调用。
**系统接口**：此接口为系统接口。
**需要权限**：ohos.permission.WRITE_IMAGEVIDEO
**系统能力**：SystemCapability.FileManagement.PhotoAccessHelper.Core
**返回值：**
| 类型 | 说明 |
| --------------------------------------- | ----------------- |
|Promise<string> | Promise对象，返回void。 |
**错误码：**
接口抛出错误码的详细介绍请参见[通用错误码](../errorcode-universal.md)和[文件管理错误码](../apis-core-file-kit/errorcode-filemanagement.md)。
| 错误码ID | 错误信息 |
| -------- | ---------------------------------------- |
| 201 | Permission denied. |
| 202 | Called by non-system application. |
| 401 | Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types. |
| 14000011 | System inner fail. |
**示例：**
```ts
import { dataSharePredicates } from '@kit.ArkData';
async function example() {
try {
console.info('revertToOriginalPromiseDemo')
let predicates: dataSharePredicates.DataSharePredicates = new dataSharePredicates.DataSharePredicates();
let fetchOptions: photoAccessHelper.FetchOptions = {
fetchColumns: [],
predicates: predicates
};
let fetchResult: photoAccessHelper.FetchResult = await phAccessHelper.getAssets(fetchOptions);
let photoAsset: photoAccessHelper.PhotoAsset = await fetchResult.getFirstObject();
photoAsset.revertToOriginal();
console.info('revertToOriginal is successful');
} catch (err) {
console.error(`revertToOriginalPromiseDemo failed with error: ${err.code}, ${err.message}`);
}
}
```
### requestPhoto11+
requestPhoto(callback: AsyncCallback<image.PixelMap>): string
通过callback的形式，获取资源的快速缩略图和普通缩略图。
快速缩略图尺寸为128\*128，普通缩略图尺寸为256\*256。应用调用接口后，callback将返回两次缩略图对象，第一次为快速缩略图，第二次为普通缩略图。
**系统接口**：此接口为系统接口。
**需要权限**：ohos.permission.READ_IMAGEVIDEO
**系统能力**：SystemCapability.FileManagement.PhotoAccessHelper.Core
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| ---------- | ------- | ---- | ---------------------------------- |
| callback | AsyncCallback<[image.PixelMap](../apis-image-kit/js-apis-image.md#pixelmap7)> | 是 | Callback对象，返回获取的缩略图，调用2次。 |
**返回值：**
| 类型 | 说明 |
| --------------------------------------- | ----------------- |
| string | 本次获取任务的id。 |
**错误码：**
接口抛出错误码的详细介绍请参见[通用错误码](../errorcode-universal.md)和[文件管理错误码](../apis-core-file-kit/errorcode-filemanagement.md)。
| 错误码ID | 错误信息 |
| -------- | ---------------------------------------- |
| 201 | Permission verification failed, usually the result returned by VerifyAccessToken. |
| 202 | Permission verification failed, application which is not a system application uses system API. |
| 401 | Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types. |
| 14000011 | System inner fail. |
**示例：**
```ts
import { dataSharePredicates } from '@kit.ArkData';
import { image } from '@kit.ImageKit';
async function example() {
try {
console.info('requestPhotoDemo')
let options: photoAccessHelper.FetchOptions = {
fetchColumns: [],
predicates: new dataSharePredicates.DataSharePredicates()
}
let fetchResult = await phAccessHelper.getAssets(options);
let photoAsset = await fetchResult.getFirstObject();
let taskId: string = photoAsset.requestPhoto(async (err, pixel: image.PixelMap) => {
if (err === undefined) {
console.info("requestSource in, size: " + JSON.stringify((await pixel.getImageInfo()).size))
} else {
console.error(`requestSource failed with error: ${err.code}, ${err.message}`);
}
})
console.info('requestSource taskId: ' + taskId)
} catch (err) {
console.error(`requestPhotoDemo failed with error: ${err.code}, ${err.message}`);
}
}
```
### requestPhoto11+
requestPhoto(options: RequestPhotoOptions, callback: AsyncCallback<image.PixelMap>): string
通过callback的形式，根据传入的选项，获取资源的缩略图。
**系统接口**：此接口为系统接口。
**需要权限**：ohos.permission.READ_IMAGEVIDEO
**系统能力**：SystemCapability.FileManagement.PhotoAccessHelper.Core
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| ---------- | ------- | ---- | ---------------------------------- |
| options | [RequestPhotoOptions](#requestphotooptions11) | 是 | 获取资源缩略图的选项。 |
| callback | AsyncCallback<[image.PixelMap](../apis-image-kit/js-apis-image.md#pixelmap7)> | 是 | Callback对象，返回获取的缩略图，根据选项的设置可能调用超过1次。 |
**返回值：**
| 类型 | 说明 |
| --------------------------------------- | ----------------- |
| string | 本次获取任务的id。 |
**错误码：**
接口抛出错误码的详细介绍请参见[通用错误码](../errorcode-universal.md)和[文件管理错误码](../apis-core-file-kit/errorcode-filemanagement.md)。
| 错误码ID | 错误信息 |
| -------- | ---------------------------------------- |
| 201 | Permission verification failed, usually the result returned by VerifyAccessToken. |
| 202 | Permission verification failed, application which is not a system application uses system API. |
| 401 | Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types; 3. Parameter verification failed. |
| 14000011 | System inner fail. |
**示例：**
```ts
import { dataSharePredicates } from '@kit.ArkData';
import { image } from '@kit.ImageKit';
async function example() {
try {
console.info('requestPhotoDemo')
let options: photoAccessHelper.FetchOptions = {
fetchColumns: [],
predicates: new dataSharePredicates.DataSharePredicates()
}
let fetchResult = await phAccessHelper.getAssets(options);
let photoAsset = await fetchResult.getFirstObject();
let taskId: string = photoAsset.requestPhoto({
"size": {
"width": 256,
"height": 256
},
"requestPhotoType": photoAccessHelper.RequestPhotoType.REQUEST_ALL_THUMBNAILS
}, async (err, pixel: image.PixelMap) => {
if (err === undefined) {
console.info("requestSource in, size: " + JSON.stringify((await pixel.getImageInfo()).size))
} else {
console.error(`requestSource failed with error: ${err.code}, ${err.message}`);
}
})
console.info('requestSource taskId: ' + taskId)
} catch (err) {
console.error(`requestPhotoDemo failed with error: ${err.code}, ${err.message}`);
}
}
```
### cancelPhotoRequest11+
cancelPhotoRequest(requestId: string): void
根据id取消指定的获取媒体缩略图的任务。
**系统接口**：此接口为系统接口。
**需要权限**：ohos.permission.READ_IMAGEVIDEO
**系统能力**：SystemCapability.FileManagement.PhotoAccessHelper.Core
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| ---------- | ------- | ---- | ---------------------------------- |
| requestId | string | 是 | 待取消的获取媒体缩略图的任务id。 |
**错误码：**
接口抛出错误码的详细介绍请参见[通用错误码](../errorcode-universal.md)和[文件管理错误码](../apis-core-file-kit/errorcode-filemanagement.md)。
| 错误码ID | 错误信息 |
| -------- | ---------------------------------------- |
| 201 | Permission verification failed, usually the result returned by VerifyAccessToken. |
| 202 | Permission verification failed, application which is not a system application uses system API. |
| 401 | Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types; 3. Parameter verification failed. |
| 14000011 | System inner fail. |
**示例：**
```ts
import { dataSharePredicates } from '@kit.ArkData';
import { image } from '@kit.ImageKit';
async function example() {
try {
console.info('cancelPhotoRequestDemo')
let options: photoAccessHelper.FetchOptions = {
fetchColumns: [],
predicates: new dataSharePredicates.DataSharePredicates()
}
let fetchResult = await phAccessHelper.getAssets(options);
let photoAsset = await fetchResult.getFirstObject();
let taskId: string = photoAsset.requestPhoto({
"size": {
"width": 256,
"height": 256
},
"requestPhotoType": photoAccessHelper.RequestPhotoType.REQUEST_ALL_THUMBNAILS
}, async (err, pixel: image.PixelMap) => {
if (err === undefined) {
console.info("requestSource in, size: " + JSON.stringify((await pixel.getImageInfo()).size))
} else {
console.error(`requestSource failed with error: ${err.code}, ${err.message}`);
}
})
console.info('requestSource taskId: ' + taskId)
photoAsset.cancelPhotoRequest(taskId);
} catch (err) {
console.error(`cancelPhotoRequestDemo failed with error: ${err.code}, ${err.message}`);
}
}
```
### getAnalysisData11+
getAnalysisData(analysisType: AnalysisType): Promise\
根据智慧分析类型获取指定分析结果数据。
**系统接口**：此接口为系统接口。
**需要权限**：ohos.permission.READ\_IMAGEVIDEO
**系统能力**：SystemCapability.FileManagement.PhotoAccessHelper.Core
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| :----------- | :----------- | :- | :----------- |
| analysisType | [AnalysisType](#analysistype11) | 是 | 需要获取的智慧分析类型。 |
**错误码：**
接口抛出错误码的详细介绍请参见[通用错误码](../errorcode-universal.md)和[文件管理错误码](../apis-core-file-kit/errorcode-filemanagement.md)。
| 错误码ID | 错误信息 |
| :------- | :-------------------------------- |
| 201 | Permission denied. |
| 202 | Called by non-system application. |
| 401 | Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types; 3. Parameter verification failed. |
| 14000011 | System inner fail. |
**示例：**
```ts
import { dataSharePredicates } from '@kit.ArkData';
async function example() {
try {
console.info('getAnalysisDataDemo')
let fetchOptions: photoAccessHelper.FetchOptions = {
fetchColumns: [],
predicates: new dataSharePredicates.DataSharePredicates()
}
let fetchResult: photoAccessHelper.FetchResult =
await phAccessHelper.getAssets(fetchOptions);
let photoAsset: photoAccessHelper.PhotoAsset = await fetchResult.getFirstObject();
if (photoAsset != undefined) {
let analysisData: string = await photoAsset.getAnalysisData(
photoAccessHelper.AnalysisType.ANALYSIS_OCR);
console.info('get ocr result: ' + JSON.stringify(analysisData));
}
fetchResult.close();
} catch (err) {
console.error(`getAnalysisDataDemofailed with error: ${err.code}, ${err.message}`);
}
}
```
## Album
实体相册
### recoverAssets(deprecated)
recoverAssets(assets: Array<PhotoAsset>, callback: AsyncCallback<void>): void
从回收站中恢复图片或者视频，需要先在回收站中预置文件资源。该方法使用callback形式来返回结果。
> **说明：**
>
> 从API version 10开始支持，从API version 11开始废弃。建议使用[MediaAlbumChangeRequest.recoverAssets](#recoverassets11)替代。
**系统接口**：此接口为系统接口。
**需要权限**：ohos.permission.WRITE_IMAGEVIDEO
**系统能力**：SystemCapability.FileManagement.PhotoAccessHelper.Core
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ------------------------- | ---- | ---------- |
| assets | Array<[PhotoAsset](#photoasset)> | 是 | 回收站中待恢复图片或者视频数组。 |
| callback | AsyncCallback<void> | 是 | callback返回void。 |
**错误码：**
接口抛出错误码的详细介绍请参见[通用错误码](../errorcode-universal.md)和[文件管理错误码](../apis-core-file-kit/errorcode-filemanagement.md)。
| 错误码ID | 错误信息 |
| -------- | ---------------------------------------- |
| 202 | Called by non-system application. |
| 401 | Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types; 3. Parameter verification failed. |
| 13900012 | Permission denied. |
| 13900020 | Invalid argument. |
| 14000011 | System inner fail. |
**示例：**
```ts
import { dataSharePredicates } from '@kit.ArkData';
async function example() {
try {
console.info('recoverAssetsDemoCallback');
let predicates: dataSharePredicates.DataSharePredicates = new dataSharePredicates.DataSharePredicates();
let fetchOption: photoAccessHelper.FetchOptions = {
fetchColumns: [],
predicates: predicates
};
let albumFetchResult: photoAccessHelper.FetchResult = await phAccessHelper.getAlbums(photoAccessHelper.AlbumType.SYSTEM, photoAccessHelper.AlbumSubtype.TRASH);
let album: photoAccessHelper.Album = await albumFetchResult.getFirstObject();
let fetchResult: photoAccessHelper.FetchResult = await album.getAssets(fetchOption);
let asset: photoAccessHelper.PhotoAsset = await fetchResult.getFirstObject();
album.recoverAssets([asset], (err) => {
if (err === undefined) {
console.info('album recoverAssets successfully');
} else {
console.error(`album recoverAssets failed with error: ${err.code}, ${err.message}`);
}
});
} catch (err) {
console.error(`recoverAssetsDemoCallback failed with error: ${err.code}, ${err.message}`);
}
}
```
### recoverAssets(deprecated)
recoverAssets(assets: Array<PhotoAsset>): Promise<void>
从回收站中恢复图片或者视频，需要先在回收站中预置文件资源。该方法使用Promise来返回结果。
> **说明：**
>
> 从API version 10开始支持，从API version 11开始废弃。建议使用[MediaAlbumChangeRequest.recoverAssets](#recoverassets11)替代。
**系统接口**：此接口为系统接口。
**需要权限**：ohos.permission.WRITE_IMAGEVIDEO
**系统能力**：SystemCapability.FileManagement.PhotoAccessHelper.Core
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ------------------------- | ---- | ---------- |
| assets | Array<[PhotoAsset](#photoasset)> | 是 | 回收站中待恢复图片或者视频数组。 |
**返回值：**
| 类型 | 说明 |
| --------------------------------------- | ----------------- |
|Promise<void> | Promise对象，返回void。 |
**错误码：**
接口抛出错误码的详细介绍请参见[通用错误码](../errorcode-universal.md)和[文件管理错误码](../apis-core-file-kit/errorcode-filemanagement.md)。
| 错误码ID | 错误信息 |
| -------- | ---------------------------------------- |
| 202 | Called by non-system application. |
| 401 | Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types; 3. Parameter verification failed. |
| 13900012 | Permission denied. |
| 13900020 | Invalid argument. |
| 14000011 | System inner fail. |
**示例：**
```ts
import { dataSharePredicates } from '@kit.ArkData';
import { BusinessError } from '@kit.BasicServicesKit';
async function example() {
try {
console.info('recoverAssetsDemoPromise');
let predicates: dataSharePredicates.DataSharePredicates = new dataSharePredicates.DataSharePredicates();
let fetchOption: photoAccessHelper.FetchOptions = {
fetchColumns: [],
predicates: predicates
};
let albumFetchResult: photoAccessHelper.FetchResult = await phAccessHelper.getAlbums(photoAccessHelper.AlbumType.SYSTEM, photoAccessHelper.AlbumSubtype.TRASH);
let album: photoAccessHelper.Album = await albumFetchResult.getFirstObject();
let fetchResult: photoAccessHelper.FetchResult = await album.getAssets(fetchOption);
let asset: photoAccessHelper.PhotoAsset = await fetchResult.getFirstObject();
album.recoverAssets([asset]).then(() => {
console.info('album recoverAssets successfully');
}).catch((err: BusinessError) => {
console.error(`album recoverAssets failed with error: ${err.code}, ${err.message}`);
});
} catch (err) {
console.error(`recoverAssetsDemoPromise failed with error: ${err.code}, ${err.message}`);
}
}
```
### deleteAssets(deprecated)
deleteAssets(assets: Array<PhotoAsset>, callback: AsyncCallback<void>): void
从回收站中彻底删除图片或者视频，需要先在回收站中预置文件资源。该方法使用callback形式来返回结果。
> **说明：**
>
> 从API version 10开始支持，从API version 11开始废弃。建议使用[MediaAlbumChangeRequest.deleteAssets](#deleteassets11)替代。
**注意**：此操作不可逆，执行此操作后文件资源将彻底删除，请谨慎操作。
**系统接口**：此接口为系统接口。
**需要权限**：ohos.permission.WRITE_IMAGEVIDEO
**系统能力**：SystemCapability.FileManagement.PhotoAccessHelper.Core
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ------------------------- | ---- | ---------- |
| assets | Array<[PhotoAsset](#photoasset)> | 是 | 回收站中待彻底删除图片或者视频数组。 |
| callback | AsyncCallback<void> | 是 | callback返回void。 |
**错误码：**
接口抛出错误码的详细介绍请参见[通用错误码](../errorcode-universal.md)和[文件管理错误码](../apis-core-file-kit/errorcode-filemanagement.md)。
| 错误码ID | 错误信息 |
| -------- | ---------------------------------------- |
| 202 | Called by non-system application. |
| 401 | Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types; 3. Parameter verification failed. |
| 13900012 | Permission denied. |
| 13900020 | Invalid argument. |
| 14000011 | System inner fail. |
**示例：**
```ts
import { dataSharePredicates } from '@kit.ArkData';
async function example() {
try {
console.info('deleteAssetsDemoCallback');
let predicates: dataSharePredicates.DataSharePredicates = new dataSharePredicates.DataSharePredicates();
let fetchOption: photoAccessHelper.FetchOptions = {
fetchColumns: [],
predicates: predicates
};
let albumFetchResult: photoAccessHelper.FetchResult = await phAccessHelper.getAlbums(photoAccessHelper.AlbumType.SYSTEM, photoAccessHelper.AlbumSubtype.TRASH);
let album: photoAccessHelper.Album = await albumFetchResult.getFirstObject();
let fetchResult: photoAccessHelper.FetchResult = await album.getAssets(fetchOption);
let asset: photoAccessHelper.PhotoAsset = await fetchResult.getFirstObject();
album.deleteAssets([asset], (err) => {
if (err === undefined) {
console.info('album deleteAssets successfully');
} else {
console.error(`album deleteAssets failed with error: ${err.code}, ${err.message}`);
}
});
} catch (err) {
console.error(`deleteAssetsDemoCallback failed with error: ${err.code}, ${err.message}`);
}
}
```
### deleteAssets(deprecated)
deleteAssets(assets: Array<PhotoAsset>): Promise<void>
从回收站中彻底删除图片或者视频，需要先在回收站中预置文件资源。该方法使用Promise来返回结果。
> **说明：**
>
> 从API version 10开始支持，从API version 11开始废弃。建议使用[MediaAlbumChangeRequest.deleteAssets](#deleteassets11)替代。
**注意**：此操作不可逆，执行此操作后文件资源将彻底删除，请谨慎操作。
**系统接口**：此接口为系统接口。
**需要权限**：ohos.permission.WRITE_IMAGEVIDEO
**系统能力**：SystemCapability.FileManagement.PhotoAccessHelper.Core
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ------------------------- | ---- | ---------- |
| assets | Array<[PhotoAsset](#photoasset)> | 是 | 回收站中待彻底删除图片或者视频数组。 |
**返回值：**
| 类型 | 说明 |
| --------------------------------------- | ----------------- |
|Promise<void> | Promise对象，返回void。 |
**错误码：**
接口抛出错误码的详细介绍请参见[通用错误码](../errorcode-universal.md)和[文件管理错误码](../apis-core-file-kit/errorcode-filemanagement.md)。
| 错误码ID | 错误信息 |
| -------- | ---------------------------------------- |
| 202 | Called by non-system application. |
| 401 | Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types; 3. Parameter verification failed. |
| 13900012 | Permission denied. |
| 13900020 | Invalid argument. |
| 14000011 | System inner fail. |
**示例：**
```ts
import { dataSharePredicates } from '@kit.ArkData';
import { BusinessError } from '@kit.BasicServicesKit';
async function example() {
try {
console.info('deleteAssetsDemoPromise');
let predicates: dataSharePredicates.DataSharePredicates = new dataSharePredicates.DataSharePredicates();
let fetchOption: photoAccessHelper.FetchOptions = {
fetchColumns: [],
predicates: predicates
};
let albumFetchResult: photoAccessHelper.FetchResult = await phAccessHelper.getAlbums(photoAccessHelper.AlbumType.SYSTEM, photoAccessHelper.AlbumSubtype.TRASH);
let album: photoAccessHelper.Album = await albumFetchResult.getFirstObject();
let fetchResult: photoAccessHelper.FetchResult = await album.getAssets(fetchOption);
let asset: photoAccessHelper.PhotoAsset = await fetchResult.getFirstObject();
album.deleteAssets([asset]).then(() => {
console.info('album deleteAssets successfully');
}).catch((err: BusinessError) => {
console.error(`album deleteAssets failed with error: ${err.code}, ${err.message}`);
});
} catch (err) {
console.error(`deleteAssetsDemoPromise failed with error: ${err.code}, ${err.message}`);
}
}
```
### setCoverUri(deprecated)
setCoverUri(uri: string, callback: AsyncCallback<void>): void
设置相册封面，该方法使用callback形式来返回结果。
> **说明：**
>
> 从API version 10开始支持，从API version 11开始废弃。建议使用[MediaAlbumChangeRequest.setCoverUri](#setcoveruri11)替代。
**注意**：此接口只可修改用户相册封面，不允许修改系统相册封面。
**系统接口**：此接口为系统接口。
**需要权限**：ohos.permission.WRITE_IMAGEVIDEO
**系统能力**：SystemCapability.FileManagement.PhotoAccessHelper.Core
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ------------------------- | ---- | ---------- |
| uri | string | 是 | 待设置为相册封面文件的uri。 |
| callback | AsyncCallback<void> | 是 | callback返回void。 |
**错误码：**
接口抛出错误码的详细介绍请参见[通用错误码](../errorcode-universal.md)和[文件管理错误码](../apis-core-file-kit/errorcode-filemanagement.md)。
| 错误码ID | 错误信息 |
| -------- | ---------------------------------------- |
| 202 | Called by non-system application. |
| 401 | Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types; 3. Parameter verification failed. |
| 13900012 | Permission denied. |
| 13900020 | Invalid argument. |
| 14000011 | System inner fail. |
**示例：**
```ts
import { dataSharePredicates } from '@kit.ArkData';
async function example() {
try {
console.info('setCoverUriDemoCallback');
let predicates: dataSharePredicates.DataSharePredicates = new dataSharePredicates.DataSharePredicates();
let fetchOption: photoAccessHelper.FetchOptions = {
fetchColumns: [],
predicates: predicates
};
let albumFetchResult: photoAccessHelper.FetchResult = await phAccessHelper.getAlbums(photoAccessHelper.AlbumType.USER, photoAccessHelper.AlbumSubtype.USER_GENERIC);
let album: photoAccessHelper.Album = await albumFetchResult.getFirstObject();
let fetchResult: photoAccessHelper.FetchResult = await album.getAssets(fetchOption);
let asset: photoAccessHelper.PhotoAsset = await fetchResult.getFirstObject();
album.setCoverUri(asset.uri, (err) => {
if (err === undefined) {
console.info('album setCoverUri successfully');
} else {
console.error(`album setCoverUri failed with error: ${err.code}, ${err.message}`);
}
});
} catch (err) {
console.error(`setCoverUriDemoCallback failed with error: ${err.code}, ${err.message}`);
}
}
```
### setCoverUri(deprecated)
setCoverUri(uri: string): Promise<void>
设置相册封面，该方法使用Promise来返回结果。
> **说明：**
>
> 从API version 10开始支持，从API version 11开始废弃。建议使用[MediaAlbumChangeRequest.setCoverUri](#setcoveruri11)替代。
**注意**：此接口只可修改用户相册封面，不允许修改系统相册封面。
**系统接口**：此接口为系统接口。
**需要权限**：ohos.permission.WRITE_IMAGEVIDEO
**系统能力**：SystemCapability.FileManagement.PhotoAccessHelper.Core
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ------------------------- | ---- | ---------- |
| uri | string | 是 | 待设置为相册封面文件的uri。 |
**返回值：**
| 类型 | 说明 |
| --------------------------------------- | ----------------- |
|Promise<void> | Promise对象，返回void。 |
**错误码：**
接口抛出错误码的详细介绍请参见[通用错误码](../errorcode-universal.md)和[文件管理错误码](../apis-core-file-kit/errorcode-filemanagement.md)。
| 错误码ID | 错误信息 |
| -------- | ---------------------------------------- |
| 202 | Called by non-system application. |
| 401 | Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types; 3. Parameter verification failed. |
| 13900012 | Permission denied. |
| 13900020 | Invalid argument. |
| 14000011 | System inner fail. |
**示例：**
```ts
import { dataSharePredicates } from '@kit.ArkData';
import { BusinessError } from '@kit.BasicServicesKit';
async function example() {
try {
console.info('setCoverUriDemoPromise');
let predicates: dataSharePredicates.DataSharePredicates = new dataSharePredicates.DataSharePredicates();
let fetchOption: photoAccessHelper.FetchOptions = {
fetchColumns: [],
predicates: predicates
};
let albumFetchResult: photoAccessHelper.FetchResult = await phAccessHelper.getAlbums(photoAccessHelper.AlbumType.USER, photoAccessHelper.AlbumSubtype.USER_GENERIC);
let album: photoAccessHelper.Album = await albumFetchResult.getFirstObject();
let fetchResult: photoAccessHelper.FetchResult = await album.getAssets(fetchOption);
let asset: photoAccessHelper.PhotoAsset = await fetchResult.getFirstObject();
album.setCoverUri(asset.uri).then(() => {
console.info('album setCoverUri successfully');
}).catch((err: BusinessError) => {
console.error(`album setCoverUri failed with error: ${err.code}, ${err.message}`);
});
} catch (err) {
console.error(`setCoverUriDemoPromise failed with error: ${err.code}, ${err.message}`);
}
}
```
## MediaAssetEditData11+
资产编辑数据。
**系统接口**：此接口为系统接口。
**系统能力**：SystemCapability.FileManagement.PhotoAccessHelper.Core
### 属性
| 名称 | 类型 | 可读 | 可写 | 说明 |
| ------------ | ------ | ---- | ---- | ------- |
| compatibleFormat | string | 是 | 是 | 编辑数据的格式。**系统接口**：此接口为系统接口。 |
| formatVersion | string | 是 | 是 | 编辑数据格式的版本。**系统接口**：此接口为系统接口。 |
| data | string | 是 | 是 | 编辑数据的内容。**系统接口**：此接口为系统接口。 |
### constructor11+
constructor(compatibleFormat: string, formatVersion: string)
构造函数。
**系统接口**：此接口为系统接口。
**系统能力**：SystemCapability.FileManagement.PhotoAccessHelper.Core
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ------------------------- | ---- | ---------- |
| compatibleFormat | string | 是 | 编辑数据的格式。 |
| formatVersion | string | 是 | 编辑数据格式的版本。 |
**错误码：**
接口抛出错误码的详细介绍请参见[通用错误码](../errorcode-universal.md)和[文件管理错误码](../apis-core-file-kit/errorcode-filemanagement.md)。
| 错误码ID | 错误信息 |
| -------- | ---------------------------------------- |
| 202 | Called by non-system application. |
| 401 | Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types; 3. Parameter verification failed. |
| 14000011 | System inner fail. |
**示例：**
```ts
let assetEditData: photoAccessHelper.MediaAssetEditData = new photoAccessHelper.MediaAssetEditData('system', '1.0');
```
## MediaAssetChangeRequest11+
资产变更请求。
**系统能力**：SystemCapability.FileManagement.PhotoAccessHelper.Core
### createAssetRequest11+
static createAssetRequest(context: Context, displayName: string, options?: PhotoCreateOptions): MediaAssetChangeRequest
指定待创建的图片或者视频的文件名，创建资产变更请求。
待创建的文件名参数规格为：
- 应包含有效文件主名和图片或视频扩展名。
- 文件名字符串长度为1~255。
- 文件主名中不允许出现非法字符，包括：
. .. \ / : * ? " ' ` < > | { } [ ]
**系统接口**：此接口为系统接口。
**系统能力**：SystemCapability.FileManagement.PhotoAccessHelper.Core
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| ------- | ------- | ---- | -------------------------- |
| context | [Context](../apis-ability-kit/js-apis-inner-application-context.md) | 是 | 传入Ability实例的Context。 |
| displayName | string | 是 | 待创建的图片或者视频文件名。 |
| options | [PhotoCreateOptions](#photocreateoptions) | 否 | 图片或视频的创建选项。 |
**返回值：**
| 类型 | 说明 |
| --------------------------------------- | ----------------- |
| [MediaAssetChangeRequest](#mediaassetchangerequest11) | 返回创建资产的变更请求。 |
**错误码：**
接口抛出错误码的详细介绍请参见[通用错误码](../errorcode-universal.md)和[文件管理错误码](../apis-core-file-kit/errorcode-filemanagement.md)。
| 错误码ID | 错误信息 |
| -------- | ---------------------------------------- |
| 202 | Called by non-system application. |
| 401 | Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types; 3. Parameter verification failed. |
| 14000001 | Invalid display name. |
| 14000011 | System inner fail. |
**示例：**
```ts
async function example() {
console.info('createAssetRequestDemo');
try {
let testFileName: string = 'testFile' + Date.now() + '.jpg';
let assetChangeRequest: photoAccessHelper.MediaAssetChangeRequest = photoAccessHelper.MediaAssetChangeRequest.createAssetRequest(context, testFileName);
// 需要确保fileUri对应的资源存在
let fileUri = 'file://com.example.temptest/data/storage/el2/base/haps/entry/files/test.jpg';
assetChangeRequest.addResource(photoAccessHelper.ResourceType.IMAGE_RESOURCE, fileUri);
await phAccessHelper.applyChanges(assetChangeRequest);
console.info('apply createAssetRequest successfully');
} catch (err) {
console.error(`createAssetRequestDemo failed with error: ${err.code}, ${err.message}`);
}
}
```
### setFavorite11+
setFavorite(favoriteState: boolean): void
将文件设置为收藏文件。
**系统接口**：此接口为系统接口。
**系统能力**：SystemCapability.FileManagement.PhotoAccessHelper.Core
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| ---------- | ------- | ---- | ---------------------------------- |
| favoriteState | boolean | 是 | 是否设置为收藏文件， true：设置为收藏文件；false：取消收藏。 |
**错误码：**
接口抛出错误码的详细介绍请参见[通用错误码](../errorcode-universal.md)和[文件管理错误码](../apis-core-file-kit/errorcode-filemanagement.md)。
| 错误码ID | 错误信息 |
| -------- | ---------------------------------------- |
| 202 | Called by non-system application. |
| 401 | Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types; 3. Parameter verification failed. |
| 14000011 | System inner fail. |
**示例：**
```ts
import { dataSharePredicates } from '@kit.ArkData';
import { BusinessError } from '@kit.BasicServicesKit';
async function example() {
console.info('setFavoriteDemo');
let predicates: dataSharePredicates.DataSharePredicates = new dataSharePredicates.DataSharePredicates();
let fetchOption: photoAccessHelper.FetchOptions = {
fetchColumns: [],
predicates: predicates
};
let fetchResult: photoAccessHelper.FetchResult = await phAccessHelper.getAssets(fetchOption);
let asset = await fetchResult.getFirstObject();
let assetChangeRequest: photoAccessHelper.MediaAssetChangeRequest = new photoAccessHelper.MediaAssetChangeRequest(asset);
assetChangeRequest.setFavorite(true);
phAccessHelper.applyChanges(assetChangeRequest).then(() => {
console.info('apply setFavorite successfully');
}).catch((err: BusinessError) => {
console.error(`apply setFavorite failed with error: ${err.code}, ${err.message}`);
});
}
```
### setHidden11+
setHidden(hiddenState: boolean): void
将文件设置为隐藏文件。
**系统接口**：此接口为系统接口。
**系统能力**：SystemCapability.FileManagement.PhotoAccessHelper.Core
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| ---------- | ------- | ---- | ---------------------------------- |
| hiddenState | boolean | 是 | 是否设置为隐藏文件，true：将文件资产放入隐藏相册；false：从隐藏相册中恢复。 |
**错误码：**
接口抛出错误码的详细介绍请参见[通用错误码](../errorcode-universal.md)和[文件管理错误码](../apis-core-file-kit/errorcode-filemanagement.md)。
| 错误码ID | 错误信息 |
| -------- | ---------------------------------------- |
| 202 | Called by non-system application. |
| 401 | Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types; 3. Parameter verification failed. |
| 14000011 | System inner fail. |
**示例：**
```ts
import { dataSharePredicates } from '@kit.ArkData';
import { BusinessError } from '@kit.BasicServicesKit';
async function example() {
console.info('setHiddenDemo');
let predicates: dataSharePredicates.DataSharePredicates = new dataSharePredicates.DataSharePredicates();
let fetchOption: photoAccessHelper.FetchOptions = {
fetchColumns: [],
predicates: predicates
};
let fetchResult: photoAccessHelper.FetchResult = await phAccessHelper.getAssets(fetchOption);
let asset = await fetchResult.getFirstObject();
let assetChangeRequest: photoAccessHelper.MediaAssetChangeRequest = new photoAccessHelper.MediaAssetChangeRequest(asset);
assetChangeRequest.setHidden(true);
phAccessHelper.applyChanges(assetChangeRequest).then(() => {
console.info('apply setHidden successfully');
}).catch((err: BusinessError) => {
console.error(`apply setHidden failed with error: ${err.code}, ${err.message}`);
});
}
```
### setUserComment11+
setUserComment(userComment: string): void
修改媒体资产的备注信息。
**系统接口**：此接口为系统接口。
**系统能力**：SystemCapability.FileManagement.PhotoAccessHelper.Core
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| ---------- | ------- | ---- | ---------------------------------- |
| userComment | string | 是 | 待修改的资产备注信息，备注信息最长为420字符。 |
**错误码：**
接口抛出错误码的详细介绍请参见[通用错误码](../errorcode-universal.md)和[文件管理错误码](../apis-core-file-kit/errorcode-filemanagement.md)。
| 错误码ID | 错误信息 |
| -------- | ---------------------------------------- |
| 202 | Called by non-system application. |
| 401 | Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types; 3. Parameter verification failed. |
| 14000011 | System inner fail. |
**示例：**
```ts
import { dataSharePredicates } from '@kit.ArkData';
import { BusinessError } from '@kit.BasicServicesKit';
async function example() {
console.info('setUserCommentDemo');
let predicates: dataSharePredicates.DataSharePredicates = new dataSharePredicates.DataSharePredicates();
let fetchOption: photoAccessHelper.FetchOptions = {
fetchColumns: [],
predicates: predicates
};
let fetchResult: photoAccessHelper.FetchResult = await phAccessHelper.getAssets(fetchOption);
let asset = await fetchResult.getFirstObject();
let assetChangeRequest: photoAccessHelper.MediaAssetChangeRequest = new photoAccessHelper.MediaAssetChangeRequest(asset);
let userComment: string = 'test_set_user_comment';
assetChangeRequest.setUserComment(userComment);
phAccessHelper.applyChanges(assetChangeRequest).then(() => {
console.info('apply setUserComment successfully');
}).catch((err: BusinessError) => {
console.error(`apply setUserComment failed with error: ${err.code}, ${err.message}`);
});
}
```
### setEditData11+
setEditData(editData: MediaAssetEditData): void
保存资产的编辑数据。
**系统接口**：此接口为系统接口。
**系统能力**：SystemCapability.FileManagement.PhotoAccessHelper.Core
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| ---------- | ------- | ---- | ---------------------------------- |
| editData | [MediaAssetEditData](#mediaasseteditdata11) | 是 | 待保存的资产编辑数据。 |
**错误码：**
接口抛出错误码的详细介绍请参见[通用错误码](../errorcode-universal.md)和[文件管理错误码](../apis-core-file-kit/errorcode-filemanagement.md)。
| 错误码ID | 错误信息 |
| -------- | ---------------------------------------- |
| 202 | Called by non-system application. |
| 401 | Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types; 3. Parameter verification failed. |
| 14000011 | System inner fail. |
**示例：**
```ts
import { dataSharePredicates } from '@kit.ArkData';
import { BusinessError } from '@kit.BasicServicesKit';
async function example() {
console.info('setEditDataDemo');
let predicates: dataSharePredicates.DataSharePredicates = new dataSharePredicates.DataSharePredicates();
let fetchOption: photoAccessHelper.FetchOptions = {
fetchColumns: [],
predicates: predicates
};
let fetchResult: photoAccessHelper.FetchResult = await phAccessHelper.getAssets(fetchOption);
let asset = await fetchResult.getFirstObject();
let assetChangeRequest: photoAccessHelper.MediaAssetChangeRequest = new photoAccessHelper.MediaAssetChangeRequest(asset);
let assetEditData: photoAccessHelper.MediaAssetEditData = new photoAccessHelper.MediaAssetEditData('system', '1.0');
let fileUri = 'file://com.example.temptest/data/storage/el2/base/haps/entry/files/test.jpg';
assetChangeRequest.addResource(photoAccessHelper.ResourceType.IMAGE_RESOURCE, fileUri);
assetEditData.data = '123456';
assetChangeRequest.setEditData(assetEditData);
phAccessHelper.applyChanges(assetChangeRequest).then(() => {
console.info('apply setEditData successfully');
}).catch((err: BusinessError) => {
console.error(`apply setEditData failed with error: ${err.code}, ${err.message}`);
});
}
```
### addResource11+
addResource(type: ResourceType, proxy: PhotoProxy): void
通过PhotoProxy数据添加资源。
**注意**：对于同一个资产变更请求，不支持在成功添加资源后，重复调用该接口。
**系统接口**：此接口为系统接口，仅提供给相机应用使用。
**系统能力**：SystemCapability.FileManagement.PhotoAccessHelper.Core
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| ------- |---------------------------------| ---- |----------------------|
| type | [ResourceType](#resourcetype11) | 是 | 待添加资源的类型。 |
| proxy | [PhotoProxy](#photoproxy11) | 是 | 待添加资源的PhotoProxy 数据。 |
**错误码：**
接口抛出错误码的详细介绍请参见[通用错误码](../errorcode-universal.md)和[文件管理错误码](../apis-core-file-kit/errorcode-filemanagement.md)。
| 错误码ID | 错误信息 |
|----------|-----------------------------------|
| 202 | Called by non-system application. |
| 401 | Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types; 3. Parameter verification failed. |
| 14000011 | System inner fail. |
| 14000016 | Operation Not Support. |
**示例：**
```ts
class PhotoProxyImpl implements photoAccessHelper.PhotoProxy {
// 应用实现PhotoProxy
}
async function example() {
console.info('addResourceByPhotoProxyDemo');
try {
let photoType: photoAccessHelper.PhotoType = photoAccessHelper.PhotoType.IMAGE;
let extension: string = 'jpg';
let assetChangeRequest: photoAccessHelper.MediaAssetChangeRequest = photoAccessHelper.MediaAssetChangeRequest.createAssetRequest(context, photoType, extension);
let photoProxy: PhotoProxyImpl = new PhotoProxyImpl();
assetChangeRequest.addResource(photoAccessHelper.ResourceType.IMAGE_RESOURCE, photoProxy);
await phAccessHelper.applyChanges(assetChangeRequest);
console.info('addResourceByPhotoProxy successfully');
} catch (err) {
console.error(`addResourceByPhotoProxyDemo failed with error: ${err.code}, ${err.message}`);
}
}
```
### setLocation11+
setLocation(longitude: number, latitude: number): void
设置文件的经纬度信息。
**系统接口**：此接口为系统接口
**系统能力**：SystemCapability.FileManagement.PhotoAccessHelper.Core
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| ------- |-------------| ---- |-------|
| longitude | number | 是 | 经度。 |
| latitude | number | 是 | 纬度。 |
**错误码：**
接口抛出错误码的详细介绍请参见[通用错误码](../errorcode-universal.md)和[文件管理错误码](../apis-core-file-kit/errorcode-filemanagement.md)。
| 错误码ID | 错误信息 |
| -------- | ---------------------------------------- |
| 202 | Called by non-system application. |
| 401 | Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types; 3. Parameter verification failed. |
| 14000011 | System inner fail. |
**示例：**
```ts
import { dataSharePredicates } from '@kit.ArkData';
import { BusinessError } from '@kit.BasicServicesKit';
async function example() {
console.info('setLocationDemo');
let predicates: dataSharePredicates.DataSharePredicates = new dataSharePredicates.DataSharePredicates();
let fetchOption: photoAccessHelper.FetchOptions = {
fetchColumns: [],
predicates: predicates
};
let fetchResult: photoAccessHelper.FetchResult = await phAccessHelper.getAssets(fetchOption);
let asset = await fetchResult.getFirstObject();
let assetChangeRequest: photoAccessHelper.MediaAssetChangeRequest = new photoAccessHelper.MediaAssetChangeRequest(asset);
assetChangeRequest.setLocation(120.52, 30.40);
phAccessHelper.applyChanges(assetChangeRequest).then(() => {
console.info('apply setLocation successfully');
}).catch((err: BusinessError) => {
console.error(`apply setLocation failed with error: ${err.code}, ${err.message}`);
});
}
```
### setCameraShotKey12+
setCameraShotKey(cameraShotKey: string): void
设置锁屏相机拍照或录像的标记字段。
**系统接口**：此接口为系统接口。
**系统能力**：SystemCapability.FileManagement.PhotoAccessHelper.Core
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| ---------- | ------- | ---- | ---------------------------------- |
| cameraShotKey | string | 是 | 锁屏相机拍照或录像的标记字段（仅开放给系统相机，其key值由系统相机定义）。 |
**错误码：**
接口抛出错误码的详细介绍请参见[通用错误码](../errorcode-universal.md)和[文件管理错误码](../apis-core-file-kit/errorcode-filemanagement.md)。
| 错误码ID | 错误信息 |
| -------- | ---------------------------------------- |
| 202 | Called by non-system application. |
| 401 | Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types; 3. Parameter verification failed. |
| 14000011 | System inner fail. |
**示例：**
```ts
async function example(asset: photoAccessHelper.PhotoAsset) {
console.info('setCameraShotKeyDemo');
try {
let assetChangeRequest: photoAccessHelper.MediaAssetChangeRequest = new photoAccessHelper.MediaAssetChangeRequest(asset);
let cameraShotKey: string = 'test_MediaAssetChangeRequest_setCameraShotKey';
assetChangeRequest.setCameraShotKey(cameraShotKey);
await phAccessHelper.applyChanges(assetChangeRequest);
console.info('apply setCameraShotKey successfully');
} catch (err) {
console.error(`apply setCameraShotKey failed with error: ${err.code}, ${err.message}`);
}
}
```
### setEffectMode12+
setEffectMode(mode: MovingPhotoEffectMode): void
设置动态照片的效果模式。
**系统接口**：此接口为系统接口。
**系统能力**：SystemCapability.FileManagement.PhotoAccessHelper.Core
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| ---------- | ------- | ---- | ---------------------------------- |
| mode | [MovingPhotoEffectMode](#movingphotoeffectmode12) | 是 | 动态照片效果模式。 |
**错误码：**
接口抛出错误码的详细介绍请参见[通用错误码](../errorcode-universal.md)和[文件管理错误码](../apis-core-file-kit/errorcode-filemanagement.md)。
| 错误码ID | 错误信息 |
| -------- | ---------------------------------------- |
| 202 | Called by non-system application. |
| 401 | Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types; 3. Parameter verification failed. |
| 14000011 | System inner fail. |
| 14000016 | Operation Not Support. |
**示例：**
```ts
async function example(asset: photoAccessHelper.PhotoAsset) {
console.info('setEffectModeDemo');
try {
let assetChangeRequest: photoAccessHelper.MediaAssetChangeRequest = new photoAccessHelper.MediaAssetChangeRequest(asset);
assetChangeRequest.setEffectMode(photoAccessHelper.MovingPhotoEffectMode.LONG_EXPOSURE);
// 需要确保fileUri对应的资源存在
let imageFileUri = 'file://com.example.temptest/data/storage/el2/base/haps/entry/files/long_exposure.jpg';
let videoFileUri = 'file://com.example.temptest/data/storage/el2/base/haps/entry/files/long_exposure.mp4';
assetChangeRequest.addResource(photoAccessHelper.ResourceType.IMAGE_RESOURCE, imageFileUri);
assetChangeRequest.addResource(photoAccessHelper.ResourceType.VIDEO_RESOURCE, videoFileUri);
await phAccessHelper.applyChanges(assetChangeRequest);
console.info('apply setEffectMode successfully');
} catch (err) {
console.error(`apply setEffectMode failed with error: ${err.code}, ${err.message}`);
}
}
```
### setSupportedWatermarkType14+
setSupportedWatermarkType(watermarkType: WatermarkType): void
设置拍照照片支持的水印类型。
**系统接口**：此接口为系统接口。
**系统能力**：SystemCapability.FileManagement.PhotoAccessHelper.Core
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| ---------- | ------- | ---- | ---------------------------------- |
| watermarkType | [WatermarkType](#watermarktype14) | 是 | 水印可编辑标识。 |
**错误码：**
接口抛出错误码的详细介绍请参见[通用错误码](../errorcode-universal.md)和[文件管理错误码](../apis-core-file-kit/errorcode-filemanagement.md)。
| 错误码ID | 错误信息 |
| -------- | ---------------------------------------- |
| 202 | Called by non-system application. |
| 401 | Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types; 3. Parameter verification failed. |
| 14000011 | Internal system error. |
**示例：**
```ts
import { dataSharePredicates } from '@kit.ArkData';
import photoAccessHelper from '@ohos.file.photoAccessHelper';
const context = getContext(this);
let phAccessHelper = photoAccessHelper.getPhotoAccessHelper(context);
async function example() {
console.info('setSupportedWatermarkTypeDemo');
let predicates: dataSharePredicates.DataSharePredicates = new dataSharePredicates.DataSharePredicates();
let fetchOption: photoAccessHelper.FetchOptions = {
fetchColumns: [],
predicates: predicates
};
try {
let fetchResult: photoAccessHelper.FetchResult = await phAccessHelper.getAssets(fetchOption);
let asset = await fetchResult.getFirstObject();
let assetChangeRequest: photoAccessHelper.MediaAssetChangeRequest = new photoAccessHelper.MediaAssetChangeRequest(asset);
assetChangeRequest.setSupportedWatermarkType(photoAccessHelper.WatermarkType.BRAND_COMMON);
await phAccessHelper.applyChanges(assetChangeRequest);
console.info('apply setSupportedWatermarkType successfully');
} catch (err) {
console.error(`apply setSupportedWatermarkType failed with error: ${err.code}, ${err.message}`);
}
}
```
## MediaAssetsChangeRequest11+
批量资产变更请求。
**系统接口**：此接口为系统接口。
**系统能力**：SystemCapability.FileManagement.PhotoAccessHelper.Core
### constructor11+
constructor(assets: Array<PhotoAsset>)
构造函数。
**系统接口**：此接口为系统接口。
**系统能力**：SystemCapability.FileManagement.PhotoAccessHelper.Core
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ------------------------- | ---- | ---------- |
| assets | Array<[PhotoAsset](#photoasset)> | 是 | 需要变更的资产数组。 |
**错误码：**
接口抛出错误码的详细介绍请参见[通用错误码](../errorcode-universal.md)和[文件管理错误码](../apis-core-file-kit/errorcode-filemanagement.md)。
| 错误码ID | 错误信息 |
| -------- | ---------------------------------------- |
| 202 | Called by non-system application. |
| 401 | Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types; 3. Parameter verification failed. |
| 14000011 | System inner fail. |
**示例：**
```ts
import { dataSharePredicates } from '@kit.ArkData';
async function example() {
console.info('MediaAssetsChangeRequest constructorDemo');
let predicates: dataSharePredicates.DataSharePredicates = new dataSharePredicates.DataSharePredicates();
let fetchOption: photoAccessHelper.FetchOptions = {
fetchColumns: [],
predicates: predicates
};
let fetchResult: photoAccessHelper.FetchResult = await phAccessHelper.getAssets(fetchOption);
let photoAssetList: Array = await fetchResult.getAllObjects();
let assetsChangeRequest: photoAccessHelper.MediaAssetsChangeRequest = new photoAccessHelper.MediaAssetsChangeRequest(photoAssetList);
}
```
### setFavorite11+
setFavorite(favoriteState: boolean): void
将文件设置为收藏文件。
**系统接口**：此接口为系统接口。
**系统能力**：SystemCapability.FileManagement.PhotoAccessHelper.Core
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| ---------- | ------- | ---- | ---------------------------------- |
| favoriteState | boolean | 是 | 是否设置为收藏文件， true：设置为收藏文件；false：取消收藏。 |
**错误码：**
接口抛出错误码的详细介绍请参见[通用错误码](../errorcode-universal.md)和[文件管理错误码](../apis-core-file-kit/errorcode-filemanagement.md)。
| 错误码ID | 错误信息 |
| -------- | ---------------------------------------- |
| 202 | Called by non-system application. |
| 401 | Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types; 3. Parameter verification failed. |
| 14000011 | System inner fail. |
**示例：**
```ts
import { dataSharePredicates } from '@kit.ArkData';
import { BusinessError } from '@kit.BasicServicesKit';
async function example() {
console.info('setFavoriteDemo');
let predicates: dataSharePredicates.DataSharePredicates = new dataSharePredicates.DataSharePredicates();
let fetchOption: photoAccessHelper.FetchOptions = {
fetchColumns: [],
predicates: predicates
};
let fetchResult: photoAccessHelper.FetchResult = await phAccessHelper.getAssets(fetchOption);
let photoAssetList: Array = await fetchResult.getAllObjects();
let assetsChangeRequest: photoAccessHelper.MediaAssetsChangeRequest = new photoAccessHelper.MediaAssetsChangeRequest(photoAssetList);
assetsChangeRequest.setFavorite(true);
phAccessHelper.applyChanges(assetsChangeRequest).then(() => {
console.info('apply setFavorite successfully');
}).catch((err: BusinessError) => {
console.error(`apply setFavorite failed with error: ${err.code}, ${err.message}`);
});
}
```
### setHidden11+
setHidden(hiddenState: boolean): void
将文件设置为隐藏文件。
**系统接口**：此接口为系统接口。
**系统能力**：SystemCapability.FileManagement.PhotoAccessHelper.Core
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| ---------- | ------- | ---- | ---------------------------------- |
| hiddenState | boolean | 是 | 是否设置为隐藏文件，true：将文件资产放入隐藏相册；false：从隐藏相册中恢复。 |
**错误码：**
接口抛出错误码的详细介绍请参见[通用错误码](../errorcode-universal.md)和[文件管理错误码](../apis-core-file-kit/errorcode-filemanagement.md)。
| 错误码ID | 错误信息 |
| -------- | ---------------------------------------- |
| 202 | Called by non-system application. |
| 401 | Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types; 3. Parameter verification failed. |
| 14000011 | System inner fail. |
**示例：**
```ts
import { dataSharePredicates } from '@kit.ArkData';
import { BusinessError } from '@kit.BasicServicesKit';
async function example() {
console.info('setHiddenDemo');
let predicates: dataSharePredicates.DataSharePredicates = new dataSharePredicates.DataSharePredicates();
let fetchOption: photoAccessHelper.FetchOptions = {
fetchColumns: [],
predicates: predicates
};
let fetchResult: photoAccessHelper.FetchResult = await phAccessHelper.getAssets(fetchOption);
let photoAssetList: Array = await fetchResult.getAllObjects();
let assetsChangeRequest: photoAccessHelper.MediaAssetsChangeRequest = new photoAccessHelper.MediaAssetsChangeRequest(photoAssetList);
assetsChangeRequest.setHidden(true);
phAccessHelper.applyChanges(assetsChangeRequest).then(() => {
console.info('apply setHidden successfully');
}).catch((err: BusinessError) => {
console.error(`apply setHidden failed with error: ${err.code}, ${err.message}`);
});
}
```
### setUserComment11+
setUserComment(userComment: string): void
修改媒体资产的备注信息。
**系统接口**：此接口为系统接口。
**系统能力**：SystemCapability.FileManagement.PhotoAccessHelper.Core
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| ---------- | ------- | ---- | ---------------------------------- |
| userComment | string | 是 | 待修改的资产备注信息，备注信息最长为420字符。 |
**错误码：**
接口抛出错误码的详细介绍请参见[通用错误码](../errorcode-universal.md)和[文件管理错误码](../apis-core-file-kit/errorcode-filemanagement.md)。
| 错误码ID | 错误信息 |
| -------- | ---------------------------------------- |
| 202 | Called by non-system application. |
| 401 | Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types; 3. Parameter verification failed. |
| 14000011 | System inner fail. |
**示例：**
```ts
import { dataSharePredicates } from '@kit.ArkData';
import { BusinessError } from '@kit.BasicServicesKit';
async function example() {
console.info('setUserCommentDemo');
let predicates: dataSharePredicates.DataSharePredicates = new dataSharePredicates.DataSharePredicates();
let fetchOption: photoAccessHelper.FetchOptions = {
fetchColumns: [],
predicates: predicates
};
let fetchResult: photoAccessHelper.FetchResult = await phAccessHelper.getAssets(fetchOption);
let photoAssetList: Array = await fetchResult.getAllObjects();
let assetsChangeRequest: photoAccessHelper.MediaAssetsChangeRequest = new photoAccessHelper.MediaAssetsChangeRequest(photoAssetList);
assetsChangeRequest.setUserComment('test_set_user_comment');
phAccessHelper.applyChanges(assetsChangeRequest).then(() => {
console.info('apply setUserComment successfully');
}).catch((err: BusinessError) => {
console.error(`apply setUserComment failed with error: ${err.code}, ${err.message}`);
});
}
```
## MediaAlbumChangeRequest11+
相册变更请求。
**系统能力**：SystemCapability.FileManagement.PhotoAccessHelper.Core
### createAlbumRequest11+
static createAlbumRequest(context: Context, name: string): MediaAlbumChangeRequest
创建相册变更请求。
相册名的参数规格为：
- 相册名字符串长度为1~255。
- 不允许出现非法字符，包括：
. .. \ / : * ? " ' ` < > | { } [ ]
- 英文字符大小写不敏感。
- 相册名不允许重名。
**系统接口**：此接口为系统接口。
**系统能力**：SystemCapability.FileManagement.PhotoAccessHelper.Core
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| ------- | ------- | ---- | -------------------------- |
| context | [Context](../apis-ability-kit/js-apis-inner-application-context.md) | 是 | 传入Ability实例的Context。 |
| name | string | 是 | 待创建相册的名称。|
**返回值：**
| 类型 | 说明 |
| --------------------------------------- | ----------------- |
| [MediaAlbumChangeRequest](#mediaalbumchangerequest11) | 返回创建相册的变更请求。 |
**错误码：**
接口抛出错误码的详细介绍请参见[通用错误码](../errorcode-universal.md)和[文件管理错误码](../apis-core-file-kit/errorcode-filemanagement.md)。
| 错误码ID | 错误信息 |
| -------- | ---------------------------------------- |
| 202 | Called by non-system application. |
| 401 | Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types; 3. Parameter verification failed. |
| 14000011 | System inner fail. |
**示例：**
```ts
async function example() {
console.info('createAlbumRequestDemo');
try {
let albumName: string = 'newAlbumName' + new Date().getTime();
let albumChangeRequest: photoAccessHelper.MediaAlbumChangeRequest = photoAccessHelper.MediaAlbumChangeRequest.createAlbumRequest(context, albumName);
await phAccessHelper.applyChanges(albumChangeRequest);
console.info('apply createAlbumRequest successfully');
} catch (err) {
console.error(`createAlbumRequestDemo failed with error: ${err.code}, ${err.message}`);
}
}
```
### deleteAlbums11+
static deleteAlbums(context: Context, albums: Array<Album>): Promise<void>
删除相册，使用Promise方式返回结果。
删除相册前需先确保相册存在，只能删除用户相册。
**系统接口**：此接口为系统接口。
**需要权限**：ohos.permission.WRITE_IMAGEVIDEO
**系统能力**：SystemCapability.FileManagement.PhotoAccessHelper.Core
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| ------- | ------- | ---- | -------------------------- |
| context | [Context](../apis-ability-kit/js-apis-inner-application-context.md) | 是 | 传入Ability实例的Context。 |
| albums | Array<[Album](#album)> | 是 | 待删除的相册数组。 |
**返回值：**
| 类型 | 说明 |
| --------------------------------------- | ----------------- |
| Promise<void>| Promise对象，返回void。 |
**错误码：**
接口抛出错误码的详细介绍请参见[通用错误码](../errorcode-universal.md)和[文件管理错误码](../apis-core-file-kit/errorcode-filemanagement.md)。
| 错误码ID | 错误信息 |
| -------- | ---------------------------------------- |
| 201 | Permission denied. |
| 202 | Called by non-system application. |
| 401 | Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types; 3. Parameter verification failed. |
| 14000011 | System inner fail. |
**示例：**
```ts
import { dataSharePredicates } from '@kit.ArkData';
async function example() {
console.info('deleteAlbumsDemo');
let predicates: dataSharePredicates.DataSharePredicates = new dataSharePredicates.DataSharePredicates();
let fetchOptions: photoAccessHelper.FetchOptions = {
fetchColumns: [],
predicates: predicates
};
try {
let fetchResult: photoAccessHelper.FetchResult = await phAccessHelper.getAlbums(photoAccessHelper.AlbumType.USER, photoAccessHelper.AlbumSubtype.USER_GENERIC, fetchOptions);
let album: photoAccessHelper.Album = await fetchResult.getFirstObject();
await photoAccessHelper.MediaAlbumChangeRequest.deleteAlbums(context, [album]);
console.info('deleteAlbums successfully');
} catch (err) {
console.error(`deleteAlbumsDemo failed with error: ${err.code}, ${err.message}`);
}
}
```
### setCoverUri11+
setCoverUri(coverUri: string): void
设置相册封面。
**系统接口**：此接口为系统接口。
**系统能力**：SystemCapability.FileManagement.PhotoAccessHelper.Core
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| ---------- | ------- | ---- | ---------------------------------- |
| coverUri | string | 是 | 待设置为相册封面文件的uri。 |
**错误码：**
接口抛出错误码的详细介绍请参见[通用错误码](../errorcode-universal.md)和[文件管理错误码](../apis-core-file-kit/errorcode-filemanagement.md)。
| 错误码ID | 错误信息 |
| -------- | ---------------------------------------- |
| 202 | Called by non-system application. |
| 401 | Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types; 3. Parameter verification failed. |
| 14000011 | System inner fail. |
**示例：**
```ts
import { dataSharePredicates } from '@kit.ArkData';
async function example() {
console.info('setCoverUriDemo');
let predicates: dataSharePredicates.DataSharePredicates = new dataSharePredicates.DataSharePredicates();
let fetchOptions: photoAccessHelper.FetchOptions = {
fetchColumns: [],
predicates: predicates
};
try {
let albumFetchResult: photoAccessHelper.FetchResult = await phAccessHelper.getAlbums(photoAccessHelper.AlbumType.USER, photoAccessHelper.AlbumSubtype.USER_GENERIC);
let album: photoAccessHelper.Album = await albumFetchResult.getFirstObject();
let fetchResult: photoAccessHelper.FetchResult = await album.getAssets(fetchOptions);
let asset: photoAccessHelper.PhotoAsset = await fetchResult.getFirstObject();
let albumChangeRequest: photoAccessHelper.MediaAlbumChangeRequest = new photoAccessHelper.MediaAlbumChangeRequest(album);
albumChangeRequest.setCoverUri(asset.uri);
await phAccessHelper.applyChanges(albumChangeRequest);
console.info('setCoverUri successfully');
} catch (err) {
console.error(`setCoverUriDemo failed with error: ${err.code}, ${err.message}`);
}
}
```
### moveAssets11+
moveAssets(assets: Array<PhotoAsset>, targetAlbum: Album): void
从相册中移动资产到另一个目标相册。
**系统接口**：此接口为系统接口。
**系统能力**：SystemCapability.FileManagement.PhotoAccessHelper.Core
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| ---------- | ------- | ---- | ---------------------------------- |
| assets | Array<[PhotoAsset](#photoasset)> | 是 | 待从相册中移出的资产数组。 |
| targetAlbum | Album | 是 | 待移入资产的目标相册。 |
**错误码：**
接口抛出错误码的详细介绍请参见[通用错误码](../errorcode-universal.md)和[文件管理错误码](../apis-core-file-kit/errorcode-filemanagement.md)。
| 错误码ID | 错误信息 |
| -------- | ---------------------------------------- |
| 202 | Called by non-system application. |
| 401 | Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types; 3. Parameter verification failed. |
| 14000011 | System inner fail. |
| 14000016 | Operation Not Support. |
**示例：**
```ts
import { dataSharePredicates } from '@kit.ArkData';
async function example() {
console.info('moveAssetsDemo');
let predicates: dataSharePredicates.DataSharePredicates = new dataSharePredicates.DataSharePredicates();
let fetchOptions: photoAccessHelper.FetchOptions = {
fetchColumns: [],
predicates: predicates
};
try {
let albumFetchResult: photoAccessHelper.FetchResult = await phAccessHelper.getAlbums(photoAccessHelper.AlbumType.USER, photoAccessHelper.AlbumSubtype.USER_GENERIC);
let album: photoAccessHelper.Album = await albumFetchResult.getFirstObject();
let fetchResult: photoAccessHelper.FetchResult = await album.getAssets(fetchOptions);
let asset: photoAccessHelper.PhotoAsset = await fetchResult.getFirstObject();
if (albumFetchResult.isAfterLast()) {
console.error('lack of album to be moved into');
return;
}
let nextAlbum: photoAccessHelper.Album = await albumFetchResult.getNextObject();
let albumChangeRequest: photoAccessHelper.MediaAlbumChangeRequest = new photoAccessHelper.MediaAlbumChangeRequest(album);
albumChangeRequest.moveAssets([asset], nextAlbum);
await phAccessHelper.applyChanges(albumChangeRequest);
console.info('moveAssets successfully');
} catch (err) {
console.error(`moveAssetsDemo failed with error: ${err.code}, ${err.message}`);
}
}
```
### recoverAssets11+
recoverAssets(assets: Array<PhotoAsset>): void
从回收站中恢复资产。
**系统接口**：此接口为系统接口。
**系统能力**：SystemCapability.FileManagement.PhotoAccessHelper.Core
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| ---------- | ------- | ---- | ---------------------------------- |
| assets | Array<[PhotoAsset](#photoasset)> | 是 | 待从回收站中恢复的资产数组。 |
**错误码：**
接口抛出错误码的详细介绍请参见[通用错误码](../errorcode-universal.md)和[文件管理错误码](../apis-core-file-kit/errorcode-filemanagement.md)。
| 错误码ID | 错误信息 |
| -------- | ---------------------------------------- |
| 202 | Called by non-system application. |
| 401 | Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types; 3. Parameter verification failed. |
| 14000011 | System inner fail. |
| 14000016 | Operation Not Support. |
**示例：**
```ts
import { dataSharePredicates } from '@kit.ArkData';
async function example() {
console.info('recoverAssetsDemo');
let predicates: dataSharePredicates.DataSharePredicates = new dataSharePredicates.DataSharePredicates();
let fetchOptions: photoAccessHelper.FetchOptions = {
fetchColumns: [],
predicates: predicates
};
try {
let albumFetchResult: photoAccessHelper.FetchResult = await phAccessHelper.getAlbums(photoAccessHelper.AlbumType.SYSTEM, photoAccessHelper.AlbumSubtype.TRASH);
let album: photoAccessHelper.Album = await albumFetchResult.getFirstObject();
let fetchResult: photoAccessHelper.FetchResult = await album.getAssets(fetchOptions);
let asset: photoAccessHelper.PhotoAsset = await fetchResult.getFirstObject();
let albumChangeRequest: photoAccessHelper.MediaAlbumChangeRequest = new photoAccessHelper.MediaAlbumChangeRequest(album);
albumChangeRequest.recoverAssets([asset]);
await phAccessHelper.applyChanges(albumChangeRequest);
console.info('recoverAssets successfully');
} catch (err) {
console.error(`recoverAssetsDemo failed with error: ${err.code}, ${err.message}`);
}
}
```
### deleteAssets11+
deleteAssets(assets: Array<PhotoAsset>): void
从回收站中彻底删除资产。
**注意**：此操作不可逆，执行此操作后文件资源将彻底删除，请谨慎操作。
**系统接口**：此接口为系统接口。
**系统能力**：SystemCapability.FileManagement.PhotoAccessHelper.Core
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| ---------- | ------- | ---- | ---------------------------------- |
| assets | Array<[PhotoAsset](#photoasset)> | 是 | 待从回收站中彻底删除的资产数组。 |
**错误码：**
接口抛出错误码的详细介绍请参见[通用错误码](../errorcode-universal.md)和[文件管理错误码](../apis-core-file-kit/errorcode-filemanagement.md)。
| 错误码ID | 错误信息 |
| -------- | ---------------------------------------- |
| 202 | Called by non-system application. |
| 401 | Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types; 3. Parameter verification failed. |
| 14000011 | System inner fail. |
| 14000016 | Operation Not Support. |
**示例：**
```ts
import { dataSharePredicates } from '@kit.ArkData';
async function example() {
console.info('deleteAssetsPermanentlyDemo');
let predicates: dataSharePredicates.DataSharePredicates = new dataSharePredicates.DataSharePredicates();
let fetchOptions: photoAccessHelper.FetchOptions = {
fetchColumns: [],
predicates: predicates
};
try {
let albumFetchResult: photoAccessHelper.FetchResult = await phAccessHelper.getAlbums(photoAccessHelper.AlbumType.SYSTEM, photoAccessHelper.AlbumSubtype.TRASH);
let album: photoAccessHelper.Album = await albumFetchResult.getFirstObject();
let fetchResult: photoAccessHelper.FetchResult = await album.getAssets(fetchOptions);
let asset: photoAccessHelper.PhotoAsset = await fetchResult.getFirstObject();
let albumChangeRequest: photoAccessHelper.MediaAlbumChangeRequest = new photoAccessHelper.MediaAlbumChangeRequest(album);
albumChangeRequest.deleteAssets([asset]);
await phAccessHelper.applyChanges(albumChangeRequest);
console.info('succeed to deleteAssets permanently');
} catch (err) {
console.error(`deleteAssetsPermanentlyDemo failed with error: ${err.code}, ${err.message}`);
}
}
```
### setDisplayLevel11+
setDisplayLevel(displayLevel: number): void
设置人像相册的显示级别。
**系统接口**：此接口为系统接口。
**系统能力**：SystemCapability.FileManagement.PhotoAccessHelper.Core
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| ---------- | ------- | ---- | ---------------------------------- |
| displayLevel | number | 是 | 设置人像相册的显示级别， 0：取消该人像相册收藏；1：设置人像相册为首届面；2：设置人像相册为更多界面；3：设置人像相册为收藏界面。 |
**错误码：**
接口抛出错误码的详细介绍请参见[通用错误码](../errorcode-universal.md)和[文件管理错误码](../apis-core-file-kit/errorcode-filemanagement.md)。
| 错误码ID | 错误信息 |
| -------- | ---------------------------------------- |
| 202 | Called by non-system application. |
| 401 | Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types; 3. Parameter verification failed. |
| 14000011 | System inner fail. |
**示例：**
``` ts
import { dataSharePredicates } from '@kit.ArkData';
async function example() {
try {
console.info('setDisplayLevel Example')
let predicates: dataSharePredicates.DataSharePredicates = new dataSharePredicates.DataSharePredicates();
predicates.equalTo('user_display_level', 2);
let fetchOptions: photoAccessHelper.FetchOptions = {
fetchColumns: [],
predicates: predicates
};
let fetchResult: photoAccessHelper.FetchResult = await phAccessHelper.getAlbums(photoAccessHelper.AlbumType.SMART, photoAccessHelper.AlbumSubtype.PORTRAIT, fetchOptions);
let album: photoAccessHelper.Album = await fetchResult.getFirstObject();
let changeRequest: photoAccessHelper.MediaAlbumChangeRequest = new photoAccessHelper.MediaAlbumChangeRequest(album);
changeRequest.setDisplayLevel(1);
await phAccessHelper.applyChanges(changeRequest);
} catch (err) {
console.error(`setDisplayLevel failed with error: ${err.code}, ${err.message}`);
}
}
```
### setIsMe11+
setIsMe(): void
将人像相册的人物关系设置为“我”。
**系统接口**：此接口为系统接口。
**系统能力**：SystemCapability.FileManagement.PhotoAccessHelper.Core
**错误码：**
接口抛出错误码的详细介绍请参见[通用错误码](../errorcode-universal.md)和[文件管理错误码](../apis-core-file-kit/errorcode-filemanagement.md)。
| 错误码ID | 错误信息 |
| -------- | ---------------------------------------- |
| 202 | Called by non-system application. |
| 401 | Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types. |
| 14000011 | System inner fail. |
**示例：**
``` ts
import { dataSharePredicates } from '@kit.ArkData';
async function example() {
try {
console.info('setIsMe Example')
let predicates: dataSharePredicates.DataSharePredicates = new dataSharePredicates.DataSharePredicates();
predicates.equalTo('user_display_level', 2);
let fetchOptions: photoAccessHelper.FetchOptions = {
fetchColumns: [],
predicates: predicates
};
let fetchResult: photoAccessHelper.FetchResult = await phAccessHelper.getAlbums(photoAccessHelper.AlbumType.SMART, photoAccessHelper.AlbumSubtype.PORTRAIT, fetchOptions);
let album: photoAccessHelper.Album = await fetchResult.getFirstObject();
let changeRequest: photoAccessHelper.MediaAlbumChangeRequest = new photoAccessHelper.MediaAlbumChangeRequest(album);
changeRequest.setIsMe();
await phAccessHelper.applyChanges(changeRequest);
} catch (err) {
console.error(`setIsMe failed with error: ${err.code}, ${err.message}`);
}
}
```
### dismissAssets11+
dismissAssets(assets: Array<PhotoAsset>): void
从该人像相册或合影相册中移除指定图片。
**系统接口**：此接口为系统接口。
**系统能力**：SystemCapability.FileManagement.PhotoAccessHelper.Core
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| ---------- | ------- | ---- | ---------------------------------- |
| assets | Array<PhotoAsset> | 是 | 需要移除的文件列表 。 |
**错误码：**
接口抛出错误码的详细介绍请参见[通用错误码](../errorcode-universal.md)和[文件管理错误码](../apis-core-file-kit/errorcode-filemanagement.md)。
| 错误码ID | 错误信息 |
| -------- | ---------------------------------------- |
| 202 | Called by non-system application. |
| 401 | Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types; 3. Parameter verification failed. |
| 14000011 | System inner fail. |
| 14000016 | Operation Not support. |
**示例：**
``` ts
import { dataSharePredicates } from '@kit.ArkData';
async function example() {
try {
console.info('dismissAssets Example')
let predicates: dataSharePredicates.DataSharePredicates = new dataSharePredicates.DataSharePredicates();
predicates.equalTo('user_display_level', 2);
let fetchOptions: photoAccessHelper.FetchOptions = {
fetchColumns: [],
predicates: predicates
};
let fetchResult: photoAccessHelper.FetchResult = await phAccessHelper.getAlbums(photoAccessHelper.AlbumType.SMART, photoAccessHelper.AlbumSubtype.PORTRAIT, fetchOptions);
let album: photoAccessHelper.Album = await fetchResult.getFirstObject();
let predicatesAsset: dataSharePredicates.DataSharePredicates = new dataSharePredicates.DataSharePredicates();
let assetFetchOptions: photoAccessHelper.FetchOptions = {
fetchColumns: [],
predicates: predicatesAsset
};
let assetFetchResult: photoAccessHelper.FetchResult = await phAccessHelper.getAssets(assetFetchOptions);
let asset: photoAccessHelper.PhotoAsset = await assetFetchResult.getFirstObject();
let changeRequest: photoAccessHelper.MediaAlbumChangeRequest = new photoAccessHelper.MediaAlbumChangeRequest(album);
changeRequest.dismissAssets([asset]);
await phAccessHelper.applyChanges(changeRequest);
} catch (err) {
console.error(`dismissAssets failed with error: ${err.code}, ${err.message}`);
}
}
```
### mergeAlbum11+
mergeAlbum(target: Album): void
将两个人像相册合并。
**系统接口**：此接口为系统接口。
**系统能力**：SystemCapability.FileManagement.PhotoAccessHelper.Core
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| ---------- | ------- | ---- | ---------------------------------- |
| target | [Album](#album) | 是 | 需要合并的目标相册，合并相册必须重命名。 |
**错误码：**
接口抛出错误码的详细介绍请参见[通用错误码](../errorcode-universal.md)和[文件管理错误码](../apis-core-file-kit/errorcode-filemanagement.md)。
| 错误码ID | 错误信息 |
| -------- | ---------------------------------------- |
| 202 | Called by non-system application. |
| 401 | Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types; 3. Parameter verification failed. |
| 14000011 | System inner fail. |
| 14000016 | Operation Not support. |
**示例：**
``` ts
import { dataSharePredicates } from '@kit.ArkData';
async function example() {
try {
console.info('mergeAlbum Example')
let predicates: dataSharePredicates.DataSharePredicates = new dataSharePredicates.DataSharePredicates();
predicates.equalTo('user_display_level', 2);
let fetchOptions: photoAccessHelper.FetchOptions = {
fetchColumns: [],
predicates: predicates
};
let fetchResult: photoAccessHelper.FetchResult = await phAccessHelper.getAlbums(photoAccessHelper.AlbumType.SMART, photoAccessHelper.AlbumSubtype.PORTRAIT, fetchOptions);
let album: photoAccessHelper.Album = await fetchResult.getFirstObject();
if (fetchResult.isAfterLast()) {
console.error('lack of album to merge');
return;
}
let target: photoAccessHelper.Album = await fetchResult.getNextObject();
let changeRequest: photoAccessHelper.MediaAlbumChangeRequest = new photoAccessHelper.MediaAlbumChangeRequest(album);
changeRequest.mergeAlbum(target);
changeRequest.setAlbumName("testName");
await phAccessHelper.applyChanges(changeRequest);
} catch (err) {
console.error(`mergeAlbum failed with error: ${err.code}, ${err.message}`);
}
}
```
### placeBefore11+
placeBefore(album: Album): void;
将当前相册排序到目标相册之前。
**系统接口**：此接口为系统接口。
**系统能力**：SystemCapability.FileManagement.PhotoAccessHelper.Core
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| ---------- | ------- | ---- | ---------------------------------- |
| album | [Album](#album) | 是 | 目标相册。如果要将当前相册排序到末位，则目标相册传入null。 |
**错误码：**
接口抛出错误码的详细介绍请参见[通用错误码](../errorcode-universal.md)和[文件管理错误码](../apis-core-file-kit/errorcode-filemanagement.md)。
| 错误码ID | 错误信息 |
| -------- | ---------------------------------------- |
| 202 | Called by non-system application. |
| 401 | Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types; 3. Parameter verification failed. |
| 14000011 | System inner fail. |
**示例：**
```ts
async function example() {
console.info('placeBeforeDemo');
try {
let albumFetchResult: photoAccessHelper.FetchResult = await phAccessHelper.getAlbums(photoAccessHelper.AlbumType.USER, photoAccessHelper.AlbumSubtype.USER_GENERIC);
let firstAlbum: photoAccessHelper.Album = await albumFetchResult.getFirstObject();
if (albumFetchResult.isAfterLast()) {
console.error('lack of album to place before');
return;
}
let secondAlbum: photoAccessHelper.Album = await albumFetchResult.getNextObject();
let albumChangeRequest: photoAccessHelper.MediaAlbumChangeRequest = new photoAccessHelper.MediaAlbumChangeRequest(secondAlbum);
albumChangeRequest.placeBefore(firstAlbum);
await phAccessHelper.applyChanges(albumChangeRequest);
console.info('placeBefore successfully');
} catch (err) {
console.error(`placeBeforeDemo failed with error: ${err.code}, ${err.message}`);
}
}
```
### dismiss13+
dismiss(): void
删除合影相册。
**系统接口**：此接口为系统接口。
**系统能力**：SystemCapability.FileManagement.PhotoAccessHelper.Core
**错误码：**
接口抛出错误码的详细介绍请参见[通用错误码](../errorcode-universal.md)和[文件管理错误码](../apis-core-file-kit/errorcode-filemanagement.md)。
| 错误码ID | 错误信息 |
| :------- | :-------------------------------- |
| 202 | Called by non-system application. |
| 401 | Parameter error. Possible causes: Incorrect parameter types. |
| 14000011 | System inner fail. |
**示例：**
```ts
import { dataSharePredicates } from '@kit.ArkData';
async function example() {
console.info('dismissDemo');
try {
let albumFetchResult: photoAccessHelper.FetchResult = await phAccessHelper.getAlbums(photoAccessHelper.AlbumType.SMART, photoAccessHelper.AlbumSubtype.GROUP_PHOTO);
let album: photoAccessHelper.Album = await albumFetchResult.getFirstObject();
let albumChangeRequest: photoAccessHelper.MediaAlbumChangeRequest = new photoAccessHelper.MediaAlbumChangeRequest(album);
albumChangeRequest.dismiss();
await phAccessHelper.applyChanges(albumChangeRequest);
console.info('dismiss successfully');
} catch (err) {
console.error(`dismissDemo failed with error: ${err.code}, ${err.message}`);
}
}
```
## HighlightAlbum12+
时刻相册。
**系统接口**：此接口为系统接口。
**系统能力**：SystemCapability.FileManagement.PhotoAccessHelper.Core
### constructor12+
constructor(album: Album)
构造函数。
**系统接口**：此接口为系统接口。
**系统能力**：SystemCapability.FileManagement.PhotoAccessHelper.Core
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ------------------------- | ---- | ---------- |
| album | [Album](#album) | 是 | 智慧相册。 |
**错误码：**
接口抛出错误码的详细介绍请参见[通用错误码](../errorcode-universal.md)和[文件管理错误码](../apis-core-file-kit/errorcode-filemanagement.md)。
| 错误码ID | 错误信息 |
| -------- | ---------------------------------------- |
| 202 | Called by non-system application. |
| 401 | Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types; 3. Parameter verification failed. |
| 14000011 | Internal system error. |
**示例：**
```ts
import { dataSharePredicates } from '@kit.ArkData';
async function example() {
console.info('HighlightAlbum constructorDemo');
let predicates: dataSharePredicates.DataSharePredicates = new dataSharePredicates.DataSharePredicates();
let fetchOption: photoAccessHelper.FetchOptions = {
fetchColumns: [],
predicates: predicates
};
let albumFetchResult: photoAccessHelper.FetchResult = await photoAccessHelper.getAlbums(
photoAccessHelper.AlbumType.SMART, photoAccessHelper.AlbumSubtype.HIGHLIGHT, fetchOption);
let album: photoAccessHelper.Album = await albumFetchResult.getFirstObject();
let highlightAlbum: photoAccessHelper.HighlightAlbum = new photoAccessHelper.HighlightAlbum(album);
albumFetchResult.close();
}
```
### getHighlightAlbumInfo12+
getHighlightAlbumInfo(type: HighlightAlbumInfoType): Promise<string>
获取指定时刻相册的特定信息。
**系统接口**：此接口为系统接口。
**需要权限**：ohos.permission.READ\_IMAGEVIDEO
**系统能力**：SystemCapability.FileManagement.PhotoAccessHelper.Core
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| ---------- | ------- | ---- | ---------------------------------- |
| type | [HighlightAlbumInfoType](#highlightalbuminfotype12) | 是 | 需要获取的时刻相册信息类型。 |
**错误码：**
接口抛出错误码的详细介绍请参见[通用错误码](../errorcode-universal.md)和[文件管理错误码](../apis-core-file-kit/errorcode-filemanagement.md)。
| 错误码ID | 错误信息 |
| :------- | :-------------------------------- |
| 201 | Permission denied. |
| 202 | Called by non-system application. |
| 401 | Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types; 3. Parameter verification failed. |
| 14000011 | Internal system error. |
**示例：**
```ts
import { dataSharePredicates } from '@kit.ArkData';
async function example() {
try {
console.info('getHighlightAlbumInfoDemo')
let fetchOptions: photoAccessHelper.FetchOptions = {
fetchColumns: [],
predicates: new dataSharePredicates.DataSharePredicates()
}
let albumFetchResult: photoAccessHelper.FetchResult = await photoAccessHelper.getAlbums(
photoAccessHelper.AlbumType.SMART, photoAccessHelper.AlbumSubtype.HIGHLIGHT, fetchOption);
let album: photoAccessHelper.Album = await albumFetchResult.getFirstObject();、
if (album != undefined) {
let highlightAlbum: photoAccessHelper.HighlightAlbum = new photoAccessHelper.HighlightAlbum(album);
let coverInfo: string = await highlightAlbum.getHighlightAlbumInfo(
photoAccessHelper.HighlightAlbumInfoType.COVER_INFO);
console.info('get cover info result: ' + JSON.stringify(coverInfo));
}
albumFetchResult.close();
} catch (err) {
console.error(`getHighlightAlbumInfoDemofailed with error: ${err.code}, ${err.message}`);
}
}
```
### getHighlightResource12+
getHighlightResource(resourceUri: string): Promise<ArrayBuffer>
获取指定时刻缓存资源的ArrayBuffer。
**系统接口**：此接口为系统接口。
**需要权限**：ohos.permission.READ\_IMAGEVIDEO
**系统能力**：SystemCapability.FileManagement.PhotoAccessHelper.Core
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| ---------- | ------- | ---- | ---------------------------------- |
| resourceUri | string | 是 | 指定时刻缓存资源uri。 |
**错误码：**
接口抛出错误码的详细介绍请参见[通用错误码](../errorcode-universal.md)和[文件管理错误码](../apis-core-file-kit/errorcode-filemanagement.md)。
| 错误码ID | 错误信息 |
| :------- | :-------------------------------- |
| 201 | Permission denied. |
| 202 | Called by non-system application. |
| 401 | Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types; 3. Parameter verification failed. |
| 14000011 | Internal system error. |
**示例：**
```ts
import { dataSharePredicates } from '@kit.ArkData';
async function example() {
try {
console.info('getHighlightResourceDemo')
let fetchOptions: photoAccessHelper.FetchOptions = {
fetchColumns: [],
predicates: new dataSharePredicates.DataSharePredicates()
}
let albumFetchResult: photoAccessHelper.FetchResult = await photoAccessHelper.getAlbums(
photoAccessHelper.AlbumType.SMART, photoAccessHelper.AlbumSubtype.HIGHLIGHT, fetchOption);
let album: photoAccessHelper.Album = await albumFetchResult.getFirstObject();、
if (album != undefined) {
let highlightAlbum: photoAccessHelper.HighlightAlbum = new photoAccessHelper.HighlightAlbum(album);
let uri: string = 'file://media/highlight/cover/10/1_1/background.png?oper=highlight'
let arrayBuffer: ArrayBuffer = await highlightAlbum.getHighlightResource(uri);
}
albumFetchResult.close();
} catch (err) {
console.error(`getHighlightResourceDemofailed with error: ${err.code}, ${err.message}`);
}
}
```
### setHighlightUserActionData12+
setHighlightUserActionData(type: HighlightUserActionType, actionData: number): Promise<void>
设置指定时刻用户行为数据。
**系统接口**：此接口为系统接口。
**需要权限**：ohos.permission.WRITE\_IMAGEVIDEO
**系统能力**：SystemCapability.FileManagement.PhotoAccessHelper.Core
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| ---------- | ------- | ---- | ---------------------------------- |
| type | [HighlightUserActionType](#highlightuseractiontype12) | 是 | 需要设置的用户行为数据类型。 |
| actionData | number | 是 | 行为数据。 |
**错误码：**
接口抛出错误码的详细介绍请参见[通用错误码](../errorcode-universal.md)和[文件管理错误码](../apis-core-file-kit/errorcode-filemanagement.md)。
| 错误码ID | 错误信息 |
| :------- | :-------------------------------- |
| 201 | Permission denied. |
| 202 | Called by non-system application. |
| 401 | Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types; 3. Parameter verification failed. |
| 14000011 | Internal system error. |
**示例：**
```ts
import { dataSharePredicates } from '@kit.ArkData';
async function example() {
try {
console.info('setHighlightUserActionDataDemo')
let fetchOptions: photoAccessHelper.FetchOptions = {
fetchColumns: [],
predicates: new dataSharePredicates.DataSharePredicates()
}
let albumFetchResult: photoAccessHelper.FetchResult = await photoAccessHelper.getAlbums(
photoAccessHelper.AlbumType.SMART, photoAccessHelper.AlbumSubtype.HIGHLIGHT, fetchOption);
let album: photoAccessHelper.Album = await albumFetchResult.getFirstObject();、
if (album != undefined) {
let highlightAlbum: photoAccessHelper.HighlightAlbum = new photoAccessHelper.HighlightAlbum(album);
highlightAlbum.setHighlightUserActionData(photoAccessHelper.HighlightUserActionType.INSERTED_PIC_COUNT, 1);
}
albumFetchResult.close();
} catch (err) {
console.error(`setHighlightUserActionDataDemofailed with error: ${err.code}, ${err.message}`);
}
}
```
## CloudEnhancement13+
云增强管理类，该类用于生成AI云增强照片任务的管理、获取原照片与AI云增强照片的关联关系。
**系统接口**：此接口为系统接口。
**系统能力**：SystemCapability.FileManagement.PhotoAccessHelper.Core
### getCloudEnhancementInstance13+
static getCloudEnhancementInstance(context: Context): CloudEnhancement
获取云增强类实例。
**系统接口**：此接口为系统接口。
**系统能力**：SystemCapability.FileManagement.PhotoAccessHelper.Core
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ------------------------- | ---- | ---------- |
| context | [Context](../apis-ability-kit/js-apis-inner-application-context.md) | 是 | 传入Ability实例的Context。 |
**错误码：**
接口抛出错误码的详细介绍请参见[通用错误码](../errorcode-universal.md)和[文件管理错误码](../apis-core-file-kit/errorcode-filemanagement.md)。
| 错误码ID | 错误信息 |
| -------- | ---------------------------------------- |
| 202 | Called by non-system application. |
| 401 | Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types; 3. Parameter verification failed. |
| 14000011 | Internal system error. |
**示例：**
```ts
import { dataSharePredicates } from '@kit.ArkData';
async function example() {
console.info('getCloudEnhancementInstanceDemo');
let photoPredicates: dataSharePredicates.DataSharePredicates = new dataSharePredicates.DataSharePredicates();
let photoFetchOptions: photoAccessHelper.FetchOptions = {
fetchColumns: [],
predicates: photoPredicates
};
let phAccessHelper = photoAccessHelper.getPhotoAccessHelper(context);
try {
let fetchResult = await phAccessHelper.getAssets(photoFetchOptions);
let asset = await fetchResult.getLastObject();
let cloudEnhancementInstance: photoAccessHelper.CloudEnhancement
= photoAccessHelper.CloudEnhancement.getCloudEnhancementInstance(context);
let hasCloudWatermark = true;
await cloudEnhancementInstance.submitCloudEnhancementTasks([asset], hasCloudWatermark);
} catch (err) {
console.error(`getCloudEnhancementInstanceDemo failed with error: ${err.code}, ${err.message}`);
}
}
```
### submitCloudEnhancementTasks13+
submitCloudEnhancementTasks(photoAssets: Array<PhotoAsset>, hasCloudWatermark: boolean): Promise<void>
提交云增强任务。
**系统接口**：此接口为系统接口。
**系统能力**：SystemCapability.FileManagement.PhotoAccessHelper.Core
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ------------------------- | ---- | ---------- |
| photoAssets | Array<[PhotoAsset](#photoasset)> | 是 | 需要增强照片的[PhotoAsset](#photoasset)集合。 |
| hasCloudWatermark | boolean | 是 | 增强后图片是否添加云增强水印。 |
**错误码：**
接口抛出错误码的详细介绍请参见[通用错误码](../errorcode-universal.md)和[文件管理错误码](../apis-core-file-kit/errorcode-filemanagement.md)。
| 错误码ID | 错误信息 |
| -------- | ---------------------------------------- |
| 201 | Permission denied. |
| 202 | Called by non-system application. |
| 401 | Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types; 3. Parameter verification failed. |
| 14000011 | Internal system error. |
**示例：**
```ts
import { dataSharePredicates } from '@kit.ArkData';
async function example() {
console.info('submitCloudEnhancementTasksDemo');
let photoPredicates: dataSharePredicates.DataSharePredicates = new dataSharePredicates.DataSharePredicates();
let photoFetchOptions: photoAccessHelper.FetchOptions = {
fetchColumns: [],
predicates: photoPredicates
};
let phAccessHelper = photoAccessHelper.getPhotoAccessHelper(context);
try {
let fetchResult = await phAccessHelper.getAssets(photoFetchOptions);
let asset = await fetchResult.getLastObject();
let cloudEnhancementInstance: photoAccessHelper.CloudEnhancement
= photoAccessHelper.CloudEnhancement.getCloudEnhancementInstance(context);
let hasCloudWatermark = true;
await cloudEnhancementInstance.submitCloudEnhancementTasks([asset], hasCloudWatermark);
} catch (err) {
console.error(`submitCloudEnhancementTasksDemo failed with error: ${err.code}, ${err.message}`);
}
}
```
### prioritizeCloudEnhancementTask13+
prioritizeCloudEnhancementTask(photoAsset: PhotoAsset): Promise<void>
提升指定云增强任务的优先级。
**系统接口**：此接口为系统接口。
**系统能力**：SystemCapability.FileManagement.PhotoAccessHelper.Core
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ------------------------- | ---- | ---------- |
| photoAsset | [PhotoAsset](#photoasset) | 是 | 需要修改云增强优先级照片的[PhotoAsset](#photoasset)。 |
**错误码：**
接口抛出错误码的详细介绍请参见[通用错误码](../errorcode-universal.md)和[文件管理错误码](../apis-core-file-kit/errorcode-filemanagement.md)。
| 错误码ID | 错误信息 |
| -------- | ---------------------------------------- |
| 201 | Permission denied. |
| 202 | Called by non-system application. |
| 401 | Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types; 3. Parameter verification failed. |
| 14000011 | Internal system error. |
**示例：**
```ts
import { dataSharePredicates } from '@kit.ArkData';
async function example() {
console.info('prioritizeCloudEnhancementTaskDemo');
let photoPredicates: dataSharePredicates.DataSharePredicates = new dataSharePredicates.DataSharePredicates();
// 查询进行中的云增强任务
photoPredicates.equalTo(photoAccessHelper.PhotoKeys.CE_AVAILABLE, 2);
let photoFetchOptions: photoAccessHelper.FetchOptions = {
fetchColumns: [],
predicates: photoPredicates
};
let phAccessHelper = photoAccessHelper.getPhotoAccessHelper(context);
try {
let fetchResult = await phAccessHelper.getAssets(photoFetchOptions);
let asset = await fetchResult.getLastObject();
let cloudEnhancementInstance: photoAccessHelper.CloudEnhancement
= photoAccessHelper.CloudEnhancement.getCloudEnhancementInstance(context);
let hasCloudWatermark = true;
await cloudEnhancementInstance.prioritizeCloudEnhancementTask(asset);
} catch (err) {
console.error(`prioritizeCloudEnhancementTaskDemo failed with error: ${err.code}, ${err.message}`);
}
}
```
### cancelCloudEnhancementTasks13+
cancelCloudEnhancementTasks(photoAssets: Array<PhotoAsset>): Promise<void>
取消指定云增强任务。
**系统接口**：此接口为系统接口。
**系统能力**：SystemCapability.FileManagement.PhotoAccessHelper.Core
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ------------------------- | ---- | ---------- |
| photoAssets | Array<[PhotoAsset](#photoasset)> | 是 | 需要取消云增强任务的[PhotoAsset](#photoasset)集合。 |
**错误码：**
接口抛出错误码的详细介绍请参见[通用错误码](../errorcode-universal.md)和[文件管理错误码](../apis-core-file-kit/errorcode-filemanagement.md)。
| 错误码ID | 错误信息 |
| -------- | ---------------------------------------- |
| 201 | Permission denied. |
| 202 | Called by non-system application. |
| 401 | Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types; 3. Parameter verification failed. |
| 14000011 | Internal system error. |
**示例：**
```ts
import { dataSharePredicates } from '@kit.ArkData';
async function example() {
console.info('cancelCloudEnhancementTasksDemo');
let photoPredicates: dataSharePredicates.DataSharePredicates = new dataSharePredicates.DataSharePredicates();
// 查询进行中的云增强任务
photoPredicates.equalTo(photoAccessHelper.PhotoKeys.CE_AVAILABLE, 2);
let photoFetchOptions: photoAccessHelper.FetchOptions = {
fetchColumns: [],
predicates: photoPredicates
};
let phAccessHelper = photoAccessHelper.getPhotoAccessHelper(context);
try {
let fetchResult = await phAccessHelper.getAssets(photoFetchOptions);
let asset = await fetchResult.getLastObject();
let cloudEnhancementInstance: photoAccessHelper.CloudEnhancement
= photoAccessHelper.CloudEnhancement.getCloudEnhancementInstance(context);
await cloudEnhancementInstance.cancelCloudEnhancementTasks([asset]);
} catch (err) {
console.error(`cancelCloudEnhancementTasksDemo failed with error: ${err.code}, ${err.message}`);
}
}
```
### cancelAllCloudEnhancementTasks13+
cancelAllCloudEnhancementTasks(): Promise<void>
取消全部云增强任务。
**系统接口**：此接口为系统接口。
**系统能力**：SystemCapability.FileManagement.PhotoAccessHelper.Core
**错误码：**
接口抛出错误码的详细介绍请参见[通用错误码](../errorcode-universal.md)和[文件管理错误码](../apis-core-file-kit/errorcode-filemanagement.md)。
| 错误码ID | 错误信息 |
| -------- | ---------------------------------------- |
| 201 | Permission denied. |
| 202 | Called by non-system application. |
| 14000011 | Internal system error. |
**示例：**
```ts
import { dataSharePredicates } from '@kit.ArkData';
async function example() {
console.info('cancelAllCloudEnhancementTasksDemo');
try {
let cloudEnhancementInstance: photoAccessHelper.CloudEnhancement
= photoAccessHelper.CloudEnhancement.getCloudEnhancementInstance(context);
await cloudEnhancementInstance.cancelCloudEnhancementTasks();
} catch (err) {
console.error(`cancelAllCloudEnhancementTasksDemo failed with error: ${err.code}, ${err.message}`);
}
}
```
### queryCloudEnhancementTaskState13+
queryCloudEnhancementTaskState(photoAsset: PhotoAsset): Promise<CloudEnhancementTaskState>
查询云增强任务信息。
**系统接口**：此接口为系统接口。
**系统能力**：SystemCapability.FileManagement.PhotoAccessHelper.Core
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ------------------------- | ---- | ---------- |
| photoAsset | [PhotoAsset](#photoasset) | 是 | 需要查询云增强任务信息的[PhotoAsset](#photoasset)。 |
**错误码：**
接口抛出错误码的详细介绍请参见[通用错误码](../errorcode-universal.md)和[文件管理错误码](../apis-core-file-kit/errorcode-filemanagement.md)。
| 错误码ID | 错误信息 |
| -------- | ---------------------------------------- |
| 201 | Permission denied. |
| 202 | Called by non-system application. |
| 401 | Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types; 3. Parameter verification failed. |
| 14000011 | Internal system error. |
**示例：**
```ts
import { dataSharePredicates } from '@kit.ArkData';
async function example() {
console.info('queryCloudEnhancementTaskStateDemo');
let photoPredicates: dataSharePredicates.DataSharePredicates = new dataSharePredicates.DataSharePredicates();
// 查询进行中的云增强任务
photoPredicates.equalTo(photoAccessHelper.PhotoKeys.CE_AVAILABLE, 2);
let photoFetchOptions: photoAccessHelper.FetchOptions = {
fetchColumns: [],
predicates: photoPredicates
};
let phAccessHelper = photoAccessHelper.getPhotoAccessHelper(context);
try {
let fetchResult = await phAccessHelper.getAssets(photoFetchOptions);
let asset = await fetchResult.getLastObject();
let cloudEnhancementInstance: photoAccessHelper.CloudEnhancement
= photoAccessHelper.CloudEnhancement.getCloudEnhancementInstance(context);
const cloudEnhancementTaskState: photoAccessHelper.CloudEnhancementTaskState
= await cloudEnhancementInstance.queryCloudEnhancementTaskState(asset);
let taskStage = cloudEnhancementTaskState.taskStage;
if (taskStage == photoAccessHelper.CloudEnhancementTaskStage.TASK_STAGE_EXCEPTION) {
console.log("task has exception");
} else if (taskStage == photoAccessHelper.CloudEnhancementTaskStage.TASK_STAGE_PREPARING) {
console.log("task is preparing");
} else if (taskStage == photoAccessHelper.CloudEnhancementTaskStage.TASK_STAGE_UPLOADING) {
let transferredFileSize = cloudEnhancementTaskState.transferredFileSize;
let totalFileSize = cloudEnhancementTaskState.totalFileSize;
let message = `task is uploading, transferredFileSize: ${transferredFileSize}, totalFileSize: ${totalFileSize}`;
console.log(message);
} else if (taskStage == photoAccessHelper.CloudEnhancementTaskStage.TASK_STAGE_EXECUTING) {
let expectedDuration = cloudEnhancementTaskState.expectedDuration;
let message = `task is executing, expectedDuration: ${expectedDuration}`;
console.log(message);
} else if (taskStage == photoAccessHelper.CloudEnhancementTaskStage.TASK_STAGE_DOWNLOADING) {
let transferredFileSize = cloudEnhancementTaskState.transferredFileSize;
let totalFileSize = cloudEnhancementTaskState.totalFileSize;
let message = `task is downloading, transferredFileSize: ${transferredFileSize}, totalFileSize: ${totalFileSize}`;
console.log(message);
} else if (taskStage == photoAccessHelper.CloudEnhancementTaskStage.TASK_STAGE_FAILED) {
let errCode = cloudEnhancementTaskState.statusCode;
let message = `task is failed, errCode: ${errCode}`;
console.log(message);
} else if (taskStage == photoAccessHelper.CloudEnhancementTaskStage.TASK_STAGE_COMPLETED) {
console.log("task is completed");
}
} catch (err) {
console.error(`queryCloudEnhancementTaskStateDemo failed with error: ${err.code}, ${err.message}`);
}
}
```
### syncCloudEnhancementTaskStatus13+
syncCloudEnhancementTaskStatus(): Promise<void>
同步云增强任务状态。
**系统接口**：此接口为系统接口。
**系统能力**：SystemCapability.FileManagement.PhotoAccessHelper.Core
**错误码：**
接口抛出错误码的详细介绍请参见[通用错误码](../errorcode-universal.md)和[文件管理错误码](../apis-core-file-kit/errorcode-filemanagement.md)。
| 错误码ID | 错误信息 |
| -------- | ---------------------------------------- |
| 201 | Permission denied. |
| 202 | Called by non-system application. |
| 14000011 | Internal system error. |
**示例：**
```ts
import { dataSharePredicates } from '@kit.ArkData';
async function example() {
console.info('syncCloudEnhancementTaskStatusDemo');
try {
let cloudEnhancementInstance: photoAccessHelper.CloudEnhancement
= photoAccessHelper.CloudEnhancement.getCloudEnhancementInstance(context);
await cloudEnhancementInstance.syncCloudEnhancementTaskStatus();
} catch (err) {
console.error(`syncCloudEnhancementTaskStatusDemo failed with error: ${err.code}, ${err.message}`);
}
}
```
### getCloudEnhancementPair13+
getCloudEnhancementPair(asset: PhotoAsset): Promise<PhotoAsset>
查询云增强配对照片。
**系统接口**：此接口为系统接口。
**系统能力**：SystemCapability.FileManagement.PhotoAccessHelper.Core
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ------------------------- | ---- | ---------- |
| photoAsset | [PhotoAsset](#photoasset) | 是 | 需要查询云增强配对照片的[PhotoAsset](#photoasset)。 |
**错误码：**
接口抛出错误码的详细介绍请参见[通用错误码](../errorcode-universal.md)和[文件管理错误码](../apis-core-file-kit/errorcode-filemanagement.md)。
| 错误码ID | 错误信息 |
| -------- | ---------------------------------------- |
| 201 | Permission denied. |
| 202 | Called by non-system application. |
| 401 | Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types; 3. Parameter verification failed. |
| 14000011 | Internal system error. |
**示例：**
```ts
import { dataSharePredicates } from '@kit.ArkData';
async function example() {
console.info('getCloudEnhancementPairDemo');
let photoPredicates: dataSharePredicates.DataSharePredicates = new dataSharePredicates.DataSharePredicates();
// 查询已完成的云增强任务
photoPredicates.equalTo(photoAccessHelper.PhotoKeys.CE_AVAILABLE, 5);
let photoFetchOptions: photoAccessHelper.FetchOptions = {
fetchColumns: [],
predicates: photoPredicates
};
let phAccessHelper = photoAccessHelper.getPhotoAccessHelper(context);
try {
let fetchResult = await phAccessHelper.getAssets(photoFetchOptions);
let asset = await fetchResult.getLastObject();
let cloudEnhancementInstance: photoAccessHelper.CloudEnhancement
= photoAccessHelper.CloudEnhancement.getCloudEnhancementInstance(context);
let photoAsset: photoAccessHelper.PhotoAsset
= await cloudEnhancementInstance.getCloudEnhancementPair(asset);
} catch (err) {
console.error(`getCloudEnhancementPairDemo failed with error: ${err.code}, ${err.message}`);
}
}
```
### setVideoEnhancementAttr13+
setVideoEnhancementAttr(videoEnhancementType: VideoEnhancementType, photoId: string): Promise<void>
设置视频的二阶段增强处理类型。
**系统接口**：此接口为系统接口。
**需要权限**：ohos.permission.WRITE\_IMAGEVIDEO
**系统能力**：SystemCapability.FileManagement.PhotoAccessHelper.Core
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| ---------- | ------- | ---- | ---------------------------------- |
| videoEnhancementType | [VideoEnhancementType](#videoenhancementtype13) | 是 | 需要进行分段式视频的处理类型。 |
| photoId | string | 是 | 图片的photoId。 |
**错误码：**
接口抛出错误码的详细介绍请参见[通用错误码](../errorcode-universal.md)和[文件管理错误码](../apis-core-file-kit/errorcode-filemanagement.md)。
| 错误码ID | 错误信息 |
| :------- | :-------------------------------- |
| 202 | Called by non-system application. |
| 401 | Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types; 3. Parameter verification failed. |
| 14000011 | Internal system error. |
| 14000016 | Operation Not Support. |
**示例：**
```ts
async function example(asset: photoAccessHelper.PhotoAsset) {
try {
let assetChangeRequest: photoAccessHelper.MediaAssetChangeRequest = new photoAccessHelper.MediaAssetChangeRequest(asset);
let photoId = "202410011800";
assetChangeRequest.setVideoEnhancementAttr(photoAccessHelper.VideoEnhancementType.QUALITY_ENHANCEMENT_LOCAL, photoId);
await phAccessHelper.applyChanges(assetChangeRequest);
} catch (err) {
console.error(`setVideoEnhancementAttr fail with error: ${err.code}, ${err.message}`);
}
}
```
### getFaceId13+
getFaceId(): Promise\
获取人像相册或合影相册的封面人脸标识。
**系统接口**：此接口为系统接口。
**需要权限**：ohos.permission.READ\_IMAGEVIDEO
**系统能力**：SystemCapability.FileManagement.PhotoAccessHelper.Core
**返回值：**
| 类型 | 说明 |
| :------------------ | :---------------------------------- |
| Promise<string> | Promise对象，人像相册返回tag_id，合影相册返回group_tag，未找到返回空字符串。 |
**错误码：**
接口抛出错误码的详细介绍请参见[通用错误码](../errorcode-universal.md)和[文件管理错误码](../apis-core-file-kit/errorcode-filemanagement.md)。
| 错误码ID | 错误信息 |
| :------- | :----------------------------------------------------------- |
| 201 | Permission denied. |
| 202 | Called by non-system application. |
| 14000011 | Internal system error |
**示例：**
```ts
import { dataSharePredicates } from '@kit.ArkData';
async function example() {
try {
console.info('getFaceIdDemo');
let predicates: dataSharePredicates.DataSharePredicates = new dataSharePredicates.DataSharePredicates();
predicates.equalTo("user_display_level", 1);
let fetchOptions: photoAccessHelper.FetchOptions = {
fetchColumns: [],
predicates: predicates
};
let fetchResult =
await phAccessHelper.getAlbums(photoAccessHelper.AlbumType.SMART, photoAccessHelper.AlbumSubtype.PORTRAIT,
fetchOptions);
let album = await fetchResult?.getFirstObject();
let faceId = await album?.getFaceId();
console.info(`getFaceId successfully, faceId: ${faceId}`);
fetchResult.close();
} catch (err) {
console.error(`getFaceId failed with err: ${err.code}, ${err.message}`);
}
}
```
## CloudMediaAssetManager14+
云端媒体资产管理类，该类用于管理云端资产的下载任务，以及删除云端资产在本地的数据和文件。
**系统接口**：此接口为系统接口。
**系统能力**：SystemCapability.FileManagement.PhotoAccessHelper.Core
### getCloudMediaAssetManagerInstance14+
static getCloudMediaAssetManagerInstance(context: Context): CloudMediaAssetManager
获取云端媒体资产管理类实例。
**系统接口**：此接口为系统接口。
**系统能力**：SystemCapability.FileManagement.PhotoAccessHelper.Core
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ------------------------- | ---- | ---------- |
| context | [Context](../apis-ability-kit/js-apis-inner-application-context.md) | 是 | 传入Ability实例的Context。 |
**返回值：**
| 类型 | 说明 |
| --------------------------------------- | ----------------- |
| [CloudMediaAssetManager](#cloudmediaassetmanager14) | 返回云端媒体资产管理类实例。 |
**错误码：**
接口抛出错误码的详细介绍请参见[通用错误码](../errorcode-universal.md)和[文件管理错误码](../apis-core-file-kit/errorcode-filemanagement.md)。
| 错误码ID | 错误信息 |
| -------- | ---------------------------------------- |
| 202 | Called by non-system application. |
| 401 | Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types; 3. Parameter verification failed. |
| 14000011 | Internal system error. It is recommended to retry and check the logs. Possible causes: 1. Database corrupted; 2. The file system is abnormal; 3. The IPC request timed out. |
**示例：**
```ts
import photoAccessHelper from '@ohos.file.photoAccessHelper'
const context = getContext(this);
async function example() {
console.info('getCloudMediaAssetManagerInstanceDemo');
try {
let cloudMediaAssetManagerInstance: photoAccessHelper.CloudMediaAssetManager
= photoAccessHelper.CloudMediaAssetManager.getCloudMediaAssetManagerInstance(context);
await cloudMediaAssetManagerInstance.pauseDownloadCloudMedia();
} catch (err) {
console.error(`getCloudMediaAssetManagerInstanceDemo failed with error: ${err.code}, ${err.message}`);
}
}
```
### startDownloadCloudMedia14+
startDownloadCloudMedia(downloadType: CloudMediaDownloadType): Promise<void>
开始或恢复云端媒体资产下载任务。
**系统接口**：此接口为系统接口。
**系统能力**：SystemCapability.FileManagement.PhotoAccessHelper.Core
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ------------------------- | ---- | ---------- |
| downloadType | [CloudMediaDownloadType](#cloudmediadownloadtype14) | 是 | 云端媒体资产的下载方式。 |
**返回值：**
| 类型 | 说明 |
| --------------------------------------- | ----------------- |
| Promise<void>| Promise对象，返回void。 |
**错误码：**
接口抛出错误码的详细介绍请参见[通用错误码](../errorcode-universal.md)和[文件管理错误码](../apis-core-file-kit/errorcode-filemanagement.md)。
| 错误码ID | 错误信息 |
| -------- | ---------------------------------------- |
| 201 | Permission denied. |
| 202 | Called by non-system application. |
| 401 | Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types; 3. Parameter verification failed. |
| 14000011 | Internal system error. It is recommended to retry and check the logs. Possible causes: 1. Database corrupted; 2. The file system is abnormal; 3. The IPC request timed out. |
**示例：**
```ts
import photoAccessHelper from '@ohos.file.photoAccessHelper'
const context = getContext(this);
async function example() {
console.info('startDownloadCloudMediaDemo');
try {
let cloudMediaAssetManagerInstance: photoAccessHelper.CloudMediaAssetManager
= photoAccessHelper.CloudMediaAssetManager.getCloudMediaAssetManagerInstance(context);
await cloudMediaAssetManagerInstance.startDownloadCloudMedia(photoAccessHelper.CloudMediaDownloadType.DOWNLOAD_FORCE);
} catch (err) {
console.error(`startDownloadCloudMediaDemo failed with error: ${err.code}, ${err.message}`);
}
}
```
### pauseDownloadCloudMedia14+
pauseDownloadCloudMedia(): Promise<void>
暂停云端媒体资产下载任务。
**系统接口**：此接口为系统接口。
**系统能力**：SystemCapability.FileManagement.PhotoAccessHelper.Core
**返回值：**
| 类型 | 说明 |
| --------------------------------------- | ----------------- |
| Promise<void>| Promise对象，返回void。 |
**错误码：**
接口抛出错误码的详细介绍请参见[通用错误码](../errorcode-universal.md)和[文件管理错误码](../apis-core-file-kit/errorcode-filemanagement.md)。
| 错误码ID | 错误信息 |
| -------- | ---------------------------------------- |
| 201 | Permission denied. |
| 202 | Called by non-system application. |
| 14000011 | Internal system error. It is recommended to retry and check the logs. Possible causes: 1. Database corrupted; 2. The file system is abnormal; 3. The IPC request timed out. |
**示例：**
```ts
import photoAccessHelper from '@ohos.file.photoAccessHelper'
const context = getContext(this);
async function example() {
console.info('pauseDownloadCloudMediaDemo');
try {
let cloudMediaAssetManagerInstance: photoAccessHelper.CloudMediaAssetManager
= photoAccessHelper.CloudMediaAssetManager.getCloudMediaAssetManagerInstance(context);
await cloudMediaAssetManagerInstance.pauseDownloadCloudMedia();
} catch (err) {
console.error(`pauseDownloadCloudMediaDemo failed with error: ${err.code}, ${err.message}`);
}
}
```
### cancelDownloadCloudMedia14+
cancelDownloadCloudMedia(): Promise<void>
取消云端媒体资产下载任务。
**系统接口**：此接口为系统接口。
**系统能力**：SystemCapability.FileManagement.PhotoAccessHelper.Core
**返回值：**
| 类型 | 说明 |
| --------------------------------------- | ----------------- |
| Promise<void>| Promise对象，返回void。 |
**错误码：**
接口抛出错误码的详细介绍请参见[通用错误码](../errorcode-universal.md)和[文件管理错误码](../apis-core-file-kit/errorcode-filemanagement.md)。
| 错误码ID | 错误信息 |
| -------- | ---------------------------------------- |
| 201 | Permission denied. |
| 202 | Called by non-system application. |
| 14000011 | Internal system error. It is recommended to retry and check the logs. Possible causes: 1. Database corrupted; 2. The file system is abnormal; 3. The IPC request timed out. |
**示例：**
```ts
import photoAccessHelper from '@ohos.file.photoAccessHelper'
const context = getContext(this);
async function example() {
console.info('cancelDownloadCloudMediaDemo');
try {
let cloudMediaAssetManagerInstance: photoAccessHelper.CloudMediaAssetManager
= photoAccessHelper.CloudMediaAssetManager.getCloudMediaAssetManagerInstance(context);
await cloudMediaAssetManagerInstance.cancelDownloadCloudMedia();
} catch (err) {
console.error(`cancelDownloadCloudMediaDemo failed with error: ${err.code}, ${err.message}`);
}
}
```
### retainCloudMediaAsset14+
retainCloudMediaAsset(retainType: CloudMediaRetainType): Promise<void>
删除云端媒体资产在本地的元数据和文件。
**系统接口**：此接口为系统接口。
**系统能力**：SystemCapability.FileManagement.PhotoAccessHelper.Core
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ------------------------- | ---- | ---------- |
| retainType | [CloudMediaRetainType](#cloudmediaretaintype14) | 是 | 云端媒体资产的删除方式。 |
**返回值：**
| 类型 | 说明 |
| --------------------------------------- | ----------------- |
| Promise<void>| Promise对象，返回void。 |
**错误码：**
接口抛出错误码的详细介绍请参见[通用错误码](../errorcode-universal.md)和[文件管理错误码](../apis-core-file-kit/errorcode-filemanagement.md)。
| 错误码ID | 错误信息 |
| -------- | ---------------------------------------- |
| 201 | Permission denied. |
| 202 | Called by non-system application. |
| 401 | Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types; 3. Parameter verification failed. |
| 14000011 | Internal system error. It is recommended to retry and check the logs. Possible causes: 1. Database corrupted; 2. The file system is abnormal; 3. The IPC request timed out. |
**示例：**
```ts
import photoAccessHelper from '@ohos.file.photoAccessHelper'
const context = getContext(this);
async function example() {
console.info('retainCloudMediaAssetDemo');
try {
let cloudMediaAssetManagerInstance: photoAccessHelper.CloudMediaAssetManager
= photoAccessHelper.CloudMediaAssetManager.getCloudMediaAssetManagerInstance(context);
await cloudMediaAssetManagerInstance.retainCloudMediaAsset(photoAccessHelper.CloudMediaRetainType.RETAIN_FORCE);
} catch (err) {
console.error(`retainCloudMediaAssetDemo failed with error: ${err.code}, ${err.message}`);
}
}
```
### getCloudMediaAssetStatus14+
getCloudMediaAssetStatus(): Promise<CloudMediaAssetStatus>
查询云端媒体资产下载任务状态。
**系统接口**：此接口为系统接口。
**系统能力**：SystemCapability.FileManagement.PhotoAccessHelper.Core
**返回值：**
| 类型 | 说明 |
| --------------------------------------- | ----------------- |
|Promise<[CloudMediaAssetStatus](#cloudmediaassetstatus14)> | Promise对象，返回云端媒体资产下载任务状态。 |
**错误码：**
接口抛出错误码的详细介绍请参见[通用错误码](../errorcode-universal.md)和[文件管理错误码](../apis-core-file-kit/errorcode-filemanagement.md)。
| 错误码ID | 错误信息 |
| -------- | ---------------------------------------- |
| 201 | Permission denied. |
| 202 | Called by non-system application. |
| 14000011 | Internal system error. It is recommended to retry and check the logs. Possible causes: 1. Database corrupted; 2. The file system is abnormal; 3. The IPC request timed out. |
**示例：**
```ts
import photoAccessHelper from '@ohos.file.photoAccessHelper'
const context = getContext(this);
async function example() {
console.info('getCloudMediaAssetStatusDemo');
try {
let cloudMediaAssetManagerInstance: photoAccessHelper.CloudMediaAssetManager
= photoAccessHelper.CloudMediaAssetManager.getCloudMediaAssetManagerInstance(context);
const cloudMediaAssetStatus: photoAccessHelper.CloudMediaAssetStatus = await cloudMediaAssetManagerInstance.getCloudMediaAssetStatus();
let taskStatus = cloudMediaAssetStatus.taskStatus;
let taskInfo = cloudMediaAssetStatus.taskInfo;
let errorCode = cloudMediaAssetStatus.errorCode;
let message = `taskStatus: ${taskStatus}, taskInfo: ${taskInfo}, errorCode: ${errorCode}`;
console.log(message);
} catch (err) {
console.error(`getCloudMediaAssetStatusDemo failed with error: ${err.code}, ${err.message}`);
}
}
```
## PhotoSubtype
枚举，不同[PhotoAsset](#photoasset)的类型。
**系统能力**：SystemCapability.FileManagement.PhotoAccessHelper.Core
| 名称 | 值 | 说明 |
| ----- | ---- | ---- |
| SCREENSHOT | 1 | 截屏录屏文件类型。**系统接口**：此接口为系统接口。 |
## PositionType
枚举，文件位置，表示文件在本地或云端。
**系统接口**：此接口为系统接口。
**系统能力**：SystemCapability.FileManagement.PhotoAccessHelper.Core
| 名称 | 值 | 说明 |
| ----- | ---- | ---- |
| LOCAL | 1 << 0 | 文件只存在于本端设备。 |
| CLOUD | 1 << 1 | 文件只存在于云端。 |
## AlbumType
枚举，相册类型，表示是用户相册还是系统预置相册。
**系统能力**：SystemCapability.FileManagement.PhotoAccessHelper.Core
| 名称 | 值 | 说明 |
| ------------------- | ---- | ------------------------- |
| SMART11+ | 4096 | 智慧分析相册。**系统接口**：此接口为系统接口。 |
## AlbumSubtype
枚举，相册子类型，表示具体的相册类型。
**系统能力**：SystemCapability.FileManagement.PhotoAccessHelper.Core
| 名称 | 值 | 说明 |
| --------------------------------- | ---------- | ------------------------------- |
| HIDDEN | 1027 | 隐藏相册。**系统接口**：此接口为系统接口。 |
| TRASH | 1028 | 回收站。**系统接口**：此接口为系统接口。 |
| SCREENSHOT | 1029 | 截屏和录屏相册。**系统接口**：此接口为系统接口。 |
| CAMERA | 1030 | 相机拍摄的照片和视频相册。**系统接口**：此接口为系统接口。 |
| SOURCE\_GENERIC11+ | 2049 | 来源相册。**系统接口**：此接口为系统接口。 |
| CLASSIFY11+ | 4097 | 分类相册。**系统接口**：此接口为系统接口。 |
| GEOGRAPHY\_LOCATION11+ | 4099 | 地图相册。**系统接口**：此接口为系统接口。 |
| GEOGRAPHY\_CITY11+ | 4100 | 城市相册。**系统接口**：此接口为系统接口。 |
| SHOOTING\_MODE11+ | 4101 | 拍摄模式相册。**系统接口**：此接口为系统接口。 |
| PORTRAIT11+ | 4102 | 人像相册。**系统接口**：此接口为系统接口。 |
| GROUP_PHOTO13+ | 4103 | 合影相册。**系统接口**：此接口为系统接口。 |
| HIGHLIGHT12+ | 4104 | 时刻相册。**系统接口**：此接口为系统接口。 |
| HIGHLIGHT_SUGGESTIONS12+ | 4105 | 时刻建议相册。**系统接口**：此接口为系统接口。 |
| CLOUD_ENHANCEMENT13+ | 1032 | AI云增强相册。**系统接口**：此接口为系统接口。 |
## RequestPhotoType11+
枚举，获取图片或视频缩略图的操作类型。
**系统接口**：此接口为系统接口。
**系统能力**：SystemCapability.FileManagement.PhotoAccessHelper.Core
| 名称 | 值 | 说明 |
| ----- | ---- | ---- |
| REQUEST_ALL_THUMBNAILS | 0 | 即获取快速缩略图，又获取质量缩略图。 |
| REQUEST_FAST_THUMBNAIL | 1 | 只获取快速缩略图。 |
| REQUEST_QUALITY_THUMBNAIL | 2 | 只获取质量缩略图。 |
## PhotoKeys
枚举，图片和视频文件关键信息。
**系统能力**：SystemCapability.FileManagement.PhotoAccessHelper.Core
| 名称 | 值 | 说明 |
| ------------- | ------------------- | ---------------------------------------------------------- |
| POSITION | 'position' | 文件位置类型。**系统接口**：此接口为系统接口。 |
| DATE_TRASHED | 'date_trashed' | 删除日期（删除文件时间距1970年1月1日的秒数值）。**系统接口**：此接口为系统接口。 |
| HIDDEN | 'hidden' | 文件的隐藏状态。**系统接口**：此接口为系统接口。 |
| CAMERA_SHOT_KEY | 'camera_shot_key' | 锁屏相机拍照或录像的标记字段（仅开放给系统相机,其key值由系统相机定义）。**系统接口**：此接口为系统接口。 |
| USER_COMMENT10+ | 'user_comment' | 用户注释信息。**系统接口**：此接口为系统接口。 |
| DATE_YEAR11+ | 'date_year' | 创建文件的年份。**系统接口**：此接口为系统接口。 |
| DATE_MONTH11+ | 'date_month' | 创建文件的月份。**系统接口**：此接口为系统接口。 |
| DATE_DAY11+ | 'date_day' | 创建文件的日期。**系统接口**：此接口为系统接口。 |
| PENDING11+ | 'pending' | pending状态。**系统接口**：此接口为系统接口。 |
| DATE_TRASHED_MS12+ | 'date_trashed_ms' | 删除日期（删除文件时间距1970年1月1日的毫秒数值）。**系统接口**：此接口为系统接口。
注意：查询照片时，不支持基于该字段排序。 |
| MOVING_PHOTO_EFFECT_MODE12+ | 'moving_photo_effect_mode' | 动态照片效果模式。**系统接口**：此接口为系统接口。 |
| CE_AVAILABLE13+ | 'ce_available' | 云增强任务标识。**系统接口**：此接口为系统接口。 |
| SUPPORTED_WATERMARK_TYPE14+ | 'supported_watermark_type' | 水印可编辑标识。**系统接口**：此接口为系统接口。 |
## HiddenPhotosDisplayMode11+
枚举，系统中隐藏文件显示模式。
**系统接口**：此接口为系统接口。
**系统能力**：SystemCapability.FileManagement.PhotoAccessHelper.Core
| 名称 | 值 | 说明 |
| ------------- | ------------------- | ---------------------------------------------------------- |
| ASSETS_MODE | 0 | 按系统预置的隐藏相册显示隐藏文件，即显示系统中所有的隐藏文件。 |
| ALBUMS_MODE | 1 | 按相册显示隐藏文件（即显示系统中所有包含隐藏文件的相册，除系统预置的隐藏相册本身和回收站相册以外）。 |
## PhotoCreateOptions
图片或视频的创建选项。
**系统接口**：此接口为系统接口。
**系统能力**：SystemCapability.FileManagement.PhotoAccessHelper.Core
| 名称 | 类型 | 必填 | 说明 |
| ---------------------- | ------------------- | ---- | ------------------------------------------------ |
| subtype | [PhotoSubtype](#photosubtype) | 否 | 图片或者视频的子类型。 |
| cameraShotKey | string | 否 | 锁屏相机拍照或录像的标记字段（仅开放给系统相机,其key值由系统相机定义）。 |
## RequestPhotoOptions11+
获取图片或视频缩略图的选项。
**系统接口**：此接口为系统接口。
**系统能力**：SystemCapability.FileManagement.PhotoAccessHelper.Core
| 名称 | 类型 | 必填 | 说明 |
| ---------------------- | ------------------- | ---- | ------------------------------------------------ |
| size | [image.Size](../apis-image-kit/js-apis-image.md#size) | 否 | 获取缩略图的尺寸。 |
| requestPhotoType | [RequestPhotoType](#requestphototype11) | 否 | 获取的操作类型。 |
## RequestOptions11+
请求策略。
**系统能力**：SystemCapability.FileManagement.PhotoAccessHelper.Core
| 名称 | 类型 | 可读 | 可写 | 说明 |
| ---------------------- |---------------------------------| ---- |---- | ------------------------------------------------ |
| sourceMode | [SourceMode](#sourcemode11) | 是 | 是 | 资源文件的读取类型，可以指定当前请求获取的是源文件，或是编辑后的文件。**系统接口**：此接口为系统接口。 |
## PhotoProxy11+
照片代理，相机应用通过该对象写入图片数据。
**系统接口**：此接口为系统接口。
**系统能力**：SystemCapability.FileManagement.PhotoAccessHelper.Core
## MediaChangeRequest11+
媒体变更请求，资产变更请求和相册变更请求的父类型。
**注意**：媒体变更请求需要在调用[applyChanges](js-apis-photoAccessHelper.md#applychanges11)后才会提交生效。
**系统能力**：SystemCapability.FileManagement.PhotoAccessHelper.Core
## FormInfo11+
图库卡片相关信息。
**系统接口**：此接口为系统接口。
**系统能力**：SystemCapability.FileManagement.PhotoAccessHelper.Core
| 名称 | 类型 | 必填 | 说明 |
| ---------------------- | ------------------- | ---- | ------------------------------------------------ |
|formId |string |是 | 卡片的ID，由图库创建卡片时提供。 |
|uri |string |是 | 卡片绑定的图片的uri。创建卡片时uri可为空或图片的uri，移除卡片时uri不做校验，传空即可。 |
## ResourceType11+
枚举，写入资源的类型。
**系统能力**：SystemCapability.FileManagement.PhotoAccessHelper.Core
| 名称 | 值 | 说明 |
| ----- | ---- | ---- |
| PHOTO_PROXY | 3 | 表示照片代理资源。**系统接口**：此接口为系统接口。 |
| PRIVATE_MOVING_PHOTO_RESOURCE13+ | 4 | 表示私有动态照片资源。**系统接口**：此接口为系统接口。 |
## DefaultChangeUri
枚举，DefaultChangeUri子类型。
**系统能力**：SystemCapability.FileManagement.PhotoAccessHelper.Core
| 名称 | 值 | 说明 |
| ----------------- | ----------------------- | ------------------------------------------------------------ |
| DEFAULT_HIDDEN_ALBUM_URI11+ | 'file://media/HiddenAlbum' | 隐藏相册-相册视图中相册的Uri，即系统中包含隐藏文件的相册（不包含系统预置隐藏相册和回收站相册）的Uri，仅用于隐藏相册-相册视图场景的通知。**系统接口**：此接口为系统接口。 |
## SourceMode11+
枚举，资源文件的读取类型。
**系统接口**：此接口为系统接口。
**系统能力**：SystemCapability.FileManagement.PhotoAccessHelper.Core
| 名称 | 值 | 说明 |
| ----- | ---- | ---- |
| ORIGINAL_MODE | 0 | 读取源文件。 |
| EDITED_MODE | 1 | 读取编辑后的文件。|
## AuthorizationMode12+
枚举，授权模式。
**系统接口**：此接口为系统接口。
**系统能力**：SystemCapability.FileManagement.PhotoAccessHelper.Core
| 名称 | 值 | 说明 |
| ----- | ---- | ---- |
| SHORT_TIME_AUTHORIZATION| 0 | 短时授权。 |
## AnalysisType11+
枚举，智慧分析类型。
**系统能力**：SystemCapability.FileManagement.PhotoAccessHelper.Core
| 名称 | 值 | 说明 |
| :---------------------------- | :- | :------- |
| ANALYSIS\_AESTHETICS\_SCORE | 0 | 美学评分分析类别。**系统接口**：此接口为系统接口。 |
| ANALYSIS\_LABEL | 1 | 分类标签分析类别。**系统接口**：此接口为系统接口。 |
| ANALYSIS\_OCR | 2 | 文字识别分析类别。**系统接口**：此接口为系统接口。 |
| ANALYSIS\_FACE | 3 | 人脸检测分析类别。**系统接口**：此接口为系统接口。 |
| ANALYSIS\_OBJECT | 4 | 目标检测分析类别。**系统接口**：此接口为系统接口。 |
| ANALYSIS\_RECOMMENDATION | 5 | 推荐构图分析类别。**系统接口**：此接口为系统接口。 |
| ANALYSIS\_SEGMENTATION | 6 | 抠图分析类别。**系统接口**：此接口为系统接口。 |
| ANALYSIS\_COMPOSITION | 7 | 美学构图分析类别。**系统接口**：此接口为系统接口。 |
| ANALYSIS\_SALIENCY | 8 | 最佳呈现主体中心分析类别。**系统接口**：此接口为系统接口。 |
| ANALYSIS\_DETAIL\_ADDRESS | 9 | 详细地址分析类别。**系统接口**：此接口为系统接口。 |
| ANALYSIS\_HUMAN\_FACE\_TAG12+ | 10 | 人像聚类信息分析类别。**系统接口**：此接口为系统接口。 |
| ANALYSIS\_HEAD\_POSITION12+ | 11 | 人头、宠物头位置分析类别。**系统接口**：此接口为系统接口。 |
| ANALYSIS\_BONE\_POSE12+ | 12 | 人体骨骼点信息分析类别。**系统接口**：此接口为系统接口。 |
| ANALYSIS\_VIDEO\_LABEL12+ | 13 | 视频标签。**系统接口**：此接口为系统接口。 |
## HighlightAlbumInfoType12+
枚举，时刻相册信息类型。
**系统接口**：此接口为系统接口。
**系统能力**：SystemCapability.FileManagement.PhotoAccessHelper.Core
| 名称 | 值 | 说明 |
| :------------ | :- | :------- |
| COVER\_INFO | 0 | 封面信息类别。 |
| PLAY\_INFO | 1 | 音乐信息类别。 |
## HighlightUserActionType12+
枚举，时刻用户行为类型。
**系统接口**：此接口为系统接口。
**系统能力**：SystemCapability.FileManagement.PhotoAccessHelper.Core
| 名称 | 值 | 说明 |
| :---------------------------- | :- | :------- |
| INSERTED\_PIC\_COUNT | 0 | 新增图片数量类别。 |
| REMOVED\_PIC\_COUNT | 1 | 移除图片数量类别。 |
| SHARED\_SCREENSHOT\_COUNT | 2 | 分享二级界面长图次数类别。 |
| SHARED\_COVER\_COUNT | 3 | 分享时刻封面次数类别。 |
| RENAMED\_COUNT | 4 | 重命名次数类别。 |
| CHANGED\_COVER\_COUNT | 5 | 修改封面次数类别。 |
| RENDER\_VIEWED\_TIMES | 100 | 轮播观看次数类别。 |
| RENDER\_VIEWED\_DURATION | 101 | 轮播观看总时长类别。 |
| ART\_LAYOUT\_VIEWED\_TIMES | 102 | 二级界面观看次数类别。 |
| ART\_LAYOUT\_VIEWED\_DURATION | 103 | 二级界面观看总时长类别。 |
## MovingPhotoEffectMode12+
枚举，动态照片效果模式。
**系统接口**：此接口为系统接口。
**系统能力**：SystemCapability.FileManagement.PhotoAccessHelper.Core
| 名称 | 值 | 说明 |
| :---------------------------- | :- | :------- |
| DEFAULT | 0 | 默认模式。|
| BOUNCE\_PLAY | 1 | 来回播放。|
| LOOP\_PLAY | 2 | 循环播放。|
| LONG\_EXPOSURE | 3 | 长曝光。 |
| MULTI\_EXPOSURE | 4 | 多曝光。 |
| CINEMA\_GRAPH13+ | 5 | 微动瞬间。 |
| IMAGE\_ONLY13+ | 10 | 关闭模式。 |
## PhotoPermissionType12+
枚举，应用对媒体资源不同访问权限的类型。
包括临时读权限和永久读权限，临时读权限会随着应用的死亡而删除，永久读权限不会。
同一个应用对同一个媒体资源的权限覆盖规则：永久读会覆盖临时读，而临时读不会覆盖永久读。
**系统接口**：此接口为系统接口。
**系统能力**：SystemCapability.FileManagement.PhotoAccessHelper.Core
| 名称 | 值 | 说明 |
| ----- | ---- | ---- |
| TEMPORARY_READ_IMAGEVIDEO | 0 | 临时读权限类型。 |
| PERSISTENT_READ_IMAGEVIDEO | 1 | 永久读权限类型。 |
## HideSensitiveType12+
枚举，应用访问媒体资源时，对媒体资源进行信息脱敏的类型。
**系统接口**：此接口为系统接口。
**系统能力**：SystemCapability.FileManagement.PhotoAccessHelper.Core
| 名称 | 值 | 说明 |
| ----- | ---- | ---- |
| HIDE_LOCATION_AND_SHOOTING_PARAM | 0 | 脱敏地理位置和拍摄参数。 |
| HIDE_LOCATION_ONLY | 1 | 脱敏地理位置信息。 |
| HIDE_SHOOTING_PARAM_ONLY | 2 | 脱敏拍摄参数。 |
| NO_HIDE_SENSITIVE_TYPE | 3 | 不脱敏。 |
## CloudEnhancementTaskStage13+
枚举，应用查询云增强任务状态时，在[CloudEnhancementTaskState](#cloudenhancement13)接口中返回，表示云增强任务状态。
**系统接口**：此接口为系统接口。
**系统能力**：SystemCapability.FileManagement.PhotoAccessHelper.Core
| 名称 | 值 | 说明 |
| ----- | ---- | ---- |
| TASK_STAGE_EXCEPTION | -1 | 云增强任务异常。 |
| TASK_STAGE_PREPARING | 0 | 云增强任务准备中。 |
| TASK_STAGE_UPLOADING | 1 | 云增强任务上传中。 |
| TASK_STAGE_EXECUTING | 2 | 云增强任务执行中。 |
| TASK_STAGE_DOWNLOADING | 3 | 云增强任务下载中。 |
| TASK_STAGE_FAILED | 4 | 云增强任务失败。 |
| TASK_STAGE_COMPLETED | 5 | 云增强任务已完成。 |
## CloudEnhancementState13+
枚举，表示云增强状态。
**系统接口**：此接口为系统接口。
**系统能力**：SystemCapability.FileManagement.PhotoAccessHelper.Core
| 名称 | 值 | 说明 |
| ----- | ---- | ---- |
| UNAVAILABLE | 0 | 云增强不可用。 |
| AVAILABLE | 1 | 云增强可用。 |
| EXECUTING | 2 | 云增强执行中。 |
| COMPLETED | 3 | 云增强已完成。 |
## CloudEnhancementTaskState13+
云增强任务状态，应用调用调用云增强任务查询接口的返回类型，包含云增强任务状态及部分状态下的额外信息。
**系统接口**：此接口为系统接口。
**系统能力**：SystemCapability.FileManagement.PhotoAccessHelper.Core
| 名称 | 类型 | 必定提供 | 说明 |
| ---------------------- | ------------------- | ---- | ------------------------------------------------ |
|taskStage |[CloudEnhancementTaskStage](#cloudenhancementtaskstage13) |是 | 云增强任务状态。 |
|transferredFileSize |number |否 | 已传输的文件大小。当taskStage为CloudEnhancementTaskStage.TASK_STAGE_UPLOADING或者CloudEnhancementTaskStage.TASK_STAGE_DOWNLOADING时提供。 |
|totalFileSize |number |否 | 总文件大小。当taskStage为CloudEnhancementTaskStage.TASK_STAGE_UPLOADING或者CloudEnhancementTaskStage.TASK_STAGE_DOWNLOADING时提供。 |
|expectedDuration |number |否 | 排队时间。当taskStage为CloudEnhancementTaskStage.TASK_STAGE_EXECUTING时提供。 |
|statusCode |number |否 | 状态码。当taskStage为CloudEnhancementTaskStage.TASK_STAGE_FAILED时提供。 |
## VideoEnhancementType13+
枚举，分段式视频的二段式触发类型。
**系统接口**：此接口为系统接口。
**系统能力**：SystemCapability.FileManagement.PhotoAccessHelper.Core
| 名称 | 值 | 说明 |
| ----- | ---- | ---- |
| QUALITY_ENHANCEMENT_LOCAL | 0 | 在端侧增强处理。 |
| QUALITY_ENHANCEMENT_CLOUD | 1 | 在云侧增强处理。 |
| QUALITY_ENHANCEMENT_LOCAL_AND_CLOUD | 2 | 在端侧和云侧同时增强处理。 |
## ThumbnailType13+
枚举，缩略图类型。
**系统接口**：此接口为系统接口。
**系统能力**：SystemCapability.FileManagement.PhotoAccessHelper.Core
| 名称 | 值 | 说明 |
| :---------------------------- | :- | :------- |
| LCD | 1 | 获取LCD缩略图 |
| THM | 2 | 获取THM缩略图 |
## WatermarkType14+
枚举，水印可编辑标识。
**系统接口**：此接口为系统接口。
**系统能力**：SystemCapability.FileManagement.PhotoAccessHelper.Core
| 名称 | 值 | 说明 |
| ----- | ---- | ---- |
| DEFAULT | 0 | 不支持水印可编辑。 |
| BRAND_COMMON | 1 | 支持品牌和通用水印可编辑。 |
| COMMON | 2 | 支持通用水印可编辑。 |
| BRAND | 3 | 支持品牌水印可编辑。 |
## CloudMediaDownloadType14+
枚举，表示云端媒体资产的下载方式。
**系统接口**：此接口为系统接口。
**系统能力**：SystemCapability.FileManagement.PhotoAccessHelper.Core
| 名称 | 值 | 说明 |
| ----- | ---- | ---- |
| DOWNLOAD_FORCE | 0 | 高优先级下载，无需进入息屏充电模式。 |
| DOWNLOAD_GENTLE | 1 | 低优先级下载，需要进入息屏充电模式。 |
## CloudMediaRetainType14+
枚举，表示云端媒体资产的删除方式。
**系统接口**：此接口为系统接口。
**系统能力**：SystemCapability.FileManagement.PhotoAccessHelper.Core
| 名称 | 值 | 说明 |
| ----- | ---- | ---- |
| RETAIN_FORCE | 0 | 删除原文件在云端的本地元数据和缩略图。 |
## CloudMediaAssetTaskStatus14+
枚举，表示云端媒体资产的下载任务状态。
**系统接口**：此接口为系统接口。
**系统能力**：SystemCapability.FileManagement.PhotoAccessHelper.Core
| 名称 | 值 | 说明 |
| ----- | ---- | ---- |
| DOWNLOADING | 0 | 当前任务下载中。 |
| PAUSED | 1 | 当前任务已暂停。 |
| IDLE | 2 | 当前无下载任务。 |
## CloudMediaTaskPauseCause14+
枚举，表示云端媒体资产下载任务暂停的类型。
**系统接口**：此接口为系统接口。
**系统能力**：SystemCapability.FileManagement.PhotoAccessHelper.Core
| 名称 | 值 | 说明 |
| ----- | ---- | ---- |
| NO_PAUSE | 0 | 正常下载，无暂停。 |
| TEMPERATURE_LIMIT | 1 | 温度过高。 |
| ROM_LIMIT | 2 | 本地磁盘空间不足。 |
| NETWORK_FLOW_LIMIT | 3 | 流量使用有限制，且没有Wi-Fi。 |
| WIFI_UNAVAILABLE | 4 | 网络异常。 |
| POWER_LIMIT | 5 | 功耗限制。 |
| BACKGROUND_TASK_UNAVAILABLE | 6 | 充电息屏未启动。 |
| FREQUENT_USER_REQUESTS | 7 | 用户请求频繁。 |
| CLOUD_ERROR | 8 | 端云错误。 |
| USER_PAUSED | 9 | 用户暂停。 |
## CloudMediaAssetStatus14+
云端媒体资产下载任务的详细信息，应用调用云端资产下载任务查询接口的返回类型。
**系统接口**：此接口为系统接口。
**系统能力**：SystemCapability.FileManagement.PhotoAccessHelper.Core
| 名称 | 类型 | 必定提供 | 说明 |
| ---------------------- | ------------------- | ---- | ------------------------------------------------ |
|taskStatus |[CloudMediaAssetTaskStatus](#cloudmediaassettaskstatus14) |是 | 云端媒体资产下载任务状态。 |
|taskInfo |string |是 | 下载资产的的总个数和总大小(byte)，以及未下载的总个数和总大小(byte)。 |
|errorCode |[CloudMediaTaskPauseCause](#cloudmediataskpausecause14) |是 | 云端媒体资产下载任务暂停类型。 |