js-apis-commonEvent.md 55.6 KB
Newer Older
X
xuchenghua09 已提交
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910
# 公共事件模块

**说明:**
本模块首批接口从API version 7开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。

## 支持设备

| API                                                          | 手机 | 平板 | 智慧屏 | 智能穿戴 | 轻量级智能穿戴 |
| ------------------------------------------------------------ | ---- | ---- | ------ | -------- | -------------- |
| CommonEvent.publish(event: string, callback: AsyncCallback\<void>) | 支持 | 支持 | 支持   | 支持     | 不支持         |
| CommonEvent.publish(event: string, options: CommonEventPublishData, callback: AsyncCallback\<void>) | 支持 | 支持 | 支持   | 支持     | 不支持         |
| CommonEvent.createSubscriber(subscribeInfo: CommonEventSubscribeInfo, callback: AsyncCallback\<CommonEventSubscriber>) | 支持 | 支持 | 支持   | 支持     | 不支持         |
| CommonEvent.createSubscriber(subscribeInfo: CommonEventSubscribeInfo) | 支持 | 支持 | 支持   | 支持     | 不支持         |
| CommonEvent.subscribe(subscriber: CommonEventSubscriber, callback: AsyncCallback\<CommonEventData>) | 支持 | 支持 | 支持   | 支持     | 不支持         |
| CommonEvent.unsubscribe(subscriber: CommonEventSubscriber, callback?: AsyncCallback\<void>) | 支持 | 支持 | 支持   | 支持     | 不支持         |

## 权限列表

| 系统公共事件宏                                               | 系统公共事件名称                                            | 订阅者所需权限                                               |
| ------------------------------------------------------------ | ----------------------------------------------------------- | ------------------------------------------------------------ |
| COMMON_EVENT_BOOT_COMPLETED                                  | usual.event.BOOT_COMPLETED                                  | ohos.permission.RECEIVER_STARTUP_COMPLETED                   |
| COMMON_EVENT_LOCKED_BOOT_COMPLETED                           | usual.event.LOCKED_BOOT_COMPLETED                           | ohos.permission.RECEIVER_STARTUP_COMPLETED                   |
| COMMON_EVENT_SHUTDOWN                                        | usual.event.SHUTDOWN                                        | 无                                                           |
| COMMON_EVENT_BATTERY_CHANGED                                 | usual.event.BATTERY_CHANGED                                 | 无                                                           |
| COMMON_EVENT_BATTERY_LOW                                     | usual.event.BATTERY_LOW                                     | 无                                                           |
| COMMON_EVENT_BATTERY_OKAY                                    | usual.event.BATTERY_OKAY                                    | 无                                                           |
| COMMON_EVENT_POWER_CONNECTED                                 | usual.event.POWER_CONNECTED                                 | 无                                                           |
| COMMON_EVENT_POWER_DISCONNECTED                              | usual.event.POWER_DISCONNECTED                              | 无                                                           |
| COMMON_EVENT_SCREEN_OFF                                      | usual.event.SCREEN_OFF                                      | 无                                                           |
| COMMON_EVENT_SCREEN_ON                                       | usual.event.SCREEN_ON                                       | 无                                                           |
| COMMON_EVENT_USER_PRESENT                                    | usual.event.USER_PRESENT                                    | 无                                                           |
| COMMON_EVENT_TIME_TICK                                       | usual.event.TIME_TICK                                       | 无                                                           |
| COMMON_EVENT_TIME_CHANGED                                    | usual.event.TIME_CHANGED                                    | 无                                                           |
| COMMON_EVENT_DATE_CHANGED                                    | usual.event.DATE_CHANGED                                    | 无                                                           |
| COMMON_EVENT_TIMEZONE_CHANGED                                | usual.event.TIMEZONE_CHANGED                                | 无                                                           |
| COMMON_EVENT_CLOSE_SYSTEM_DIALOGS                            | usual.event.CLOSE_SYSTEM_DIALOGS                            | 无                                                           |
| COMMON_EVENT_PACKAGE_ADDED                                   | usual.event.PACKAGE_ADDED                                   | 无                                                           |
| COMMON_EVENT_PACKAGE_REPLACED                                | usual.event.PACKAGE_REPLACED                                | 无                                                           |
| COMMON_EVENT_MY_PACKAGE_REPLACED                             | usual.event.MY_PACKAGE_REPLACED                             | 无                                                           |
| COMMON_EVENT_PACKAGE_REMOVED                                 | usual.event.PACKAGE_REMOVED                                 | 无                                                           |
| COMMON_EVENT_PACKAGE_FULLY_REMOVED                           | usual.event.PACKAGE_FULLY_REMOVED                           | 无                                                           |
| COMMON_EVENT_PACKAGE_CHANGED                                 | usual.event.PACKAGE_CHANGED                                 | 无                                                           |
| COMMON_EVENT_PACKAGE_RESTARTED                               | usual.event.PACKAGE_RESTARTED                               | 无                                                           |
| COMMON_EVENT_PACKAGE_DATA_CLEARED                            | usual.event.PACKAGE_DATA_CLEARED                            | 无                                                           |
| COMMON_EVENT_PACKAGES_SUSPENDED                              | usual.event.PACKAGES_SUSPENDED                              | 无                                                           |
| COMMON_EVENT_PACKAGES_UNSUSPENDED                            | usual.event.PACKAGES_UNSUSPENDED                            | 无                                                           |
| COMMON_EVENT_MY_PACKAGE_SUSPENDED                            | usual.event.MY_PACKAGE_SUSPENDED                            | 无                                                           |
| COMMON_EVENT_MY_PACKAGE_UNSUSPENDED                          | usual.event.MY_PACKAGE_UNSUSPENDED                          | 无                                                           |
| COMMON_EVENT_UID_REMOVED                                     | usual.event.UID_REMOVED                                     | 无                                                           |
| COMMON_EVENT_PACKAGE_FIRST_LAUNCH                            | usual.event.PACKAGE_FIRST_LAUNCH                            | 无                                                           |
| COMMON_EVENT_PACKAGE_NEEDS_VERIFICATION                      | usual.event.PACKAGE_NEEDS_VERIFICATION                      | 无                                                           |
| COMMON_EVENT_PACKAGE_VERIFIED                                | usual.event.PACKAGE_VERIFIED                                | 无                                                           |
| COMMON_EVENT_EXTERNAL_APPLICATIONS_AVAILABLE                 | usual.event.EXTERNAL_APPLICATIONS_AVAILABLE                 | 无                                                           |
| COMMON_EVENT_EXTERNAL_APPLICATIONS_UNAVAILABLE               | usual.event.EXTERNAL_APPLICATIONS_UNAVAILABLE               | 无                                                           |
| COMMON_EVENT_CONFIGURATION_CHANGED                           | usual.event.CONFIGURATION_CHANGED                           | 无                                                           |
| COMMON_EVENT_LOCALE_CHANGED                                  | usual.event.LOCALE_CHANGED                                  | 无                                                           |
| COMMON_EVENT_MANAGE_PACKAGE_STORAGE                          | usual.event.MANAGE_PACKAGE_STORAGE                          | 无                                                           |
| COMMON_EVENT_DRIVE_MODE                                      | common.event.DRIVE_MODE                                     | 无                                                           |
| COMMON_EVENT_HOME_MODE                                       | common.event.HOME_MODE                                      | 无                                                           |
| COMMON_EVENT_OFFICE_MODE                                     | common.event.OFFICE_MODE                                    | 无                                                           |
| COMMON_EVENT_USER_STARTED                                    | usual.event.USER_STARTED                                    | 无                                                           |
| COMMON_EVENT_USER_BACKGROUND                                 | usual.event.USER_BACKGROUND                                 | 无                                                           |
| COMMON_EVENT_USER_FOREGROUND                                 | usual.event.USER_FOREGROUND                                 | 无                                                           |
| COMMON_EVENT_USER_SWITCHED                                   | usual.event.USER_SWITCHED                                   | ohos.permission.MANAGE_USERS                                 |
| COMMON_EVENT_USER_STARTING                                   | usual.event.USER_STARTING                                   | ohos.permission.INTERACT_ACROSS_USERS                        |
| COMMON_EVENT_USER_UNLOCKED                                   | usual.event.USER_UNLOCKED                                   | 无                                                           |
| COMMON_EVENT_USER_STOPPING                                   | usual.event.USER_STOPPING                                   | ohos.permission.INTERACT_ACROSS_USERS                        |
| COMMON_EVENT_USER_STOPPED                                    | usual.event.USER_STOPPED                                    | 无                                                           |
| COMMON_EVENT_HWID_LOGIN                                      | common.event.HWID_LOGIN                                     | 无                                                           |
| COMMON_EVENT_HWID_LOGOUT                                     | common.event.HWID_LOGOUT                                    | 无                                                           |
| COMMON_EVENT_HWID_TOKEN_INVALID                              | common.event.HWID_TOKEN_INVALID                             | 无                                                           |
| COMMON_EVENT_HWID_LOGOFF                                     | common.event.HWID_LOGOFF                                    | 无                                                           |
| COMMON_EVENT_WIFI_POWER_STATE                                | usual.event.wifi.POWER_STATE                                | 无                                                           |
| COMMON_EVENT_WIFI_SCAN_FINISHED                              | usual.event.wifi.SCAN_FINISHED                              | ohos.permission.LOCATION                                     |
| COMMON_EVENT_WIFI_RSSI_VALUE                                 | usual.event.wifi.RSSI_VALUE                                 | ohos.permission.GET_WIFI_INFO                                |
| COMMON_EVENT_WIFI_CONN_STATE                                 | usual.event.wifi.CONN_STATE                                 | 无                                                           |
| COMMON_EVENT_WIFI_HOTSPOT_STATE                              | usual.event.wifi.HOTSPOT_STATE                              | 无                                                           |
| COMMON_EVENT_WIFI_AP_STA_JOIN                                | usual.event.wifi.WIFI_HS_STA_JOIN                           | ohos.permission.GET_WIFI_INFO                                |
| COMMON_EVENT_WIFI_AP_STA_LEAVE                               | usual.event.wifi.WIFI_HS_STA_LEAVE                          | ohos.permission.GET_WIFI_INFO                                |
| COMMON_EVENT_WIFI_MPLINK_STATE_CHANGE                        | usual.event.wifi.mplink.STATE_CHANGE                        | ohos.permission.MPLINK_CHANGE_STATE                          |
| COMMON_EVENT_WIFI_P2P_CONN_STATE                             | usual.event.wifi.p2p.CONN_STATE_CHANGE                      | ohos.permission.GET_WIFI_INFO and ohos.permission.LOCATION   |
| COMMON_EVENT_WIFI_P2P_STATE_CHANGED                          | usual.event.wifi.p2p.STATE_CHANGE                           | ohos.permission.GET_WIFI_INFO                                |
| COMMON_EVENT_WIFI_P2P_PEERS_STATE_CHANGED                    | usual.event.wifi.p2p.DEVICES_CHANGE                         | ohos.permission.GET_WIFI_INFO                                |
| COMMON_EVENT_WIFI_P2P_PEERS_DISCOVERY_STATE_CHANGED          | usual.event.wifi.p2p.PEER_DISCOVERY_STATE_CHANGE            | ohos.permission.GET_WIFI_INFO                                |
| COMMON_EVENT_WIFI_P2P_CURRENT_DEVICE_STATE_CHANGED           | usual.event.wifi.p2p.CURRENT_DEVICE_CHANGE                  | ohos.permission.GET_WIFI_INFO                                |
| COMMON_EVENT_WIFI_P2P_GROUP_STATE_CHANGED                    | usual.event.wifi.p2p.GROUP_STATE_CHANGED                    | ohos.permission.GET_WIFI_INFO                                |
| COMMON_EVENT_BLUETOOTH_HANDSFREE_AG_CONNECT_STATE_UPDATE     | usual.event.bluetooth.handsfree.ag.CONNECT_STATE_UPDATE     | ohos.permission.USE_BLUETOOTH                                |
| COMMON_EVENT_BLUETOOTH_HANDSFREE_AG_CURRENT_DEVICE_UPDATE    | usual.event.bluetooth.handsfree.ag.CURRENT_DEVICE_UPDATE    | ohos.permission.USE_BLUETOOTH                                |
| COMMON_EVENT_BLUETOOTH_HANDSFREE_AG_AUDIO_STATE_UPDATE       | usual.event.bluetooth.handsfree.ag.AUDIO_STATE_UPDATE       | ohos.permission.USE_BLUETOOTH                                |
| COMMON_EVENT_BLUETOOTH_A2DPSOURCE_CONNECT_STATE_UPDATE       | usual.event.bluetooth.a2dpsource.CONNECT_STATE_UPDATE       | ohos.permission.USE_BLUETOOTH                                |
| COMMON_EVENT_BLUETOOTH_A2DPSOURCE_CURRENT_DEVICE_UPDATE      | usual.event.bluetooth.a2dpsource.CURRENT_DEVICE_UPDATE      | ohos.permission.USE_BLUETOOTH                                |
| COMMON_EVENT_BLUETOOTH_A2DPSOURCE_PLAYING_STATE_UPDATE       | usual.event.bluetooth.a2dpsource.PLAYING_STATE_UPDATE"      | ohos.permission.USE_BLUETOOTH                                |
| COMMON_EVENT_BLUETOOTH_A2DPSOURCE_AVRCP_CONNECT_STATE_UPDATE | usual.event.bluetooth.a2dpsource.AVRCP_CONNECT_STATE_UPDATE | ohos.permission.USE_BLUETOOTH                                |
| COMMON_EVENT_BLUETOOTH_A2DPSOURCE_CODEC_VALUE_UPDATE         | usual.event.bluetooth.a2dpsource.CODEC_VALUE_UPDATE         | ohos.permission.USE_BLUETOOTH                                |
| COMMON_EVENT_BLUETOOTH_REMOTEDEVICE_DISCOVERED               | usual.event.bluetooth.remotedevice.DISCOVERED               | ohos.permission.USE_BLUETOOTH and ohos.permission.LOCATION   |
| COMMON_EVENT_BLUETOOTH_REMOTEDEVICE_CLASS_VALUE_UPDATE       | usual.event.bluetooth.remotedevice.CLASS_VALUE_UPDATE       | ohos.permission.USE_BLUETOOTH                                |
| COMMON_EVENT_BLUETOOTH_REMOTEDEVICE_ACL_CONNECTED            | usual.event.bluetooth.remotedevice.ACL_CONNECTED            | ohos.permission.USE_BLUETOOTH                                |
| COMMON_EVENT_BLUETOOTH_REMOTEDEVICE_ACL_DISCONNECTED         | usual.event.bluetooth.remotedevice.ACL_DISCONNECTED         | ohos.permission.USE_BLUETOOTH                                |
| COMMON_EVENT_BLUETOOTH_REMOTEDEVICE_NAME_UPDATE              | usual.event.bluetooth.remotedevice.NAME_UPDATE              | ohos.permission.USE_BLUETOOTH                                |
| COMMON_EVENT_BLUETOOTH_REMOTEDEVICE_PAIR_STATE               | usual.event.bluetooth.remotedevice.PAIR_STATE               | ohos.permission.USE_BLUETOOTH                                |
| COMMON_EVENT_BLUETOOTH_REMOTEDEVICE_BATTERY_VALUE_UPDATE     | usual.event.bluetooth.remotedevice.BATTERY_VALUE_UPDATE     | ohos.permission.USE_BLUETOOTH                                |
| COMMON_EVENT_BLUETOOTH_REMOTEDEVICE_SDP_RESULT               | usual.event.bluetooth.remotedevice.SDP_RESULT               | 无                                                           |
| COMMON_EVENT_BLUETOOTH_REMOTEDEVICE_UUID_VALUE               | usual.event.bluetooth.remotedevice.UUID_VALUE               | ohos.permission.DISCOVER_BLUETOOTH                           |
| COMMON_EVENT_BLUETOOTH_REMOTEDEVICE_PAIRING_REQ              | usual.event.bluetooth.remotedevice.PAIRING_REQ              | ohos.permission.DISCOVER_BLUETOOTH                           |
| COMMON_EVENT_BLUETOOTH_REMOTEDEVICE_PAIRING_CANCEL           | usual.event.bluetooth.remotedevice.PAIRING_CANCEL           | 无                                                           |
| COMMON_EVENT_BLUETOOTH_REMOTEDEVICE_CONNECT_REQ              | usual.event.bluetooth.remotedevice.CONNECT_REQ              | 无                                                           |
| COMMON_EVENT_BLUETOOTH_REMOTEDEVICE_CONNECT_REPLY            | usual.event.bluetooth.remotedevice.CONNECT_REPLY            | 无                                                           |
| COMMON_EVENT_BLUETOOTH_REMOTEDEVICE_CONNECT_CANCEL           | usual.event.bluetooth.remotedevice.CONNECT_CANCEL           | 无                                                           |
| COMMON_EVENT_BLUETOOTH_HANDSFREEUNIT_CONNECT_STATE_UPDATE    | usual.event.bluetooth.handsfreeunit.CONNECT_STATE_UPDATE    | 无                                                           |
| COMMON_EVENT_BLUETOOTH_HANDSFREEUNIT_AUDIO_STATE_UPDATE      | usual.event.bluetooth.handsfreeunit.AUDIO_STATE_UPDATE      | 无                                                           |
| COMMON_EVENT_BLUETOOTH_HANDSFREEUNIT_AG_COMMON_EVENT         | usual.event.bluetooth.handsfreeunit.AG_COMMON_EVENT         | 无                                                           |
| COMMON_EVENT_BLUETOOTH_HANDSFREEUNIT_AG_CALL_STATE_UPDATE    | usual.event.bluetooth.handsfreeunit.AG_CALL_STATE_UPDATE    | 无                                                           |
| COMMON_EVENT_BLUETOOTH_HOST_STATE_UPDATE                     | usual.event.bluetooth.host.STATE_UPDATE                     | 无                                                           |
| COMMON_EVENT_BLUETOOTH_HOST_REQ_DISCOVERABLE                 | usual.event.bluetooth.host.REQ_DISCOVERABLE                 | 无                                                           |
| COMMON_EVENT_BLUETOOTH_HOST_REQ_ENABLE                       | usual.event.bluetooth.host.REQ_ENABLE                       | ohos.permission.USE_BLUETOOTH                                |
| COMMON_EVENT_BLUETOOTH_HOST_REQ_DISABLE                      | usual.event.bluetooth.host.REQ_DISABLE                      | ohos.permission.USE_BLUETOOTH                                |
| COMMON_EVENT_BLUETOOTH_HOST_SCAN_MODE_UPDATE                 | usual.event.bluetooth.host.SCAN_MODE_UPDATE                 | ohos.permission.USE_BLUETOOTH                                |
| COMMON_EVENT_BLUETOOTH_HOST_DISCOVERY_STARTED                | usual.event.bluetooth.host.DISCOVERY_STARTED                | ohos.permission.USE_BLUETOOTH                                |
| COMMON_EVENT_BLUETOOTH_HOST_DISCOVERY_FINISHED               | usual.event.bluetooth.host.DISCOVERY_FINISHED               | ohos.permission.USE_BLUETOOTH                                |
| COMMON_EVENT_BLUETOOTH_HOST_NAME_UPDATE                      | usual.event.bluetooth.host.NAME_UPDATE                      | ohos.permission.USE_BLUETOOTH                                |
| COMMON_EVENT_BLUETOOTH_A2DPSINK_CONNECT_STATE_UPDATE         | usual.event.bluetooth.a2dpsink.CONNECT_STATE_UPDATE         | ohos.permission.USE_BLUETOOTH                                |
| COMMON_EVENT_BLUETOOTH_A2DPSINK_PLAYING_STATE_UPDATE         | usual.event.bluetooth.a2dpsink.PLAYING_STATE_UPDATE         | ohos.permission.USE_BLUETOOTH                                |
| COMMON_EVENT_BLUETOOTH_A2DPSINK_AUDIO_STATE_UPDATE           | usual.event.bluetooth.a2dpsink.AUDIO_STATE_UPDATE           | ohos.permission.USE_BLUETOOTH                                |
| COMMON_EVENT_NFC_ACTION_ADAPTER_STATE_CHANGED                | usual.event.nfc.action.ADAPTER_STATE_CHANGED                | 无                                                           |
| COMMON_EVENT_NFC_ACTION_RF_FIELD_ON_DETECTED                 | usual.event.nfc.action.RF_FIELD_ON_DETECTED                 | ohos.permission.MANAGE_SECURE_SETTINGS                       |
| COMMON_EVENT_NFC_ACTION_RF_FIELD_OFF_DETECTED                | usual.event.nfc.action.RF_FIELD_OFF_DETECTED                | ohos.permission.MANAGE_SECURE_SETTINGS                       |
| COMMON_EVENT_DISCHARGING                                     | usual.event.DISCHARGING                                     | 无                                                           |
| COMMON_EVENT_CHARGING                                        | usual.event.CHARGING                                        | 无                                                           |
| COMMON_EVENT_DEVICE_IDLE_MODE_CHANGED                        | usual.event.DEVICE_IDLE_MODE_CHANGED                        | 无                                                           |
| COMMON_EVENT_POWER_SAVE_MODE_CHANGED                         | usual.event.POWER_SAVE_MODE_CHANGED                         | 无                                                           |
| COMMON_EVENT_USER_ADDED                                      | usual.event.USER_ADDED                                      | ohos.permission.MANAGE_USERS                                 |
| COMMON_EVENT_USER_REMOVED                                    | usual.event.USER_REMOVED                                    | ohos.permission.MANAGE_USERS                                 |
| COMMON_EVENT_ABILITY_ADDED                                   | common.event.ABILITY_ADDED                                  | ohos.permission.LISTEN_BUNDLE_CHANGE                         |
| COMMON_EVENT_ABILITY_REMOVED                                 | common.event.ABILITY_REMOVED                                | ohos.permission.LISTEN_BUNDLE_CHANGE                         |
| COMMON_EVENT_ABILITY_UPDATED                                 | common.event.ABILITY_UPDATED                                | ohos.permission.LISTEN_BUNDLE_CHANGE                         |
| COMMON_EVENT_LOCATION_MODE_STATE_CHANGED                     | usual.event.location.MODE_STATE_CHANGED                     | 无                                                           |
| COMMON_EVENT_IVI_SLEEP                                       | common.event.IVI_SLEEP                                      | 无                                                           |
| COMMON_EVENT_IVI_PAUSE                                       | common.event.IVI_PAUSE                                      | 无                                                           |
| COMMON_EVENT_IVI_STANDBY                                     | common.event.IVI_STANDBY                                    | 无                                                           |
| COMMON_EVENT_IVI_LASTMODE_SAVE                               | common.event.IVI_LASTMODE_SAVE                              | 无                                                           |
| COMMON_EVENT_IVI_VOLTAGE_ABNORMAL                            | common.event.IVI_VOLTAGE_ABNORMAL                           | 无                                                           |
| COMMON_EVENT_IVI_HIGH_TEMPERATURE                            | common.event.IVI_HIGH_TEMPERATURE                           | 无                                                           |
| COMMON_EVENT_IVI_EXTREME_TEMPERATURE                         | common.event.IVI_EXTREME_TEMPERATURE                        | 无                                                           |
| COMMON_EVENT_IVI_TEMPERATURE_ABNORMAL                        | common.event.IVI_TEMPERATURE_ABNORMAL                       | 无                                                           |
| COMMON_EVENT_IVI_VOLTAGE_RECOVERY                            | common.event.IVI_VOLTAGE_RECOVERY                           | 无                                                           |
| COMMON_EVENT_IVI_TEMPERATURE_RECOVERY                        | common.event.IVI_TEMPERATURE_RECOVERY                       | 无                                                           |
| COMMON_EVENT_IVI_ACTIVE                                      | common.event.IVI_ACTIVE                                     | 无                                                           |
| COMMON_EVENT_USB_DEVICE_ATTACHED                             | usual.event.hardware.usb.action.USB_DEVICE_ATTACHED         | 无                                                           |
| COMMON_EVENT_USB_DEVICE_DETACHED                             | usual.event.hardware.usb.action.USB_DEVICE_DETACHED         | 无                                                           |
| COMMON_EVENT_USB_ACCESSORY_ATTACHED                          | usual.event.hardware.usb.action.USB_ACCESSORY_ATTACHED      | 无                                                           |
| COMMON_EVENT_USB_ACCESSORY_DETACHED                          | usual.event.hardware.usb.action.USB_ACCESSORY_DETACHED      | 无                                                           |
| COMMON_EVENT_DISK_REMOVED                                    | usual.event.data.DISK_REMOVED                               | ohos.permission.WRITE_USER_STORAGE or ohos.permission.READ_USER_STORAGE |
| COMMON_EVENT_DISK_UNMOUNTED                                  | usual.event.data.DISK_UNMOUNTED                             | ohos.permission.WRITE_USER_STORAGEor ohos.permission.READ_USER_STORAGE |
| COMMON_EVENT_DISK_MOUNTED                                    | usual.event.data.DISK_MOUNTED                               | ohos.permission.WRITE_USER_STORAGEor ohos.permission.READ_USER_STORAGE |
| COMMON_EVENT_DISK_BAD_REMOVAL                                | usual.event.data.DISK_BAD_REMOVAL                           | ohos.permission.WRITE_USER_STORAGEor ohos.permission.READ_USER_STORAGE |
| COMMON_EVENT_DISK_UNMOUNTABLE                                | usual.event.data.DISK_UNMOUNTABLE                           | ohos.permission.WRITE_USER_STORAGEor ohos.permission.READ_USER_STORAGE |
| COMMON_EVENT_DISK_EJECT                                      | usual.event.data.DISK_EJECT                                 | ohos.permission.WRITE_USER_STORAGEor ohos.permission.READ_USER_STORAGE |
| COMMON_EVENT_VISIBLE_ACCOUNTS_UPDATED                        | usual.event.data.VISIBLE_ACCOUNTS_UPDATED                   | ohos.permission.GET_APP_ACCOUNTS                             |
| COMMON_EVENT_ACCOUNT_DELETED                                 | usual.event.data.ACCOUNT_DELETED                            | ohos.permission.INTERACT_ACROSS_LOCAL_ACCOUNTS               |
| COMMON_EVENT_FOUNDATION_READY                                | common.event.FOUNDATION_READY                               | ohos.permission.RECEIVER_STARTUP_COMPLETED                   |
| COMMON_EVENT_AIRPLANE_MODE_CHANGED                           | usual.event.AIRPLANE_MODE                                   | 无                                                           |

## 导入模块

```js
import CommonEvent from '@ohos.commonevent';
```



## CommonEvent.publish(event: string, callback: AsyncCallback\<void>): void

- 接口说明

  发布公共事件(callback形式)

* publish参数描述

  | 名称     | 读写属性 | 类型                 | 必填 | 描述                 |
  | -------- | -------- | -------------------- | ---- | -------------------- |
  | event    | 只读     | string               | 是   | 表示要发送的公共事件 |
  | callback | 只读     | AsyncCallback\<void> | 是   | 表示被指定的回调方法 |

* 示例

```js
//发布公共事件回调
function PublishCallBack(err) {
	console.info("==========================>PublishCallBack=======================>");
    console.info("==========================>err:=======================>", err.code);
}
//发布公共事件
CommonEvent.publish("publish_event", PublishCallBack);
```



## CommonEvent.publish(event: string, options: CommonEventPublishData, callback: AsyncCallback\<void>): void

- 接口说明

  发布公共事件指定发布信息(callback形式)

- publish参数描述

  | 名称     | 读写属性 | 类型                   | 必填 | 描述                   |
  | -------- | -------- | ---------------------- | ---- | ---------------------- |
  | event    | 只读     | string                 | 是   | 表示要发布的公共事件   |
  | options  | 只读     | [CommonEventPublishData](#publishData) | 是   | 表示发布公共事件的属性 |
  | callback | 只读     | AsyncCallback\<void>   | 是   | 表示被指定的回调方法   |

- 示例


```js
//公共事件相关信息
var options = {
	code: 0;			 //公共事件的初始代码
	data: "initial data";//公共事件的初始数据
	isOrdered: true;	 //有序公共事件
}
//发布公共事件回调
function PublishCallBack(err) {
	console.info("==========================>PublishCallBack=======================>");
}
//发布公共事件
CommonEvent.publish("publish_event", options, PublishCallBack);
```



## CommonEvent.createSubscriber(subscribeInfo: CommonEventSubscribeInfo, callback: AsyncCallback\<CommonEventSubscriber>): void

- 接口说明

  创建订阅者(callback形式)

- createSubscriber参数描述

  | 名称          | 读写属性 | 类型                                                 | 必填 | 描述                     |
  | ------------- | -------- | ---------------------------------------------------- | ---- | ------------------------ |
  | subscribeInfo | 只读     | [CommonEventSubscribeInfo](#SubscribeInfo)           | 是   | 表示订阅信息             |
  | callback      | 只读     | AsyncCallback\<[CommonEventSubscriber](#Subscriber)> | 是   | 表示创建订阅者的回调方法 |

- 示例


```js
var subscriber; //用于保存创建成功的订阅者对象,后续使用其完成订阅及退订的动作
//订阅者信息
var subscribeInfo = {
	events: ["event"]
};
//创建订阅者回调
function CreateSubscriberCallBack(err, data) {
    console.info("==========================>CreateSubscriberCallBack=======================>");
    subscriber = data;
}
//创建订阅者
CommonEvent.createSubscriber(subscribeInfo, CreateSubscriberCallBack);
```



## CommonEvent.createSubscriber(subscribeInfo: CommonEventSubscribeInfo): Promise\<CommonEventSubscriber>

- 接口说明

  创建订阅者(Promise形式)

- createSubscriber参数描述

  | 名称          | 读写属性 | 类型                                       | 必填 | 描述         |
  | ------------- | -------- | ------------------------------------------ | ---- | ------------ |
  | subscribeInfo | 只读     | [CommonEventSubscribeInfo](#SubscribeInfo) | 是   | 表示订阅信息 |

- 返回值

  Promise\<[CommonEventSubscriber](#Subscriber)>
  
  订阅者对象
  
- 示例

```js
var subscriber; //用于保存创建成功的订阅者对象,后续使用其完成订阅及退订的动作
//订阅者信息
var subscribeInfo = {
	events: ["event"]
};
//创建订阅者
CommonEvent.createSubscriber(subscribeInfo).then((data) => {
	console.info("==========================>createSubscriberPromise=======================>");
    subscriber = data;
});
```



## CommonEvent.subscribe(subscriber: CommonEventSubscriber, callback: AsyncCallback\<CommonEventData>): void

- 接口说明

  订阅公共事件(callback形式)

- subscribe参数描述

  | 名称       | 读写属性 | 类型                                                | 必填 | 描述                           |
  | ---------- | -------- | --------------------------------------------------- | ---- | ------------------------------ |
  | subscriber | 只读     | [CommonEventSubscriber](#Subscriber)                | 是   | 表示订阅者对象                 |
  | callback   | 只读     | AsyncCallback\<[CommonEventData](#CommonEventData)> | 是   | 表示接收公共事件数据的回调函数 |

- 示例

  无序事件:
  

```js
var subscriber; //用于保存创建成功的订阅者对象,后续使用其完成订阅及退订的动作
//订阅者信息
var subscribeInfo = {
    events: ["event"]
};
//订阅公共事件回调
function SubscribeCallBack(err, data) {
    console.info("==========================>SubscribeCallBack=======================>");
}
//创建订阅者回调
function CreateSubscriberCallBack(err, data) {
    console.info("==========================>CreateSubscriberCallBack=======================>");
    subscriber = data;
    //订阅公共事件
    CommonEvent.subscribe(subscriber, SubscribeCallBack);
}
//创建订阅者
CommonEvent.createSubscriber(subscribeInfo, CreateSubscriberCallBack);
```

​    有序事件:

```js
var subscriber; //用于保存创建成功的订阅者对象,后续使用其完成订阅及退订的动作
//订阅者信息
var subscribeInfo = {
    events: ["event"]
};

//设置有序公共事件的结果代码回调
function SetCodeCallBack(err) {
    console.info("==========================>SetCodeCallBack=======================>");
}
//设置有序公共事件的结果数据回调
function SetDataCallBack(err) {
    console.info("==========================>SetDataCallBack=======================>");
}
//完成本次有序公共事件处理回调
function FinishCommonEventCallBack(err) {
    console.info("==========================>FinishCommonEventCallBack=======================>");
}
//订阅公共事件回调
function SubscribeCallBack(err, data) {
    console.info("==========================>SubscribeCallBack=======================>");
    //设置有序公共事件的结果代码
    subscriber.setCode(0, SetCodeCallBack);
    //设置有序公共事件的结果数据
    subscriber.setData("publish_data_changed", SetDataCallBack);
    //完成本次有序公共事件处理
    subscriber.finishCommonEvent(FinishCommonEventCallBack)
}

//创建订阅者回调
function CreateSubscriberCallBack(err, data) {
    console.info("==========================>CreateSubscriberCallBack=======================>");
    subscriber = data;
    //订阅公共事件
    CommonEvent.subscribe(subscriber, SubscribeCallBack);
}

//创建订阅者
CommonEvent.createSubscriber(subscribeInfo, CreateSubscriberCallBack);
```



## CommonEvent.unsubscribe(subscriber: CommonEventSubscriber, callback?: AsyncCallback\<void>): void

- 接口说明

  取消订阅公共事件(callback形式)

- unsubscribe参数描述

  | 名称       | 读写属性 | 类型                  | 必填 | 描述                   |
  | ---------- | -------- | --------------------- | ---- | ---------------------- |
  | subscriber | 只读     | CommonEventSubscriber | 是   | 表示订阅者对象         |
  | callback   | 只读     | AsyncCallback\<void>  | 是   | 表示取消订阅的回调方法 |

- 示例

```js
var subscriber;	//用于保存创建成功的订阅者对象,后续使用其完成订阅及退订的动作
//订阅者信息
var subscribeInfo = {
	events: ["event"]
};
//订阅公共事件回调
function SubscribeCallBack(err, data) {
	console.info("==========================>SubscribeCallBack=======================>");
}
//创建订阅者回调
function CreateSubscriberCallBack(err, data) {
	console.info("==========================>CreateSubscriberCallBack=======================>");
	subscriber = data;
	//订阅公共事件
	CommonEvent.subscribe(subscriber, SubscribeCallBack);
}
//取消订阅公共事件回调
function UnsubscribeCallBack(err) {
	console.info("==========================>UnsubscribeCallBack=======================>");
}
//创建订阅者
CommonEvent.createSubscriber(subscribeInfo, CreateSubscriberCallBack);
//取消订阅公共事件
CommonEvent.unsubscribe(subscriber, UnsubscribeCallBack);
```

## <span id = "publishData">CommonEventPublishData</span>

| 名称                  | 读写属性 | 类型                 | 必填 | 描述                         |
| --------------------- | -------- | -------------------- | ---- | ---------------------------- |
| bundleName            | 只读     | string               | 否   | 表示包名称                   |
| code                  | 只读     | number               | 否   | 表示公共事件的结果代码       |
| data                  | 只读     | string               | 否   | 表示公共事件的自定义结果数据 |
| subscriberPermissions | 只读     | Array\<string>       | 否   | 表示订阅者的权限             |
| isOrdered             | 只读     | boolean              | 否   | 表示是否是有序事件           |
| parameters            | 只读     | {[key: string]: any} | 否   | 表示公共事件的附加信息       |

## <span id = "SubscribeInfo">CommonEventSubscribeInfo</span>

| 名称                | 读写属性 | 类型           | 必填 | 描述                                                         |
| ------------------- | -------- | -------------- | ---- | ------------------------------------------------------------ |
| events              | 只读     | Array\<string> | 是   | 表示要发送的公共事件                                         |
| publisherPermission | 只读     | string         | 否   | 表示发布者的权限                                             |
| publisherDeviceId   | 只读     | string         | 否   | 表示设备ID,该值必须是同一ohos网络上的现有设备ID             |
| userId              | 只读     | number         | 否   | 表示用户ID。此参数是可选的,默认值当前用户的ID。如果指定了此参数,则该值必须是系统中现有的用户ID。 |
| priority            | 只读     | number         | 否   | 表示订阅者的优先级。值的范围是-100到1000                     |

## <span id = "CommonEventData">CommonEventData</span>

| 名称       | 读写属性 | 类型                 | 必填 | 描述                                                   |
| ---------- | -------- | -------------------- | ---- | ------------------------------------------------------ |
| event      | 只读     | string               | 是   | 表示当前接收的公共事件名称                             |
| bundleName | 只读     | string               | 否   | 表示包名称                                             |
| code       | 只读     | number               | 否   | 表示公共事件的结果代码,用于传递int类型的数据          |
| data       | 只读     | string               | 否   | 表示公共事件的自定义结果数据,用于传递string类型的数据 |
| parameters | 只读     | {[key: string]: any} | 否   | 表示公共事件的附加信息                                 |

## <span id = "Subscriber">CommonEventSubscriber</span>

### getCode(callback形式)

- 方法说明

  获取公共事件的结果代码(callback形式)

- 参数

  | 参数名   | 类型                   | 必填 | 描述               |
  | -------- | ---------------------- | ---- | ------------------ |
  | callback | AsyncCallback\<number> | 是   | 公共事件的结果代码 |

- 示例

  ```js
  var subscriber;	//用于保存创建成功的订阅者对象,后续使用其完成订阅及退订的动作
  //设置有序公共事件的结果数据回调
  function getCodeCallback(err, data) {
      console.info("==========================>getCodeCallback=======================>");
      console.info("==========================>err:=======================>", err.code);
      console.info("==========================>code:=======================>", data);
  }
  subscriber.getCode(getCodeCallback);
  ```

### getCode(Promise形式)

- 方法说明

  获取公共事件的结果代码(Promise形式)

- 返回值

  | 类型             | 说明               |
  | ---------------- | ------------------ |
  | Promise\<number> | 公共事件的结果代码 |

- 示例

  ```js
  var subscriber;	//用于保存创建成功的订阅者对象,后续使用其完成订阅及退订的动作
  subscriber.getCode().then((data) => {
  	console.info("==========================>getCodePromise=======================>");
      console.info("==========================>code:=======================>", data);
  });
  ```

### setCode(callback形式)

- 方法说明

  设置公共事件的结果代码(callback形式)

- 参数

  | 参数名   | 类型                 | 必填 | 描述                 |
  | -------- | -------------------- | ---- | -------------------- |
  | code     | number               | 是   | 公共事件的结果代码   |
  | callback | AsyncCallback\<void> | 是   | 表示被指定的回调方法 |

- 示例

  ```js
  var subscriber;	//用于保存创建成功的订阅者对象,后续使用其完成订阅及退订的动作
  //设置有序公共事件的结果数据回调
  function setCodeCallback(err) {
      console.info("==========================>setCodeCallback=======================>");
      console.info("==========================>err:=======================>", err.code);
  }
  subscriber.setCode(1, setCodeCallback);
  ```

### setCode(Promise形式)

- 方法说明

  设置公共事件的结果代码(Promise形式)

- 参数

  | 参数名 | 类型   | 必填 | 描述               |
  | ------ | ------ | ---- | ------------------ |
  | code   | number | 是   | 公共事件的结果代码 |

- 示例

  ```js
  var subscriber;	//用于保存创建成功的订阅者对象,后续使用其完成订阅及退订的动作
  subscriber.setCode(1).then(() => {
  	console.info("==========================>setCodePromise=======================>");
  });
  ```

### getData(callback形式)

- 方法说明

  获取公共事件的结果数据(callback形式)

- 参数

  | 参数名   | 类型                   | 必填 | 描述               |
  | -------- | ---------------------- | ---- | ------------------ |
  | callback | AsyncCallback\<string> | 是   | 公共事件的结果数据 |

- 示例

  ```js
  var subscriber;	//用于保存创建成功的订阅者对象,后续使用其完成订阅及退订的动作
  //设置有序公共事件的结果数据回调
  function getDataCallback(err, data) {
      console.info("==========================>getDataCallback=======================>");
      console.info("==========================>err:=======================>", err.code);
      console.info("==========================>data:=======================>", data);
  }
  subscriber.getData(getDataCallback);
  ```

### getData(Promise形式)

- 方法说明

  获取公共事件的结果数据(Promise形式)

- 返回值

  | 类型             | 说明               |
  | ---------------- | ------------------ |
  | Promise\<string> | 公共事件的结果数据 |

- 示例

  ```js
  var subscriber;	//用于保存创建成功的订阅者对象,后续使用其完成订阅及退订的动作
  subscriber.getData().then((data) => {
  	console.info("==========================>getDataPromise=======================>");
      console.info("==========================>data:=======================>", data);
  });
  ```

### setData(callback形式)

- 方法说明

  设置公共事件的结果数据(callback形式)

- 参数

  | 参数名   | 类型                 | 必填 | 描述                 |
  | -------- | -------------------- | ---- | -------------------- |
  | data     | string               | 是   | 公共事件的结果数据   |
  | callback | AsyncCallback\<void> | 是   | 表示被指定的回调方法 |

- 示例

  ```js
  var subscriber;	//用于保存创建成功的订阅者对象,后续使用其完成订阅及退订的动作
  //设置有序公共事件的结果数据回调
  function setDataCallback(err) {
      console.info("==========================>setDataCallback=======================>");
      console.info("==========================>err:=======================>", err.code);
  }
  subscriber.setData("publish_data_changed", setDataCallback);
  ```

### setData(Promise形式)

- 方法说明

  设置公共事件的结果数据(Promise形式)

- 参数

  | 参数名 | 类型   | 必填 | 描述               |
  | ------ | ------ | ---- | ------------------ |
  | data   | string | 是   | 公共事件的结果数据 |

- 示例

  ```js
  var subscriber;	//用于保存创建成功的订阅者对象,后续使用其完成订阅及退订的动作
  subscriber.setData("publish_data_changed").then(() => {
  	console.info("==========================>setDataPromise=======================>");
  });
  ```

### setCodeAndData(callback形式)

- 方法说明

  设置公共事件的结果代码和结果数据(callback形式)

- 参数

  | 参数名   | 类型                 | 必填 | 描述                 |
  | -------- | -------------------- | ---- | -------------------- |
  | code     | number               | 是   | 公共事件的结果代码   |
  | data     | string               | 是   | 公共事件的结果数据   |
  | callback | AsyncCallback\<void> | 是   | 表示被指定的回调方法 |

- 示例

  ```js
  var subscriber;	//用于保存创建成功的订阅者对象,后续使用其完成订阅及退订的动作
  //设置有序公共事件的结果数据回调
  function setCodeDataCallback(err) {
      console.info("==========================>setCodeDataCallback=======================>");
      console.info("==========================>err:=======================>", err.code);
  }
  subscriber.setCodeAndData(1, "publish_data_changed", setCodeDataCallback);
  ```

### setCodeAndData(Promise形式)

- 方法说明

  设置公共事件的结果代码和结果数据(Promise形式)

- 参数

  | 参数名 | 类型   | 必填 | 描述               |
  | ------ | ------ | ---- | ------------------ |
  | code   | number | 是   | 公共事件的结果代码 |
  | data   | string | 是   | 公共事件的结果数据 |

- 示例

  ```js
  var subscriber;	//用于保存创建成功的订阅者对象,后续使用其完成订阅及退订的动作
  subscriber.setCodeAndData(1, "publish_data_changed").then(() => {
  	console.info("==========================>setCodeAndData=======================>");
  });
  ```

### isOrderedCommonEvent(callback形式)

- 方法说明

  查询当前公共事件的是否为有序公共事件,返回true代表是有序公共事件,false代表不是有序公共事件(callback形式)

- 参数

  | 参数名   | 类型                    | 必填 | 描述                             |
  | -------- | ----------------------- | ---- | -------------------------------- |
  | callback | AsyncCallback\<boolean> | 是   | 当前公共事件的是否为有序公共事件 |

- 示例

  ```js
  var subscriber;	//用于保存创建成功的订阅者对象,后续使用其完成订阅及退订的动作
  //设置有序公共事件的结果数据回调
  function isOrderedCallback(err, data) {
      console.info("==========================>isOrderedCallback=======================>");
      console.info("==========================>err:=======================>", err.code);
      console.info("==========================>isOrdered:=======================>", data);
  }
  subscriber.isOrderedCommonEvent(isOrderedCallback);
  ```

### isOrderedCommonEvent(Promise形式)

- 方法说明

  查询当前公共事件的是否为有序公共事件,返回true代表是有序公共事件,false代表不是有序公共事件(Promise形式)

- 返回值

  | 类型              | 说明                             |
  | ----------------- | -------------------------------- |
  | Promise\<boolean> | 当前公共事件的是否为有序公共事件 |

- 示例

  ```js
  var subscriber;	//用于保存创建成功的订阅者对象,后续使用其完成订阅及退订的动作
  subscriber.isOrderedCommonEvent().then((data) => {
  	console.info("==========================>isOrdered:=======================>", data);
  });
  ```

### abortCommonEvent(callback形式)

- 方法说明

  取消当前的公共事件,仅对有序公共事件有效,取消后,公共事件不再向下一个订阅者传递(callback形式)

- 参数

  | 参数名   | 类型                    | 必填 | 描述               |
  | -------- | ----------------------- | ---- | ------------------ |
  | callback | AsyncCallback\<boolean> | 是   | 取消当前的公共事件 |

- 示例

  ```js
  var subscriber;	//用于保存创建成功的订阅者对象,后续使用其完成订阅及退订的动作
  //设置有序公共事件的结果数据回调
  function abortCallback(err) {
      console.info("==========================>abortCallback=======================>");
   	console.info("==========================>err:=======================>", err.code);
  }
  subscriber.abortCommonEvent(abortCallback);
  ```

### abortCommonEvent(Promise形式)

- 方法说明

  取消当前的公共事件,仅对有序公共事件有效,取消后,公共事件不再向下一个订阅者传递(Promise形式)

- 示例

  ```js
  var subscriber;	//用于保存创建成功的订阅者对象,后续使用其完成订阅及退订的动作
  subscriber.abortCommonEvent().then(() => {
  	console.info("==========================>abortCommonEvent:=======================>");
  });
  ```

### clearAbortCommonEvent(callback形式)

- 方法说明

  取消当前的公共事件,仅对有序公共事件有效,取消后,公共事件不再向下一个订阅者传递(callback形式)

- 参数

  | 参数名   | 类型                 | 必填 | 描述                 |
  | -------- | -------------------- | ---- | -------------------- |
  | callback | AsyncCallback\<void> | 是   | 表示被指定的回调方法 |

- 示例

  ```js
  var subscriber;	//用于保存创建成功的订阅者对象,后续使用其完成订阅及退订的动作
  //设置有序公共事件的结果数据回调
  function clearAbortCallback(err) {
      console.info("==========================>clearAbortCallback=======================>");
   	console.info("==========================>err:=======================>", err.code);
  }
  subscriber.clearAbortCommonEvent(clearAbortCallback);
  ```

### clearAbortCommonEvent(Promise形式)

- 方法说明

  取消当前的公共事件,仅对有序公共事件有效,取消后,公共事件不再向下一个订阅者传递(Promise形式)

- 示例

  ```js
  var subscriber;	//用于保存创建成功的订阅者对象,后续使用其完成订阅及退订的动作
  subscriber.clearAbortCommonEvent().then(() => {
  	console.info("==========================>clearAbortCommonEvent:=======================>");
  });
  ```

### getAbortCommonEvent(callback形式)

- 方法说明

  获取当前有序公共事件是否取消的状态(callback形式)

- 参数

  | 参数名   | 类型                    | 必填 | 描述                               |
  | -------- | ----------------------- | ---- | ---------------------------------- |
  | callback | AsyncCallback\<boolean> | 是   | 表示当前有序公共事件是否取消的状态 |

- 示例

  ```js
  var subscriber;	//用于保存创建成功的订阅者对象,后续使用其完成订阅及退订的动作
  //设置有序公共事件的结果数据回调
  function getAbortCallback(err, data) {
      console.info("==========================>getAbortCallback=======================>");
   	console.info("==========================>err:=======================>", err.code);
      console.info("==========================>abort:=======================>", data);
  }
  subscriber.getAbortCommonEvent(getAbortCallback);
  ```

### getAbortCommonEvent(Promise形式)

- 方法说明

  获取当前有序公共事件是否取消的状态(Promise形式)

- 返回值

  | 类型              | 说明                               |
  | ----------------- | ---------------------------------- |
  | Promise\<boolean> | 表示当前有序公共事件是否取消的状态 |

- 示例

  ```js
  var subscriber;	//用于保存创建成功的订阅者对象,后续使用其完成订阅及退订的动作
  subscriber.getAbortCommonEvent().then((data) => {
  	console.info("==========================>getAbortCommonEvent:=======================>");
      console.info("==========================>abort:=======================>", data);
  });
  ```

### getSubscribeInfo(callback形式)

- 方法说明

  获取订阅者的订阅信息(callback形式)

- 参数

  | 参数名   | 类型                                     | 必填 | 描述                 |
  | -------- | ---------------------------------------- | ---- | -------------------- |
  | callback | AsyncCallback\<CommonEventSubscribeInfo> | 是   | 表示订阅者的订阅信息 |

- 示例

  ```js
  var subscriber;	//用于保存创建成功的订阅者对象,后续使用其完成订阅及退订的动作
  //设置有序公共事件的结果数据回调
  function getSubscribeInfoCallback(err, data) {
      console.info("==========================>getSubscribeInfoCallback=======================>");
   	console.info("==========================>err:=======================>", err.code);
      console.info("==========================>priority:=======================>", data.priority);
  }
  subscriber.getSubscribeInfo(getSubscribeInfoCallback);
  ```

### getSubscribeInfo(Promise形式)

- 方法说明

  获取订阅者的订阅信息(Promise形式)

- 返回值

  | 类型                               | 说明                 |
  | ---------------------------------- | -------------------- |
  | Promise\<CommonEventSubscribeInfo> | 表示订阅者的订阅信息 |

- 示例

  ```js
  var subscriber;	//用于保存创建成功的订阅者对象,后续使用其完成订阅及退订的动作
  subscriber.getSubscribeInfo().then((data) => {
  	console.info("==========================>getSubscribeInfo:=======================>");
      console.info("==========================>priority:=======================>", data.priority);
  });
  ```