2022-10-17 08:41:13 +00:00
|
|
|
/*
|
2023-05-06 07:20:31 +00:00
|
|
|
* Copyright (c) 2022-2023 Huawei Device Co., Ltd.
|
2022-10-17 08:41:13 +00:00
|
|
|
* 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.
|
|
|
|
*/
|
|
|
|
|
2023-12-11 09:08:03 +00:00
|
|
|
/**
|
|
|
|
* @file
|
2024-01-08 07:25:39 +00:00
|
|
|
* @kit AbilityKit
|
2023-12-11 09:08:03 +00:00
|
|
|
*/
|
|
|
|
|
2023-05-06 06:59:50 +00:00
|
|
|
import AbilityConstant from './@ohos.app.ability.AbilityConstant';
|
|
|
|
import AbilityStageContext from './application/AbilityStageContext';
|
2022-10-18 12:14:04 +00:00
|
|
|
import Want from './@ohos.app.ability.Want';
|
|
|
|
import { Configuration } from './@ohos.app.ability.Configuration';
|
2022-10-17 08:41:13 +00:00
|
|
|
|
|
|
|
/**
|
|
|
|
* The class of an ability stage.
|
2023-05-06 06:59:50 +00:00
|
|
|
*
|
2022-10-17 08:41:13 +00:00
|
|
|
* @syscap SystemCapability.Ability.AbilityRuntime.Core
|
2022-11-16 03:03:26 +00:00
|
|
|
* @StageModelOnly
|
2022-10-17 08:51:36 +00:00
|
|
|
* @since 9
|
2022-10-17 08:41:13 +00:00
|
|
|
*/
|
2023-05-17 11:09:22 +00:00
|
|
|
/**
|
|
|
|
* The class of an ability stage.
|
2023-05-26 02:24:08 +00:00
|
|
|
*
|
2023-05-17 11:09:22 +00:00
|
|
|
* @syscap SystemCapability.Ability.AbilityRuntime.Core
|
|
|
|
* @StageModelOnly
|
|
|
|
* @crossplatform
|
|
|
|
* @since 10
|
|
|
|
*/
|
2023-11-11 10:44:20 +00:00
|
|
|
/**
|
|
|
|
* The class of an ability stage.
|
|
|
|
*
|
|
|
|
* @syscap SystemCapability.Ability.AbilityRuntime.Core
|
|
|
|
* @StageModelOnly
|
|
|
|
* @crossplatform
|
|
|
|
* @atomicservice
|
|
|
|
* @since 11
|
|
|
|
*/
|
2022-10-17 08:41:13 +00:00
|
|
|
export default class AbilityStage {
|
2023-04-21 09:47:24 +00:00
|
|
|
/**
|
|
|
|
* Indicates configuration information about context.
|
2023-05-06 06:59:50 +00:00
|
|
|
*
|
2023-04-21 09:47:24 +00:00
|
|
|
* @type { AbilityStageContext }
|
|
|
|
* @syscap SystemCapability.Ability.AbilityRuntime.Core
|
|
|
|
* @StageModelOnly
|
|
|
|
* @since 9
|
|
|
|
*/
|
2023-05-17 11:09:22 +00:00
|
|
|
/**
|
|
|
|
* Indicates configuration information about context.
|
2023-05-26 02:24:08 +00:00
|
|
|
*
|
2023-05-17 11:09:22 +00:00
|
|
|
* @type { AbilityStageContext }
|
|
|
|
* @syscap SystemCapability.Ability.AbilityRuntime.Core
|
|
|
|
* @StageModelOnly
|
|
|
|
* @crossplatform
|
|
|
|
* @since 10
|
|
|
|
*/
|
2023-11-11 10:44:20 +00:00
|
|
|
/**
|
|
|
|
* Indicates configuration information about context.
|
|
|
|
*
|
|
|
|
* @type { AbilityStageContext }
|
|
|
|
* @syscap SystemCapability.Ability.AbilityRuntime.Core
|
|
|
|
* @StageModelOnly
|
|
|
|
* @crossplatform
|
|
|
|
* @atomicservice
|
|
|
|
* @since 11
|
|
|
|
*/
|
2023-04-21 09:47:24 +00:00
|
|
|
context: AbilityStageContext;
|
2022-10-17 08:41:13 +00:00
|
|
|
|
2023-04-21 09:47:24 +00:00
|
|
|
/**
|
|
|
|
* Called back when an ability stage is started for initialization.
|
2023-05-06 06:59:50 +00:00
|
|
|
*
|
2023-04-21 09:47:24 +00:00
|
|
|
* @syscap SystemCapability.Ability.AbilityRuntime.Core
|
|
|
|
* @StageModelOnly
|
|
|
|
* @since 9
|
|
|
|
*/
|
2023-05-17 11:09:22 +00:00
|
|
|
/**
|
|
|
|
* Called back when an ability stage is started for initialization.
|
2023-05-26 02:24:08 +00:00
|
|
|
*
|
2023-05-17 11:09:22 +00:00
|
|
|
* @syscap SystemCapability.Ability.AbilityRuntime.Core
|
|
|
|
* @StageModelOnly
|
|
|
|
* @crossplatform
|
|
|
|
* @since 10
|
|
|
|
*/
|
2023-11-11 10:44:20 +00:00
|
|
|
/**
|
|
|
|
* Called back when an ability stage is started for initialization.
|
|
|
|
*
|
|
|
|
* @syscap SystemCapability.Ability.AbilityRuntime.Core
|
|
|
|
* @StageModelOnly
|
|
|
|
* @crossplatform
|
|
|
|
* @atomicservice
|
|
|
|
* @since 11
|
|
|
|
*/
|
2023-04-21 09:47:24 +00:00
|
|
|
onCreate(): void;
|
2022-10-17 08:41:13 +00:00
|
|
|
|
2023-04-21 09:47:24 +00:00
|
|
|
/**
|
|
|
|
* Called back when start specified ability.
|
2023-05-06 06:59:50 +00:00
|
|
|
*
|
2023-04-21 09:47:24 +00:00
|
|
|
* @param { Want } want - Indicates the want info of started ability.
|
|
|
|
* @returns { string } The user returns an ability string ID. If the ability of this ID has been started before,
|
|
|
|
* do not create a new instance and pull it back to the top of the stack.
|
|
|
|
* Otherwise, create a new instance and start it.
|
|
|
|
* @syscap SystemCapability.Ability.AbilityRuntime.Core
|
|
|
|
* @StageModelOnly
|
|
|
|
* @since 9
|
|
|
|
*/
|
2023-11-11 10:44:20 +00:00
|
|
|
/**
|
|
|
|
* Called back when start specified ability.
|
|
|
|
*
|
|
|
|
* @param { Want } want - Indicates the want info of started ability.
|
|
|
|
* @returns { string } The user returns an ability string ID. If the ability of this ID has been started before,
|
|
|
|
* do not create a new instance and pull it back to the top of the stack.
|
|
|
|
* Otherwise, create a new instance and start it.
|
|
|
|
* @syscap SystemCapability.Ability.AbilityRuntime.Core
|
|
|
|
* @StageModelOnly
|
|
|
|
* @atomicservice
|
|
|
|
* @since 11
|
|
|
|
*/
|
2023-04-21 09:47:24 +00:00
|
|
|
onAcceptWant(want: Want): string;
|
2022-10-17 08:41:13 +00:00
|
|
|
|
2023-10-16 07:17:06 +00:00
|
|
|
/**
|
2023-10-28 01:00:01 +00:00
|
|
|
* Called back when start UIAbility in specified process.
|
2023-10-16 07:17:06 +00:00
|
|
|
*
|
|
|
|
* @param { Want } want - Indicates the want info of started ability.
|
|
|
|
* @returns { string } The user returns an process string ID. If the process of this ID has been created before,
|
|
|
|
* let the ability run in this process. Otherwise, create a new process.
|
|
|
|
* @syscap SystemCapability.Ability.AbilityRuntime.Core
|
|
|
|
* @StageModelOnly
|
|
|
|
* @since 11
|
|
|
|
*/
|
|
|
|
onNewProcessRequest(want: Want): string;
|
|
|
|
|
2023-04-21 09:47:24 +00:00
|
|
|
/**
|
|
|
|
* Called when the system configuration is updated.
|
2023-05-06 06:59:50 +00:00
|
|
|
*
|
2023-04-21 09:47:24 +00:00
|
|
|
* @param { Configuration } newConfig - Indicates the updated configuration.
|
|
|
|
* @syscap SystemCapability.Ability.AbilityRuntime.Core
|
|
|
|
* @StageModelOnly
|
|
|
|
* @since 9
|
|
|
|
*/
|
2023-05-17 11:09:22 +00:00
|
|
|
/**
|
|
|
|
* Called when the system configuration is updated.
|
2023-05-26 02:24:08 +00:00
|
|
|
*
|
2023-05-17 11:09:22 +00:00
|
|
|
* @param { Configuration } newConfig - Indicates the updated configuration.
|
|
|
|
* @syscap SystemCapability.Ability.AbilityRuntime.Core
|
|
|
|
* @StageModelOnly
|
|
|
|
* @crossplatform
|
|
|
|
* @since 10
|
|
|
|
*/
|
2023-11-11 10:44:20 +00:00
|
|
|
/**
|
|
|
|
* Called when the system configuration is updated.
|
|
|
|
*
|
|
|
|
* @param { Configuration } newConfig - Indicates the updated configuration.
|
|
|
|
* @syscap SystemCapability.Ability.AbilityRuntime.Core
|
|
|
|
* @StageModelOnly
|
|
|
|
* @crossplatform
|
|
|
|
* @atomicservice
|
|
|
|
* @since 11
|
|
|
|
*/
|
2023-04-21 09:47:24 +00:00
|
|
|
onConfigurationUpdate(newConfig: Configuration): void;
|
2022-10-17 08:41:13 +00:00
|
|
|
|
2023-04-21 09:47:24 +00:00
|
|
|
/**
|
|
|
|
* Called when the system has determined to trim the memory, for example, when the ability is running in the
|
|
|
|
* background and there is no enough memory for running as many background processes as possible.
|
2023-05-06 06:59:50 +00:00
|
|
|
*
|
2023-04-21 09:47:24 +00:00
|
|
|
* @param { AbilityConstant.MemoryLevel } level - Indicates the memory trim level, which shows the current memory usage status.
|
|
|
|
* @syscap SystemCapability.Ability.AbilityRuntime.Core
|
|
|
|
* @StageModelOnly
|
|
|
|
* @since 9
|
|
|
|
*/
|
2023-11-11 10:44:20 +00:00
|
|
|
/**
|
|
|
|
* Called when the system has determined to trim the memory, for example, when the ability is running in the
|
|
|
|
* background and there is no enough memory for running as many background processes as possible.
|
|
|
|
*
|
|
|
|
* @param { AbilityConstant.MemoryLevel } level - Indicates the memory trim level, which shows the current memory usage status.
|
|
|
|
* @syscap SystemCapability.Ability.AbilityRuntime.Core
|
|
|
|
* @StageModelOnly
|
|
|
|
* @atomicservice
|
|
|
|
* @since 11
|
|
|
|
*/
|
2023-04-21 09:47:24 +00:00
|
|
|
onMemoryLevel(level: AbilityConstant.MemoryLevel): void;
|
2024-04-11 10:52:47 +00:00
|
|
|
|
|
|
|
/**
|
|
|
|
* Called back when an ability stage is Destroyed.
|
|
|
|
* Will not call the onDestroy function when killing a process or crashing abnormally.
|
|
|
|
*
|
|
|
|
* @syscap SystemCapability.Ability.AbilityRuntime.Core
|
|
|
|
* @StageModelOnly
|
|
|
|
* @atomicservice
|
|
|
|
* @since 12
|
|
|
|
*/
|
|
|
|
onDestroy(): void;
|
2022-10-17 08:41:13 +00:00
|
|
|
}
|