1/* 2 * Copyright (c) 2022-2024 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 * Want is the basic communication component of the system. 23 * 24 * @syscap SystemCapability.Ability.AbilityBase 25 * @since 9 26 */ 27/** 28 * Want is the basic communication component of the system. 29 * 30 * @syscap SystemCapability.Ability.AbilityBase 31 * @crossplatform 32 * @since 10 33 */ 34/** 35 * Want is the basic communication component of the system. 36 * 37 * @syscap SystemCapability.Ability.AbilityBase 38 * @crossplatform 39 * @atomicservice 40 * @since 11 41 */ 42export default class Want { 43 /** 44 * bundle name 45 * 46 * @type { ?string } 47 * @syscap SystemCapability.Ability.AbilityBase 48 * @since 9 49 */ 50 /** 51 * bundle name 52 * 53 * @syscap SystemCapability.Ability.AbilityBase 54 * @crossplatform 55 * @since 10 56 */ 57 /** 58 * bundle name 59 * 60 * @type { ?string } 61 * @syscap SystemCapability.Ability.AbilityBase 62 * @crossplatform 63 * @atomicservice 64 * @since 11 65 */ 66 bundleName?: string; 67 68 /** 69 * ability name 70 * 71 * @type { ?string } 72 * @syscap SystemCapability.Ability.AbilityBase 73 * @since 9 74 */ 75 /** 76 * ability name 77 * 78 * @syscap SystemCapability.Ability.AbilityBase 79 * @crossplatform 80 * @since 10 81 */ 82 /** 83 * ability name 84 * 85 * @type { ?string } 86 * @syscap SystemCapability.Ability.AbilityBase 87 * @crossplatform 88 * @atomicservice 89 * @since 11 90 */ 91 abilityName?: string; 92 93 /** 94 * device id 95 * 96 * @type { ?string } 97 * @syscap SystemCapability.Ability.AbilityBase 98 * @since 9 99 */ 100 /** 101 * device id 102 * 103 * @type { ?string } 104 * @syscap SystemCapability.Ability.AbilityBase 105 * @atomicservice 106 * @since 11 107 */ 108 deviceId?: string; 109 110 /** 111 * The description of a URI in a Want. 112 * 113 * @type { ?string } 114 * @syscap SystemCapability.Ability.AbilityBase 115 * @since 9 116 */ 117 /** 118 * The description of a URI in a Want. 119 * 120 * @type { ?string } 121 * @syscap SystemCapability.Ability.AbilityBase 122 * @atomicservice 123 * @since 11 124 */ 125 uri?: string; 126 127 /** 128 * The description of the type in this Want. 129 * 130 * @type { ?string } 131 * @syscap SystemCapability.Ability.AbilityBase 132 * @since 9 133 */ 134 /** 135 * The description of the type in this Want. 136 * 137 * @type { ?string } 138 * @syscap SystemCapability.Ability.AbilityBase 139 * @atomicservice 140 * @since 11 141 */ 142 /** 143 * The description of the type in this Want. 144 * 145 * @type { ?string } 146 * @syscap SystemCapability.Ability.AbilityBase 147 * @crossplatform 148 * @atomicservice 149 * @since 18 150 */ 151 type?: string; 152 153 /** 154 * The options of the flags in this Want. 155 * 156 * @type { ?number } 157 * @syscap SystemCapability.Ability.AbilityBase 158 * @since 9 159 */ 160 /** 161 * The options of the flags in this Want. 162 * 163 * @type { ?number } 164 * @syscap SystemCapability.Ability.AbilityBase 165 * @atomicservice 166 * @since 11 167 */ 168 flags?: number; 169 170 /** 171 * The description of an action in an want. 172 * 173 * @type { ?string } 174 * @syscap SystemCapability.Ability.AbilityBase 175 * @since 9 176 */ 177 /** 178 * The description of an action in an want. 179 * 180 * @type { ?string } 181 * @syscap SystemCapability.Ability.AbilityBase 182 * @atomicservice 183 * @since 11 184 */ 185 action?: string; 186 187 /** 188 * The description of the WantParams object in an Want 189 * 190 * @type { ?object } 191 * @syscap SystemCapability.Ability.AbilityBase 192 * @since 9 193 */ 194 /** 195 * The description of the WantParams object in an Want 196 * 197 * @type { ?object } 198 * @syscap SystemCapability.Ability.AbilityBase 199 * @crossplatform 200 * @since 10 201 */ 202 /** 203 * The description of the WantParams object in an Want 204 * 205 * @type { ?Record<string, Object> } 206 * @syscap SystemCapability.Ability.AbilityBase 207 * @crossplatform 208 * @atomicservice 209 * @since 11 210 */ 211 parameters?: Record<string, Object>; 212 213 /** 214 * The description of a entities in a Want. 215 * 216 * @type { ?Array<string> } 217 * @syscap SystemCapability.Ability.AbilityBase 218 * @since 9 219 */ 220 /** 221 * The description of a entities in a Want. 222 * 223 * @type { ?Array<string> } 224 * @syscap SystemCapability.Ability.AbilityBase 225 * @atomicservice 226 * @since 11 227 */ 228 entities?: Array<string>; 229 230 /** 231 * The description of an module name in an want. 232 * 233 * @type { ?string } 234 * @syscap SystemCapability.Ability.AbilityBase 235 * @since 9 236 */ 237 /** 238 * The description of an module name in an want. 239 * 240 * @syscap SystemCapability.Ability.AbilityBase 241 * @crossplatform 242 * @since 10 243 */ 244 /** 245 * The description of an module name in an want. 246 * 247 * @type { ?string } 248 * @syscap SystemCapability.Ability.AbilityBase 249 * @crossplatform 250 * @atomicservice 251 * @since 11 252 */ 253 moduleName?: string; 254 255 /** 256 * The description of fds in a Want. 257 * 258 * @type { ?Record<string, number> } 259 * @readonly 260 * @syscap SystemCapability.Ability.AbilityBase 261 * @atomicservice 262 * @since 15 263 */ 264 readonly fds?: Record<string, number>; 265} 266