• 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> 本模块接口仅可在Stage模型下使用。
11
12## 导入模块
13
14```ts
15import AbilityStage from '@ohos.app.ability.AbilityStage';
16```
17
18## AbilityStage.onCreate
19
20onCreate(): void
21
22当应用创建时调用。
23
24**系统能力**:SystemCapability.Ability.AbilityRuntime.Core
25
26**示例:**
27
28```ts
29import AbilityStage from '@ohos.app.ability.AbilityStage';
30
31class MyAbilityStage extends AbilityStage {
32    onCreate() {
33        console.log('MyAbilityStage.onCreate is called');
34    }
35}
36```
37
38
39## AbilityStage.onAcceptWant
40
41onAcceptWant(want: Want): string;
42
43启动一个specified ability时触发的事件。
44
45**系统能力**:SystemCapability.Ability.AbilityRuntime.Core
46
47**参数:**
48
49| 参数名 | 类型 | 必填 | 说明 |
50| -------- | -------- | -------- | -------- |
51| want | [Want](js-apis-app-ability-want.md) | 是 | Want类型参数,传入需要启动的ability的信息,如Ability名称,Bundle名称等。 |
52
53**返回值:**
54
55  | 类型 | 说明 |
56  | -------- | -------- |
57  | string | 用户返回一个ability标识,如果之前启动过标识的ability,不创建新的实例并拉回栈顶,否则创建新的实例并启动。 |
58
59**示例:**
60
61```ts
62import AbilityStage from '@ohos.app.ability.AbilityStage';
63
64class MyAbilityStage extends AbilityStage {
65    onAcceptWant(want) {
66        console.log('MyAbilityStage.onAcceptWant called');
67        return 'com.example.test';
68    }
69}
70```
71
72
73## AbilityStage.onConfigurationUpdate
74
75onConfigurationUpdate(newConfig: Configuration): void;
76
77环境变化通知接口,发生全局配置变更时回调。
78
79**系统能力**:SystemCapability.Ability.AbilityRuntime.Core
80
81**参数:**
82
83  | 参数名 | 类型 | 必填 | 说明 |
84  | -------- | -------- | -------- | -------- |
85  | newConfig | [Configuration](js-apis-app-ability-configuration.md) | 是 | 发生全局配置变更时触发回调,当前全局配置包括系统语言、深浅色模式。 |
86
87**示例:**
88
89```ts
90import AbilityStage from '@ohos.app.ability.AbilityStage';
91
92class MyAbilityStage extends AbilityStage {
93    onConfigurationUpdate(config) {
94        console.log('onConfigurationUpdate, language:' + config.language);
95    }
96}
97```
98
99## AbilityStage.onMemoryLevel
100
101onMemoryLevel(level: AbilityConstant.MemoryLevel): void;
102
103当系统已决定调整内存时调用。例如,当该功能在后台运行时,没有足够的内存来运行尽可能多的后台进程时可以使用。
104
105**系统能力**:SystemCapability.Ability.AbilityRuntime.Core
106
107**参数:**
108
109  | 参数名 | 类型 | 必填 | 说明 |
110  | -------- | -------- | -------- | -------- |
111  | level | [AbilityConstant.MemoryLevel](js-apis-app-ability-abilityConstant.md#abilityconstantmemorylevel) | 是 | 回调返回内存微调级别,显示当前内存使用状态。|
112
113**示例:**
114
115```ts
116import AbilityStage from '@ohos.app.ability.AbilityStage';
117
118class MyAbilityStage extends AbilityStage {
119    onMemoryLevel(level) {
120        console.log('onMemoryLevel, level:' + JSON.stringify(level));
121    }
122}
123```
124
125## AbilityStage.context
126
127context: AbilityStageContext;
128
129指示AbilityStage的上下文。
130
131**系统能力**:SystemCapability.Ability.AbilityRuntime.Core
132
133| 属性名      | 类型                        | 说明                                                         |
134| ----------- | --------------------------- | ------------------------------------------------------------ |
135| context  | [AbilityStageContext](js-apis-inner-application-abilityStageContext.md) | 在Ability启动阶段进行初始化时回调,获取到该Ability的context值。 |
136