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 * The definition of AbilityConstant. 18 * 19 * @namespace AbilityConstant 20 * @syscap SystemCapability.Ability.AbilityRuntime.Core 21 * @StageModelOnly 22 * @since 9 23 */ 24/** 25 * The definition of AbilityConstant. 26 * 27 * @namespace AbilityConstant 28 * @syscap SystemCapability.Ability.AbilityRuntime.Core 29 * @StageModelOnly 30 * @crossplatform 31 * @since 10 32 */ 33declare namespace AbilityConstant { 34 /** 35 * Interface of launch param. 36 * 37 * @typedef LaunchParam 38 * @syscap SystemCapability.Ability.AbilityRuntime.Core 39 * @StageModelOnly 40 * @since 9 41 */ 42 /** 43 * Interface of launch param. 44 * 45 * @typedef LaunchParam 46 * @syscap SystemCapability.Ability.AbilityRuntime.Core 47 * @StageModelOnly 48 * @crossplatform 49 * @since 10 50 */ 51 export interface LaunchParam { 52 /** 53 * Indicates launch reason. 54 * 55 * @type { LaunchReason } 56 * @syscap SystemCapability.Ability.AbilityRuntime.Core 57 * @StageModelOnly 58 * @since 9 59 */ 60 /** 61 * Indicates launch reason. 62 * 63 * @type { LaunchReason } 64 * @syscap SystemCapability.Ability.AbilityRuntime.Core 65 * @StageModelOnly 66 * @crossplatform 67 * @since 10 68 */ 69 launchReason: LaunchReason; 70 71 /** 72 * Indicates last exit reason. 73 * 74 * @type { LastExitReason } 75 * @syscap SystemCapability.Ability.AbilityRuntime.Core 76 * @StageModelOnly 77 * @since 9 78 */ 79 /** 80 * Indicates last exit reason. 81 * 82 * @type { LastExitReason } 83 * @syscap SystemCapability.Ability.AbilityRuntime.Core 84 * @StageModelOnly 85 * @crossplatform 86 * @since 10 87 */ 88 lastExitReason: LastExitReason; 89 } 90 91 /** 92 * Type of launch reason. 93 * 94 * @enum { number } 95 * @syscap SystemCapability.Ability.AbilityRuntime.Core 96 * @StageModelOnly 97 * @since 9 98 */ 99 /** 100 * Type of launch reason. 101 * 102 * @enum { number } 103 * @syscap SystemCapability.Ability.AbilityRuntime.Core 104 * @StageModelOnly 105 * @crossplatform 106 * @since 10 107 */ 108 export enum LaunchReason { 109 /** 110 * Unknown reason. 111 * 112 * @syscap SystemCapability.Ability.AbilityRuntime.Core 113 * @StageModelOnly 114 * @since 9 115 */ 116 /** 117 * @syscap SystemCapability.Ability.AbilityRuntime.Core 118 * @StageModelOnly 119 * @crossplatform 120 * @since 10 121 */ 122 UNKNOWN = 0, 123 124 /** 125 * Start ability through the startAbility interface. 126 * 127 * @syscap SystemCapability.Ability.AbilityRuntime.Core 128 * @StageModelOnly 129 * @since 9 130 */ 131 START_ABILITY = 1, 132 133 /** 134 * Start ability through the startAbilityByCall interface. 135 * 136 * @syscap SystemCapability.Ability.AbilityRuntime.Core 137 * @StageModelOnly 138 * @since 9 139 */ 140 CALL = 2, 141 142 /** 143 * Start ability through cross-end device migration. 144 * 145 * @syscap SystemCapability.Ability.AbilityRuntime.Core 146 * @StageModelOnly 147 * @since 9 148 */ 149 CONTINUATION = 3, 150 151 /** 152 * After the application is restored, the ability is automatically restored and started when the application fails. 153 * 154 * @syscap SystemCapability.Ability.AbilityRuntime.Core 155 * @StageModelOnly 156 * @since 9 157 */ 158 APP_RECOVERY = 4, 159 160 /** 161 * Start ability through the acquireShareData interface. 162 * 163 * @syscap SystemCapability.Ability.AbilityRuntime.Core 164 * @StageModelOnly 165 * @since 10 166 */ 167 SHARE = 5 168 } 169 170 /** 171 * Type of last exit reason. 172 * 173 * @enum { number } 174 * @syscap SystemCapability.Ability.AbilityRuntime.Core 175 * @StageModelOnly 176 * @since 9 177 */ 178 /** 179 * Type of last exit reason. 180 * 181 * @enum { number } 182 * @syscap SystemCapability.Ability.AbilityRuntime.Core 183 * @StageModelOnly 184 * @crossplatform 185 * @since 10 186 */ 187 export enum LastExitReason { 188 /** 189 * Exit reason : Unknown. The reason for the last exit of the target application is not recorded in the application 190 * framework. 191 * 192 * @syscap SystemCapability.Ability.AbilityRuntime.Core 193 * @StageModelOnly 194 * @since 9 195 */ 196 /** 197 * Exit reason : Unknown. The reason for the last exit of the target application is not recorded in the application 198 * framework. 199 * 200 * @syscap SystemCapability.Ability.AbilityRuntime.Core 201 * @StageModelOnly 202 * @crossplatform 203 * @since 10 204 */ 205 UNKNOWN = 0, 206 207 /** 208 * Exit reason : Ability is not responding. 209 * 210 * @syscap SystemCapability.Ability.AbilityRuntime.Core 211 * @StageModelOnly 212 * @since 9 213 * @deprecated since 10 214 * @useinstead AbilityConstant.LastExitReason#APP_FREEZE 215 */ 216 ABILITY_NOT_RESPONDING = 1, 217 218 /** 219 * Exit reason : normally. App exit due to user active close. 220 * 221 * @syscap SystemCapability.Ability.AbilityRuntime.Core 222 * @StageModelOnly 223 * @since 9 224 */ 225 NORMAL = 2, 226 227 /** 228 * Exit reason : cpp crash. The app exit due to native exception signal. 229 * 230 * @syscap SystemCapability.Ability.AbilityRuntime.Core 231 * @StageModelOnly 232 * @since 10 233 */ 234 CPP_CRASH = 3, 235 236 /** 237 * Exit reason : js error. App exit due to js error. 238 * 239 * @syscap SystemCapability.Ability.AbilityRuntime.Core 240 * @StageModelOnly 241 * @since 10 242 */ 243 JS_ERROR = 4, 244 245 /** 246 * Exit reason : app freeze. App exit due to appFreeze error. 247 * 248 * @syscap SystemCapability.Ability.AbilityRuntime.Core 249 * @StageModelOnly 250 * @since 10 251 */ 252 APP_FREEZE = 5, 253 254 /** 255 * Exit reason : performance control. App exit due to system performance issues, such as device low memory. 256 * 257 * @syscap SystemCapability.Ability.AbilityRuntime.Core 258 * @StageModelOnly 259 * @since 10 260 */ 261 PERFORMANCE_CONTROL = 6, 262 263 /** 264 * Exit reason : resource control. App exit due to resource usage violation, such as exceed cpu/io/memory usage. 265 * 266 * @syscap SystemCapability.Ability.AbilityRuntime.Core 267 * @StageModelOnly 268 * @since 10 269 */ 270 RESOURCE_CONTROL = 7, 271 272 /** 273 * Exit reason : upgrade. App exit due to upgrade. 274 * 275 * @syscap SystemCapability.Ability.AbilityRuntime.Core 276 * @StageModelOnly 277 * @since 10 278 */ 279 UPGRADE = 8 280 } 281 282 /** 283 * Type of onContinue result. 284 * 285 * @enum { number } 286 * @syscap SystemCapability.Ability.AbilityRuntime.Core 287 * @StageModelOnly 288 * @since 9 289 */ 290 export enum OnContinueResult { 291 /** 292 * Agree to the result of Ability migration. 293 * 294 * @syscap SystemCapability.Ability.AbilityRuntime.Core 295 * @StageModelOnly 296 * @since 9 297 */ 298 AGREE = 0, 299 300 /** 301 * Reject to the result of Ability migration. 302 * 303 * @syscap SystemCapability.Ability.AbilityRuntime.Core 304 * @StageModelOnly 305 * @since 9 306 */ 307 REJECT = 1, 308 309 /** 310 * Mismatch to the result of Ability migration. 311 * 312 * @syscap SystemCapability.Ability.AbilityRuntime.Core 313 * @StageModelOnly 314 * @since 9 315 */ 316 MISMATCH = 2 317 } 318 319 /** 320 * Type of memory level. 321 * 322 * @enum { number } 323 * @syscap SystemCapability.Ability.AbilityRuntime.Core 324 * @StageModelOnly 325 * @since 9 326 */ 327 export enum MemoryLevel { 328 /** 329 * Memory footprint is moderate. 330 * 331 * @syscap SystemCapability.Ability.AbilityRuntime.Core 332 * @StageModelOnly 333 * @since 9 334 */ 335 MEMORY_LEVEL_MODERATE = 0, 336 337 /** 338 * Low memory footprint. 339 * 340 * @syscap SystemCapability.Ability.AbilityRuntime.Core 341 * @StageModelOnly 342 * @since 9 343 */ 344 MEMORY_LEVEL_LOW = 1, 345 346 /** 347 * High memory footprint. 348 * 349 * @syscap SystemCapability.Ability.AbilityRuntime.Core 350 * @StageModelOnly 351 * @since 9 352 */ 353 MEMORY_LEVEL_CRITICAL = 2 354 } 355 356 /** 357 * Type of window mode. 358 * 359 * @enum { number } 360 * @syscap SystemCapability.Ability.AbilityRuntime.Core 361 * @systemapi 362 * @StageModelOnly 363 * @since 9 364 */ 365 export enum WindowMode { 366 /** 367 * The window mode is not defined. 368 * 369 * @syscap SystemCapability.Ability.AbilityRuntime.Core 370 * @systemapi 371 * @StageModelOnly 372 * @since 9 373 */ 374 WINDOW_MODE_UNDEFINED = 0, 375 376 /** 377 * Full screen mode. 378 * 379 * @syscap SystemCapability.Ability.AbilityRuntime.Core 380 * @systemapi 381 * @StageModelOnly 382 * @since 9 383 */ 384 WINDOW_MODE_FULLSCREEN = 1, 385 386 /** 387 * If the screen is horizontal, it means the right split screen, and if the screen is vertical, 388 * it means the lower split screen. 389 * 390 * @syscap SystemCapability.Ability.AbilityRuntime.Core 391 * @systemapi 392 * @StageModelOnly 393 * @since 9 394 */ 395 WINDOW_MODE_SPLIT_PRIMARY = 100, 396 397 /** 398 * If the screen is horizontal, it means the right split screen, and if the screen is vertical, 399 * it means the lower split screen. 400 * 401 * @syscap SystemCapability.Ability.AbilityRuntime.Core 402 * @systemapi 403 * @StageModelOnly 404 * @since 9 405 */ 406 WINDOW_MODE_SPLIT_SECONDARY = 101, 407 408 /** 409 * Free floating window mode. 410 * 411 * @syscap SystemCapability.Ability.AbilityRuntime.Core 412 * @systemapi 413 * @StageModelOnly 414 * @since 9 415 */ 416 WINDOW_MODE_FLOATING = 102 417 } 418 419 /** 420 * Type of onSave result. 421 * 422 * @enum { number } 423 * @syscap SystemCapability.Ability.AbilityRuntime.Core 424 * @StageModelOnly 425 * @since 9 426 */ 427 export enum OnSaveResult { 428 /** 429 * Always agree to save the state. 430 * 431 * @syscap SystemCapability.Ability.AbilityRuntime.Core 432 * @StageModelOnly 433 * @since 9 434 */ 435 ALL_AGREE = 0, 436 437 /** 438 * Refuse to migrate the saved state. 439 * 440 * @syscap SystemCapability.Ability.AbilityRuntime.Core 441 * @StageModelOnly 442 * @since 9 443 */ 444 CONTINUATION_REJECT = 1, 445 446 /** 447 * Migration mismatch. 448 * 449 * @syscap SystemCapability.Ability.AbilityRuntime.Core 450 * @StageModelOnly 451 * @since 9 452 */ 453 CONTINUATION_MISMATCH = 2, 454 455 /** 456 * Agree to restore the saved state. 457 * 458 * @syscap SystemCapability.Ability.AbilityRuntime.Core 459 * @StageModelOnly 460 * @since 9 461 */ 462 RECOVERY_AGREE = 3, 463 464 /** 465 * Refuse to restore the saved state. 466 * 467 * @syscap SystemCapability.Ability.AbilityRuntime.Core 468 * @StageModelOnly 469 * @since 9 470 */ 471 RECOVERY_REJECT = 4, 472 473 /** 474 * Always refuses to save the state. 475 * 476 * @syscap SystemCapability.Ability.AbilityRuntime.Core 477 * @StageModelOnly 478 * @since 9 479 */ 480 ALL_REJECT 481 } 482 483 /** 484 * Type of save state. 485 * 486 * @enum { number } 487 * @syscap SystemCapability.Ability.AbilityRuntime.Core 488 * @StageModelOnly 489 * @since 9 490 */ 491 export enum StateType { 492 /** 493 * Migrate and save the state. 494 * 495 * @syscap SystemCapability.Ability.AbilityRuntime.Core 496 * @StageModelOnly 497 * @since 9 498 */ 499 CONTINUATION = 0, 500 501 /** 502 * App recovery to restore the saved state. 503 * 504 * @syscap SystemCapability.Ability.AbilityRuntime.Core 505 * @StageModelOnly 506 * @since 9 507 */ 508 APP_RECOVERY = 1 509 } 510 511 /** 512 * Continue state. 513 * 514 * @enum { number } 515 * @syscap SystemCapability.Ability.AbilityRuntime.Core 516 * @StageModelOnly 517 * @since 10 518 */ 519 export enum ContinueState { 520 /** 521 * Mission continuable active. 522 * 523 * @syscap SystemCapability.Ability.AbilityRuntime.Core 524 * @StageModelOnly 525 * @since 10 526 */ 527 ACTIVE = 0, 528 529 /** 530 * Mission continuable inactive. 531 * 532 * @syscap SystemCapability.Ability.AbilityRuntime.Core 533 * @StageModelOnly 534 * @since 10 535 */ 536 INACTIVE = 1 537 } 538} 539 540export default AbilityConstant; 541