文档管理中心
我的

您当前正在浏览HarmonyOS最新文档,覆盖已发布的所有API版本,可在API参考中筛选您使用的API版本。详细的版本配套关系请参考版本说明。

指南与API参考API参考应用框架Ability Kit(程序框架服务)ArkTS APIFA模型能力的接口abilityStartAbilityParameter

StartAbilityParameter

Phone12+PC/2in113+Tablet12+TV19+Wearable18+
本文导读

定义启动Ability参数,可以作为入参,调用startAbility启动指定的Ability。

说明

本接口从API version 6开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。

此接口仅可在FA模型下使用。

导入模块

收起
自动换行
深色代码主题
复制
  1. import ability from '@ohos.ability.ability';

属性

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

展开
名称 类型 只读 可选 说明
want Want 否 否 启动Ability的want信息。
abilityStartSetting { [key: string]: any } 否 是 启动Ability的特殊属性,当开发者启动Ability时,该属性可以作为调用中的输入参数传递。
abilityStartSettings11+ Record<string, Object> 否 是 启动Ability的特殊属性,当开发者启动Ability时,该属性可以作为调用中的输入参数传递。推荐使用该属性替代abilityStartSetting,设置该属性后,abilityStartSetting不再生效。

示例:

收起
自动换行
深色代码主题
复制
  1. import ability from '@ohos.ability.ability';
  2. import featureAbility from '@ohos.ability.featureAbility';
  3. import Want from '@ohos.app.ability.Want';
  4. let want: Want = {
  5. bundleName: 'com.example.abilityStartSettingApp2',
  6. abilityName: 'com.example.abilityStartSettingApp.EntryAbility',
  7. };
  8. let startAbilityParameter: ability.StartAbilityParameter = {
  9. want : want,
  10. abilityStartSettings : {
  11. abilityBounds : [100,200,300,400],
  12. windowMode :
  13. featureAbility.AbilityWindowConfiguration.WINDOW_MODE_UNDEFINED,
  14. displayId : 1,
  15. }
  16. };
  17. try {
  18. featureAbility.startAbility(startAbilityParameter, (error, data) => {
  19. if (error && error.code !== 0) {
  20. console.error(`startAbility fail, error: ${JSON.stringify(error)}`);
  21. } else {
  22. console.info(`startAbility success, data: ${JSON.stringify(data)}`);
  23. }
  24. });
  25. } catch(error) {
  26. console.error(`startAbility error: ${JSON.stringify(error)}`);
  27. }