1# @ohos.app.ability.wantConstant (Want常量) 2 3<!--Kit: Ability Kit--> 4<!--Subsystem: Ability--> 5<!--Owner: @linjunjie6--> 6<!--Designer: @li-weifeng2--> 7<!--Tester: @lixueqing513--> 8<!--Adviser: @huipeizi--> 9 10 11wantConstant模块提供了[Want](js-apis-app-ability-want.md)操作相关的系统预设枚举和常量，例如在启动Ability时常用的Flag、Param参数等。 12 13> **说明：** 14> 15> 本模块首批接口从API version 9开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。 16 17## 导入模块 18 19```ts 20import { wantConstant } from '@kit.AbilityKit'; 21``` 22 23## Params 24 25[Want.parameters](js-apis-app-ability-want.md#want)字段常用的系统预置关键字。开发者可以通过这些预置关键字设置或获取应用跳转等场景中额外携带的参数信息。例如在UIAbility的启动阶段，如果从onCreate回调的入参want字段中获取到ABILITY_RECOVERY_RESTART的值为true，则表示当前UIAbility发生了故障重启。 26 27**系统能力**：SystemCapability.Ability.AbilityBase 28 29| 名称 | 值 | 说明 | 30| ----------------------- | ---------------------------------- | ------------------------------------------------------------------------------ | 31| ABILITY_BACK_TO_OTHER_MISSION_STACK | ability.params.backToOtherMissionStack | 表示是否支持跨任务链返回。<br>该参数用于控制跨应用的UIAbility返回逻辑，其核心作用是改变用户执行返回键时的应用跳转行为。例如现有UIAbility A和UIAbility B，当前前台显示的是UIAbility A，随后系统服务又拉起UIAbility B（同时在Want的Params字段配置该参数为true），那么，当UIAbility B退出时，会返回到UIAbility A（即返回到最近一次的访问任务）。如果未配置该参数，则默认直接返回桌面。需要注意的是，该字段仅支持系统设置，三方应用传入该字段不生效。<br>**原子化服务API**：从API version 11开始，该接口支持在原子化服务中使用。 | 32| ABILITY_RECOVERY_RESTART<sup>10+</sup> | ohos.ability.params.abilityRecoveryRestart | 表示当前Ability是否发生了故障恢复重启。<br>**原子化服务API**：从API version 11开始，该接口支持在原子化服务中使用。 | 33| CONTENT_TITLE_KEY<sup>10+</sup> | ohos.extra.param.key.contentTitle | 表示原子化服务分享的标题。<br>在跨端分享的[onShare](js-apis-app-ability-uiAbility.md#onshare10)回调中，开发者可通过该字段设置分享的标题。<br>**原子化服务API**：从API version 11开始，该接口支持在原子化服务中使用。 | 34| SHARE_ABSTRACT_KEY<sup>10+</sup> | ohos.extra.param.key.shareAbstract | 表示原子化服务分享的内容摘要。<br>在跨端分享的[onShare](js-apis-app-ability-uiAbility.md#onshare10)回调中，开发者可通过该字段设置分享的摘要。<br>**原子化服务API**：从API version 11开始，该接口支持在原子化服务中使用。 | 35| SHARE_URL_KEY<sup>10+</sup> | ohos.extra.param.key.shareUrl | 表示原子化服务分享的URL链接。<br>在跨端分享的[onShare](js-apis-app-ability-uiAbility.md#onshare10)回调中，开发者可通过该字段设置分享的URL链接。<br>**原子化服务API**：从API version 11开始，该接口支持在原子化服务中使用。 | 36| SUPPORT_CONTINUE_PAGE_STACK_KEY<sup>10+</sup> | ohos.extra.param.key.supportContinuePageStack | 表示在跨端迁移过程中是否迁移页面栈信息。默认值为true，表示在跨端迁移过程中自动迁移页面栈信息。<br>**原子化服务API**：从API version 11开始，该接口支持在原子化服务中使用。| 37| SUPPORT_CONTINUE_SOURCE_EXIT_KEY<sup>10+</sup> | ohos.extra.param.key.supportContinueSourceExit | 表示跨端迁移源端应用是否退出。默认值为true，表示在跨端迁移过程中源端应用自动退出。<br>**原子化服务API**：从API version 11开始，该接口支持在原子化服务中使用。| 38| SHOW_MODE_KEY<sup>12+</sup> | ohos.extra.param.key.showMode | 表示[EmbeddableUIAbility](js-apis-app-ability-embeddableUIAbility.md)的显示模式，值为枚举类型[ShowMode](#showmode12)<br>**原子化服务API**：从API version 12开始，该接口支持在原子化服务中使用。| 39| PARAMS_STREAM<sup>12+</sup> | ability.params.stream | 表示授权给目标方的文件URI列表。对应的value必须是string类型的文件URI数组。文件URI的获取参考[fileUri](../apis-core-file-kit/js-apis-file-fileuri.md#fileurigeturifrompath) 。该字段需要与文件URI[读写Flag](js-apis-app-ability-wantConstant.md#flags)配合使用。<br>**原子化服务API**：从API version 12开始，该接口支持在原子化服务中使用。 | 40| APP_CLONE_INDEX_KEY<sup>12+</sup> | ohos.extra.param.key.appCloneIndex | 表示分身应用索引。 <br>**原子化服务API**：从API version 12开始，该接口支持在原子化服务中使用。 | 41| CALLER_REQUEST_CODE<sup>12+</sup> | ohos.extra.param.key.callerRequestCode | 表示应用拉起的请求码。<br>当调用[startAbilityForResult](js-apis-inner-application-uiAbilityContext.md#startabilityforresult)或[openLink](js-apis-inner-application-uiAbilityContext.md#openlink12)拉起目标方Ability时，需要目标方返回结果。为了确保目标方能够将结果准确返回到调用方，系统会自动生成唯一的requestCode，以标识本次调用。 <br>**原子化服务API**：从API version 12开始，该接口支持在原子化服务中使用。 | 42| PAGE_PATH<sup>12+</sup> | ohos.param.atomicservice.pagePath | 表示原子化服务的页面路径。<br>如果原子化服务的页面跳转是通过[router](../../ui/arkts-routing.md)实现的，可以使用该参数指定跳转的页面，例如"library/ets/pages/menu"。<br>**原子化服务API**：从API version 12开始，该接口支持在原子化服务中使用。 | 43| ROUTER_NAME<sup>12+</sup> | ohos.param.atomicservice.routerName | 表示原子化服务的页面路由名称，即进行页面跳转时指定的页面名称。<br>如果原子化服务的页面跳转是通过[Navigation](../../ui/arkts-navigation-navigation.md)实现的，可以通过ROUTER_NAME、PAGE_SOURCE_FILE及BUILD_FUNCTION联合使用指定跳转的页面。<br>**原子化服务API**：从API version 12开始，该接口支持在原子化服务中使用。 | 44| PAGE_SOURCE_FILE<sup>12+</sup> | ohos.param.atomicservice.pageSourceFile | 表示原子化服务的页面源文件。<br>如果原子化服务的页面跳转是通过[Navigation](../../ui/arkts-navigation-navigation.md)实现的，可以通过ROUTER_NAME、PAGE_SOURCE_FILE及BUILD_FUNCTION联合使用指定跳转的页面。<br>**原子化服务API**：从API version 12开始，该接口支持在原子化服务中使用。 | 45| BUILD_FUNCTION<sup>12+</sup> | ohos.param.atomicservice.buildFunction | 表示原子化服务的生成函数。<br>如果原子化服务的页面跳转是通过[Navigation](../../ui/arkts-navigation-navigation.md)实现的，可以通过ROUTER_NAME、PAGE_SOURCE_FILE及BUILD_FUNCTION联合使用指定跳转的页面。<br>**原子化服务API**：从API version 12开始，该接口支持在原子化服务中使用。 | 46| SUB_PACKAGE_NAME<sup>12+</sup> | ohos.param.atomicservice.subpackageName | 表示原子化服务的分包名。应用程序包支持多模块开发，每个应用程序包可能包含多个HAP或HSP。原子化服务为了实现快速启动效果，对HAP和HSP文件大小做了限制，并同时优化了启动机制，原子化服务的这种多模块开发方式称为“分包”。<br>打开原子化服务的时候，可以通过设置该参数拉起对应的分包。<br>**原子化服务API**：从API version 12开始，该接口支持在原子化服务中使用。 | 47| APP_INSTANCE_KEY<sup>14+</sup> | ohos.extra.param.key.appInstance | 表示具体的应用实例。<br>在[应用创建多实例](../../quick-start/multiInstance.md)时，系统会为每个实例分配唯一的标识。应用跳转时，开发者可以通过设置该参数指定希望跳转到的已创建的应用实例。 | 48| CREATE_APP_INSTANCE_KEY<sup>14+</sup> | ohos.extra.param.key.createAppInstance | 表示是否创建新应用实例。默认为false，表示不创建新应用实例。<br>开发者可以通过设置该参数为true拉起新的应用实例。需要注意的是，被拉起的应用需要支持多实例，参考[应用创建多实例](../../quick-start/multiInstance.md)。 | 49| CALLER_APP_CLONE_INDEX<sup>14+</sup> | ohos.param.callerAppCloneIndex | 表示被拉起方应用的分身索引。当应用有多个[分身](../../quick-start/app-clone.md)时，可通过设置该参数指定被拉起方的分身。| 50| APP_LAUNCH_TRUSTLIST<sup>17+</sup> | ohos.params.appLaunchTrustList | 表示隐式启动时的应用过滤列表。<br>隐式启动时仅匹配列表中的应用，值为string类型的[AppIdentifier](js-apis-bundleManager-bundleInfo.md#signatureinfo)数组，过滤列表最多支持50个应用，传入空数组不生效。<br>**原子化服务API**：从API version 17开始，该接口支持在原子化服务中使用。 | 51| LAUNCH_REASON_MESSAGE<sup>18+</sup> | ohos.params.launchReasonMessage | 表示应用拉起的原因。<br>调用方必须为系统应用，且需要申请ohos.permission.SET_LAUNCH_REASON_MESSAGE权限。当前取值仅支持"ReasonMessage_SystemShare"。 <br>**原子化服务API**：从API version 18开始，该接口支持在原子化服务中使用。 | 52| DESTINATION_PLUGIN_ABILITY<sup>19+</sup> | ohos.params.pluginAbility | 指示目标Ability是插件Ability。 | 53| ATOMIC_SERVICE_SHARE_ROUTER<sup>20+</sup> | ohos.params.atomicservice.shareRouter | 表示被拉起的原子化服务的页面栈信息。仅当拉起方为UIAbilityContext，被拉起方为原子化服务时生效。<br>例如，某原子化服务中包含首页和第2页，如果希望直接拉起原子化服务的第2页，可以在拉起原子化服务时通过该字段传递第2页的页面栈信息。<br>**原子化服务API**：从API version 20开始，该接口支持在原子化服务中使用。 | 54| ABILITY_UNIFIED_DATA_KEY<sup>20+</sup> | ohos.param.ability.udKey | 表示基于[UDMF](../../reference/apis-arkdata/js-apis-data-unifiedDataChannel.md)进行文件分享时使用的唯一标识。该字段只允许系统应用设置，三方应用可以读取。<br>当Want中存在URI授权Flag字段（即[FLAG_AUTH_READ_URI_PERMISSION](#flags)或[FLAG_AUTH_WRITE_URI_PERMISSION](#flags)），且同时存在PARAMS_STREAM字段时，该字段将不生效。 <br>**原子化服务API**：从API version 20开始，该接口支持在原子化服务中使用。| 55 56## Flags 57 58[Want.flags](js-apis-app-ability-want.md#want)字段常用的系统预置关键字。开发者可以通过这些预置关键字设置或获取应用跳转等场景中额外携带的标志位信息。 59 60**系统能力**：SystemCapability.Ability.AbilityBase 61 62| 名称 | 值 | 说明 | 63| ------------------------------------ | ---------- | ------------------------------------------------------------ | 64| FLAG_AUTH_READ_URI_PERMISSION | 0x00000001 | 表示临时授予接收方读取该URI指向的数据的权限。<br>**原子化服务API**：从API version 11开始，该接口支持在原子化服务中使用。 | 65| FLAG_AUTH_WRITE_URI_PERMISSION | 0x00000002 | 表示临时授予接收方写入该URI指向的数据的权限。<br>**原子化服务API**：从API version 11开始，该接口支持在原子化服务中使用。 | 66| FLAG_AUTH_PERSISTABLE_URI_PERMISSION<sup>12+</sup> | 0x00000040 | 表示该URI可被接收方持久化。该字段仅在2in1和Tablet设备上生效。| 67| FLAG_INSTALL_ON_DEMAND | 0x00000800 | 表示拉起原子化服务时开启免安装功能。<br>- 如果开启了免安装功能，当系统检测到被拉起的原子化服务未安装时，会自动安装原子化服务，再进行拉起。<br>- 如果未开启免安装功能，当原子化服务未安装时，将拉起失败。<br>**原子化服务API**：从API version 11开始，该接口支持在原子化服务中使用。 | 68| FLAG_START_WITHOUT_TIPS<sup>11+</sup> | 0x40000000 | 表示是否关闭匹配失败弹窗功能。<br>通过[隐式方式拉起应用](../../application-models/app-startup-overview.md)时，如果没有能够匹配的应用，默认会弹出提示弹窗“暂无可用打开方式”。开发者可以通过该字段屏蔽该弹窗。 | 69| FLAG_ABILITY_ON_COLLABORATE<sup>18+</sup> | 0x00002000 | 在多设备协同场景下，调用方应用通过DMS系统发起请求并且通过Flags字段携带此标志，协同方应用才会触发生命周期回调方法[onCollaborate()](js-apis-app-ability-uiAbility.md#oncollaborate18)。 | 70 71## ShowMode<sup>12+</sup> 72 73表示[EmbeddableUIAbility](js-apis-app-ability-embeddableUIAbility.md)被拉起时的显示模式。 74 75**原子化服务API**：从API version 12开始，该接口支持在原子化服务中使用。 76 77**系统能力**：SystemCapability.Ability.AbilityBase 78 79| 名称 | 值 | 说明 | 80| ----------------------------------- |---|--------------| 81| WINDOW | 0 | 表示独立窗口拉起模式。 | 82| EMBEDDED_FULL | 1 | 表示嵌入式全屏拉起模式。 | 83