1/* 2 * Copyright (c) 2022 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 * Contains basic Ability information, which uniquely identifies an ability. 23 * You can use this class to obtain values of the fields set in an element, 24 * such as the device ID, bundle name, and ability name. 25 * 26 * @typedef ElementName 27 * @syscap SystemCapability.BundleManager.BundleFramework.Core 28 * @since 9 29 */ 30/** 31 * Contains basic Ability information, which uniquely identifies an ability. 32 * You can use this class to obtain values of the fields set in an element, 33 * such as the device ID, bundle name, and ability name. 34 * 35 * @typedef ElementName 36 * @syscap SystemCapability.BundleManager.BundleFramework.Core 37 * @atomicservice 38 * @since arkts {'1.1':'11', '1.2':'20'} 39 * @arkts 1.1&1.2 40 */ 41export interface ElementName { 42 /** 43 * Indicates device id 44 * 45 * @type { ?string } 46 * @syscap SystemCapability.BundleManager.BundleFramework.Core 47 * @since 9 48 */ 49 /** 50 * Indicates device id 51 * 52 * @type { ?string } 53 * @syscap SystemCapability.BundleManager.BundleFramework.Core 54 * @atomicservice 55 * @since arkts {'1.1':'11', '1.2':'20'} 56 * @arkts 1.1&1.2 57 */ 58 deviceId?: string; 59 60 /** 61 * @type { string } 62 * @default Indicates bundle name 63 * @syscap SystemCapability.BundleManager.BundleFramework.Core 64 * @since 9 65 */ 66 /** 67 * @type { string } 68 * @default Indicates bundle name 69 * @syscap SystemCapability.BundleManager.BundleFramework.Core 70 * @atomicservice 71 * @since arkts {'1.1':'11', '1.2':'20'} 72 * @arkts 1.1&1.2 73 */ 74 bundleName: string; 75 76 /** 77 * @type { ?string } 78 * @default Indicates module name 79 * @syscap SystemCapability.BundleManager.BundleFramework.Core 80 * @since 9 81 */ 82 /** 83 * @type { ?string } 84 * @default Indicates module name 85 * @syscap SystemCapability.BundleManager.BundleFramework.Core 86 * @atomicservice 87 * @since arkts {'1.1':'11', '1.2':'20'} 88 * @arkts 1.1&1.2 89 */ 90 moduleName?: string; 91 92 /** 93 * Indicates ability name 94 * 95 * @type { string } 96 * @syscap SystemCapability.BundleManager.BundleFramework.Core 97 * @since 9 98 */ 99 /** 100 * Indicates ability name 101 * 102 * @type { string } 103 * @syscap SystemCapability.BundleManager.BundleFramework.Core 104 * @atomicservice 105 * @since arkts {'1.1':'11', '1.2':'20'} 106 * @arkts 1.1&1.2 107 */ 108 abilityName: string; 109 110 /** 111 * Indicates uri 112 * 113 * @type { ?string } 114 * @syscap SystemCapability.BundleManager.BundleFramework.Core 115 * @since 9 116 */ 117 /** 118 * Indicates uri 119 * 120 * @type { ?string } 121 * @syscap SystemCapability.BundleManager.BundleFramework.Core 122 * @atomicservice 123 * @since arkts {'1.1':'11', '1.2':'20'} 124 * @arkts 1.1&1.2 125 */ 126 uri?: string; 127 128 /** 129 * Indicates short name 130 * 131 * @type { ?string } 132 * @syscap SystemCapability.BundleManager.BundleFramework.Core 133 * @since 9 134 */ 135 /** 136 * Indicates short name 137 * 138 * @type { ?string } 139 * @syscap SystemCapability.BundleManager.BundleFramework.Core 140 * @atomicservice 141 * @since arkts {'1.1':'11', '1.2':'20'} 142 * @arkts 1.1&1.2 143 */ 144 shortName?: string; 145} 146