• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1# @ohos.app.ability.contextConstant (Context相关常量)
2<!--Kit: Ability Kit-->
3<!--Subsystem: Ability-->
4<!--Owner: @wangkailong; @yangxuguang-huawei; @Luobniz21-->
5<!--Designer: @ccllee1; @li-weifeng2-->
6<!--Tester: @lixueqing513-->
7<!--Adviser: @huipeizi-->
8
9ContextConstant提供Context相关的枚举,包含文件加密分区等级、UIAbility启动后的进程模式等。
10
11> **说明:**
12>
13> 本模块首批接口从API version 9开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。
14>
15> 本模块接口仅可在Stage模型下使用。
16
17## 导入模块
18
19```ts
20import { contextConstant } from '@kit.AbilityKit';
21```
22
23## AreaMode
24
25文件加密分区等级,保证应用在不同场景下的数据安全。开发者可以根据应用的具体需求选择合适的加密等级,以保护用户的数据安全。
26
27**系统能力**:SystemCapability.Ability.AbilityRuntime.Core
28
29| 名称  | 值 | 说明                                                                                                                   |
30|-----| -------- |----------------------------------------------------------------------------------------------------------------------|
31| EL1 | 0 | 设备级加密区,设备开机后可访问的数据区。<br/>**原子化服务API**:从API version 11开始,该接口支持在原子化服务中使用。    |
32| EL2 | 1 | 用户级加密区,设备开机,首次输入密码后才能够访问的数据区。<br/>**原子化服务API**:从API version 11开始,该接口支持在原子化服务中使用。       |
33| EL3<sup>11+<sup> | 2 | 用户级加密区,不同场景的文件权限如下:<br/>已打开文件:锁屏时,可读写;解锁后,可读写。<br/>未打开文件:锁屏时,不可打开、不可读写;解锁后,可打开、可读写。<br/>创建新文件:锁屏时,可创建、可打开、可写不可读;解锁后,可创建、可打开、可读写。<br/>**原子化服务API**:从API version 11开始,该接口支持在原子化服务中使用。 |
34| EL4<sup>11+<sup> | 3 | 用户级加密区,不同场景的文件权限如下:<br/>已打开文件:锁屏时,不可读写;解锁后,可读写。<br/>未打开文件:锁屏时,不可打开、不可读写;解锁后,可打开、可读写。<br/>创建新文件:锁屏时,不可创建;解锁后,可创建、可打开、可读写。<br/>**原子化服务API**:从API version 11开始,该接口支持在原子化服务中使用。  |
35| EL5<sup>12+<sup> | 4 | 应用级加密区,不同场景的文件权限如下:<br/>已打开文件:锁屏时,可读写;解锁后,可读写。<br/>未打开文件:锁屏时,调用[Access](js-apis-screenLockFileManager.md#screenlockfilemanageracquireaccess)接口获取保留密钥后,可打开、可读写,否则不可打开、不可读写;解锁后,可打开、可读写。<br/>创建新文件:锁屏时,可创建、可打开、可读写;解锁后,可创建、可打开、可读写。<br/>**原子化服务API**:从API version 12开始,该接口支持在原子化服务中使用。 |
36
37
38## ProcessMode<sup>12+</sup>
39
40UIAbility启动后的进程模式。
41
42ProcessMode作为[StartOptions](js-apis-app-ability-startOptions.md)的一个属性,仅在[UIAbilityContext.startAbility](js-apis-inner-application-uiAbilityContext.md#startability-1)中生效,用来指定目标UIAbility的进程模式。
43
44**系统能力**:SystemCapability.Ability.AbilityRuntime.Core
45
46**设备行为差异**:该功能仅在2in1和Tablet设备上生效,在其他设备中返回801错误码。
47
48| 名称  | 值 | 说明                                                                                                                   |
49|-----| -------- |----------------------------------------------------------------------------------------------------------------------|
50| NEW_PROCESS_ATTACH_TO_PARENT | 1 | 创建一个新进程,并在该进程上启动UIAbility。该进程会跟随父进程退出。<br>**约束:**<br>使用此模式时,要求目标UIAbility跟调用方是在同一个应用。                     |
51| NEW_PROCESS_ATTACH_TO_STATUS_BAR_ITEM | 2 | 创建一个新进程,在该进程上启动UIAbility,并绑定该进程到状态栏图标上。<br>**约束:**<br>使用此模式时,要求目标UIAbility跟调用方是在同一个应用,并且应用要在状态栏中有图标。                  |
52| ATTACH_TO_STATUS_BAR_ITEM | 3 | 启动UIAbility,并绑定该UIAbility所在进程到状态栏图标上。<br>**约束:**<br>使用此模式时,要求目标UIAbility跟调用方是在同一个应用,并且应用要在状态栏中有图标。                  |
53
54**示例:**
55
56  ```ts
57  import { UIAbility, Want, StartOptions, contextConstant } from '@kit.AbilityKit';
58  import { BusinessError } from '@kit.BasicServicesKit';
59
60  export default class EntryAbility extends UIAbility {
61    onForeground() {
62      let want: Want = {
63        deviceId: '',
64        bundleName: 'com.example.myapplication',
65        abilityName: 'MainAbility2'
66      };
67      let options: StartOptions = {
68        processMode: contextConstant.ProcessMode.NEW_PROCESS_ATTACH_TO_STATUS_BAR_ITEM,
69        startupVisibility: contextConstant.StartupVisibility.STARTUP_HIDE
70      };
71
72      try {
73        this.context.startAbility(want, options, (err: BusinessError) => {
74          if (err.code) {
75            // 处理业务逻辑错误
76            console.error(`startAbility failed, code is ${err.code}, message is ${err.message}`);
77            return;
78          }
79          // 执行正常业务
80          console.info('startAbility succeed');
81        });
82      } catch (err) {
83        // 处理入参错误异常
84        let code = (err as BusinessError).code;
85        let message = (err as BusinessError).message;
86        console.error(`startAbility failed, code is ${code}, message is ${message}`);
87      }
88    }
89  }
90  ```
91
92## StartupVisibility<sup>12+</sup>
93
94UIAbility启动后是否可见。
95
96当用户设置目标UIAbility为不可见时,目标UIAbility的窗口不会显示在前台,dock栏也不会有图标,同时目标UIAbility的onForeground生命周期不会被调用。
97
98StartupVisibility作为[StartOptions](js-apis-app-ability-startOptions.md)的一个属性,仅在[UIAbilityContext.startAbility](js-apis-inner-application-uiAbilityContext.md#startability-1)中生效,用来指定目标UIAbility启动后的可见性。
99
100**系统能力**:SystemCapability.Ability.AbilityRuntime.Core
101
102**设备行为差异**:该功能仅在2in1和Tablet设备上生效,在其他设备中返回801错误码。
103
104| 名称  | 值 | 说明                                                                                                                   |
105|-----| -------- |----------------------------------------------------------------------------------------------------------------------|
106| STARTUP_HIDE | 0 | 目标UIAbility启动后,进入隐藏状态。不会调用UIAbility的onForeground生命周期。        |
107| STARTUP_SHOW | 1 | 目标UIAbility启动后,正常显示。     |
108
109**示例:**
110
111  参见[ContextConstant.ProcessMode](#processmode12)。
112
113## Scenarios<sup>20+</sup>
114
115表示不触发[onNewWant](./js-apis-app-ability-uiAbility.md#onnewwant)生命周期回调场景的枚举,用于[setOnNewWantSkipScenarios](./js-apis-inner-application-uiAbilityContext.md#setonnewwantskipscenarios20)接口。
116
117**原子化服务API**:从API version 20开始,该接口支持在原子化服务中使用。
118
119**系统能力**:SystemCapability.Ability.AbilityRuntime.Core
120
121| 名称  | 值 | 说明                                                                                                                   |
122|-----| -------- |----------------------------------------------------------------------------------------------------------------------|
123| SCENARIO_MOVE_MISSION_TO_FRONT | 0x00000001 | <!--RP1-->系统接口[missionManager.moveMissionToFront](./js-apis-app-ability-missionManager-sys.md#missionmanagermovemissiontofront-2)接口触发的UIAbility到前台场景。<!--RP1End-->        |
124| SCENARIO_SHOW_ABILITY | 0x00000002 | [showAbility](./js-apis-inner-application-uiAbilityContext.md#showability12)接口触发的UIAbility到前台场景。     |
125| SCENARIO_BACK_TO_CALLER_ABILITY_WITH_RESULT | 0x00000004 | [backToCallerAbilityWithResult](./js-apis-inner-application-uiAbilityContext.md#backtocallerabilitywithresult12)接口触发的UIAbility到前台场景。     |
126
127**示例:**
128
129```ts
130import { AbilityConstant, contextConstant, UIAbility, Want } from '@kit.AbilityKit';
131import { BusinessError } from '@kit.BasicServicesKit';
132
133export default class EntryAbility extends UIAbility {
134  onCreate(want: Want, launchParam: AbilityConstant.LaunchParam) {
135    let scenarios: number = contextConstant.Scenarios.SCENARIO_MOVE_MISSION_TO_FRONT |
136      contextConstant.Scenarios.SCENARIO_SHOW_ABILITY |
137      contextConstant.Scenarios.SCENARIO_BACK_TO_CALLER_ABILITY_WITH_RESULT;
138
139    try {
140      this.context.setOnNewWantSkipScenarios(scenarios).then(() => {
141        // 执行正常业务
142        console.info('setOnNewWantSkipScenarios succeed');
143      }).catch((err: BusinessError) => {
144        // 处理业务逻辑错误
145        console.error(`setOnNewWantSkipScenarios failed, code is ${err.code}, message is ${err.message}`);
146      });
147    } catch (err) {
148      // 处理入参错误异常
149      let code = (err as BusinessError).code;
150      let message = (err as BusinessError).message;
151      console.error(`setOnNewWantSkipScenarios failed, code is ${code}, message is ${message}`);
152    }
153  }
154}
155```