1# System Common Events (System API) 2 3This topic provides a list of common events defined by the system. 4 5Common event types are defined in [Support enumeration of the ohos.commonEventManager module](../js-apis-commonEventManager.md#support). 6 7> **NOTE** 8> 9> The current page contains only the system APIs of this module. For details about other public APIs, see [System Common Events](../common_event/commonEventManager-definitions.md). 10 11 12 13 14## Ability Kit 15 16 17### COMMON_EVENT_BOOT_COMPLETED 18 19Indicates that the boot is complete and the system is loaded. 20 21When the specified user finishes the boot process on the device, the common event service is triggered to publish this event. 22 23**System API**: This is a system API. 24 25**System capability**: SystemCapability.Notification.CommonEvent 26 27**Required permissions**: ohos.permission.RECEIVER_STARTUP_COMPLETED (for system applications only) 28 29 30**Value**: "usual.event.BOOT_COMPLETED" 31 32 33 34### COMMON_EVENT_PACKAGE_INSTALLATION_STARTED<sup>12+</sup> 35 36Indicates that a package is sent by the system verifier when the package is verified. 37 38When a new application starts to be installed by a specified user on the device, the common event service is triggered to publish this event. 39 40**System API**: This is a system API. 41 42**System capability**: SystemCapability.Notification.CommonEvent 43 44**Required permissions**: none 45 46**Value**: "usual.event.PACKAGE_INSTALLATION_STARTED" 47 48 49### COMMON_EVENT_BUNDLE_RESOURCES_CHANGED<sup>15+</sup> 50 51Indicates the common event of updating bundle management resource data. 52 53This common event is sent when the bundle management resource data is updated in scenarios such as language or theme switching. 54 55**System API**: This is a system API. 56 57**System capability**: SystemCapability.Notification.CommonEvent 58 59**Required permissions**: ohos.permission.GET_BUNDLE_RESOURCES 60 61**Value**: "usual.event.BUNDLE_RESOURCES_CHANGED" 62 63 64### COMMON_EVENT_DEFAULT_APPLICATION_CHANGED<sup>19+</sup> 65 66Indicates that the default application for opening a file has changed. 67 68This common event is sent when the default application for opening a file changes. 69 70**System API**: This is a system API. 71 72**System capability**: SystemCapability.Notification.CommonEvent 73 74**Required permissions**: ohos.permission.CHANGE_DEFAULT_APPLICATION 75 76**Value:** "usual.event.DEFAULT_APPLICATION_CHANGED" 77 78 79### COMMON_EVENT_SHORTCUT_CHANGED<sup>20+</sup> 80 81Indicates that the application shortcut has changed. 82 83This common event is sent when the shortcut is changed (for example, when [setShortcutVisibleForSelf](../../apis-ability-kit/js-apis-shortcutManager.md#shortcutmanagersetshortcutvisibleforself) of the shortcutManager module is successfully called). 84 85**System API**: This is a system API. 86 87**System capability**: SystemCapability.Notification.CommonEvent 88 89**Required permissions**: ohos.permission.MANAGE_SHORTCUTS 90 91**Value:** "usual.event.SHORTCUT_CHANGED" 92 93 94### COMMON_EVENT_KIOSK_MODE_ON<sup>20+</sup> 95 96Indicates that the kiosk mode is enabled. When this mode is on, the common event service is triggered to publish this system common event. 97 98**System API**: This is a system API. 99 100**System capability**: SystemCapability.Notification.CommonEvent 101 102**Required permissions**: none 103 104**Value:** usual.event.KIOSK_MODE_ON 105 106 107### COMMON_EVENT_KIOSK_MODE_OFF<sup>20+</sup> 108 109Indicates that the kiosk mode is disabled. When this mode is off, the common event service is triggered to publish this system common event. 110 111**System API**: This is a system API. 112 113**System capability**: SystemCapability.Notification.CommonEvent 114 115**Required permissions**: none 116 117**Value:** usual.event.KIOSK_MODE_OFF 118 119 120## Background Tasks Kit 121 122### COMMON_EVENT_DEVICE_IDLE_EXEMPTION_LIST_UPDATED<sup>10+</sup> 123 124Indicates that the exemption list for resource usage restrictions has been updated in idle mode. 125 126When the exemption list for resource usage restrictions is updated, the common event service is triggered to publish this event. 127Resources include application network access, Timer usage, and WorkScheduler task usage. 128 129System applications can call JavaScript APIs to apply for removing resource usage restrictions. 130 131**System API**: This is a system API. 132 133**System capability**: SystemCapability.Notification.CommonEvent 134 135**Required permissions**: none 136 137**Value**: "usual.event.DEVICE_IDLE_EXEMPTION_LIST_UPDATED" 138 139## Basic Services Kit - Customization 140 141### COMMON_EVENT_CUSTOM_CONFIG_POLICY_UPDATED<sup>20+</sup> 142 143Indicates that the configuration directory level and system parameters of a device are updated. 144 145This common event is sent when the system updates the device configuration directory level and system parameters after identifying the home area and roaming area of the device. 146 147**System API**: This is a system API. 148 149**System capability**: SystemCapability.Notification.CommonEvent 150 151**Required permissions**: none 152 153**Value:** "usual.event.CUSTOM_CONFIG_POLICY_UPDATED" 154 155### COMMON_EVENT_CUSTOM_ROAMING_REGION_UPDATED<sup>20+</sup> 156 157Indicates that the roaming area of a device is updated. 158 159When the attributes such as network injection, persistent Connection, and GPS location of a device change, the system identifies the roaming area and updates the parameters if the roaming area changes. After the update is complete, this common event is sent. 160 161**System API**: This is a system API. 162 163**System capability**: SystemCapability.Notification.CommonEvent 164 165**Required permissions**: none 166 167**Value:** "usual.event.CUSTOM_ROAMING_REGION_UPDATED" 168 169## Basic Services Kit - Power Supply 170 171### COMMON_EVENT_CHARGE_TYPE_CHANGED<sup>10+</sup> 172 173Indicates that the system charging type has changed. 174 175When the system charging type changes, the common event service is triggered to publish this event. 176 177**System API**: This is a system API. 178 179**System capability**: SystemCapability.Notification.CommonEvent 180 181**Required permissions**: none 182 183**Value**: "usual.event.CHARGE_TYPE_CHANGED" 184 185 186### COMMON_EVENT_USER_ADDED 187 188Indicates that a user has been added to the system. 189 190When a system account is created, the common event service is triggered to publish this event carrying the system account ID. 191 192APIs related to this event: **createOsAccount** and **createOsAccountForDomain**. These APIs are system APIs. For details, see [@ohos.account.osAccount (System Account Management)](../js-apis-osAccount.md). 193 194**System API**: This is a system API. 195 196**System capability**: SystemCapability.Notification.CommonEvent 197 198**Required permissions**: ohos.permission.MANAGE_LOCAL_ACCOUNTS (for system applications only) 199 200**Value**: "usual.event.USER_ADDED" 201 202 203### COMMON_EVENT_USER_REMOVED 204 205Indicates that a user has been removed from the system. 206 207When a system account is removed, the common event service is triggered to publish this event carrying the system account ID. 208 209APIs related to this event: **removeOsAccount**. This API is a system API. For details, see [@ohos.account.osAccount (System Account Management)](../js-apis-osAccount.md). 210 211**System API**: This is a system API. 212 213**System capability**: SystemCapability.Notification.CommonEvent 214 215**Required permissions**: ohos.permission.MANAGE_LOCAL_ACCOUNTS (for system applications only) 216 217**Value**: "usual.event.USER_REMOVED" 218 219 220### COMMON_EVENT_DOMAIN_ACCOUNT_STATUS_CHANGED 221 222Indicates that the status of the domain account status changes. 223 224When a domain user account is authenticated, deleted, or has the token updated, the common event service is triggered to publish this event carrying the system account ID, domain name, and account status. 225 226APIs related to this event: **removeOsAccount**, **DomainAccountManager.auth**, and **updateAccountToken**. These APIs are system APIs. For details, see [@ohos.account.osAccount (System Account Management)](../js-apis-osAccount.md). 227 228**System API**: This is a system API. 229 230**System capability**: SystemCapability.Notification.CommonEvent 231 232**Required permissions**: ohos.permission.GET_LOCAL_ACCOUNTS (for system applications only) 233 234**Value**: "usual.event.DOMAIN_ACCOUNT_STATUS_CHANGED" 235 236 237### COMMON_EVENT_USER_SWITCHED 238 239Indicates that a user switchover is complete. 240 241When a system account is switched, the common event service is triggered to publish this event carrying the system account ID. 242 243APIs related to this event: **activateOsAccount**. This API is a system API. For details, see [@ohos.account.osAccount (System Account Management)](../js-apis-osAccount.md). 244 245**System API**: This is a system API. 246 247**System capability**: SystemCapability.Notification.CommonEvent 248 249**Required permissions**: ohos.permission.MANAGE_LOCAL_ACCOUNTS (for system applications only) 250 251**Value**: "usual.event.USER_SWITCHED" 252 253 254### COMMON_EVENT_USER_LOCKING 255 256Indicates that a user is about to be locked. 257 258Before a user is locked, the common event service is triggered to publish this event carrying the system account ID. 259 260**System API**: This is a system API. 261 262**System capability**: SystemCapability.Notification.CommonEvent 263 264**Value**: "usual.event.USER_LOCKING" 265 266 267### COMMON_EVENT_USER_LOCKED 268 269Indicates that a user is locked. 270 271After a user is locked, the common event service is triggered to publish this event carrying the system account ID. 272 273**System API**: This is a system API. 274 275**System capability**: SystemCapability.Notification.CommonEvent 276 277**Value**: "usual.event.USER_LOCKED" 278 279 280## Core File Kit 281 282This document lists the common system events provided by the file management subsystem to applications. Applications can use [APIs](../js-apis-commonEventManager.md) to subscribe to common system events. 283 284 285### COMMON_EVENT_VOLUME_REMOVED 286 287Indicates that an external storage device was removed. 288 289This common event is triggered when an external storage device is removed. 290 291**System API**: This is a system API. 292 293**System capability**: SystemCapability.Notification.CommonEvent 294 295**Required permissions**: ohos.permission.STORAGE_MANAGER 296 297**Value**: "usual.event.data.VOLUME_REMOVED" 298 299 300 301### COMMON_EVENT_VOLUME_UNMOUNTED 302 303Indicates that an external storage device was unmounted. 304 305This common event is triggered when an external storage device is successfully unmounted by calling the **unmount** API or by removing the device. 306 307**System API**: This is a system API. 308 309**System capability**: SystemCapability.Notification.CommonEvent 310 311**Required permissions**: ohos.permission.STORAGE_MANAGER 312 313**Value**: "usual.event.data.VOLUME_UNMOUNTED" 314 315 316### COMMON_EVENT_VOLUME_MOUNTED 317 318Indicates that an external storage device was mounted. 319 320This common event is triggered when an external storage device is successfully mounted by calling the **mount** API or by inserting the device. 321 322**System API**: This is a system API. 323 324**System capability**: SystemCapability.Notification.CommonEvent 325 326**Required permissions**: ohos.permission.STORAGE_MANAGER 327 328**Value**: "usual.event.data.VOLUME_MOUNTED" 329 330 331### COMMON_EVENT_VOLUME_BAD_REMOVAL 332 333Indicates that an external storage device was removed without being unmounted. 334 335This common event is triggered when an external storage device is directly removed without being unmounted. 336 337**System API**: This is a system API. 338 339**System capability**: SystemCapability.Notification.CommonEvent 340 341**Required permissions**: ohos.permission.STORAGE_MANAGER 342 343**Value**: "usual.event.data.VOLUME_BAD_REMOVAL" 344 345 346### COMMON_EVENT_VOLUME_EJECT 347 348Indicates that an external storage device is about to be ejected. 349 350This common event is triggered when the user calls the **unmount** API on a mounted external storage device or removes the device. 351 352**System API**: This is a system API. 353 354**System capability**: SystemCapability.Notification.CommonEvent 355 356**Required permissions**: ohos.permission.STORAGE_MANAGER 357 358**Value**: "usual.event.data.VOLUME_EJECT" 359 360 361### COMMON_EVENT_RESTORE_START<sup>13+</sup> 362 363Indicates the common event that an application starts to be restored. 364 365When a data migration application starts the backup and restore framework to perform a restoration task, the common event service is triggered to publish this event. 366 367**System API**: This is a system API. 368 369**System capability**: SystemCapability.Notification.CommonEvent 370 371**Required permissions**: ohos.permission.START_RESTORE_NOTIFICATION 372 373**Value**: "usual.event.RESTORE_START" 374 375 376## Media Kit 377 378### COMMON_EVENT_SCREEN_SHARE 379 380Indicates that a screen sharing event has occurred in the system. 381 382This is a protected common event and can be sent only by the system. 383 384**System API**: This is a system API. 385 386**System capability**: SystemCapability.Notification.CommonEvent 387 388**Required permissions**: ohos.permission.RECEIVE_SMS (for system applications only) 389 390**Value**: usual.event.SCREEN_SHARE 391 392 393## Telephony Kit 394 395### COMMON_EVENT_SMS_RECEIVE_COMPLETED<sup>10+</sup> 396 397Indicates that an SMS message is received. 398 399When the device receives an SMS message, the common event service is triggered to publish this event. 400 401**System API**: This is a system API. 402 403**System capability**: SystemCapability.Notification.CommonEvent 404 405**Required permissions**: ohos.permission.RECEIVE_SMS (for system applications only) 406 407**Value**: usual.event.SMS_RECEIVED_COMPLETED 408 409 410### COMMON_EVENT_SMS_EMERGENCY_CB_RECEIVE_COMPLETED<sup>10+</sup> 411 412Indicates that an emergency cell broadcast message is received. 413 414When the device receives an emergency cell broadcast message, the common event service is triggered to publish this event. 415 416**System API**: This is a system API. 417 418**System capability**: SystemCapability.Notification.CommonEvent 419 420**Required permissions**: ohos.permission.RECEIVE_SMS (for system applications only) 421 422**Value**: usual.event.SMS_EMERGENCY_CB_RECEIVE_COMPLETED 423 424 425### COMMON_EVENT_SMS_CB_RECEIVE_COMPLETED<sup>10+</sup> 426 427Indicates that a cell broadcast message is received. 428 429When the device receives a cell broadcast message, the common event service is triggered to publish this event. 430 431**System API**: This is a system API. 432 433**System capability**: SystemCapability.Notification.CommonEvent 434 435**Required permissions**: ohos.permission.RECEIVE_SMS (for system applications only) 436 437**Value**: usual.event.SMS_CB_RECEIVE_COMPLETED 438 439 440 441 442 443### COMMON_EVENT_OPERATOR_CONFIG_CHANGED<sup>10+</sup> 444 445Indicates that the carrier configuration has been updated. 446 447When the carrier configuration of the device is updated, the common event service is triggered to publish this event. 448 449**System API**: This is a system API. 450 451**System capability**: SystemCapability.Notification.CommonEvent 452 453**Required permissions**: none 454 455**Value**: usual.event.OPERATOR_CONFIG_CHANGED 456 457 458### COMMON_EVENT_SIM_CARD_DEFAULT_SMS_SUBSCRIPTION_CHANGED<sup>10+</sup> 459 460Indicates that the default primary SIM card for the SMS service has been updated. 461 462When the default primary SIM card for the SMS service is updated, the common event service is triggered to publish this event. 463 464**System API**: This is a system API. 465 466**System capability**: SystemCapability.Notification.CommonEvent 467 468**Required permissions**: none 469 470**Value**: usual.event.DEFAULT_SMS_SUBSCRIPTION_CHANGED 471 472 473### COMMON_EVENT_SIM_CARD_DEFAULT_DATA_SUBSCRIPTION_CHANGED<sup>10+</sup> 474 475Indicates that the default primary SIM card for the data service has been updated. 476 477When the default primary SIM card for the data service is updated, the common event service is triggered to publish this event. 478 479**System API**: This is a system API. 480 481**System capability**: SystemCapability.Notification.CommonEvent 482 483**Required permissions**: none 484 485**Value**: usual.event.DEFAULT_DATA_SUBSCRIPTION_CHANGED 486 487 488### COMMON_EVENT_SIM_CARD_DEFAULT_MAIN_SUBSCRIPTION_CHANGED<sup>10+</sup> 489 490Indicates that the default primary SIM card of the device has been updated. 491 492When the default primary SIM card of the device is updated, the common event service is triggered to publish this event. 493 494**System API**: This is a system API. 495 496**System capability**: SystemCapability.Notification.CommonEvent 497 498**Required permissions**: none 499 500**Value**: usual.event.SIM.DEFAULT_MAIN_SUBSCRIPTION_CHANGED 501 502 503### COMMON_EVENT_SET_PRIMARY_SLOT_STATUS<sup>11+</sup> 504 505Indicates that the status of the action for setting the primary SIM card changes. 506 507When the status of the action for setting the primary SIM card changes (for example, when the status is updated to executing or completed), the common event service is triggered to publish this event. 508 509**System API**: This is a system API. 510 511**System capability**: SystemCapability.Notification.CommonEvent 512 513**Required permissions**: none 514 515**Value**: usual.event.SET_PRIMARY_SLOT_STATUS 516 517 518### COMMON_EVENT_PRIMARY_SLOT_ROAMING<sup>11+</sup> 519 520Indicates that the roaming status of the default primary SIM card is updated. 521 522When the roaming status of the default primary SIM card changes, the common event service is triggered to publish this event. 523 524**System API**: This is a system API. 525 526**System capability**: SystemCapability.Notification.CommonEvent 527 528**Required permissions**: none 529 530**Value**: usual.event.PRIMARY_SLOT_ROAMING 531 532 533### COMMON_EVENT_SIM_CARD_DEFAULT_VOICE_SUBSCRIPTION_CHANGED<sup>10+</sup> 534 535Indicates that the default primary SIM card for the voice service has been updated. 536 537When the default primary SIM card for the voice service is updated, the common event service is triggered to publish this event. 538 539**System API**: This is a system API. 540 541**System capability**: SystemCapability.Notification.CommonEvent 542 543**Required permissions**: none 544 545**Value**: usual.event.DEFAULT_VOICE_SUBSCRIPTION_CHANGED 546 547 548### COMMON_EVENT_CELLULAR_DATA_STATE_CHANGED<sup>10+</sup> 549 550Indicates that the cellular data state has been updated. 551 552When the cellular data state of the device is updated, the common event service is triggered to publish this event. 553 554**System API**: This is a system API. 555 556**System capability**: SystemCapability.Notification.CommonEvent 557 558**Required permissions**: none 559 560**Value**: usual.event.CELLULAR_DATA_STATE_CHANGED 561 562 563### COMMON_EVENT_INCOMING_CALL_MISSED<sup>10+</sup> 564 565Indicates that an incoming call is missed. 566 567When an incoming call is missed on the device, the common event service is triggered to publish this event. 568 569**System API**: This is a system API. 570 571**System capability**: SystemCapability.Notification.CommonEvent 572 573**Required permissions**: ohos.permission.GET_TELEPHONY_STATE (for system applications only) 574 575**Value**: usual.event.INCOMING_CALL_MISSED 576 577 578### COMMON_EVENT_RADIO_STATE_CHANGE<sup>10+</sup> 579 580Indicates that the radio state of the device has changed. 581 582When there is a change in the radio state of the device, the common event service is triggered to publish this event. 583 584**System API**: This is a system API. 585 586**System capability**: SystemCapability.Notification.CommonEvent 587 588**Required permissions**: none 589 590**Value**: usual.event.RADIO_STATE_CHANGE 591 592 593### COMMON_EVENT_SPECIAL_CODE<sup>10+</sup> 594 595Indicates that a secret code is sent successfully. 596 597When a secret code is successfully sent on the device, the common event service is triggered to publish this event. 598 599**System API**: This is a system API. 600 601**System capability**: SystemCapability.Notification.CommonEvent 602 603**Required permissions**: none 604 605**Value**: usual.event.DIALER_SPECIAL_CODE 606 607 608### COMMON_EVENT_AUDIO_QUALITY_CHANGE<sup>10+</sup> 609 610Indicates that the audio quality has changed. 611 612When there is a change in the audio quality of the device, the common event service is triggered to publish this event. 613 614**System API**: This is a system API. 615 616**System capability**: SystemCapability.Notification.CommonEvent 617 618**Required permissions**: none 619 620**Value**: usual.event.AUDIO_QUALITY_CHANGE 621 622 623## Reserved Common Event 624 625Below are reserved common events that are not supported yet. 626 627### COMMON_EVENT_STK_COMMAND<sup>10+</sup> 628 629(Reserved, not supported yet) Indicates that an STK command is sent. 630 631When an STK command is sent, the common event service is triggered to publish this event. 632 633**System API**: This is a system API. 634 635**System capability**: SystemCapability.Notification.CommonEvent 636 637**Required permissions**: none 638 639**Value**: usual.event.STK_COMMAND 640 641 642### COMMON_EVENT_STK_SESSION_END<sup>10+</sup> 643 644(Reserved, not supported yet) Indicates that an STK session has ended. 645 646When an STK session ends, the common event service is triggered to publish this event. 647 648**System API**: This is a system API. 649 650**System capability**: SystemCapability.Notification.CommonEvent 651 652**Required permissions**: none 653 654**Value**: usual.event.STK_SESSION_END 655 656 657### COMMON_EVENT_STK_CARD_STATE_CHANGED<sup>10+</sup> 658 659(Reserved, not supported yet) Indicates that the STK card state has been updated. 660 661When the STK card state is updated, the common event service is triggered to publish this event. 662 663**System API**: This is a system API. 664 665**System capability**: SystemCapability.Notification.CommonEvent 666 667**Required permissions**: none 668 669 670**Value**: usual.event.STK_CARD_STATE_CHANGED 671 672### COMMON_EVENT_STK_ALPHA_IDENTIFIER<sup>10+</sup> 673 674(Reserved, not supported yet) Indicates that an STK Alpha identifier is sent. 675 676When an STK Alpha identifier is sent, the common event service is triggered to publish this event. 677 678**System API**: This is a system API. 679 680**System capability**: SystemCapability.Notification.CommonEvent 681 682**Required permissions**: none 683 684**Value**: usual.event.STK_ALPHA_IDENTIFIER 685 686 687### COMMON_EVENT_SMS_WAPPUSH_RECEIVE_COMPLETED<sup>10+</sup> 688 689(Reserved, not supported yet) Indicates that a WAP push message is received. 690 691When the device receives a WAP push message, the common event service is triggered to publish this event. 692 693**System API**: This is a system API. 694 695**System capability**: SystemCapability.Notification.CommonEvent 696 697**Required permissions**: ohos.permission.RECEIVE_SMS (for system applications only) 698 699**Value**: usual.event.SMS_WAPPUSH_RECEIVE_COMPLETED 700