• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1/*
2 * Copyright (c) 2024 Huawei Device Co., Ltd.
3 * Licensed under the Apache License, Version 2.0 (the "License"),
4 * you may not use this file except in compliance with the License.
5 * You may obtain a copy of the License at
6 *
7 *     http://www.apache.org/licenses/LICENSE-2.0
8 *
9 * Unless required by applicable law or agreed to in writing, software
10 * distributed under the License is distributed on an "AS IS" BASIS,
11 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12 * See the License for the specific language governing permissions and
13 * limitations under the License.
14 */
15
16/**
17 * @file
18 * @kit AbilityKit
19 */
20
21import AbilityStageContext from './application/AbilityStageContext';
22
23/**
24 * The base class of startup task.
25 *
26 * @syscap SystemCapability.Ability.AppStartup
27 * @stagemodelonly
28 * @since 12
29 */
30@Sendable
31export default class StartupTask {
32  /**
33   * Called when specific dependent task complete.
34   *
35   * @param { string } dependency - Indicates name of specific dependent startup task.
36   * @param { Object } result - Indicates result of specific dependent startup task.
37   * @syscap SystemCapability.Ability.AppStartup
38   * @stagemodelonly
39   * @since 12
40   */
41  onDependencyCompleted?(dependency: string, result: Object): void;
42
43  /**
44   * Initializes current startup task.
45   * A developer could override this function to init current task and return a result for other tasks.
46   *
47   * @param { AbilityStageContext } context - Indicates ability stage context.
48   * @returns { Promise<Object | void> } The result of initialization.
49   * @syscap SystemCapability.Ability.AppStartup
50   * @stagemodelonly
51   * @since 12
52   */
53  init(context: AbilityStageContext): Promise<Object | void>;
54}
55