@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_RESTART10+ | 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_KEY10+ | 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_KEY10+ | 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_KEY10+ | 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_KEY10+ | 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_KEY10+ | 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_KEY12+ | 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_STREAM12+ | 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_KEY12+ | 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_CODE12+ | 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_PATH12+ | ohos.param.atomicservice.pagePath | Path of page parameters. Atomic service API: This API can be used in atomic services since API version 12. |
| ROUTER_NAME12+ | 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_FILE12+ | 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_FUNCTION12+ | ohos.param.atomicservice.buildFunction | Build function. Atomic service API: This API can be used in atomic services since API version 12. |
| SUB_PACKAGE_NAME12+ | 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_KEY14+ | ohos.extra.param.key.appInstance | Specific application instance. |
| CREATE_APP_INSTANCE_KEY14+ | ohos.extra.param.key.createAppInstance | Action of creating an application instance. |
| CALLER_APP_CLONE_INDEX14+ | ohos.param.callerAppCloneIndex | Clone index of the caller. |
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_PERMISSION12+ | 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_TIPS11+ | 0x40000000 | Do not display any tips if the ability implicitly started does not match any application. |
ShowMode12+
Enumerates the modes used to show the atomic service startup.
Atomic service API: This API can be used in atomic services since API version 12.
System capability: SystemCapability.Ability.AbilityBase
| Name | Value | Description |
|---|---|---|
| WINDOW | 0 | An independent window is used to show the ability startup. |
| EMBEDDED_FULL | 1 | An embedded full-screen is used to show the ability startup. |