1.2K Star 6.4K Fork 5.4K

OpenHarmony/docs

加入 Gitee
与超过 1200万 开发者一起发现、参与优秀开源项目,私有仓库也完全免费 :)
免费加入
克隆/下载
js-apis-app-ability-startOptions.md 3.60 KB
一键复制 编辑 原始数据 按行查看 历史
jsjzju 提交于 2024-06-29 18:29 . ATTACH_TO_STATUS_BAR_ITEM文档修改

@ohos.app.ability.StartOptions (StartOptions)

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

说明:

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

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

导入模块

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

属性

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

名称 类型 只读 必填 说明
windowMode12+ number 启动Ability时的窗口模式,详见WindowMode
displayId number 屏幕ID模式。默认是0,表示当前屏幕。
原子化服务API: 从API version 11开始,该接口支持在原子化服务中使用。
withAnimation11+ boolean Ability是否具有动画效果。
windowLeft11+ number 窗口左边的位置。
windowTop11+ number 窗口顶部的位置。
windowWidth11+ number 窗口的宽度。
windowHeight11+ number 窗口的高度。
processMode12+ contextConstant.ProcessMode 进程模式。
约束:
1.仅在平板类设备上生效。
2.仅在UIAbilityContext.startAbility中生效。
3.processMode和startupVisibility必须同时设置。
startupVisibility12+ contextConstant.StartupVisibility Ability启动后的可见性。
约束:
1.仅在平板类设备上生效。
2.仅在UIAbilityContext.startAbility中生效。
3.processMode和startupVisibility必须同时设置。
windowFocused12+ boolean 窗口是否获焦。默认是true,表示窗口获焦。
约束:
1.仅在平板类设备上生效。
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}`);
    }
  }
}
马建仓 AI 助手
尝试更多
代码解读
代码找茬
代码优化
其他
1
https://gitee.com/openharmony/docs.git
git@gitee.com:openharmony/docs.git
openharmony
docs
docs
master

搜索帮助

344bd9b3 5694891 D2dac590 5694891