• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1# @ohos.app.ability.wantConstant (wantConstant)
2
3wantConstant模块提供want中操作want常数和解释Flags说明的能力。
4
5> **说明:**
6>
7> 本模块首批接口从API version 9开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。
8
9## 导入模块
10
11```ts
12import { wantConstant } from '@kit.AbilityKit';
13```
14
15## Params
16
17want的Params操作的常量。
18
19**系统能力**:SystemCapability.Ability.AbilityBase
20
21| 名称                    | 值                                 | 说明                                                                           |
22| ----------------------- | ---------------------------------- | ------------------------------------------------------------------------------ |
23| ABILITY_BACK_TO_OTHER_MISSION_STACK   | ability.params.backToOtherMissionStack     | 表示是否支持跨任务链返回。<br>**原子化服务API**:从API version 11开始,该接口支持在原子化服务中使用。  |
24| ABILITY_RECOVERY_RESTART<sup>10+</sup> | ohos.ability.params.abilityRecoveryRestart | 指示当前Ability是否发生了故障恢复重启。<br>**原子化服务API**:从API version 11开始,该接口支持在原子化服务中使用。 |
25| CONTENT_TITLE_KEY<sup>10+</sup>       | ohos.extra.param.key.contentTitle  | 指示原子化服务支持分享标题的参数的操作。<br>**原子化服务API**:从API version 11开始,该接口支持在原子化服务中使用。  |
26| SHARE_ABSTRACT_KEY<sup>10+</sup>      | ohos.extra.param.key.shareAbstract | 指示原子化服务支持分享内容的参数的操作。<br>**原子化服务API**:从API version 11开始,该接口支持在原子化服务中使用。  |
27| SHARE_URL_KEY<sup>10+</sup>           | ohos.extra.param.key.shareUrl      | 指示原子化服务支持分享链接的参数的操作。<br>**原子化服务API**:从API version 11开始,该接口支持在原子化服务中使用。  |
28| SUPPORT_CONTINUE_PAGE_STACK_KEY<sup>10+</sup>    | ohos.extra.param.key.supportContinuePageStack  | 指示在跨端迁移过程中是否迁移页面栈信息,默认值为true,自动迁移页面栈信息。<br>**原子化服务API**:从API version 11开始,该接口支持在原子化服务中使用。|
29| SUPPORT_CONTINUE_SOURCE_EXIT_KEY<sup>10+</sup>  | ohos.extra.param.key.supportContinueSourceExit      | 指示跨端迁移源端应用是否退出,默认值为true,源端应用自动退出。<br>**原子化服务API**:从API version 11开始,该接口支持在原子化服务中使用。|
30| SHOW_MODE_KEY<sup>12+</sup>  | ohos.extra.param.key.showMode      | 指示展示模式,值为枚举类型wantConstant.ShowMode<br>**原子化服务API**:从API version 12开始,该接口支持在原子化服务中使用。|
31| PARAMS_STREAM<sup>12+</sup>  | ability.params.stream  | 指示携带的文件URI要授权给目标方。对应的value必须是string类型的文件URI数组。文件URI的获取参考[fileUri](../apis-core-file-kit/js-apis-file-fileuri.md#fileurigeturifrompath) <br>**原子化服务API**:从API version 12开始,该接口支持在原子化服务中使用。 |
32| APP_CLONE_INDEX_KEY<sup>12+</sup>  | ohos.extra.param.key.appCloneIndex  | 指示分身应用索引。 <br>**原子化服务API**:从API version 12开始,该接口支持在原子化服务中使用。 |
33| CALLER_REQUEST_CODE<sup>12+</sup>  | ohos.extra.param.key.callerRequestCode  | 当调用[startAbilityForResult](js-apis-inner-application-uiAbilityContext.md#uiabilitycontextstartabilityforresult)或[openLink](js-apis-inner-application-uiAbilityContext.md#uiabilitycontextopenlink12)拉起目标方Ability时,需要目标方返回结果。为了确保目标方能够将结果准确返回到调用方,系统会自动生成唯一的requestCode,以标识本次调用。 <br>**原子化服务API**:从API version 12开始,该接口支持在原子化服务中使用。 |
34| PAGE_PATH<sup>12+</sup>  | ohos.param.atomicservice.pagePath | 指示页面参数路径。<br>**原子化服务API**:从API version 12开始,该接口支持在原子化服务中使用。  |
35| ROUTER_NAME<sup>12+</sup>  | ohos.param.atomicservice.routerName | 指示页面路由名称。<br>**原子化服务API**:从API version 12开始,该接口支持在原子化服务中使用。  |
36| PAGE_SOURCE_FILE<sup>12+</sup>  | ohos.param.atomicservice.pageSourceFile | 指示页面源文件。<br>**原子化服务API**:从API version 12开始,该接口支持在原子化服务中使用。  |
37| BUILD_FUNCTION<sup>12+</sup>  | ohos.param.atomicservice.buildFunction | 指示生成函数的参数。<br>**原子化服务API**:从API version 12开始,该接口支持在原子化服务中使用。  |
38| SUB_PACKAGE_NAME<sup>12+</sup>  | ohos.param.atomicservice.subpackageName | 指示子包名。<br>**原子化服务API**:从API version 12开始,该接口支持在原子化服务中使用。  |
39| APP_INSTANCE_KEY<sup>14+</sup>  | ohos.extra.param.key.appInstance  | 指示具体的应用实例。 |
40| CREATE_APP_INSTANCE_KEY<sup>14+</sup>  | ohos.extra.param.key.createAppInstance  | 指示创建新应用实例。 |
41| CALLER_APP_CLONE_INDEX<sup>14+</sup>  | ohos.param.callerAppCloneIndex  | 指示拉起方应用的分身索引。|
42| APP_LAUNCH_TRUSTLIST<sup>17+</sup>  | ohos.params.appLaunchTrustList  | 指示隐式启动时的应用过滤列表,隐式启动时仅匹配列表中的应用,值为string类型的[AppIdentifier](js-apis-bundleManager-bundleInfo.md#signatureinfo)数组,过滤列表最多支持50个应用,传入空数组不生效。<br>**原子化服务API**:从API version 17开始,该接口支持在原子化服务中使用。 |
43| LAUNCH_REASON_MESSAGE<sup>18+</sup>  | ohos.params.launchReasonMessage  | 调用方拉起目标方Ability时,可通过该字段设置拉起原因。调用方必须为系统应用,且需要申请ohos.permission.SET_LAUNCH_REASON_MESSAGE权限。 <br>**原子化服务API**:从API version 18开始,该接口支持在原子化服务中使用。 |
44
45## Flags
46
47Flags说明。用于表示处理Want的方式。
48
49**系统能力**:SystemCapability.Ability.AbilityBase
50
51| 名称                                 | 值       | 说明                                                         |
52| ------------------------------------ | ---------- | ------------------------------------------------------------ |
53| FLAG_AUTH_READ_URI_PERMISSION        | 0x00000001 | 指示对URI执行读取操作的授权。<br>**原子化服务API**:从API version 11开始,该接口支持在原子化服务中使用。                                  |
54| FLAG_AUTH_WRITE_URI_PERMISSION       | 0x00000002 | 指示对URI执行写入操作的授权。<br>**原子化服务API**:从API version 11开始,该接口支持在原子化服务中使用。                                  |
55| FLAG_AUTH_PERSISTABLE_URI_PERMISSION<sup>12+</sup> | 0x00000040 | 指示该URI可被接收方持久化。该字段仅在2in1和tablet设备上生效。|
56| FLAG_INSTALL_ON_DEMAND               | 0x00000800 | 如果未安装指定的功能,请安装该功能。<br>**原子化服务API**:从API version 11开始,该接口支持在原子化服务中使用。                              |
57| FLAG_START_WITHOUT_TIPS<sup>11+</sup>              | 0x40000000 | 如果隐式启动能力不能匹配任何应用程序,则不会弹出提示对话框。       |
58| FLAG_ABILITY_ON_COLLABORATE<sup>18+</sup> | 0x00002000 | 在多设备协同场景下,调用方应用通过DMS系统发起请求并且通过Flags字段携带此标志,协同方应用才会触发生命周期回调方法[onCollaborate(wantParam)](js-apis-app-ability-uiAbility.md#uiabilityoncollaborate18)。 |
59
60## ShowMode<sup>12+</sup>
61
62ShowMode说明。用于表示拉起原子化服务的展示模式。
63
64**原子化服务API**:从API version 12开始,该接口支持在原子化服务中使用。
65
66**系统能力**:SystemCapability.Ability.AbilityBase
67
68| 名称                                | 值 | 说明           |
69| ----------------------------------- |---|--------------|
70| WINDOW        | 0 | 指示独立窗口拉起模式。  |
71| EMBEDDED_FULL       | 1 | 指示嵌入式全屏拉起模式。 |
72