harmony 鸿蒙@ohos.app.ability.StartOptions (StartOptions)(系统接口)

2025-06-12
浏览 (4)

@ohos.app.ability.StartOptions (StartOptions)(系统接口)

StartOptions可以作为startAbility()的入参，用于指定目标Ability的窗口模式。

说明：

本模块首批接口从API version 9 开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。

本模块接口仅可在Stage模型下使用。

当前页面仅包含本模块的系统接口，其他公开接口参见@ohos.app.ability.StartOptions (StartOptions)。

导入模块

import { StartOptions } from '@kit.AbilityKit';

StartOptions

系统能力：SystemCapability.Ability.AbilityRuntime.Core

系统接口：此接口为系统接口。

名称	类型	只读	可选	说明
windowFocused¹²⁺	boolean	否	是	窗口是否获焦。默认是true，表示窗口获焦。约束： 1.该功能仅在2in1和tablet设备上生效。 2.仅在UIAbilityContext.startAbility中生效。

示例：

  import { UIAbility, Want, StartOptions } from '@kit.AbilityKit';
  import { BusinessError } from '@kit.BasicServicesKit';

  export default class EntryAbility extends UIAbility {

    onForeground() {
      let want: Want = {
        deviceId: '',
        bundleName: 'com.example.myapplication',
        abilityName: 'EntryAbility'
      };
      let options: StartOptions = {
        displayId: 0
      };

      try {
        this.context.startAbility(want, options, (err: BusinessError) => {
          if (err.code) {
            // 处理业务逻辑错误
            console.error(`startAbility failed, code is ${err.code}, message is ${err.message}`);
            return;
          }
          // 执行正常业务
          console.info('startAbility succeed');
        });
      } catch (err) {
        // 处理入参错误异常
        let code = (err as BusinessError).code;
        let message = (err as BusinessError).message;
        console.error(`startAbility failed, code is ${code}, message is ${message}`);
      }
    }
  }