@ohos.app.ability.StartOptions (StartOptions)

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

说明：

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

导入模块

import StartOptions from '@ohos.app.ability.StartOptions';

属性

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

名称	类型	只读	必填	说明
windowMode	number	否	否	窗口模式。系统API：该接口为系统接口，三方应用不支持调用。
displayId	number	否	否	屏幕ID模式。默认是0，表示当前屏幕。
withAnimation¹¹⁺	boolean	否	否	Ability是否具有动画效果。
windowLeft¹¹⁺	number	否	否	窗口左边的位置。
windowTop¹¹⁺	number	否	否	窗口顶部的位置。
windowWidth¹¹⁺	number	否	否	窗口的宽度。
windowHeight¹¹⁺	number	否	否	窗口的高度。

示例：

import UIAbility from '@ohos.app.ability.UIAbility';
import Want from '@ohos.app.ability.Want';
import StartOptions from '@ohos.app.ability.StartOptions';
import { BusinessError } from '@ohos.base';

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}`);
    }
  }
}