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 11 39 */ 40export interface ElementName { 41 /** 42 * Indicates device id 43 * 44 * @type { ?string } 45 * @syscap SystemCapability.BundleManager.BundleFramework.Core 46 * @since 9 47 */ 48 /** 49 * Indicates device id 50 * 51 * @type { ?string } 52 * @syscap SystemCapability.BundleManager.BundleFramework.Core 53 * @atomicservice 54 * @since 11 55 */ 56 deviceId?: string; 57 58 /** 59 * @type { string } 60 * @default Indicates bundle name 61 * @syscap SystemCapability.BundleManager.BundleFramework.Core 62 * @since 9 63 */ 64 /** 65 * @type { string } 66 * @default Indicates bundle name 67 * @syscap SystemCapability.BundleManager.BundleFramework.Core 68 * @atomicservice 69 * @since 11 70 */ 71 bundleName: string; 72 73 /** 74 * @type { ?string } 75 * @default Indicates module name 76 * @syscap SystemCapability.BundleManager.BundleFramework.Core 77 * @since 9 78 */ 79 /** 80 * @type { ?string } 81 * @default Indicates module name 82 * @syscap SystemCapability.BundleManager.BundleFramework.Core 83 * @atomicservice 84 * @since 11 85 */ 86 moduleName?: string; 87 88 /** 89 * Indicates ability name 90 * 91 * @type { string } 92 * @syscap SystemCapability.BundleManager.BundleFramework.Core 93 * @since 9 94 */ 95 /** 96 * Indicates ability name 97 * 98 * @type { string } 99 * @syscap SystemCapability.BundleManager.BundleFramework.Core 100 * @atomicservice 101 * @since 11 102 */ 103 abilityName: string; 104 105 /** 106 * Indicates uri 107 * 108 * @type { ?string } 109 * @syscap SystemCapability.BundleManager.BundleFramework.Core 110 * @since 9 111 */ 112 /** 113 * Indicates uri 114 * 115 * @type { ?string } 116 * @syscap SystemCapability.BundleManager.BundleFramework.Core 117 * @atomicservice 118 * @since 11 119 */ 120 uri?: string; 121 122 /** 123 * Indicates short name 124 * 125 * @type { ?string } 126 * @syscap SystemCapability.BundleManager.BundleFramework.Core 127 * @since 9 128 */ 129 /** 130 * Indicates short name 131 * 132 * @type { ?string } 133 * @syscap SystemCapability.BundleManager.BundleFramework.Core 134 * @atomicservice 135 * @since 11 136 */ 137 shortName?: string; 138} 139