• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1# @ohos.app.ability.StartOptions (StartOptions)(系统接口)
2<!--Kit: Ability Kit-->
3<!--Subsystem: Ability-->
4<!--Owner: @dsz2025; @yangxuguang-huawei; @Luobniz21-->
5<!--Designer: @ccllee1-->
6<!--Tester: @lixueqing513-->
7<!--Adviser: @huipeizi-->
8
9StartOptions可以作为启动UIAbility接口（例如[startAbility()](js-apis-inner-application-uiAbilityContext.md#startability-1)）的入参，用于指定目标UIAbility启动时的选项，包括但不局限于窗口模式、目标UIAbility启动时所在的屏幕等。
10
11> **说明：**
12>
13> 本模块首批接口从API version 9 开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。
14>
15> 本模块接口仅可在Stage模型下使用。
16>
17> 当前页面仅包含本模块的系统接口，其他公开接口参见[@ohos.app.ability.StartOptions (StartOptions)](js-apis-app-ability-startOptions.md)。
18
19## 导入模块
20
21```ts
22import { StartOptions } from '@kit.AbilityKit';
23```
24
25## StartOptions
26
27**系统能力**：SystemCapability.Ability.AbilityRuntime.Core
28
29**系统接口**：此接口为系统接口。
30
31| 名称 | 类型 | 只读 | 可选 | 说明 |
32| -------- | -------- | -------- | -------- | -------- |
33| windowFocused<sup>12+</sup> | boolean | 否 | 是 | 窗口是否获焦。默认是true，表示窗口获焦。<br>**约束：**<br>1.该功能仅在2in1和Tablet设备上生效。<br>2.仅在[UIAbilityContext.startAbility](js-apis-inner-application-uiAbilityContext.md#startability-1)中生效。 |
34
35**示例：**
36
37  ```ts
38  import { UIAbility, Want, StartOptions } from '@kit.AbilityKit';
39  import { BusinessError } from '@kit.BasicServicesKit';
40
41  export default class EntryAbility extends UIAbility {
42
43    onForeground() {
44      let want: Want = {
45        deviceId: '',
46        bundleName: 'com.example.myapplication',
47        abilityName: 'EntryAbility'
48      };
49      let options: StartOptions = {
50        displayId: 0
51      };
52
53      try {
54        this.context.startAbility(want, options, (err: BusinessError) => {
55          if (err.code) {
56            // 处理业务逻辑错误
57            console.error(`startAbility failed, code is ${err.code}, message is ${err.message}`);
58            return;
59          }
60          // 执行正常业务
61          console.info('startAbility succeed');
62        });
63      } catch (err) {
64        // 处理入参错误异常
65        let code = (err as BusinessError).code;
66        let message = (err as BusinessError).message;
67        console.error(`startAbility failed, code is ${code}, message is ${message}`);
68      }
69    }
70  }
71  ```
72