• 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 StartupConfig from './@ohos.app.appstartup.StartupConfig';
22import Want from './@ohos.app.ability.Want';
23
24/**
25 * The configuration entry for running startup tasks.
26 *
27 * @syscap SystemCapability.Ability.AppStartup
28 * @stagemodelonly
29 * @since 12
30 */
31export default class StartupConfigEntry {
32  /**
33   * Called when startup initialization to configure startup mode.
34   *
35   * @returns { StartupConfig } The developer returns a startup configuration.
36   * @syscap SystemCapability.Ability.AppStartup
37   * @stagemodelonly
38   * @since 12
39   */
40  onConfig?(): StartupConfig;
41
42  /**
43   * Called to obtain a custom match rule during application launch.
44   * Depending on the parameters in the Want passed in, you can return various custom rules to match against the
45   * `customization` field in `matchRules` configured for the startup task. If a match is successful, the task is
46   * executed automatically.
47   * This interface can be used to further refine matching rules when a startup scenario cannot be matched to
48   * a startup task through URI, action, or intent name rules.
49   *
50   * @param { Want } want Want information of the started ability.
51   * @returns { string } Custom match rule
52   * @syscap SystemCapability.Ability.AppStartup
53   * @stagemodelonly
54   * @since 20
55   */
56  onRequestCustomMatchRule(want: Want): string;
57}
58