Skip to content

D
Docs

OpenHarmony / Docs
大约 1 年 前同步成功

通知 159
Star 292
Fork 28
D
Docs

体验新版 GitCode，发现更多精彩内容 >>

提交 d782edab 编写于 作者: Z zengyawen
浏览文件
操作

update docs 

Signed-off-by: Nzengyawen <zengyawen1@huawei.com>
上级 cd6f5eaf
隐藏空白更改
内联 并排
Showing with 143 addition and 86 deletion
zh-cn/application-dev/reference/apis/js-apis-medialibrary.md
浏览文件 @ d782edab
......@@ -2,7 +2,7 @@
> **说明：**
>
> - 该组件从API Version 6开始支持。后续版本如有新增内容，则采用上角标单独标记该内容的起始版本。
> - 该组件从API version 6开始支持。后续版本如有新增内容，则采用上角标单独标记该内容的起始版本。
> - 本模块从API version 9开始废弃。对应的替代接口请参考具体接口说明。
## 导入模块
......@@ -20,7 +20,8 @@ getMediaLibrary(context: Context): MediaLibrary
此接口仅可在Stage模型下使用。
> **说明：**
> 此接口从API Version 9开始废弃。请使用[getPhotoAccessHelper](js-apis-photoAccessHelper.md#photoaccesshelpergetphotoaccesshelper)替代。
>
> 此接口从API version 9开始废弃。请使用[getPhotoAccessHelper](js-apis-photoAccessHelper.md#photoaccesshelpergetphotoaccesshelper)替代。
**系统能力**：SystemCapability.Multimedia.MediaLibrary.Core
......@@ -36,7 +37,7 @@ getMediaLibrary(context: Context): MediaLibrary
| ----------------------------- | :---- |
| [MediaLibrary](#medialibrary) | 媒体库实例。 |
**示例：（从API Version 9开始）**
**示例：（从API version 9开始）**
```ts
// 获取mediaLibrary实例，后续用到此实例均采用此处获取的实例。
......@@ -44,7 +45,7 @@ const context = getContext(this);
let media = mediaLibrary.getMediaLibrary(context);
```
**示例：（API Version 8）**
**示例：（API version 8）**
```js
import featureAbility from '@ohos.ability.featureAbility';
......@@ -62,7 +63,8 @@ getMediaLibrary(): MediaLibrary
此接口仅可在FA模型下使用。
> **说明：**
> 此接口从API Version 9开始废弃。无替代接口。
>
> 此接口从API version 9开始废弃。无替代接口。
**系统能力**：SystemCapability.Multimedia.MediaLibrary.Core
......@@ -88,7 +90,7 @@ getFileAssets(options: MediaFetchOptions, callback: AsyncCallback&lt;FetchFileRe
> **说明：**
>
> - 此接口从API Version 9开始废弃。请使用[getAssets](js-apis-photoAccessHelper.md#getassets)替代。
> - 此接口从API version 9开始废弃。请使用[getAssets](js-apis-photoAccessHelper.md#getassets)替代。
> - 在API version 10上，摒弃了物理目录作为相册的设计，采用了逻辑相册的设计，一个相册中可以添加多个文件，一个文件也可以在多个相册中呈现。新的设计将带来parent、albumId、albumUri和albumName属性使用上的不兼容，无法作为MediaFetchOptions的参数在getFileAssets接口中使用。请参考[changelogs-mediaLibrary.md](../../../release-notes/changelogs/OpenHarmony_4.0.8.2/changelogs-mediaLibrary.md)。
**需要权限**：ohos.permission.READ_MEDIA
......@@ -161,7 +163,7 @@ getFileAssets(options: MediaFetchOptions): Promise&lt;FetchFileResult&gt;
> **说明：**
>
> - 此接口从API Version 9开始废弃。请使用[getAssets](js-apis-photoAccessHelper.md#getassets-1)替代。
> - 此接口从API version 9开始废弃。请使用[getAssets](js-apis-photoAccessHelper.md#getassets-1)替代。
> - 在API version 10上，摒弃了物理目录作为相册的设计，采用了逻辑相册的设计，一个相册中可以添加多个文件，一个文件也可以在多个相册中呈现。新的设计将带来parent、albumId、albumUri和albumName属性使用上的不兼容，无法作为MediaFetchOptions的参数在getFileAssets接口中使用。请参考[changelogs-mediaLibrary.md](../../../release-notes/changelogs/OpenHarmony_4.0.8.2/changelogs-mediaLibrary.md)。
**需要权限**：ohos.permission.READ_MEDIA
......@@ -234,7 +236,8 @@ on(type: 'deviceChange'&#124;'albumChange'&#124;'imageChange'&#124;'audioChange'
打开媒体库变更通知，使用callback方式返回异步结果。
> **说明：**
> 此接口从API Version 9开始废弃。请使用[registerChange](js-apis-photoAccessHelper.md#registerchange)替代。
>
> 此接口从API version 9开始废弃。请使用[registerChange](js-apis-photoAccessHelper.md#registerchange)替代。
**系统能力**：SystemCapability.Multimedia.MediaLibrary.Core
......@@ -260,7 +263,8 @@ off(type: 'deviceChange'&#124;'albumChange'&#124;'imageChange'&#124;'audioChange
关闭媒体库变更通知，使用callback方式返回异步结果。
> **说明：**
> 此接口从API Version 9开始废弃。请使用[unRegisterChange](js-apis-photoAccessHelper.md#unregisterchange)替代。
>
> 此接口从API version 9开始废弃。请使用[unRegisterChange](js-apis-photoAccessHelper.md#unregisterchange)替代。
**系统能力**：SystemCapability.Multimedia.MediaLibrary.Core
......@@ -287,7 +291,7 @@ createAsset(mediaType: MediaType, displayName: string, relativePath: string, cal
> **说明：**
>
> - 此接口从API Version 9开始废弃。请使用[createAsset](js-apis-photoAccessHelper.md#createasset)替代。
> - 此接口从API version 9开始废弃。请使用[createAsset](js-apis-photoAccessHelper.md#createasset)替代。
> - 由于API version 10的SDK上relativePath和相册没有关联关系，文件创建成功后，relativePath的最后一级目录不会作为相册呈现。变更详情请参考[changelogs-mediaLibrary.md](../../../release-notes/changelogs/OpenHarmony_4.0.8.2/changelogs-mediaLibrary.md)。
**需要权限**：ohos.permission.READ_MEDIA, ohos.permission.WRITE_MEDIA
......@@ -329,7 +333,7 @@ createAsset(mediaType: MediaType, displayName: string, relativePath: string): Pr
> **说明：**
>
> - 此接口从API Version 9开始废弃。请使用[createAsset](js-apis-photoAccessHelper.md#createasset-1)替代。
> - 此接口从API version 9开始废弃。请使用[createAsset](js-apis-photoAccessHelper.md#createasset-1)替代。
> - 由于API version 10的SDK上relativePath和相册没有关联关系，文件创建成功后，relativePath的最后一级目录不会作为相册呈现。变更详情请参考[changelogs-mediaLibrary.md](../../../release-notes/changelogs/OpenHarmony_4.0.8.2/changelogs-mediaLibrary.md)。
**需要权限**：ohos.permission.READ_MEDIA, ohos.permission.WRITE_MEDIA
......@@ -375,7 +379,8 @@ deleteAsset(uri: string): Promise\<void>
调用该接口彻底删除文件前，需要先调用[FileAsset.trash](#trash8)将文件放入回收站，否则文件会删除失败。
> **说明：**
> 此接口从API Version 9开始废弃。请使用[deleteAssets](js-apis-photoAccessHelper.md#deleteassets-3)替代。
>
> 此接口从API version 9开始废弃。请使用[deleteAssets](js-apis-photoAccessHelper.md#deleteassets-3)替代。
**系统接口**：此接口为系统接口。
......@@ -429,7 +434,8 @@ deleteAsset(uri: string, callback: AsyncCallback\<void>): void
调用该接口彻底删除文件前，需要先调用[FileAsset.trash](#trash8)将文件放入回收站，否则文件会删除失败。
> **说明：**
> 此接口从API Version 9开始废弃。请使用[deleteAssets](js-apis-photoAccessHelper.md#deleteassets-2)替代。
>
> 此接口从API version 9开始废弃。请使用[deleteAssets](js-apis-photoAccessHelper.md#deleteassets-2)替代。
**系统接口**：此接口为系统接口。
......@@ -478,7 +484,8 @@ getPublicDirectory(type: DirectoryType, callback: AsyncCallback&lt;string&gt;):
获取公共目录路径，使用callback方式返回结果。
> **说明：**
> 此接口从API Version 9开始废弃。无替代接口。
>
> 此接口从API version 9开始废弃。无替代接口。
**系统能力**：SystemCapability.Multimedia.MediaLibrary.Core
......@@ -509,7 +516,8 @@ getPublicDirectory(type: DirectoryType): Promise&lt;string&gt;
获取公共目录路径，使用Promise方式返回结果。
> **说明：**
> 此接口从API Version 9开始废弃。无替代接口。
>
> 此接口从API version 9开始废弃。无替代接口。
**系统能力**：SystemCapability.Multimedia.MediaLibrary.Core
......@@ -550,7 +558,7 @@ getAlbums(options: MediaFetchOptions, callback: AsyncCallback&lt;Array&lt;Album&
> **说明：**
>
> - 此接口从API Version 9开始废弃。请使用[getAlbums](js-apis-photoAccessHelper.md#getalbums)替代。
> - 此接口从API version 9开始废弃。请使用[getAlbums](js-apis-photoAccessHelper.md#getalbums)替代。
> - 由于API version 10的SDK上relativePath和相册没有关联关系，在使用getAlbums时不支持relativePath作为查询条件，当前仅支持“Camera”和“ScreenShots”两类相册，变更详情请参考[changelogs-mediaLibrary.md](../../../release-notes/changelogs/OpenHarmony_4.0.8.2/changelogs-mediaLibrary.md)。
**需要权限**：ohos.permission.READ_MEDIA
......@@ -590,7 +598,7 @@ getAlbums(options: MediaFetchOptions): Promise&lt;Array&lt;Album&gt;&gt;
> **说明：**
>
> - 此接口从API Version 9开始废弃。请使用[getAlbums](js-apis-photoAccessHelper.md#getalbums-2)替代。
> - 此接口从API version 9开始废弃。请使用[getAlbums](js-apis-photoAccessHelper.md#getalbums-2)替代。
> - 由于API version 10的SDK上relativePath和相册没有关联关系，在使用getAlbums时不支持relativePath作为查询条件.当前仅支持“Camera”和“ScreenShots”两类相册，变更详情请参考[changelogs-mediaLibrary.md](../../../release-notes/changelogs/OpenHarmony_4.0.8.2/changelogs-mediaLibrary.md)。
**需要权限**：ohos.permission.READ_MEDIA
......@@ -633,7 +641,8 @@ release(callback: AsyncCallback&lt;void&gt;): void
当后续不需要使用MediaLibrary实例中的方法时调用。
> **说明：**
> 此接口从API Version 9开始废弃。请使用[release](js-apis-photoAccessHelper.md#release)替代。
>
> 此接口从API version 9开始废弃。请使用[release](js-apis-photoAccessHelper.md#release)替代。
**系统能力**：SystemCapability.Multimedia.MediaLibrary.Core
......@@ -659,7 +668,8 @@ release(): Promise&lt;void&gt;
当后续不需要使用MediaLibrary实例中的方法时调用。
> **说明：**
> 此接口从API Version 9开始废弃。请使用[release](js-apis-photoAccessHelper.md#release-1)替代。
>
> 此接口从API version 9开始废弃。请使用[release](js-apis-photoAccessHelper.md#release-1)替代。
**系统能力**：SystemCapability.Multimedia.MediaLibrary.Core
......@@ -683,8 +693,8 @@ storeMediaAsset(option: MediaAssetOption, callback: AsyncCallback&lt;string&gt;)
> **说明：**
>
> - 此接口为API Version 6开始支持，只支持FA模型使用。
> - 此接口从API Version 9开始废弃。请使用[save](js-apis-file-picker.md#save-1)接口替代。
> - 此接口为API version 6开始支持，只支持FA模型使用。
> - 此接口从API version 9开始废弃。请使用[save](js-apis-file-picker.md#save-1)接口替代。
**系统能力**：SystemCapability.Multimedia.MediaLibrary.Core
......@@ -721,8 +731,8 @@ storeMediaAsset(option: MediaAssetOption): Promise&lt;string&gt;
> **说明：**
>
> - 此接口为API Version 6开始支持，只支持FA模型使用。
> - 此接口从API Version 9开始废弃。请使用[save](js-apis-file-picker.md#save)接口替代。
> - 此接口为API version 6开始支持，只支持FA模型使用。
> - 此接口从API version 9开始废弃。请使用[save](js-apis-file-picker.md#save)接口替代。
**系统能力**：SystemCapability.Multimedia.MediaLibrary.Core
......@@ -762,8 +772,8 @@ startImagePreview(images: Array&lt;string&gt;, index: number, callback: AsyncCal
> **说明：**
>
> - 此接口为API Version 6开始支持，只支持FA模型使用。
> - 此接口从API Version 9开始废弃。建议使用[Image组件](../arkui-ts/ts-basic-components-image.md)替代。<br/>Image组件，可用于本地图片和网络图片的渲染展示。
> - 此接口为API version 6开始支持，只支持FA模型使用。
> - 此接口从API version 9开始废弃。建议使用[Image组件](../arkui-ts/ts-basic-components-image.md)替代。<br/>Image组件，可用于本地图片和网络图片的渲染展示。
**系统能力**：SystemCapability.Multimedia.MediaLibrary.Core
......@@ -806,8 +816,8 @@ startImagePreview(images: Array&lt;string&gt;, callback: AsyncCallback&lt;void&g
> **说明：**
>
> - 此接口为API Version 6开始支持，只支持FA模型使用。
> - 此接口从API Version 9开始废弃。建议使用[Image组件](../arkui-ts/ts-basic-components-image.md)替代。<br/>Image组件，可用于本地图片和网络图片的渲染展示。
> - 此接口为API version 6开始支持，只支持FA模型使用。
> - 此接口从API version 9开始废弃。建议使用[Image组件](../arkui-ts/ts-basic-components-image.md)替代。<br/>Image组件，可用于本地图片和网络图片的渲染展示。
**系统能力**：SystemCapability.Multimedia.MediaLibrary.Core
......@@ -848,8 +858,8 @@ startImagePreview(images: Array&lt;string&gt;, index?: number): Promise&lt;void&
> **说明：**
>
> - 此接口为API Version 6开始支持，只支持FA模型使用。
> - 此接口从API Version 9开始废弃。建议使用[Image组件](../arkui-ts/ts-basic-components-image.md)替代。<br/>Image组件，可用于本地图片和网络图片的渲染展示。
> - 此接口为API version 6开始支持，只支持FA模型使用。
> - 此接口从API version 9开始废弃。建议使用[Image组件](../arkui-ts/ts-basic-components-image.md)替代。<br/>Image组件，可用于本地图片和网络图片的渲染展示。
**系统能力**：SystemCapability.Multimedia.MediaLibrary.Core
......@@ -895,8 +905,8 @@ startMediaSelect(option: MediaSelectOption, callback: AsyncCallback&lt;Array&lt;
> **说明：**
>
> - 此接口为API Version 6开始支持，只支持FA模型使用。
> - 此接口从API Version 9开始废弃。请使用[select](js-apis-file-picker.md#select-1)接口替代。
> - 此接口为API version 6开始支持，只支持FA模型使用。
> - 此接口从API version 9开始废弃。请使用[select](js-apis-file-picker.md#select-1)接口替代。
**系统能力**：SystemCapability.Multimedia.MediaLibrary.Core
......@@ -932,8 +942,8 @@ startMediaSelect(option: MediaSelectOption): Promise&lt;Array&lt;string&gt;&gt;
> **说明：**
>
> - 此接口为API Version 6开始支持，只支持FA模型使用。
> - 此接口从API Version 9开始废弃。请使用[select](js-apis-file-picker.md#select)接口替代。
> - 此接口为API version 6开始支持，只支持FA模型使用。
> - 此接口从API version 9开始废弃。请使用[select](js-apis-file-picker.md#select)接口替代。
**系统能力**：SystemCapability.Multimedia.MediaLibrary.Core
......@@ -971,7 +981,8 @@ getActivePeers(): Promise\<Array\<PeerInfo>>;
获取在线对端设备的信息，使用Promise方式返回异步结果。
> **说明：**
> 此接口从API Version 9开始废弃。无替代接口。
>
> 此接口从API version 9开始废弃。无替代接口。
**系统接口**：此接口为系统接口。
......@@ -1008,7 +1019,8 @@ getActivePeers(callback: AsyncCallback\<Array\<PeerInfo>>): void;
获取在线对端设备的信息，使用callback方式返回异步结果。
> **说明：**
> 此接口从API Version 9开始废弃。无替代接口。
>
> 此接口从API version 9开始废弃。无替代接口。
**系统接口**：此接口为系统接口。
......@@ -1043,7 +1055,8 @@ getAllPeers(): Promise\<Array\<PeerInfo>>;
获取所有对端设备的信息，使用Promise方式返回异步结果。
> **说明：**
> 此接口从API Version 9开始废弃。无替代接口。
>
> 此接口从API version 9开始废弃。无替代接口。
**系统接口**：此接口为系统接口。
......@@ -1080,7 +1093,8 @@ getAllPeers(callback: AsyncCallback\<Array\<PeerInfo>>): void;
获取所有对端设备的信息，使用callback方式返回异步结果。
> **说明：**
> 此接口从API Version 9开始废弃。无替代接口。
>
> 此接口从API version 9开始废弃。无替代接口。
**系统接口**：此接口为系统接口。
......@@ -1116,7 +1130,7 @@ async function example() {
>
> - title字段默认为去掉后缀的文件名，音频和视频文件会尝试解析文件内容，部分设备写入后在触发扫描时会被还原。
> - orientation字段部分设备可能不支持修改，建议使用image组件的[ModifyImageProperty](js-apis-image.md#modifyimageproperty9)接口。
> - 此接口从API Version 9开始废弃。请使用[PhotoAsset](js-apis-photoAccessHelper.md#photoasset)替代。
> - 此接口从API version 9开始废弃。请使用[PhotoAsset](js-apis-photoAccessHelper.md#photoasset)替代。
### 属性
......@@ -1153,7 +1167,8 @@ isDirectory(callback: AsyncCallback&lt;boolean&gt;): void
判断fileAsset是否为目录，使用callback方式返回异步结果。
> **说明：**
> 此接口从API Version 9开始废弃。无替代接口。
>
> 此接口从API version 9开始废弃。无替代接口。
**需要权限**：ohos.permission.READ_MEDIA
......@@ -1196,7 +1211,8 @@ isDirectory():Promise&lt;boolean&gt;
判断fileAsset是否为目录，使用Promise方式返回异步结果。
> **说明：**
> 此接口从API Version 9开始废弃。无替代接口。
>
> 此接口从API version 9开始废弃。无替代接口。
**需要权限**：ohos.permission.READ_MEDIA
......@@ -1238,7 +1254,7 @@ commitModify(callback: AsyncCallback&lt;void&gt;): void
> **说明：**
>
> - 此接口从API Version 9开始废弃。请使用[commitModify](js-apis-photoAccessHelper.md#commitmodify)替代。
> - 此接口从API version 9开始废弃。请使用[commitModify](js-apis-photoAccessHelper.md#commitmodify)替代。
> - 由于API version 10的SDK上audio没有orientation属性，在使用commitModify接口时将无法对audio资源的orientation属性进行修改。请参考[changelogs-mediaLibrary.md](../../../release-notes/changelogs/OpenHarmony_4.0.8.2/changelogs-mediaLibrary.md)。
**需要权限**：ohos.permission.READ_MEDIA, ohos.permission.WRITE_MEDIA
......@@ -1280,7 +1296,7 @@ commitModify(): Promise&lt;void&gt;
> **说明：**
>
> - 此接口从API Version 9开始废弃。请使用[commitModify](js-apis-photoAccessHelper.md#commitmodify-1)替代。
> - 此接口从API version 9开始废弃。请使用[commitModify](js-apis-photoAccessHelper.md#commitmodify-1)替代。
> 由于API version 10的SDK上audio没有orientation属性，在使用commitModify接口时将无法对audio资源的orientation属性进行修改。请参考[changelogs-mediaLibrary.md](../../../release-notes/changelogs/OpenHarmony_4.0.8.2/changelogs-mediaLibrary.md)。
**需要权限**：ohos.permission.READ_MEDIA, ohos.permission.WRITE_MEDIA
......@@ -1319,7 +1335,8 @@ open(mode: string, callback: AsyncCallback&lt;number&gt;): void
打开当前文件，使用callback方式返回异步结果。
> **说明：**
> 此接口从API Version 9开始废弃。请使用[open](js-apis-photoAccessHelper.md#open)替代。
>
> 此接口从API version 9开始废弃。请使用[open](js-apis-photoAccessHelper.md#open)替代。
**注意**：以 'w' 模式打开文件时，返回的fd无法进行读取。但由于不同文件系统实现上的差异，部分用户态文件系统在 'w' 模式打开时会允许用fd读取。若有针对fd的读写行为，建议使用 'rw' 模式打开文件。当前写操作是互斥的操作，写操作完成后需要调用close进行释放。
......@@ -1359,7 +1376,8 @@ open(mode: string): Promise&lt;number&gt;
打开当前文件，使用promise方式返回异步结果。
> **说明：**
> 此接口从API Version 9开始废弃。请使用[open](js-apis-photoAccessHelper.md#open-1)替代。
>
> 此接口从API version 9开始废弃。请使用[open](js-apis-photoAccessHelper.md#open-1)替代。
**注意**：以 'w' 模式打开文件时，返回的fd无法进行读取。但由于不同文件系统实现上的差异，部分用户态文件系统在 'w' 模式打开时会允许用fd读取。若有针对fd的读写行为，建议使用 'rw' 模式打开文件。当前写操作是互斥的操作，写操作完成后需要调用close进行释放。
......@@ -1402,7 +1420,8 @@ close(fd: number, callback: AsyncCallback&lt;void&gt;): void
关闭当前文件，使用callback方式返回异步结果。
> **说明：**
> 此接口从API Version 9开始废弃。请使用[close](js-apis-photoAccessHelper.md#close)替代。
>
> 此接口从API version 9开始废弃。请使用[close](js-apis-photoAccessHelper.md#close)替代。
**需要权限**：ohos.permission.READ_MEDIA or ohos.permission.WRITE_MEDIA
......@@ -1451,7 +1470,8 @@ close(fd: number): Promise&lt;void&gt;
关闭当前文件，使用promise方式返回异步结果。
> **说明：**
> 此接口从API Version 9开始废弃。请使用[close](js-apis-photoAccessHelper.md#close-1)替代。
>
> 此接口从API version 9开始废弃。请使用[close](js-apis-photoAccessHelper.md#close-1)替代。
**需要权限**：ohos.permission.READ_MEDIA or ohos.permission.WRITE_MEDIA
......@@ -1503,7 +1523,8 @@ getThumbnail(callback: AsyncCallback&lt;image.PixelMap&gt;): void
获取文件的缩略图，使用callback方式返回异步结果。
> **说明：**
> 此接口从API Version 9开始废弃。请使用[close](js-apis-photoAccessHelper.md#getThumbnail)替代。
>
> 此接口从API version 9开始废弃。请使用[close](js-apis-photoAccessHelper.md#getThumbnail)替代。
**需要权限**：ohos.permission.READ_MEDIA
......@@ -1546,7 +1567,8 @@ getThumbnail(size: Size, callback: AsyncCallback&lt;image.PixelMap&gt;): void
获取文件的缩略图，传入缩略图尺寸，使用callback方式返回异步结果。
> **说明：**
> 此接口从API Version 9开始废弃。请使用[close](js-apis-photoAccessHelper.md#getThumbnail-1)替代。
>
> 此接口从API version 9开始废弃。请使用[close](js-apis-photoAccessHelper.md#getThumbnail-1)替代。
**需要权限**：ohos.permission.READ_MEDIA
......@@ -1591,7 +1613,8 @@ getThumbnail(size?: Size): Promise&lt;image.PixelMap&gt;
获取文件的缩略图，传入缩略图尺寸，使用promise方式返回异步结果。
> **说明：**
> 此接口从API Version 9开始废弃。请使用[close](js-apis-photoAccessHelper.md#getThumbnail-2)替代。
>
> 此接口从API version 9开始废弃。请使用[close](js-apis-photoAccessHelper.md#getThumbnail-2)替代。
**需要权限**：ohos.permission.READ_MEDIA
......@@ -1639,7 +1662,8 @@ favorite(isFavorite: boolean, callback: AsyncCallback&lt;void&gt;): void
将文件设置为收藏文件，使用callback方式返回异步结果。
> **说明：**
> 此接口从API Version 9开始废弃。请使用[setFavorite](js-apis-photoAccessHelper.md#setfavorite)替代。
>
> 此接口从API version 9开始废弃。请使用[setFavorite](js-apis-photoAccessHelper.md#setfavorite)替代。
**需要权限**：ohos.permission.READ_MEDIA, ohos.permission.WRITE_MEDIA
......@@ -1683,7 +1707,8 @@ favorite(isFavorite: boolean): Promise&lt;void&gt;
将文件设置为收藏文件，使用promise方式返回异步结果。
> **说明：**
> 此接口从API Version 9开始废弃。请使用[setFavorite](js-apis-photoAccessHelper.md#setfavorite-1)替代。
>
> 此接口从API version 9开始废弃。请使用[setFavorite](js-apis-photoAccessHelper.md#setfavorite-1)替代。
**需要权限**：ohos.permission.READ_MEDIA, ohos.permission.WRITE_MEDIA
......@@ -1730,7 +1755,8 @@ isFavorite(callback: AsyncCallback&lt;boolean&gt;): void
判断该文件是否为收藏文件，使用callback方式返回异步结果。
> **说明：**
> 此接口从API Version 9开始废弃。无替代接口。
>
> 此接口从API version 9开始废弃。无替代接口。
**需要权限**：ohos.permission.READ_MEDIA
......@@ -1773,7 +1799,8 @@ isFavorite():Promise&lt;boolean&gt;
判断该文件是否为收藏文件，使用promise方式返回异步结果。
> **说明：**
> 此接口从API Version 9开始废弃。无替代接口。
>
> 此接口从API version 9开始废弃。无替代接口。
**需要权限**：ohos.permission.READ_MEDIA
......@@ -1816,7 +1843,8 @@ trash(isTrash: boolean, callback: AsyncCallback&lt;void&gt;): void
放入垃圾文件夹的文件不会被真正删除，可以通过isTrash = false参数恢复成正常文件。
> **说明：**
> 此接口从API Version 9开始废弃。请使用[deleteAssets](js-apis-photoAccessHelper.md#deleteAssets)替代。
>
> 此接口从API version 9开始废弃。请使用[deleteAssets](js-apis-photoAccessHelper.md#deleteAssets)替代。
**需要权限**：ohos.permission.READ_MEDIA, ohos.permission.WRITE_MEDIA
......@@ -1862,7 +1890,8 @@ trash(isTrash: boolean): Promise&lt;void&gt;
放入垃圾文件夹的文件不会被真正删除，可以通过isTrash = false参数恢复成正常文件。
> **说明：**
> 此接口从API Version 9开始废弃。请使用[deleteAssets](js-apis-photoAccessHelper.md#deleteAssets-1)替代。
>
> 此接口从API version 9开始废弃。请使用[deleteAssets](js-apis-photoAccessHelper.md#deleteAssets-1)替代。
**需要权限**：ohos.permission.READ_MEDIA, ohos.permission.WRITE_MEDIA
......@@ -1909,7 +1938,8 @@ isTrash(callback: AsyncCallback&lt;boolean&gt;): void
当文件被定位，判断文件是否为垃圾文件，使用callback方式返回异步结果。
> **说明：**
> 此接口从API Version 9开始废弃。无替代接口。
>
> 此接口从API version 9开始废弃。无替代接口。
**需要权限**：ohos.permission.READ_MEDIA
......@@ -1952,7 +1982,8 @@ isTrash():Promise&lt;boolean&gt;
当文件被定位，判断文件是否为垃圾文件，使用promise方式返回异步结果。
> **说明：**
> 此接口从API Version 9开始废弃。无替代接口。
>
> 此接口从API version 9开始废弃。无替代接口。
**需要权限**：ohos.permission.READ_MEDIA
......@@ -1991,7 +2022,8 @@ async function example() {
文件检索结果集。
> **说明：**
> 此接口从API Version 9开始废弃。请使用[FetchResult](js-apis-photoAccessHelper.md#fetchresult)替代。
>
> 此接口从API version 9开始废弃。请使用[FetchResult](js-apis-photoAccessHelper.md#fetchresult)替代。
### getCount<sup>7+</sup>
......@@ -2000,7 +2032,8 @@ getCount(): number
获取文件检索结果中的文件总数。
> **说明：**
> 此接口从API Version 9开始废弃。请使用[getCount](js-apis-photoAccessHelper.md#getcount)替代。
>
> 此接口从API version 9开始废弃。请使用[getCount](js-apis-photoAccessHelper.md#getcount)替代。
**系统能力**：SystemCapability.Multimedia.MediaLibrary.Core
......@@ -2035,7 +2068,8 @@ isAfterLast(): boolean
检查结果集是否指向最后一行。
> **说明：**
> 此接口从API Version 9开始废弃。请使用[isAfterLast](js-apis-photoAccessHelper.md#isafterlast)替代。
>
> 此接口从API version 9开始废弃。请使用[isAfterLast](js-apis-photoAccessHelper.md#isafterlast)替代。
**系统能力**：SystemCapability.Multimedia.MediaLibrary.Core
......@@ -2078,7 +2112,8 @@ close(): void
释放 FetchFileResult 实例并使其失效。无法调用其他方法。
> **说明：**
> 此接口从API Version 9开始废弃。请使用[close](js-apis-photoAccessHelper.md#close)替代。
>
> 此接口从API version 9开始废弃。请使用[close](js-apis-photoAccessHelper.md#close)替代。
**系统能力**：SystemCapability.Multimedia.MediaLibrary.Core
......@@ -2105,7 +2140,8 @@ getFirstObject(callback: AsyncCallback&lt;FileAsset&gt;): void
获取文件检索结果中的第一个文件资产。此方法使用回调返回FileAsset。
> **说明：**
> 此接口从API Version 9开始废弃。请使用[getFirstObject](js-apis-photoAccessHelper.md#getfirstobject)替代。
>
> 此接口从API version 9开始废弃。请使用[getFirstObject](js-apis-photoAccessHelper.md#getfirstobject)替代。
**系统能力**：SystemCapability.Multimedia.MediaLibrary.Core
......@@ -2145,7 +2181,8 @@ getFirstObject(): Promise&lt;FileAsset&gt;
获取文件检索结果中的第一个文件资产。此方法使用Promise方式返回FileAsset。
> **说明：**
> 此接口从API Version 9开始废弃。请使用[getFirstObject](js-apis-photoAccessHelper.md#getfirstobject-1)替代。
>
> 此接口从API version 9开始废弃。请使用[getFirstObject](js-apis-photoAccessHelper.md#getfirstobject-1)替代。
**系统能力**：SystemCapability.Multimedia.MediaLibrary.Core
......@@ -2185,7 +2222,7 @@ getNextObject(callback: AsyncCallback&lt;FileAsset&gt;): void
> **说明：**
>
> - 在使用前需要先使用[getFirstObject](#getfirstobject7)接口获取第一个文件资产，然后使用[isAfterLast](#isafterlast7)确认文件检索集当前不是指向最后一个时方可使用此接口。
> - 此接口从API Version 9开始废弃。请使用[getNextObject](js-apis-photoAccessHelper.md#getnextobject)替代。
> - 此接口从API version 9开始废弃。请使用[getNextObject](js-apis-photoAccessHelper.md#getnextobject)替代。
**系统能力**：SystemCapability.Multimedia.MediaLibrary.Core
......@@ -2232,7 +2269,7 @@ getNextObject(): Promise&lt;FileAsset&gt;
> **说明：**
>
> - 在使用前需要先使用[getFirstObject](#getfirstobject7)接口获取第一个文件资产，然后使用[isAfterLast](#isafterlast7)确认文件检索集当前不是指向最后一个时方可使用此接口。
> - 此接口从API Version 9开始废弃。请使用[getNextObject](js-apis-photoAccessHelper.md#getnextobject-1)替代。
> - 此接口从API version 9开始废弃。请使用[getNextObject](js-apis-photoAccessHelper.md#getnextobject-1)替代。
**系统能力**：SystemCapability.Multimedia.MediaLibrary.Core
......@@ -2274,7 +2311,8 @@ getLastObject(callback: AsyncCallback&lt;FileAsset&gt;): void
获取文件检索结果中的最后一个文件资产。此方法使用callback回调来返回FileAsset。
> **说明：**
> 此接口从API Version 9开始废弃。请使用[getLastObject](js-apis-photoAccessHelper.md#getlastobject)替代。
>
> 此接口从API version 9开始废弃。请使用[getLastObject](js-apis-photoAccessHelper.md#getlastobject)替代。
**系统能力**：SystemCapability.Multimedia.MediaLibrary.Core
......@@ -2314,7 +2352,8 @@ getLastObject(): Promise&lt;FileAsset&gt;
获取文件检索结果中的最后一个文件资产。此方法使用Promise方式来返回FileAsset。
> **说明：**
> 此接口从API Version 9开始废弃。请使用[getLastObject](js-apis-photoAccessHelper.md#getlastobject-1)替代。
>
> 此接口从API version 9开始废弃。请使用[getLastObject](js-apis-photoAccessHelper.md#getlastobject-1)替代。
**系统能力**：SystemCapability.Multimedia.MediaLibrary.Core
......@@ -2352,7 +2391,8 @@ getPositionObject(index: number, callback: AsyncCallback&lt;FileAsset&gt;): void
获取文件检索结果中具有指定索引的文件资产。此方法使用回调来返回FileAsset。
> **说明：**
> 此接口从API Version 9开始废弃。请使用[getObjectByPosition](js-apis-photoAccessHelper.md#getobjectbyposition)替代。
>
> 此接口从API version 9开始废弃。请使用[getObjectByPosition](js-apis-photoAccessHelper.md#getobjectbyposition)替代。
**系统能力**：SystemCapability.Multimedia.MediaLibrary.Core
......@@ -2393,7 +2433,8 @@ getPositionObject(index: number): Promise&lt;FileAsset&gt;
获取文件检索结果中具有指定索引的文件资产。此方法使用Promise形式返回文件Asset。
> **说明：**
> 此接口从API Version 9开始废弃。请使用[getObjectByPosition](js-apis-photoAccessHelper.md#getobjectbyposition-1)替代。
>
> 此接口从API version 9开始废弃。请使用[getObjectByPosition](js-apis-photoAccessHelper.md#getobjectbyposition-1)替代。
**系统能力**：SystemCapability.Multimedia.MediaLibrary.Core
......@@ -2437,7 +2478,8 @@ getAllObject(callback: AsyncCallback&lt;Array&lt;FileAsset&gt;&gt;): void
获取文件检索结果中的所有文件资产。此方法使用Callback回调来返回FileAsset结果集。
> **说明：**
> 此接口从API Version 9开始废弃。请使用[getAllObjects](js-apis-photoAccessHelper.md#getallobjects)替代。
>
> 此接口从API version 9开始废弃。请使用[getAllObjects](js-apis-photoAccessHelper.md#getallobjects)替代。
**系统能力**：SystemCapability.Multimedia.MediaLibrary.Core
......@@ -2479,7 +2521,8 @@ getAllObject(): Promise&lt;Array&lt;FileAsset&gt;&gt;
获取文件检索结果中的所有文件资产。此方法使用Promise来返回FileAsset结果集。
> **说明：**
> 此接口从API Version 9开始废弃。请使用[getAllObjects](js-apis-photoAccessHelper.md#getallobjects-1)替代。
>
> 此接口从API version 9开始废弃。请使用[getAllObjects](js-apis-photoAccessHelper.md#getallobjects-1)替代。
**系统能力**：SystemCapability.Multimedia.MediaLibrary.Core
......@@ -2517,7 +2560,8 @@ async function example() {
实体相册
> **说明：**
> 此接口从API Version 9开始废弃。请使用[Album](js-apis-photoAccessHelper.md#album)替代。
>
> 此接口从API version 9开始废弃。请使用[Album](js-apis-photoAccessHelper.md#album)替代。
### 属性
......@@ -2540,7 +2584,8 @@ commitModify(callback: AsyncCallback&lt;void&gt;): void
更新相册属性修改到数据库中。
> **说明：**
> 此接口从API Version 9开始废弃。请使用[commitModify](js-apis-photoAccessHelper.md#commitmodify-2)替代。
>
> 此接口从API version 9开始废弃。请使用[commitModify](js-apis-photoAccessHelper.md#commitmodify-2)替代。
**需要权限**：ohos.permission.READ_MEDIA, ohos.permission.WRITE_MEDIA
......@@ -2581,7 +2626,8 @@ commitModify(): Promise&lt;void&gt;
更新相册属性修改到数据库中。
> **说明：**
> 此接口从API Version 9开始废弃。请使用[commitModify](js-apis-photoAccessHelper.md#commitmodify-3)替代。
>
> 此接口从API version 9开始废弃。请使用[commitModify](js-apis-photoAccessHelper.md#commitmodify-3)替代。
**需要权限**：ohos.permission.READ_MEDIA, ohos.permission.WRITE_MEDIA
......@@ -2620,7 +2666,8 @@ getFileAssets(callback: AsyncCallback&lt;FetchFileResult&gt;): void
按照检索条件获取相册中的文件。此方法使用Callback回调来返回文件结果集。
> **说明：**
> 此接口从API Version 9开始废弃。请使用[getAssets](js-apis-photoAccessHelper.md#getassets)替代。
>
> 此接口从API version 9开始废弃。请使用[getAssets](js-apis-photoAccessHelper.md#getassets)替代。
**需要权限**：ohos.permission.READ_MEDIA
......@@ -2664,7 +2711,8 @@ getFileAssets(options: MediaFetchOptions, callback: AsyncCallback&lt;FetchFileRe
按照检索条件获取相册中的文件。此方法使用Callback回调来返回文件结果集。
> **说明：**
> 此接口从API Version 9开始废弃。请使用[getAssets](js-apis-photoAccessHelper.md#getassets)替代。
>
> 此接口从API version 9开始废弃。请使用[getAssets](js-apis-photoAccessHelper.md#getassets)替代。
**需要权限**：ohos.permission.READ_MEDIA
......@@ -2713,7 +2761,8 @@ async function example() {
按照检索条件获取相册中的文件。此方法使用异步Promise来返回文件结果集。
> **说明：**
> 此接口从API Version 9开始废弃。请使用[getAssets](js-apis-photoAccessHelper.md#getassets-1)替代。
>
> 此接口从API version 9开始废弃。请使用[getAssets](js-apis-photoAccessHelper.md#getassets-1)替代。
**需要权限**：ohos.permission.READ_MEDIA
......@@ -2763,7 +2812,8 @@ async function example() {
注册设备的信息。
> **说明：**
> 此接口从API Version 9开始废弃。无替代接口。
>
> 此接口从API version 9开始废弃。无替代接口。
**系统接口**：此接口为系统接口。
......@@ -2781,7 +2831,8 @@ async function example() {
枚举，媒体类型。
> **说明：**
> 此接口从API Version 9开始废弃。请使用[PhotoType](js-apis-photoAccessHelper.md#phototype)替代。
>
> 此接口从API version 9开始废弃。请使用[PhotoType](js-apis-photoAccessHelper.md#phototype)替代。
**系统能力：** 以下各项对应的系统能力均为SystemCapability.Multimedia.MediaLibrary.Core
......@@ -2799,7 +2850,7 @@ async function example() {
> **说明：**
>
> - bucket_id字段在文件重命名或移动后可能会发生变化，开发者使用前需要重新获取。
> - 此接口从API Version 9开始废弃。请使用[PhotoKeys](js-apis-photoAccessHelper.md#photokeys)替代。
> - 此接口从API version 9开始废弃。请使用[PhotoKeys](js-apis-photoAccessHelper.md#photokeys)替代。
**系统能力：** 以下各项对应的系统能力均为SystemCapability.Multimedia.MediaLibrary.Core
......@@ -2830,7 +2881,8 @@ async function example() {
枚举，目录类型。
> **说明：**
> 此接口从API Version 9开始废弃。无替代接口。
>
> 此接口从API version 9开始废弃。无替代接口。
**系统能力：** 以下各项对应的系统能力均为SystemCapability.Multimedia.MediaLibrary.Core
......@@ -2848,7 +2900,8 @@ async function example() {
枚举，设备类型。
> **说明：**
> 此接口从API Version 9开始废弃。无替代接口。
>
> 此接口从API version 9开始废弃。无替代接口。
**系统接口**：此接口为系统接口。
......@@ -2869,7 +2922,8 @@ async function example() {
检索条件。
> **说明：**
> 此接口从API Version 9开始废弃。请使用[FetchOptions](js-apis-photoAccessHelper.md#fetchoptions)替代。
>
> 此接口从API version 9开始废弃。请使用[FetchOptions](js-apis-photoAccessHelper.md#fetchoptions)替代。
**系统能力：** 以下各项对应的系统能力均为SystemCapability.Multimedia.MediaLibrary.Core
......@@ -2887,7 +2941,8 @@ async function example() {
图片尺寸。
> **说明：**
> 此接口从API Version 9开始废弃。请使用[image.Size](js-apis-image.md#size)替代。
>
> 此接口从API version 9开始废弃。请使用[image.Size](js-apis-image.md#size)替代。
**系统能力：** 以下各项对应的系统能力均为SystemCapability.Multimedia.MediaLibrary.Core
......@@ -2901,7 +2956,8 @@ async function example() {
媒体资源选项。
> **说明：**
> 此接口从API Version 9开始废弃。无替代接口。
>
> 此接口从API version 9开始废弃。无替代接口。
**系统能力：** 以下各项对应的系统能力均为SystemCapability.Multimedia.MediaLibrary.Core
......@@ -2916,7 +2972,8 @@ async function example() {
媒体资源类型选项。
> **说明：**
> 此接口从API Version 9开始废弃。无替代接口。
>
> 此接口从API version 9开始废弃。无替代接口。
**系统能力：** 以下各项对应的系统能力均为SystemCapability.Multimedia.MediaLibrary.Core
......
Markdown is supported
0% 或 .
You are about to add 0 people to the discussion. Proceed with caution.
先完成此消息的编辑！
想要评论请 注册 或