• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1# @ohos.app.ability.AbilityStage (AbilityStage)
2
3AbilityStage是HAP的运行时类。
4
5AbilityStage类提供在HAP加载的时候,通知开发者,可以在此进行该HAP的初始化(如资源预加载,线程创建等)能力。
6
7> **说明:**
8>
9> 本模块首批接口从API version 9 开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。
10>
11> 本模块接口仅可在Stage模型下使用。
12
13## 导入模块
14
15```ts
16import AbilityStage from '@ohos.app.ability.AbilityStage';
17```
18
19## AbilityStage.onCreate
20
21onCreate(): void
22
23当应用创建时调用。
24
25**系统能力**:SystemCapability.Ability.AbilityRuntime.Core
26
27**示例:**
28
29```ts
30import AbilityStage from '@ohos.app.ability.AbilityStage';
31
32class MyAbilityStage extends AbilityStage {
33    onCreate() {
34        console.log('MyAbilityStage.onCreate is called');
35    }
36}
37```
38
39
40## AbilityStage.onAcceptWant
41
42onAcceptWant(want: Want): string
43
44启动一个specified ability时触发的事件。
45
46**系统能力**:SystemCapability.Ability.AbilityRuntime.Core
47
48**参数:**
49
50| 参数名 | 类型 | 必填 | 说明 |
51| -------- | -------- | -------- | -------- |
52| want | [Want](js-apis-app-ability-want.md) | 是 | Want类型参数,传入需要启动的ability的信息,如Ability名称,Bundle名称等。 |
53
54**返回值:**
55
56  | 类型 | 说明 |
57  | -------- | -------- |
58  | string | 返回一个ability标识,如果之前启动过标识的ability,不创建新的实例并拉回栈顶,否则创建新的实例并启动。 |
59
60**示例:**
61
62```ts
63import AbilityStage from '@ohos.app.ability.AbilityStage';
64import Want from '@ohos.app.ability.Want';
65
66class MyAbilityStage extends AbilityStage {
67    onAcceptWant(want: Want) {
68        console.log('MyAbilityStage.onAcceptWant called');
69        return 'com.example.test';
70    }
71}
72```
73
74## AbilityStage.onNewProcessRequest<sup>11+</sup>
75
76onNewProcessRequest(want: Want): string
77
78在指定进程中启动UIAbility时回调。
79
80**系统能力**:SystemCapability.Ability.AbilityRuntime.Core
81
82**参数:**
83
84| 参数名 | 类型 | 必填 | 说明 |
85| -------- | -------- | -------- | -------- |
86| want | [Want](js-apis-app-ability-want.md) | 是 | Want类型参数,传入需要启动的ability的信息,如Ability名称,Bundle名称等。 |
87
88**返回值:**
89
90| 类型 | 说明 |
91| -------- | -------- |
92| string | 返回一个由开发者自行决定的进程字符串标识,如果之前此标识对应的进程已被创建,就让ability在此进程中运行,否则创建新的进程。 |
93
94**示例:**
95
96```ts
97import AbilityStage from '@ohos.app.ability.AbilityStage';
98import Want from '@ohos.app.ability.Want';
99
100class MyAbilityStage extends AbilityStage {
101    onNewProcessRequest(want: Want) {
102        console.log('MyAbilityStage.onNewProcessRequest called');
103        return 'com.example.test';
104    }
105}
106```
107
108
109## AbilityStage.onConfigurationUpdate
110
111onConfigurationUpdate(newConfig: Configuration): void
112
113环境变化通知接口,发生全局配置变更时回调。
114
115**系统能力**:SystemCapability.Ability.AbilityRuntime.Core
116
117**参数:**
118
119  | 参数名 | 类型 | 必填 | 说明 |
120  | -------- | -------- | -------- | -------- |
121  | newConfig | [Configuration](js-apis-app-ability-configuration.md) | 是 | 发生全局配置变更时触发回调,当前全局配置包括系统语言、深浅色模式。 |
122
123**示例:**
124
125```ts
126import AbilityStage from '@ohos.app.ability.AbilityStage';
127import { Configuration } from '@ohos.app.ability.Configuration';
128
129class MyAbilityStage extends AbilityStage {
130    onConfigurationUpdate(config: Configuration) {
131        console.log(`onConfigurationUpdate, language: ${config.language}`);
132    }
133}
134```
135
136## AbilityStage.onMemoryLevel
137
138onMemoryLevel(level: AbilityConstant.MemoryLevel): void
139
140当系统已决定调整内存时调用。例如,当该功能在后台运行时,没有足够的内存来运行尽可能多的后台进程时可以使用。
141
142**系统能力**:SystemCapability.Ability.AbilityRuntime.Core
143
144**参数:**
145
146  | 参数名 | 类型 | 必填 | 说明 |
147  | -------- | -------- | -------- | -------- |
148  | level | [AbilityConstant.MemoryLevel](js-apis-app-ability-abilityConstant.md#abilityconstantmemorylevel) | 是 | 回调返回内存微调级别,显示当前内存使用状态。|
149
150**示例:**
151
152```ts
153import AbilityStage from '@ohos.app.ability.AbilityStage';
154import AbilityConstant from '@ohos.app.ability.AbilityConstant';
155
156class MyAbilityStage extends AbilityStage {
157    onMemoryLevel(level: AbilityConstant.MemoryLevel) {
158        console.log(`onMemoryLevel, level: ${JSON.stringify(level)}`);
159    }
160}
161```
162
163## AbilityStage.context
164
165context: AbilityStageContext
166
167指示AbilityStage的上下文。
168
169**系统能力**:SystemCapability.Ability.AbilityRuntime.Core
170
171| 属性名      | 类型                        | 说明                                                         |
172| ----------- | --------------------------- | ------------------------------------------------------------ |
173| context  | [AbilityStageContext](js-apis-inner-application-abilityStageContext.md) | 在Ability启动阶段进行初始化时回调,获取到该Ability的context值。 |
174
175**示例:**
176
177```ts
178import AbilityStage from '@ohos.app.ability.AbilityStage';
179
180export default class MyAbilityStage extends AbilityStage {
181  onCreate() {
182    let abilityStageContext = this.context;
183  }
184  // ...
185}
186```
187