• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1/*
2 * Copyright (c) 2023 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
21/**
22 * Obtains configuration information about a overlay hap module.
23 *
24 * @typedef OverlayModuleInfo
25 * @syscap SystemCapability.BundleManager.BundleFramework.Core
26 * @since 10
27 */
28export interface OverlayModuleInfo {
29  /**
30   * Indicates the name of the bundle
31   *
32   * @type { string }
33   * @syscap SystemCapability.BundleManager.BundleFramework.Core
34   * @since 10
35   */
36  readonly bundleName: string;
37
38  /**
39   * Indicates the name of the .hap package to which the capability belongs
40   *
41   * @type { string }
42   * @syscap SystemCapability.BundleManager.BundleFramework.Core
43   * @since 10
44   */
45  readonly moduleName: string;
46
47  /**
48   * Indicates the name of target module which is overlaid by the overlay module
49   *
50   * @type { string }
51   * @syscap SystemCapability.BundleManager.BundleFramework.Core
52   * @since 10
53   */
54  readonly targetModuleName: string;
55
56  /**
57   * Indicates the priority of the overlay module
58   *
59   * @type { number }
60   * @syscap SystemCapability.BundleManager.BundleFramework.Core
61   * @since 10
62   */
63  readonly priority: number;
64
65  /**
66   * Indicates the state of the overlay module
67   *
68   * @type { number }
69   * @syscap SystemCapability.BundleManager.BundleFramework.Core
70   * @since 10
71   */
72  readonly state: number;
73}
74