1# @ohos.app.ability.EmbeddedUIExtensionAbility (跨进程界面嵌入扩展能力)
2
3EmbeddedUIExtensionAbility为开发者提供了跨进程界面嵌入的能力，继承自[UIExtensionAbility](js-apis-app-ability-uiExtensionAbility.md)。目前EmbeddedUIExtensionAbility只能被同应用的UIAbility拉起，并且仅允许在拥有多进程权限的场景下使用。各类Ability的继承关系详见[继承关系说明](./js-apis-app-ability-ability.md#ability的继承关系说明)。
4
5> **说明：**
6>
7> 本模块首批接口从API version 12 开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。
8>
9> 本模块接口仅可在Stage模型下使用。
10
11## 导入模块
12
13```ts
14import { EmbeddedUIExtensionAbility } from '@kit.AbilityKit';
15```
16
17## 属性
18
19**系统能力**：SystemCapability.Ability.AbilityRuntime.AbilityCore
20
21| 名称 | 类型 | 只读 | 必填 | 说明 |
22| -------- | -------- | -------- | -------- | -------- |
23| context | [UIExtensionContext](js-apis-inner-application-uiExtensionContext.md) | 否 | 否 | 上下文。 |
24
25## EmbeddedUIExtensionAbility.onCreate
26
27onCreate(): void
28
29EmbeddedUIExtensionAbility创建时回调，执行初始化业务逻辑操作。
30
31**系统能力**：SystemCapability.Ability.AbilityRuntime.Core
32
33**示例：**
34
35  ```ts
36  import { EmbeddedUIExtensionAbility } from '@kit.AbilityKit';
37
38  const TAG: string = '[testTag] EmbeddedUIExt';
39
40  export default class EmbeddedUIExt extends EmbeddedUIExtensionAbility {
41    onCreate() {
42      console.info(TAG, `onCreate`);
43    }
44  }
45  ```
46
47## EmbeddedUIExtensionAbility.onSessionCreate
48
49onSessionCreate(want: Want, session: UIExtensionContentSession): void
50
51当EmbeddedUIExtensionAbility界面内容对象创建后调用。
52
53**系统能力**：SystemCapability.Ability.AbilityRuntime.Core
54
55**参数：**
56
57| 参数名 | 类型 | 必填 | 说明 |
58| -------- | -------- | -------- | -------- |
59| want | [Want](js-apis-app-ability-want.md) | 是 | 当前EmbeddedUIExtensionAbility的Want类型信息，包括Ability名称、Bundle名称等。 |
60| session | [UIExtensionContentSession](js-apis-app-ability-uiExtensionContentSession.md) | 是 | EmbeddedUIExtensionAbility界面内容相关信息。 |
61
62**示例：**
63
64  ```ts
65  import { EmbeddedUIExtensionAbility, Want, UIExtensionContentSession } from '@kit.AbilityKit';
66
67  const TAG: string = '[testTag] EmbeddedUIExt';
68
69  export default class EmbeddedUIExt extends EmbeddedUIExtensionAbility {
70    onSessionCreate(want: Want, session: UIExtensionContentSession) {
71      console.info(TAG, `onSessionCreate, want: ${JSON.stringify(want)}`);
72    }
73  }
74  ```
75
76## EmbeddedUIExtensionAbility.onSessionDestroy
77
78onSessionDestroy(session: UIExtensionContentSession): void
79
80当EmbeddedUIExtensionAbility界面内容对象销毁后调用。
81
82**系统能力**：SystemCapability.Ability.AbilityRuntime.Core
83
84**参数：**
85
86| 参数名 | 类型 | 必填 | 说明 |
87| -------- | -------- | -------- | -------- |
88| session | [UIExtensionContentSession](js-apis-app-ability-uiExtensionContentSession.md) | 是 | EmbeddedUIExtensionAbility界面内容相关信息。 |
89
90**示例：**
91
92  ```ts
93  import { EmbeddedUIExtensionAbility, UIExtensionContentSession } from '@kit.AbilityKit';
94
95  const TAG: string = '[testTag] EmbeddedUIExt';
96
97  export default class EmbeddedUIExt extends EmbeddedUIExtensionAbility {
98    onSessionDestroy(session: UIExtensionContentSession) {
99      console.info(TAG, `onSessionDestroy`);
100    }
101  }
102  ```
103
104## EmbeddedUIExtensionAbility.onForeground
105
106onForeground(): void
107
108EmbeddedUIExtensionAbility生命周期回调，当EmbeddedUIExtensionAbility从后台转到前台时触发。
109
110**系统能力**：SystemCapability.Ability.AbilityRuntime.AbilityCore
111
112**示例：**
113
114  ```ts
115  import { EmbeddedUIExtensionAbility } from '@kit.AbilityKit';
116
117  const TAG: string = '[testTag] EmbeddedUIExt';
118
119  export default class EmbeddedUIExt extends EmbeddedUIExtensionAbility {
120    onForeground() {
121      console.info(TAG, `onForeground`);
122    }
123  }
124  ```
125
126## EmbeddedUIExtensionAbility.onBackground
127
128onBackground(): void
129
130EmbeddedUIExtensionAbility生命周期回调，当EmbeddedUIExtensionAbility从前台转到后台时触发。
131
132**系统能力**：SystemCapability.Ability.AbilityRuntime.AbilityCore
133
134**示例：**
135
136  ```ts
137  import { EmbeddedUIExtensionAbility } from '@kit.AbilityKit';
138
139  const TAG: string = '[testTag] EmbeddedUIExt';
140
141  export default class EmbeddedUIExt extends EmbeddedUIExtensionAbility {
142    onBackground() {
143      console.info(TAG, `onBackground`);
144    }
145  }
146  ```
147
148## EmbeddedUIExtensionAbility.onDestroy
149
150onDestroy(): void | Promise<void>
151
152EmbeddedUIExtensionAbility生命周期回调，在销毁时回调，执行资源清理等操作。
153在执行完onDestroy生命周期回调后，应用可能会退出，从而可能导致onDestroy中的异步函数未能正确执行，比如异步写入数据库。可以使用异步生命周期，以确保异步onDestroy完成后再继续后续的生命周期。
154
155**系统能力**：SystemCapability.Ability.AbilityRuntime.Core
156
157**返回值：**
158
159| 类型              | 说明                                                         |
160| ----------------- | ------------------------------------------------------------ |
161| void \| Promise\<void> | 无返回结果或无返回结果的Promise对象。       |
162
163**示例：**
164
165  ```ts
166  import { EmbeddedUIExtensionAbility } from '@kit.AbilityKit';
167
168  const TAG: string = '[testTag] EmbeddedUIExt';
169
170  export default class EmbeddedUIExt extends EmbeddedUIExtensionAbility {
171    onDestroy() {
172      console.info(TAG, `onDestroy`);
173    }
174  }
175  ```
176