• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1# Functions
2<!--Kit: Media Library Kit-->
3<!--Subsystem: Multimedia-->
4<!--Owner: @yixiaoff-->
5<!--Designer: @liweilu1-->
6<!--Tester: @xchaosioda-->
7<!--Adviser: @zengyawen-->
8
9> **说明:**
10>
11> 本模块首批接口从API version 10开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。
12
13## 导入模块
14
15```ts
16import { photoAccessHelper } from '@kit.MediaLibraryKit';
17```
18
19## photoAccessHelper.getPhotoAccessHelper
20
21getPhotoAccessHelper(context: Context): PhotoAccessHelper
22
23获取相册管理模块的实例,用于访问和修改相册中的媒体文件。
24
25**模型约束**: 此接口仅可在Stage模型下使用。
26
27**原子化服务API:** 从API version 11开始,该接口支持在原子化服务中使用。
28
29**系统能力**:SystemCapability.FileManagement.PhotoAccessHelper.Core
30
31**参数:**
32
33| 参数名  | 类型    | 必填 | 说明                       |
34| ------- | ------- | ---- | -------------------------- |
35| context | [Context](../apis-ability-kit/js-apis-inner-application-context.md) | 是   | 传入Ability实例的上下文。 |
36
37**返回值:**
38
39| 类型                            | 说明    |
40| ----------------------------- | :---- |
41| [PhotoAccessHelper](arkts-apis-photoAccessHelper-PhotoAccessHelper.md) | 相册管理模块的实例。 |
42
43**错误码:**
44
45接口抛出错误码的详细介绍请参见[通用错误码](../errorcode-universal.md)。
46
47| 错误码ID | 错误信息 |
48| -------- | ---------------------------------------- |
49| 401 | Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types; 3. Parameter verification failed. |
50
51**示例:**
52
53```ts
54// 此处获取的phAccessHelper实例为全局对象,后续使用到phAccessHelper的地方默认为使用此处获取的对象,如未添加此段代码报phAccessHelper未定义的错误请自行添加。
55// 请在组件内获取context,确保this.getUiContext().getHostContext()返回结果为UIAbilityContext
56import { common } from '@kit.AbilityKit';
57
58@Entry
59@Component
60struct Index {
61  build() {
62    Row() {
63      Button("example").onClick(async () => {
64        let context: Context = this.getUIContext().getHostContext() as common.UIAbilityContext;
65        let phAccessHelper = photoAccessHelper.getPhotoAccessHelper(context);
66      }).width('100%')
67    }
68    .height('90%')
69  }
70}
71```
72