1/* 2 * Copyright (c) 2022-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 * 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 type?: string; 143 144 /** 145 * The options of the flags in this Want. 146 * 147 * @type { ?number } 148 * @syscap SystemCapability.Ability.AbilityBase 149 * @since 9 150 */ 151 /** 152 * The options of the flags in this Want. 153 * 154 * @type { ?number } 155 * @syscap SystemCapability.Ability.AbilityBase 156 * @atomicservice 157 * @since 11 158 */ 159 flags?: number; 160 161 /** 162 * The description of an action in an want. 163 * 164 * @type { ?string } 165 * @syscap SystemCapability.Ability.AbilityBase 166 * @since 9 167 */ 168 /** 169 * The description of an action in an want. 170 * 171 * @type { ?string } 172 * @syscap SystemCapability.Ability.AbilityBase 173 * @atomicservice 174 * @since 11 175 */ 176 action?: string; 177 178 /** 179 * The description of the WantParams object in an Want 180 * 181 * @type { ?object } 182 * @syscap SystemCapability.Ability.AbilityBase 183 * @since 9 184 */ 185 /** 186 * The description of the WantParams object in an Want 187 * 188 * @type { ?object } 189 * @syscap SystemCapability.Ability.AbilityBase 190 * @crossplatform 191 * @since 10 192 */ 193 /** 194 * The description of the WantParams object in an Want 195 * 196 * @type { ?Record<string, Object> } 197 * @syscap SystemCapability.Ability.AbilityBase 198 * @crossplatform 199 * @atomicservice 200 * @since 11 201 */ 202 parameters?: Record<string, Object>; 203 204 /** 205 * The description of a entities in a Want. 206 * 207 * @type { ?Array<string> } 208 * @syscap SystemCapability.Ability.AbilityBase 209 * @since 9 210 */ 211 /** 212 * The description of a entities in a Want. 213 * 214 * @type { ?Array<string> } 215 * @syscap SystemCapability.Ability.AbilityBase 216 * @atomicservice 217 * @since 11 218 */ 219 entities?: Array<string>; 220 221 /** 222 * The description of an module name in an want. 223 * 224 * @type { ?string } 225 * @syscap SystemCapability.Ability.AbilityBase 226 * @since 9 227 */ 228 /** 229 * The description of an module name in an want. 230 * 231 * @syscap SystemCapability.Ability.AbilityBase 232 * @crossplatform 233 * @since 10 234 */ 235 /** 236 * The description of an module name in an want. 237 * 238 * @type { ?string } 239 * @syscap SystemCapability.Ability.AbilityBase 240 * @crossplatform 241 * @atomicservice 242 * @since 11 243 */ 244 moduleName?: string; 245 246 /** 247 * The description of fds in a Want. 248 * 249 * @type { ?Record<string, number> } 250 * @readonly 251 * @syscap SystemCapability.Ability.AbilityBase 252 * @atomicservice 253 * @since 15 254 */ 255 readonly fds?: Record<string, number>; 256} 257