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 arkts {'1.1':'10', '1.2':'20'} 27 * @arkts 1.1&1.2 28 */ 29export interface OverlayModuleInfo { 30 /** 31 * Indicates the name of the bundle 32 * 33 * @type { string } 34 * @readonly 35 * @syscap SystemCapability.BundleManager.BundleFramework.Core 36 * @since arkts {'1.1':'10', '1.2':'20'} 37 * @arkts 1.1&1.2 38 */ 39 readonly bundleName: string; 40 41 /** 42 * Indicates the name of the .hap package to which the capability belongs 43 * 44 * @type { string } 45 * @readonly 46 * @syscap SystemCapability.BundleManager.BundleFramework.Core 47 * @since arkts {'1.1':'10', '1.2':'20'} 48 * @arkts 1.1&1.2 49 */ 50 readonly moduleName: string; 51 52 /** 53 * Indicates the name of target module which is overlaid by the overlay module 54 * 55 * @type { string } 56 * @readonly 57 * @syscap SystemCapability.BundleManager.BundleFramework.Core 58 * @since arkts {'1.1':'10', '1.2':'20'} 59 * @arkts 1.1&1.2 60 */ 61 readonly targetModuleName: string; 62 63 /** 64 * Indicates the priority of the overlay module 65 * 66 * @type { number } 67 * @readonly 68 * @syscap SystemCapability.BundleManager.BundleFramework.Core 69 * @since arkts {'1.1':'10', '1.2':'20'} 70 * @arkts 1.1&1.2 71 */ 72 readonly priority: number; 73 74 /** 75 * Indicates the state of the overlay module 76 * 77 * @type { number } 78 * @readonly 79 * @syscap SystemCapability.BundleManager.BundleFramework.Core 80 * @since arkts {'1.1':'10', '1.2':'20'} 81 * @arkts 1.1&1.2 82 */ 83 readonly state: number; 84} 85