1# @ohos.app.ability.ActionExtensionAbility (自定义服务扩展能力)
2
3ActionExtensionAbility是为开发者提供的自定义操作业务模板，继承自[UIExtensionAbility](js-apis-app-ability-uiExtensionAbility.md)。ActionExtension主要用于查看宿主应用中的内容以及对其进行对应处理。例如，添加一个书签、将选中的文本翻译成其他语言、在当前页面编辑图像等。各类Ability的继承关系详见[继承关系说明](./js-apis-app-ability-ability.md#ability的继承关系说明)。
4
5> **说明：**
6>
7> 本模块首批接口从API version 10 开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。
8>
9> 本模块接口仅可在Stage模型下使用。
10
11## 场景介绍
12
13以翻译文本为例。首先需要创建请求发起方，再创建出ActionExtension，请求发起方需要将翻译的文本发送给ActionExtension，ActionExtension接收到文本后，需要将接收的文本进行翻译，翻译后的文本再发送给请求发起方。
14
15## 导入模块
16
17```ts
18import { ActionExtensionAbility } from '@kit.AbilityKit';
19```
20
21## 属性
22
23**系统能力**：SystemCapability.Ability.AbilityRuntime.AbilityCore
24
25| 名称 | 类型 | 只读 | 必填 | 说明 |
26| -------- | -------- | -------- | -------- | -------- |
27| context | [UIExtensionContext](js-apis-inner-application-uiExtensionContext.md) | 否 | 否 | 上下文。 |
28
29## ActionExtensionAbility.onCreate
30
31onCreate(): void
32
33ActionExtensionAbility创建时回调，执行初始化业务逻辑操作。
34
35**系统能力**：SystemCapability.Ability.AbilityRuntime.AbilityCore
36
37**示例：**
38
39参见[创建ActionExtensionAbility](#创建actionextensionability)。
40
41## ActionExtensionAbility.onSessionCreate
42
43onSessionCreate(want: Want, session: UIExtensionContentSession): void
44
45当ActionExtensionAbility界面内容对象创建后调用。
46
47**系统能力**：SystemCapability.Ability.AbilityRuntime.AbilityCore
48
49**参数：**
50
51| 参数名 | 类型 | 必填 | 说明 |
52| -------- | -------- | -------- | -------- |
53| want | [Want](js-apis-app-ability-want.md) | 是 | 当前ActionExtensionAbility的Want类型信息，包括ability名称、bundle名称等。 |
54| session | [UIExtensionContentSession](js-apis-app-ability-uiExtensionContentSession.md) | 是 | ActionExtensionAbility界面内容相关信息。 |
55
56**示例：**
57
58参见[创建ActionExtensionAbility](#创建actionextensionability)。
59
60## ActionExtensionAbility.onForeground
61
62onForeground(): void
63
64ActionExtensionAbility生命周期回调，当ActionExtensionAbility从后台转到前台时触发。
65
66**系统能力**：SystemCapability.Ability.AbilityRuntime.AbilityCore
67
68**示例：**
69
70参见[创建ActionExtensionAbility](#创建actionextensionability)。
71
72## ActionExtensionAbility.onBackground
73
74onBackground(): void
75
76ActionExtensionAbility生命周期回调，当ActionExtensionAbility从前台转到后台时触发。
77
78**系统能力**：SystemCapability.Ability.AbilityRuntime.AbilityCore
79
80**示例：**
81
82参见[创建ActionExtensionAbility](#创建actionextensionability)。
83
84## ActionExtensionAbility.onSessionDestroy
85
86onSessionDestroy(session: UIExtensionContentSession): void
87
88当ActionExtensionAbility界面内容对象销毁后调用。
89
90**系统能力**：SystemCapability.Ability.AbilityRuntime.AbilityCore
91
92**参数：**
93
94| 参数名 | 类型 | 必填 | 说明 |
95| -------- | -------- | -------- | -------- |
96| session | [UIExtensionContentSession](js-apis-app-ability-uiExtensionContentSession.md) | 是 | ActionExtensionAbility界面内容相关信息。 |
97
98**示例：**
99
100参见[创建ActionExtensionAbility](#创建actionextensionability)。
101
102## ActionExtensionAbility.onDestroy
103
104onDestroy(): void | Promise<void>
105
106ActionExtensionAbility生命周期回调，在ActionExtensionAbility销毁时回调，执行资源清理等操作。
107在执行完onDestroy生命周期回调后，应用可能会退出，从而可能导致onDestroy中的异步函数未能正确执行，比如异步写入数据库。可以使用异步生命周期，以确保异步onDestroy完成后再继续后续的生命周期。
108
109**系统能力**：SystemCapability.Ability.AbilityRuntime.AbilityCore
110
111**返回值：**
112
113| 类型                                  | 说明                            |
114| ------------------------------------- | ------------------------------- |
115| void \| Promise<void> | 无返回结果或无返回结果的Promise对象。 |
116
117**示例：**
118
119参见[创建ActionExtensionAbility](#创建actionextensionability)。
120
121## 创建ActionExtensionAbility
122
123在DevEco Studio工程中手动新建一个ActionExtensionAbility，具体步骤如下：
124
1251. 在工程Module对应的ets目录下，右键选择“New > Directory”，新建一个目录并命名为ActionExtAbility。
126
1272. 在actionextability目录，右键选择“New > ArkTS File”，新建一个文件并命名为ActionExtAbility.ets。
128
129    ```text
130    ├── ets
131    │ ├── actionextability
132    │ │   ├── ActionExtAbility.ets
133    └
134    ```
135
1363. ActionExtAbility.ets文件中，增加导入ActionExtensionAbility的依赖包，自定义类继承ActionExtensionAbility并实现生命周期回调。
137
138    ```ts
139    import { ActionExtensionAbility, Want, UIExtensionContentSession } from '@kit.AbilityKit';
140
141    const TAG: string = "[ActionExtAbility]";
142
143    export default class ActionExtAbility extends ActionExtensionAbility {
144      onCreate() {
145        console.info(TAG, `onCreate`);
146      }
147      onSessionCreate(want: Want, session: UIExtensionContentSession) {
148        console.info(TAG, `onSessionCreate, want: ${want.abilityName}`);
149        if (want.parameters) {
150          let obj: Record<string, UIExtensionContentSession | object> = {
151            'session': session,
152            'messages': want.parameters.shareMessages
153          };
154          let storage: LocalStorage = new LocalStorage(obj);
155          session.loadContent('pages/Index', storage);
156        }
157      }
158      onForeground() {
159        console.info(TAG, `ononForeground`);
160      }
161      onBackground() {
162        console.info(TAG, `onBackground`);
163      }
164      onSessionDestroy(session: UIExtensionContentSession) {
165        console.info(TAG, `onSessionDestroy`);
166      }
167      onDestroy() {
168        console.info(TAG, `onDestroy`);
169      }
170    }
171    ```
172
1734. 在工程Module对应的[module.json5配置文件](../../quick-start/module-configuration-file.md)中注册ActionExtensionAbility，type标签需要设置为“action”，srcEntry标签表示当前ExtensionAbility组件所对应的代码路径。
174
175   ```json
176   {
177     "module": {
178       ...
179       "extensionAbilities": [
180         {
181           "name": "ActionExtAbility",
182           "icon": "$media:icon",
183           "description": "action",
184           "type": "action",
185           "exported": true,
186           "srcEntry": "./ets/actionextability/ActionExtAbility.ets"
187         }
188       ]
189     }
190   }
191   ```
192