From e5b97a348f839b02e59a0ac0e7de5037f3c1980d Mon Sep 17 00:00:00 2001 From: yangxuguang-huawei Date: Thu, 20 Mar 2025 11:45:00 +0800 Subject: [PATCH] feat: add CompletionHandler Signed-off-by: yangxuguang-huawei --- api/@ohos.app.ability.CompletionHandler.d.ts | 55 ++++++++++++++++++++ api/@ohos.app.ability.StartOptions.d.ts | 12 +++++ build-tools/dts_parser/kit.json | 1 + 3 files changed, 68 insertions(+) create mode 100644 api/@ohos.app.ability.CompletionHandler.d.ts diff --git a/api/@ohos.app.ability.CompletionHandler.d.ts b/api/@ohos.app.ability.CompletionHandler.d.ts new file mode 100644 index 0000000000..2499461a6b --- /dev/null +++ b/api/@ohos.app.ability.CompletionHandler.d.ts @@ -0,0 +1,55 @@ +/* + * Copyright (c) 2025 Huawei Device Co., Ltd. + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +/** + * @file + * @kit AbilityKit + */ + +import { ElementName } from "./bundleManager/ElementName"; + +/** + * CompletionHandler is a handler to handle the completion events of start ability. + * + * @syscap SystemCapability.Ability.AbilityRuntime.Core + * @stagemodelonly + * @atomicservice + * @since 20 + */ +export default class CompletionHandler { + /** + * Notify the success result of startAbility. + * + * @param { ElementName } elementName - Indicates the component to start. + * @param { string } message - Indicates the message of the request result. + * @syscap SystemCapability.Ability.AbilityRuntime.Core + * @stagemodelonly + * @atomicservice + * @since 20 + */ + onRequestSuccess(elementName: ElementName, message: string): void; + + /** + * Notify the failure result of startAbility. + * + * @param { ElementName } elementName - Indicates the component to start. + * @param { string } message - Indicates the message of the request result. + * @syscap SystemCapability.Ability.AbilityRuntime.Core + * @stagemodelonly + * @atomicservice + * @since 20 + */ + onRequestFailure(elementName: ElementName, message: string): void; +} \ No newline at end of file diff --git a/api/@ohos.app.ability.StartOptions.d.ts b/api/@ohos.app.ability.StartOptions.d.ts index 89c77749b5..f924b29938 100644 --- a/api/@ohos.app.ability.StartOptions.d.ts +++ b/api/@ohos.app.ability.StartOptions.d.ts @@ -21,6 +21,7 @@ import contextConstant from "./@ohos.app.ability.contextConstant"; import image from "./@ohos.multimedia.image"; import bundleManager from './@ohos.bundle.bundleManager'; +import CompletionHandler from "./@ohos.app.ability.CompletionHandler"; /** * StartOptions is the basic communication component of the system. @@ -224,4 +225,15 @@ export default class StartOptions { * @since 18 */ maxWindowHeight?: number; + + /** + * The completion handler of StartAbility. + * + * @type { ?CompletionHandler } + * @syscap SystemCapability.Ability.AbilityRuntime.Core + * @stagemodelonly + * @atomicservice + * @since 20 + */ + completionHandler?: CompletionHandler; } \ No newline at end of file diff --git a/build-tools/dts_parser/kit.json b/build-tools/dts_parser/kit.json index dfe42871f2..2f8cf4dc07 100644 --- a/build-tools/dts_parser/kit.json +++ b/build-tools/dts_parser/kit.json @@ -251,6 +251,7 @@ }, { "filePath": "@ohos.application.appManager.d.ts", "kitName": "AbilityKit", "subSystem": "元能力" }, { "filePath": "@ohos.application.BackupExtensionAbility.d.ts", "kitName": "CoreFileKit", "subSystem": "文件管理" }, + { "filePath": "@ohos.application.CompletionHandler.d.ts", "kitName": "AbilityKit", "subSystem": "元能力" }, { "filePath": "@ohos.application.Configuration.d.ts", "kitName": "AbilityKit", "subSystem": "元能力" }, { "filePath": "@ohos.application.ConfigurationConstant.d.ts", "kitName": "AbilityKit", "subSystem": "元能力" }, { -- Gitee