• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1# @ohos.app.ability.UIExtensionAbility (带界面扩展能力基类)
2
3UIExtensionAbility是特定场景下带界面扩展能力的基类,继承自[ExtensionAbility](js-apis-app-ability-extensionAbility.md),新增带界面扩展能力相关的属性和方法。不支持开发者直接继承该基类。
4
5> **说明:**
6>
7> 本模块首批接口从API version 10 开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。
8> 本模块接口仅可在Stage模型下使用。
9
10## 导入模块
11
12```ts
13import UIExtensionAbility from '@ohos.app.ability.UIExtensionAbility';
14```
15
16## 属性
17
18**系统能力**:SystemCapability.Ability.AbilityRuntime.AbilityCore
19
20| 名称 | 类型 | 可读 | 可写 | 说明 |
21| -------- | -------- | -------- | -------- | -------- |
22| context | [UIExtensionContext](js-apis-inner-application-uiExtensionContext.md) | 是 | 否 | 上下文。 |
23
24## UIExtensionAbility.onCreate
25
26onCreate(): void
27
28UIExtensionAbility创建时回调,执行初始化业务逻辑操作。
29
30**系统能力**:SystemCapability.Ability.AbilityRuntime.Core
31
32## UIExtensionAbility.onSessionCreate
33
34onSessionCreate(want: Want, session: UIExtensionContentSession): void
35
36当UIExtensionAbility界面内容对象创建后调用。
37
38**系统能力**:SystemCapability.Ability.AbilityRuntime.Core
39
40**参数:**
41
42| 参数名 | 类型 | 必填 | 说明 |
43| -------- | -------- | -------- | -------- |
44| want | [Want](js-apis-app-ability-want.md) | 是 | 当前UIExtensionAbility的Want类型信息,包括ability名称、bundle名称等。 |
45| session | [UIExtensionContentSession](js-apis-app-ability-uiExtensionContentSession.md) | 是 | UIExtensionAbility界面内容相关信息。 |
46
47## UIExtensionAbility.onSessionDestroy
48
49onSessionDestroy(session: UIExtensionContentSession): void
50
51当UIExtensionAbility界面内容对象销毁后调用。
52
53**系统能力**:SystemCapability.Ability.AbilityRuntime.Core
54
55**参数:**
56
57| 参数名 | 类型 | 必填 | 说明 |
58| -------- | -------- | -------- | -------- |
59| session | [UIExtensionContentSession](js-apis-app-ability-uiExtensionContentSession.md) | 是 | UIExtensionAbility界面内容相关信息。 |
60
61## UIExtensionAbility.onForeground
62
63onForeground(): void;
64
65UIExtensionAbility生命周期回调,当UIExtensionAbility从后台转到前台时触发。
66
67**系统能力**:SystemCapability.Ability.AbilityRuntime.AbilityCore
68
69## UIExtensionAbility.onBackground
70
71onBackground(): void;
72
73UIExtensionAbility生命周期回调,当UIExtensionAbility从前台转到后台时触发。
74
75**系统能力**:SystemCapability.Ability.AbilityRuntime.AbilityCore
76
77## UIExtensionAbility.onDestroy
78
79onDestroy(): void | Promise<void>;
80
81UIExtensionAbility生命周期回调,在销毁时回调,执行资源清理等操作。
82在执行完onDestroy生命周期回调后,应用可能会退出,从而可能导致onDestroy中的异步函数未能正确执行,比如异步写入数据库。可以使用异步生命周期,以确保异步onDestroy完成后再继续后续的生命周期。
83
84**系统能力**:SystemCapability.Ability.AbilityRuntime.Core
85