文档管理中心
您当前正在浏览HarmonyOS最新文档,覆盖已发布的所有API版本,可在API参考中筛选您使用的API版本。详细的版本配套关系请参考版本说明
开发与测试开放能力API应用框架Ability Kit(程序框架服务)ArkTS APIStage模型能力的接口@ohos.app.ability.CompletionHandlerForAbilityStartCallback (拉起应用结果回调的操作类)

@ohos.app.ability.CompletionHandlerForAbilityStartCallback (拉起应用结果回调的操作类)

Phone21+PC/2in121+Tablet21+TV21+Wearable21+

CompletionHandlerForAbilityStartCallback作为AbilityStartCallback的可选参数,用于返回垂域面板拉起指定类型的Ability组件的回调结果。

说明
  • 本模块首批接口从API version 21 开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。

  • 本模块接口仅可在Stage模型下使用。

导入模块

收起
自动换行
深色代码主题
复制
  1. import { CompletionHandlerForAbilityStartCallback } from '@kit.AbilityKit';

CompletionHandlerForAbilityStartCallback

Phone21+PC/2in121+Tablet21+TV21+Wearable21+

CompletionHandlerForAbilityStartCallback提供了onRequestSuccess和onRequestFailure两个回调函数属性,分别在拉起指定类型的Ability组件成功和失败时回调。

属性

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

展开
名称 类型 只读 可选 说明
onRequestSuccess OnRequestSuccessFn

拉起指定类型的Ability组件成功时的回调函数。

元服务API:从API version 21开始,该接口支持在元服务中使用。

onRequestFailure OnRequestFailureFn

拉起指定类型的Ability组件失败时的回调函数。

元服务API:从API version 21开始,该接口支持在元服务中使用。

OnRequestSuccessFn

Phone21+PC/2in121+Tablet21+TV21+Wearable21+

type OnRequestSuccessFn = (name: string) => void

拉起指定类型的Ability组件成功时的回调函数类型。

元服务API:从API version 21开始,该接口支持在元服务中使用。

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

参数:

展开
参数名 类型 必填 说明
name string

被拉起Ability组件或系统操作的名称。

Ability组件名称采用'[bundleName]#[moduleName]#[abilityName]'格式拼接。

示例:

参见OnRequestFailureFn

OnRequestFailureFn

Phone21+PC/2in121+Tablet21+TV21+Wearable21+

type OnRequestFailureFn = (name: string, failureCode: AbilityStartFailureCode, failureMessage: string) => void

拉起指定类型的Ability组件失败时的回调函数类型。

元服务API:从API version 21开始,该接口支持在元服务中使用。

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

参数:

展开
参数名 类型 必填 说明
name string

被拉起Ability组件或系统操作的名称。

Ability组件名称采用'[bundleName]#[moduleName]#[abilityName]'格式拼接。如果用户自动取消拉起,name为空。

failureCode AbilityStartFailureCode 失败原因的错误码。
failureMessage string 失败原因的描述。

示例:

收起
自动换行
深色代码主题
复制
  1. import { AbilityStartFailureCode, common, CompletionHandlerForAbilityStartCallback } from '@kit.AbilityKit';
  2. import { BusinessError } from '@kit.BasicServicesKit';
  3. @Entry
  4. @Component
  5. struct Index {
  6. @State message: string = 'Hello World';
  7. context: common.UIAbilityContext = this.getUIContext().getHostContext() as common.UIAbilityContext;
  8. completionHandler: CompletionHandlerForAbilityStartCallback = {
  9. onRequestSuccess: (name: string) => {
  10. console.info(`testTag onRequestSuccess name` + name);
  11. },
  12. onRequestFailure: (name: string, failureCode: AbilityStartFailureCode, failureMessage: string) => {
  13. console.info(`testTag onRequestFailure name: ` + name + `, failureCode:` + failureCode + `, failureMessage:` +
  14. failureMessage);
  15. }
  16. };
  17. abilityStartCallback: common.AbilityStartCallback = {
  18. onError: (code: number, name: string, message: string) => {
  19. console.error(`testTag code:` + code + `name:` + name + `message:` + message);
  20. },
  21. onResult: (abilityResult: common.AbilityResult) => {
  22. console.info(`testTag resultCode:` + abilityResult.resultCode + `bundleName:` + abilityResult.want?.bundleName);
  23. },
  24. completionHandler: this.completionHandler,
  25. };
  26. build() {
  27. Column({ space: 10 }) {
  28. Button('test')
  29. .type(ButtonType.Capsule)
  30. .offset({ x: 0, y: 60 })
  31. .width('80%')
  32. .type(ButtonType.Capsule)
  33. .margin({ top: 10 })
  34. .onClick(() => {
  35. let wantParam: Record<string, Object> = {
  36. 'time': '2023-10-23 20:45'
  37. };
  38. this.context.startAbilityByType("share", wantParam, this.abilityStartCallback).then(() => {
  39. console.info(`startAbilityByType success`);
  40. }).catch((err: BusinessError) => {
  41. console.error(`Failed startAbilityByType. Code: ${JSON.stringify(err.code)}, message: ${JSON.stringify(err.message)}`);
  42. });
  43. })
  44. }
  45. }
  46. }

AbilityStartFailureCode

Phone21+PC/2in121+Tablet21+TV21+Wearable21+

拉起指定类型的Ability组件失败的特定错误码。

元服务API:从API version 21开始,该接口支持在元服务中使用。

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

展开
名称 说明
FAILURE_CODE_SYSTEM_MALFUNCTION 0 表示由于系统错误(如跳转弹框崩溃)而无法拉起Ability组件。
FAILURE_CODE_USER_CANCEL 1 用户取消。
在 开发与测试 开放能力API 中进行搜索
请输入您想要搜索的关键词