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