• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1# @ohos.app.ability.StartOptions (StartOptions)
2
3**StartOptions** is used as an input parameter of [startAbility()](js-apis-inner-application-uiAbilityContext.md#uiabilitycontextstartability-1) to specify the window mode of an ability.
4
5> **NOTE**
6>
7> The initial APIs of this module are supported since API version 9. Newly added APIs will be marked with a superscript to indicate their earliest API version.
8> The APIs of this module can be used only in the stage model.
9
10## Modules to Import
11
12```ts
13import StartOptions from '@ohos.app.ability.StartOptions';
14```
15
16## Attributes
17
18**System capability**: SystemCapability.Ability.AbilityRuntime.Core
19
20| Name| Type| Mandatory| Description|
21| -------- | -------- | -------- | -------- |
22| [windowMode](js-apis-app-ability-abilityConstant.md#abilityconstantwindowmode) | number | No| Window mode.<br>**System API**: This is a system API and cannot be called by third-party applications.|
23| displayId | number | No| Display ID. The default value is **0**, indicating the current display.|
24
25**Example**
26
27  ```ts
28  import missionManager from '@ohos.app.ability.missionManager';
29  import StartOptions from '@ohos.app.ability.StartOptions';
30  import { BusinessError } from '@ohos.base';
31
32  try {
33    missionManager.getMissionInfos('', 10, (error, missions) => {
34      if (error) {
35          console.error(`getMissionInfos failed, error.code: ${JSON.stringify(error.code)}, error.message: ${JSON.stringify(error.message)}`);
36          return;
37      }
38      console.log(`size = ${missions.length}`);
39      console.log(`missions = ${JSON.stringify(missions)}`);
40      let id = missions[0].missionId;
41
42      let startOptions: StartOptions = {
43          windowMode : 101,
44          displayId: 0
45      };
46      missionManager.moveMissionToFront(id, startOptions).then(() => {
47  	    console.log('moveMissionToFront is called');
48      });
49    });
50  } catch (paramError) {
51    let code = (paramError as BusinessError).code;
52    let message = (paramError as BusinessError).message;
53    console.error(`error: ${code}, ${message}`);
54  }
55  ```
56