@ohos.app.ability.wantConstant (wantConstant)

The wantConstant module provides the actions, entities, and flags used in Want objects.

NOTE

The initial APIs of this module are supported since API version 9. Newly added APIs will be marked with a superscript to indicate their earliest API version.

Modules to Import

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

Params

Defines Params (specifying the action that can be performed) in the Want.

System capability: SystemCapability.Ability.AbilityBase

Name	Value	Description
ABILITY_BACK_TO_OTHER_MISSION_STACK	ability.params.backToOtherMissionStack	Action of redirection back across mission stacks. Atomic service API: This API can be used in atomic services since API version 11.
ABILITY_RECOVERY_RESTART¹⁰⁺	ohos.ability.params.abilityRecoveryRestart	Action of recovering an ability from a fault and restarting it. Atomic service API: This API can be used in atomic services since API version 11.
CONTENT_TITLE_KEY¹⁰⁺	ohos.extra.param.key.contentTitle	Action of sharing the content title. Atomic service API: This API can be used in atomic services since API version 11.
SHARE_ABSTRACT_KEY¹⁰⁺	ohos.extra.param.key.shareAbstract	Action of sharing the abstract. Atomic service API: This API can be used in atomic services since API version 11.
SHARE_URL_KEY¹⁰⁺	ohos.extra.param.key.shareUrl	Action of sharing the URL. Atomic service API: This API can be used in atomic services since API version 11.
SUPPORT_CONTINUE_PAGE_STACK_KEY¹⁰⁺	ohos.extra.param.key.supportContinuePageStack	Action of migrating page stack information during cross-device migration. The default value is true, indicating that page stack information is automatically migrated. Atomic service API: This API can be used in atomic services since API version 11.
SUPPORT_CONTINUE_SOURCE_EXIT_KEY¹⁰⁺	ohos.extra.param.key.supportContinueSourceExit	Action of exiting the application on the source device during cross-device migration. The default value is true, indicating that the application on the source device automatically exits. Atomic service API: This API can be used in atomic services since API version 11.
SHOW_MODE_KEY¹²⁺	ohos.extra.param.key.showMode	Show mode. For details, see wantConstant.ShowMode. Atomic service API: This API can be used in atomic services since API version 12.
PARAMS_STREAM¹²⁺	ability.params.stream	File URIs to be authorized to the target ability. The value must be an array of file URIs of the string type. For details about how to obtain the file URI, see fileUri. Atomic service API: This API can be used in atomic services since API version 12.
APP_CLONE_INDEX_KEY¹²⁺	ohos.extra.param.key.appCloneIndex	Index of an application clone. Atomic service API: This API can be used in atomic services since API version 12.
CALLER_REQUEST_CODE¹²⁺	ohos.extra.param.key.callerRequestCode	Request code that uniquely identifies the caller of startAbilityForResult or openLink. When either of the APIs is called to start an ability, the target ability returns the result to the caller based on the request code. Atomic service API: This API can be used in atomic services since API version 12.
PAGE_PATH¹²⁺	ohos.param.atomicservice.pagePath	Path of page parameters. Atomic service API: This API can be used in atomic services since API version 12.
ROUTER_NAME¹²⁺	ohos.param.atomicservice.routerName	Name of the page router. Atomic service API: This API can be used in atomic services since API version 12.
PAGE_SOURCE_FILE¹²⁺	ohos.param.atomicservice.pageSourceFile	Source file of the page. Atomic service API: This API can be used in atomic services since API version 12.
BUILD_FUNCTION¹²⁺	ohos.param.atomicservice.buildFunction	Build function. Atomic service API: This API can be used in atomic services since API version 12.
SUB_PACKAGE_NAME¹²⁺	ohos.param.atomicservice.subpackageName	Name of a subpackage. Atomic service API: This API can be used in atomic services since API version 12.
APP_INSTANCE_KEY¹⁴⁺	ohos.extra.param.key.appInstance	Specific application instance.
CREATE_APP_INSTANCE_KEY¹⁴⁺	ohos.extra.param.key.createAppInstance	Action of creating an application instance.
CALLER_APP_CLONE_INDEX¹⁴⁺	ohos.param.callerAppCloneIndex	Clone index of the caller.
APP_LAUNCH_TRUSTLIST¹⁷⁺	ohos.params.appLaunchTrustList	Filter list of applications for implicit launch. Only applications in the list are matched during implicit launch. The value is an array of AppIdentifiers of the string type. The filter list supports a maximum of 50 applications. Passing an empty array will have no effect. Atomic service API: This API can be used in atomic services since API version 17.
LAUNCH_REASON_MESSAGE¹⁸⁺	ohos.params.launchReasonMessage	Reason for starting the ability when the caller starts the target ability. The caller must be a system application and must request the ohos.permission.SET_LAUNCH_REASON_MESSAGE permission. Currently, the value can only be ReasonMessage_SystemShare. Atomic service API: This API can be used in atomic services since API version 18.

Flags

Enumerates the flags that specify how the Want will be handled.

System capability: SystemCapability.Ability.AbilityBase

Name	Value	Description
FLAG_AUTH_READ_URI_PERMISSION	0x00000001	Grant the permission to read the URI. Atomic service API: This API can be used in atomic services since API version 11.
FLAG_AUTH_WRITE_URI_PERMISSION	0x00000002	Grant the permission to write data to the URI. Atomic service API: This API can be used in atomic services since API version 11.
FLAG_AUTH_PERSISTABLE_URI_PERMISSION¹²⁺	0x00000040	Make the URI persistent. It takes effect only on 2-in-1 devices and tablets.
FLAG_INSTALL_ON_DEMAND	0x00000800	Install the ability if it has not been installed. Atomic service API: This API can be used in atomic services since API version 11.
FLAG_START_WITHOUT_TIPS¹¹⁺	0x40000000	Do not display any tips if the ability implicitly started does not match any application.
FLAG_ABILITY_ON_COLLABORATE¹⁸⁺	0x00002000	In multi-device collaboration scenario, the caller application must initiate a request through the DMS, with this flag included in the Flags field, in order to invoke the lifecycle callback onCollaborate(wantParam) of the target application.