diff --git a/zh-cn/application-dev/reference/apis/commonEvent-definitions.md b/zh-cn/application-dev/reference/apis/commonEvent-definitions.md index 89074cb4ba3524edcea665c2e393be7a94e67304..6de84fd8a843d2506b05d6df87dfc242d4c3190c 100644 --- a/zh-cn/application-dev/reference/apis/commonEvent-definitions.md +++ b/zh-cn/application-dev/reference/apis/commonEvent-definitions.md @@ -11,12 +11,12 @@ - 订阅者所需权限：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 - 订阅者所需权限：无 @@ -66,7 +66,7 @@ ## COMMON_EVENT_USER_PRESENT -（预留事件能力，暂未支持）提示用户解锁了设备。 +（预留事件，暂未支持）提示用户解锁了设备。 - 值：usual.event.USER_PRESENT - 订阅者所需权限：无 @@ -84,7 +84,7 @@ ## COMMON_EVENT_DATE_CHANGED -（预留事件能力，暂未支持）提示系统日期已更改。 +（预留事件，暂未支持）提示系统日期已更改。 - 值：usual.event.DATE_CHANGED - 订阅者所需权限：无 @@ -96,7 +96,7 @@ ## COMMON_EVENT_CLOSE_SYSTEM_DIALOGS -（预留事件能力，暂未支持）提示用户关闭临时系统对话框。 +（预留事件，暂未支持）提示用户关闭临时系统对话框。 - 值：usual.event.CLOSE_SYSTEM_DIALOGS - 订阅者所需权限：无 @@ -108,13 +108,13 @@ ## COMMON_EVENT_PACKAGE_REPLACED -（预留事件能力，暂未支持）提示设备上已安装的旧版本应用程序已被新版本所替换。 +（预留事件，暂未支持）提示设备上已安装的旧版本应用程序已被新版本所替换。 - 值：usual.event.PACKAGE_REPLACED - 订阅者所需权限：无 ## COMMON_EVENT_MY_PACKAGE_REPLACED -（预留事件能力，暂未支持）提示应用程序包的新版本已取代前一个版本。 +（预留事件，暂未支持）提示应用程序包的新版本已取代前一个版本。 - 值：usual.event.MY_PACKAGE_REPLACED - 订阅者所需权限：无 @@ -125,13 +125,13 @@ ## COMMON_EVENT_BUNDLE_REMOVED -（预留事件能力，暂未支持）提示已从设备中卸载已安装应用程序的附加包，但应用程序数据得到保留。 +（预留事件，暂未支持）提示已从设备中卸载已安装应用程序的附加包，但应用程序数据得到保留。 - 值：usual.event.BUNDLE_REMOVED - 订阅者所需权限：无 ## COMMON_EVENT_PACKAGE_FULLY_REMOVED -（预留事件能力，暂未支持）提示已从设备中完全卸载已安装的应用程序（包括应用程序数据和代码）。 +（预留事件，暂未支持）提示已从设备中完全卸载已安装的应用程序（包括应用程序数据和代码）。 - 值：usual.event.PACKAGE_FULLY_REMOVED - 订阅者所需权限：无 @@ -161,13 +161,13 @@ ## COMMON_EVENT_PACKAGES_SUSPENDED -（预留事件能力，暂未支持）提示应用程序已挂起。 +（预留事件，暂未支持）提示应用程序已挂起。 - 值：usual.event.PACKAGES_SUSPENDED - 订阅者所需权限：无 ## COMMON_EVENT_PACKAGES_UNSUSPENDED -（预留事件能力，暂未支持）提示应用HAP包未挂起（从挂起状态恢复）。 +（预留事件，暂未支持）提示应用HAP包未挂起（从挂起状态恢复）。 - 值：usual.event.PACKAGES_UNSUSPENDED - 订阅者所需权限：无 @@ -185,91 +185,91 @@ ## COMMON_EVENT_UID_REMOVED -（预留事件能力，暂未支持）提示用户ID已从系统中删除。 +（预留事件，暂未支持）提示用户ID已从系统中删除。 - 值：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 -（预留事件能力，暂未支持）提示系统处于HOME模式。 +（预留事件，暂未支持）提示系统处于HOME模式。 - 值：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 - 订阅者所需权限：无 @@ -281,25 +281,25 @@ ## COMMON_EVENT_USER_STARTING -（预留事件能力，暂未支持）提示用户正在启动。 +（预留事件，暂未支持）提示用户正在启动。 - 值：usual.event.USER_STARTING - 订阅者所需权限：ohos.permission.INTERACT_ACROSS_LOCAL_ACCOUNTS ## COMMON_EVENT_USER_UNLOCKED -（预留事件能力，暂未支持）在重启后解锁时，提示当前用户的凭据加密存储已解锁。 +（预留事件，暂未支持）在重启后解锁时，提示当前用户的凭据加密存储已解锁。 - 值：usual.event.USER_UNLOCKED - 订阅者所需权限：无 ## COMMON_EVENT_USER_STOPPING -（预留事件能力，暂未支持）提示要停止用户。 +（预留事件，暂未支持）提示要停止用户。 - 值：usual.event.USER_STOPPING - 订阅者所需权限：ohos.permission.INTERACT_ACROSS_LOCAL_ACCOUNTS ## COMMON_EVENT_USER_STOPPED -（预留事件能力，暂未支持）提示用户已停止。 +（预留事件，暂未支持）提示用户已停止。 - 值：usual.event.USER_STOPPED - 订阅者所需权限：无 @@ -389,241 +389,241 @@ ## 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 -（预留事件能力，暂未支持）提示蓝牙A2DP连接状态已更改。 +（预留事件，暂未支持）提示蓝牙A2DP连接状态已更改。 - 值：usual.event.bluetooth.handsfree.ag.AUDIO_STATE_UPDATE - 订阅者所需权限：ohos.permission.USE_BLUETOOTH ## COMMON_EVENT_BLUETOOTH_A2DPSOURCE_CONNECT_STATE_UPDATE -（预留事件能力，暂未支持）提示蓝牙A2DP连接状态。 +（预留事件，暂未支持）提示蓝牙A2DP连接状态。 - 值：usual.event.bluetooth.a2dpsource.CONNECT_STATE_UPDATE - 订阅者所需权限：ohos.permission.USE_BLUETOOTH ## COMMON_EVENT_BLUETOOTH_A2DPSOURCE_CURRENT_DEVICE_UPDATE -（预留事件能力，暂未支持）提示使用蓝牙A2DP连接的设备处于活动状态。 +（预留事件，暂未支持）提示使用蓝牙A2DP连接的设备处于活动状态。 - 值：usual.event.bluetooth.a2dpsource.CURRENT_DEVICE_UPDATE - 订阅者所需权限：ohos.permission.USE_BLUETOOTH ## COMMON_EVENT_BLUETOOTH_A2DPSOURCE_PLAYING_STATE_UPDATE -（预留事件能力，暂未支持）提示蓝牙A2DP播放状态发生改变。 +（预留事件，暂未支持）提示蓝牙A2DP播放状态发生改变。 - 值：usual.event.bluetooth.a2dpsource.PLAYING_STATE_UPDATE - 订阅者所需权限：ohos.permission.USE_BLUETOOTH ## COMMON_EVENT_BLUETOOTH_A2DPSOURCE_AVRCP_CONNECT_STATE_UPDATE -（预留事件能力，暂未支持）提示蓝牙A2DP的AVRCP连接状态已更改。 +（预留事件，暂未支持）提示蓝牙A2DP的AVRCP连接状态已更改。 - 值：usual.event.bluetooth.a2dpsource.AVRCP_CONNECT_STATE_UPDATE - 订阅者所需权限：ohos.permission.USE_BLUETOOTH ## COMMON_EVENT_BLUETOOTH_A2DPSOURCE_CODEC_VALUE_UPDATE -（预留事件能力，暂未支持）提示蓝牙A2DP音频编解码状态更改。 +（预留事件，暂未支持）提示蓝牙A2DP音频编解码状态更改。 - 值：usual.event.bluetooth.a2dpsource.CODEC_VALUE_UPDATE - 订阅者所需权限：ohos.permission.USE_BLUETOOTH ## COMMON_EVENT_BLUETOOTH_REMOTEDEVICE_DISCOVERED -（预留事件能力，暂未支持）提示发现远程蓝牙设备。 +（预留事件，暂未支持）提示发现远程蓝牙设备。 - 值：usual.event.bluetooth.remotedevice.DISCOVERED - 订阅者所需权限：ohos.permission.LOCATION and ohos.permission.USE_BLUETOOTH ## COMMON_EVENT_BLUETOOTH_REMOTEDEVICE_CLASS_VALUE_UPDATE -（预留事件能力，暂未支持）提示远程蓝牙设备的蓝牙类别已更改。 +（预留事件，暂未支持）提示远程蓝牙设备的蓝牙类别已更改。 - 值：usual.event.bluetooth.remotedevice.CLASS_VALUE_UPDATE - 订阅者所需权限：ohos.permission.USE_BLUETOOTH ## COMMON_EVENT_BLUETOOTH_REMOTEDEVICE_ACL_CONNECTED -（预留事件能力，暂未支持）提示已与远程蓝牙设备建立低级别（ACL）连接。 +（预留事件，暂未支持）提示已与远程蓝牙设备建立低级别（ACL）连接。 - 值：usual.event.bluetooth.remotedevice.ACL_CONNECTED - 订阅者所需权限：ohos.permission.USE_BLUETOOTH ## COMMON_EVENT_BLUETOOTH_REMOTEDEVICE_ACL_DISCONNECTED -（预留事件能力，暂未支持）提示低级别（ACL）连接已从远程蓝牙设备断开。 +（预留事件，暂未支持）提示低级别（ACL）连接已从远程蓝牙设备断开。 - 值：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 -（预留事件能力，暂未支持）提示远程蓝牙设备SDP状态。 +（预留事件，暂未支持）提示远程蓝牙设备SDP状态。 - 值：usual.event.bluetooth.remotedevice.SDP_RESULT - 订阅者所需权限：无 ## COMMON_EVENT_BLUETOOTH_REMOTEDEVICE_UUID_VALUE -（预留事件能力，暂未支持）提示远程蓝牙设备UUID连接状态。 +（预留事件，暂未支持）提示远程蓝牙设备UUID连接状态。 - 值：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 - 订阅者所需权限：ohos.permission.USE_BLUETOOTH ## 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 -（预留事件能力，暂未支持）提示蓝牙A2DP宿的连接状态已更改。 +（预留事件，暂未支持）提示蓝牙A2DP宿的连接状态已更改。 - 值：usual.event.bluetooth.a2dpsink.CONNECT_STATE_UPDATE - 订阅者所需权限：ohos.permission.USE_BLUETOOTH ## COMMON_EVENT_BLUETOOTH_A2DPSINK_PLAYING_STATE_UPDATE -（预留事件能力，暂未支持）提示蓝牙A2DP宿的播放状态发生改变。 +（预留事件，暂未支持）提示蓝牙A2DP宿的播放状态发生改变。 - 值：usual.event.bluetooth.a2dpsink.PLAYING_STATE_UPDATE - 订阅者所需权限：ohos.permission.USE_BLUETOOTH ## COMMON_EVENT_BLUETOOTH_A2DPSINK_AUDIO_STATE_UPDATE -（预留事件能力，暂未支持）提示蓝牙A2DP宿的音频状态已更改。 +（预留事件，暂未支持）提示蓝牙A2DP宿的音频状态已更改。 - 值：usual.event.bluetooth.a2dpsink.AUDIO_STATE_UPDATE - 订阅者所需权限：ohos.permission.USE_BLUETOOTH ## COMMON_EVENT_NFC_ACTION_ADAPTER_STATE_CHANGED -（预留事件能力，暂未支持）提示设备NFC适配器状态已更改。 +（预留事件，暂未支持）提示设备NFC适配器状态已更改。 - 值：usual.event.nfc.action.ADAPTER_STATE_CHANGED - 订阅者所需权限：无 ## COMMON_EVENT_NFC_ACTION_RF_FIELD_ON_DETECTED -（预留事件能力，暂未支持）提示检测到NFC设备RF字段处于使能状态。 +（预留事件，暂未支持）提示检测到NFC设备RF字段处于使能状态。 - 值：usual.event.nfc.action.RF_FIELD_ON_DETECTED - 订阅者所需权限：ohos.permission.MANAGE_SECURE_SETTINGS ## COMMON_EVENT_NFC_ACTION_RF_FIELD_OFF_DETECTED -（预留事件能力，暂未支持）提示检测到NFC设备RF字段处于关闭状态。 +（预留事件，暂未支持）提示检测到NFC设备RF字段处于关闭状态。 - 值：usual.event.nfc.action.RF_FIELD_OFF_DETECTED - 订阅者所需权限：ohos.permission.MANAGE_SECURE_SETTINGS @@ -641,7 +641,7 @@ ## COMMON_EVENT_DEVICE_IDLE_MODE_CHANGED -（预留事件能力，暂未支持）提示系统空闲模式已更改。 +（预留事件，暂未支持）提示系统空闲模式已更改。 - 值：usual.event.DEVICE_IDLE_MODE_CHANGED - 订阅者所需权限：无 @@ -665,91 +665,91 @@ ## COMMON_EVENT_ABILITY_ADDED -（预留事件能力，暂未支持）提示有某个能力已被添加。 +（预留事件，暂未支持）提示有某个能力已被添加。 - 值：usual.event.ABILITY_ADDED - 订阅者所需权限：ohos.permission.LISTEN_BUNDLE_CHANGE ## COMMON_EVENT_ABILITY_REMOVED -（预留事件能力，暂未支持）提示已删除某个能力。 +（预留事件，暂未支持）提示已删除某个能力。 - 值：usual.event.ABILITY_REMOVED - 订阅者所需权限：ohos.permission.LISTEN_BUNDLE_CHANGE ## COMMON_EVENT_ABILITY_UPDATED -（预留事件能力，暂未支持）提示能力已更新。 +（预留事件，暂未支持）提示能力已更新。 - 值：usual.event.ABILITY_UPDATED - 订阅者所需权限：ohos.permission.LISTEN_BUNDLE_CHANGE ## COMMON_EVENT_LOCATION_MODE_STATE_CHANGED -（预留事件能力，暂未支持）提示系统定位模式已更改。 +（预留事件，暂未支持）提示系统定位模式已更改。 - 值：usual.event.location.MODE_STATE_CHANGED - 订阅者所需权限：无 ## COMMON_EVENT_IVI_SLEEP -（预留事件能力，暂未支持）提示车辆的车载信息娱乐（IVI）系统正在休眠。 +（预留事件，暂未支持）提示车辆的车载信息娱乐（IVI）系统正在休眠。 - 值：common.event.IVI_SLEEP - 订阅者所需权限：无 ## COMMON_EVENT_IVI_PAUSE -（预留事件能力，暂未支持）提示车辆的车载信息娱乐（IVI）系统已休眠，并通知应用程序停止播放。 +（预留事件，暂未支持）提示车辆的车载信息娱乐（IVI）系统已休眠，并通知应用程序停止播放。 - 值：common.event.IVI_PAUSE - 订阅者所需权限：无 ## COMMON_EVENT_IVI_STANDBY -（预留事件能力，暂未支持）提示车辆的车载信息娱乐（IVI）系统中的第三方应用暂停当前工作。 +（预留事件，暂未支持）提示车辆的车载信息娱乐（IVI）系统中的第三方应用暂停当前工作。 - 值：common.event.IVI_STANDBY - 订阅者所需权限：无 ## COMMON_EVENT_IVI_LASTMODE_SAVE -（预留事件能力，暂未支持）提示车辆的车载信息娱乐（IVI）系统中的第三方应用保存其最后一个模式。 +（预留事件，暂未支持）提示车辆的车载信息娱乐（IVI）系统中的第三方应用保存其最后一个模式。 - 值：common.event.IVI_LASTMODE_SAVE - 订阅者所需权限：无 ## COMMON_EVENT_IVI_VOLTAGE_ABNORMAL -（预留事件能力，暂未支持）提示车辆电源系统电压异常。 +（预留事件，暂未支持）提示车辆电源系统电压异常。 - 值：common.event.IVI_VOLTAGE_ABNORMAL - 订阅者所需权限：无 ## COMMON_EVENT_IVI_HIGH_TEMPERATURE -（预留事件能力，暂未支持）提示车辆的车载信息娱乐（IVI）系统温度过高。 +（预留事件，暂未支持）提示车辆的车载信息娱乐（IVI）系统温度过高。 - 值：common.event.IVI_HIGH_TEMPERATURE - 订阅者所需权限：无 ## COMMON_EVENT_IVI_EXTREME_TEMPERATURE -（预留事件能力，暂未支持）提示车辆的车载信息娱乐（IVI）系统温度极高。 +（预留事件，暂未支持）提示车辆的车载信息娱乐（IVI）系统温度极高。 - 值：common.event.IVI_EXTREME_TEMPERATURE - 订阅者所需权限：无 ## COMMON_EVENT_IVI_TEMPERATURE_ABNORMAL -（预留事件能力，暂未支持）提示车辆的车载信息娱乐（IVI）系统具有极端温度。 +（预留事件，暂未支持）提示车辆的车载信息娱乐（IVI）系统具有极端温度。 - 值：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 - 订阅者所需权限：无 @@ -779,49 +779,49 @@ ## COMMON_EVENT_USB_ACCESSORY_ATTACHED -（预留事件能力，暂未支持）提示已连接USB附件。 +（预留事件，暂未支持）提示已连接USB附件。 - 值：usual.event.hardware.usb.action.USB_ACCESSORY_ATTACHED - 订阅者所需权限：无 ## COMMON_EVENT_USB_ACCESSORY_DETACHED -（预留事件能力，暂未支持）提示USB附件被卸载。 +（预留事件，暂未支持）提示USB附件被卸载。 - 值：usual.event.hardware.usb.action.USB_ACCESSORY_DETACHED - 订阅者所需权限：无 ## COMMON_EVENT_DISK_REMOVED -（预留事件能力，暂未支持）提示外部存储设备状态变更为移除。 +（预留事件，暂未支持）提示外部存储设备状态变更为移除。 - 值：usual.event.data.DISK_REMOVED - 订阅者所需权限：ohos.permission.STORAGE_MANAGER ## COMMON_EVENT_DISK_UNMOUNTED -（预留事件能力，暂未支持）提示外部存储设备状态变更为卸载。 +（预留事件，暂未支持）提示外部存储设备状态变更为卸载。 - 值：usual.event.data.DISK_UNMOUNTED - 订阅者所需权限：ohos.permission.STORAGE_MANAGER ## COMMON_EVENT_DISK_MOUNTED -（预留事件能力，暂未支持）提示外部存储设备状态变更为挂载。 +（预留事件，暂未支持）提示外部存储设备状态变更为挂载。 - 值：usual.event.data.DISK_MOUNTED - 订阅者所需权限：ohos.permission.STORAGE_MANAGER ## COMMON_EVENT_DISK_BAD_REMOVAL -（预留事件能力，暂未支持）提示外部存储设备在挂载状态下被移除。 +（预留事件，暂未支持）提示外部存储设备在挂载状态下被移除。 - 值：usual.event.data.DISK_BAD_REMOVAL - 订阅者所需权限：ohos.permission.STORAGE_MANAGER ## COMMON_EVENT_DISK_UNMOUNTABLE -（预留事件能力，暂未支持）提示外部存储设备在插卡情况下无法挂载。 +（预留事件，暂未支持）提示外部存储设备在插卡情况下无法挂载。 - 值：usual.event.data.DISK_UNMOUNTABLE - 订阅者所需权限：ohos.permission.STORAGE_MANAGER ## COMMON_EVENT_DISK_EJECT -（预留事件能力，暂未支持）提示用户已作出弹出外部存储介质的操作（系统软件层面的交互操作，非直接物理弹出）。 +（预留事件，暂未支持）提示用户已作出弹出外部存储介质的操作（系统软件层面的交互操作，非直接物理弹出）。 - 值：usual.event.data.DISK_EJECT - 订阅者所需权限：ohos.permission.STORAGE_MANAGER @@ -857,19 +857,19 @@ ## 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 -（预留事件能力，暂未支持）提示foundation已准备好。 +（预留事件，暂未支持）提示foundation已准备好。 - 值：usual.event.data.FOUNDATION_READY - 订阅者所需权限：ohos.permission.RECEIVER_STARTUP_COMPLETED diff --git a/zh-cn/application-dev/reference/apis/commonEventManager-definitions.md b/zh-cn/application-dev/reference/apis/commonEventManager-definitions.md new file mode 100644 index 0000000000000000000000000000000000000000..c0746868293d557d45f0978773954db4a3cda0bf --- /dev/null +++ b/zh-cn/application-dev/reference/apis/commonEventManager-definitions.md @@ -0,0 +1,781 @@ +# 系统公共事件定义 + +本文档提供OpenHarmony系统所定义的公共事件类型的索引。 +公共事件类型定义在[ohos.commonEvent模块的Support枚举](./js-apis-commonEventManager.md#support)中。 + +**系统能力：** SystemCapability.Notification.CommonEvent + +## 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_THERMAL_LEVEL_CHANGED +表示设备热状态的公共事件的动作。 +- 值： usual.event.THERMAL_LEVEL_CHANGED +- 订阅者所需权限： 无 + +## 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_BUNDLE_REMOVED +（预留事件，暂未支持）表示已从设备中卸载已安装的捆绑包，但应用程序数据仍保留的公共事件的操作。 +- 值： usual.event.BUNDLE_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_PACKAGE_CACHE_CLEARED9+ +用户清除应用包缓存数据的公共事件的动作。 +- 值： usual.event.PACKAGE_CACHE_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 +（预留事件，暂未支持）表示用户ID已从系统中删除的公共事件的动作。 +- 值： 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 +（预留事件，暂未支持）表示系统处于HOME模式的公共事件的动作。 +- 值： 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_LOCAL_ACCOUNTS + +## COMMON_EVENT_USER_STARTING +（预留事件，暂未支持）表示要启动用户的公共事件的动作。 +- 值： usual.event.USER_STARTING +- 订阅者所需权限： ohos.permission.INTERACT_ACROSS_LOCAL_ACCOUNTS + +## COMMON_EVENT_USER_UNLOCKED +（预留事件，暂未支持）设备重启后解锁时，当前用户的凭据加密存储已解锁的公共事件的动作。 +- 值： usual.event.USER_UNLOCKED +- 订阅者所需权限： 无 + +## COMMON_EVENT_USER_STOPPING +（预留事件，暂未支持）表示要停止用户的公共事件的动作。 +- 值： usual.event.USER_STOPPING +- 订阅者所需权限： ohos.permission.INTERACT_ACROSS_LOCAL_ACCOUNTS + +## COMMON_EVENT_USER_STOPPED +（预留事件，暂未支持）表示用户已停止的公共事件的动作。 +- 值： usual.event.USER_STOPPED +- 订阅者所需权限： 无 + +## COMMON_EVENT_DISTRIBUTED_ACCOUNT_LOGIN +（预留事件，暂未支持）表示分布式账号登录成功的动作。 +- 值： usual.event.DISTRIBUTED_ACCOUNT_LOGIN +- 订阅者所需权限： 无 + +## COMMON_EVENT_DISTRIBUTED_ACCOUNT_LOGOUT +（预留事件，暂未支持）表示分布式账号登出成功的动作。 +- 值： usual.event.DISTRIBUTED_ACCOUNT_LOGOUT +- 订阅者所需权限： 无 + +## COMMON_EVENT_DISTRIBUTED_ACCOUNT_TOKEN_INVALID +（预留事件，暂未支持）表示分布式账号token令牌无效的动作。 +- 值： usual.event.DISTRIBUTED_ACCOUNT_TOKEN_INVALID +- 订阅者所需权限： 无 + +## COMMON_EVENT_DISTRIBUTED_ACCOUNT_LOGOFF +（预留事件，暂未支持）表示分布式账号注销的动作。 +- 值： usual.event.DISTRIBUTED_ACCOUNT_LOGOFF +- 订阅者所需权限： 无 + +## COMMON_EVENT_WIFI_POWER_STATE +Wi-Fi状态公共事件的动作，如启用和禁用。 +- 值： usual.event.wifi.POWER_STATE +- 订阅者所需权限： 无 + +## COMMON_EVENT_WIFI_SCAN_FINISHED +表示Wi-Fi接入点已被扫描并证明可用的公共事件的操作。 +- 值： usual.event.wifi.SCAN_FINISHED +- 订阅者所需权限： ohos.permission.LOCATION + +## COMMON_EVENT_WIFI_RSSI_VALUE +表示Wi-Fi信号强度（RSSI）改变的公共事件的动作。 +- 值： usual.event.wifi.RSSI_VALUE +- 订阅者所需权限： ohos.permission.GET_WIFI_INFO + +## COMMON_EVENT_WIFI_CONN_STATE +Wi-Fi连接状态发生改变的公共事件的动作 +- 值： usual.event.wifi.CONN_STATE +- 订阅者所需权限： 无 + +## COMMON_EVENT_WIFI_HOTSPOT_STATE +Wi-Fi热点状态的公共事件的动作，如启用或禁用。 +- 值： usual.event.wifi.HOTSPOT_STATE +- 订阅者所需权限： 无 + +## COMMON_EVENT_WIFI_AP_STA_JOIN +客户端加入当前设备Wi-Fi热点的普通事件的动作。 +- 值： usual.event.wifi.WIFI_HS_STA_JOIN +- 订阅者所需权限： ohos.permission.GET_WIFI_INFO + +## COMMON_EVENT_WIFI_AP_STA_LEAVE +客户端已断开与当前设备Wi-Fi热点的连接的公共事件的动作。 +- 值： usual.event.wifi.WIFI_HS_STA_LEAVE +- 订阅者所需权限： ohos.permission.GET_WIFI_INFO + +## COMMON_EVENT_WIFI_MPLINK_STATE_CHANGE +表示MPLink（增强Wi-Fi功能）状态已更改的公共事件的动作。 +- 值： usual.event.wifi.mplink.STATE_CHANGE +- 订阅者所需权限： ohos.permission.MPLINK_CHANGE_STATE + +## COMMON_EVENT_WIFI_P2P_CONN_STATE + Wi-Fi P2P连接状态改变的公共事件的动作。 +- 值： usual.event.wifi.p2p.CONN_STATE_CHANGE +- 订阅者所需权限： ohos.permission.GET_WIFI_INFO和ohos.permission.LOCATION + +## COMMON_EVENT_WIFI_P2P_STATE_CHANGED +Wi-Fi P2P状态公共事件的动作，如启用和禁用。 +- 值： usual.event.wifi.p2p.STATE_CHANGE +- 订阅者所需权限： ohos.permission.GET_WIFI_INFO + +## COMMON_EVENT_WIFI_P2P_PEERS_STATE_CHANGED +Wi-Fi P2P对等体状态变化。 +- 值： usual.event.wifi.p2p.DEVICES_CHANGE +- 订阅者所需权限： ohos.permission.GET_WIFI_INFO + +## COMMON_EVENT_WIFI_P2P_PEERS_DISCOVERY_STATE_CHANGED +Wi-Fi P2P发现状态变化。 +- 值： usual.event.wifi.p2p.PEER_DISCOVERY_STATE_CHANGE +- 订阅者所需权限： ohos.permission.GET_WIFI_INFO + +## COMMON_EVENT_WIFI_P2P_CURRENT_DEVICE_STATE_CHANGED +Wi-Fi P2P当前设备状态变化。 +- 值： usual.event.wifi.p2p.CURRENT_DEVICE_CHANGE +- 订阅者所需权限： ohos.permission.GET_WIFI_INFO + +## COMMON_EVENT_WIFI_P2P_GROUP_STATE_CHANGED +Wi-Fi P2P群组信息已更改。 +- 值： 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 +（预留事件，暂未支持）表示蓝牙A2DP连接状态已更改的公共事件的动作。 +- 值： usual.event.bluetooth.handsfree.ag.AUDIO_STATE_UPDATE +- 订阅者所需权限： ohos.permission.USE_BLUETOOTH + +## COMMON_EVENT_BLUETOOTH_A2DPSOURCE_CONNECT_STATE_UPDATE +（预留事件，暂未支持）蓝牙A2DP连接状态公共事件的动作。 +- 值： usual.event.bluetooth.a2dpsource.CONNECT_STATE_UPDATE +- 订阅者所需权限： ohos.permission.USE_BLUETOOTH + +## COMMON_EVENT_BLUETOOTH_A2DPSOURCE_CURRENT_DEVICE_UPDATE +（预留事件，暂未支持）表示使用蓝牙A2DP连接的设备处于活动状态的公共事件的动作。 +- 值： usual.event.bluetooth.a2dpsource.CURRENT_DEVICE_UPDATE +- 订阅者所需权限： ohos.permission.USE_BLUETOOTH + +## COMMON_EVENT_BLUETOOTH_A2DPSOURCE_PLAYING_STATE_UPDATE +（预留事件，暂未支持）蓝牙A2DP播放状态改变的普通事件的动作。 +- 值： usual.event.bluetooth.a2dpsource.PLAYING_STATE_UPDATE +- 订阅者所需权限： ohos.permission.USE_BLUETOOTH + +## COMMON_EVENT_BLUETOOTH_A2DPSOURCE_AVRCP_CONNECT_STATE_UPDATE +（预留事件，暂未支持）表示蓝牙A2DP的AVRCP连接状态已更改的公共事件的动作。 +- 值： usual.event.bluetooth.a2dpsource.AVRCP_CONNECT_STATE_UPDATE +- 订阅者所需权限： ohos.permission.USE_BLUETOOTH + +## COMMON_EVENT_BLUETOOTH_A2DPSOURCE_CODEC_VALUE_UPDATE +（预留事件，暂未支持）表示蓝牙A2DP音频编解码状态更改的公共事件的动作。 +- 值： usual.event.bluetooth.a2dpsource.CODEC_VALUE_UPDATE +- 订阅者所需权限： ohos.permission.USE_BLUETOOTH + +## COMMON_EVENT_BLUETOOTH_REMOTEDEVICE_DISCOVERED +（预留事件，暂未支持）表示发现远程蓝牙设备的公共事件的动作。 +- 值： usual.event.bluetooth.remotedevice.DISCOVERED +- 订阅者所需权限： ohos.permission.LOCATION和ohos.permission.USE_BLUETOOTH + +## COMMON_EVENT_BLUETOOTH_REMOTEDEVICE_CLASS_VALUE_UPDATE +（预留事件，暂未支持）表示远程蓝牙设备的蓝牙类别已更改的公共事件的动作。 +- 值： usual.event.bluetooth.remotedevice.CLASS_VALUE_UPDATE +- 订阅者所需权限： ohos.permission.USE_BLUETOOTH + +## COMMON_EVENT_BLUETOOTH_REMOTEDEVICE_ACL_CONNECTED +（预留事件，暂未支持）表示已与远程蓝牙设备建立低级别（ACL）连接的公共事件的动作。 +- 值： usual.event.bluetooth.remotedevice.ACL_CONNECTED +- 订阅者所需权限： 无 + +## COMMON_EVENT_BLUETOOTH_REMOTEDEVICE_ACL_DISCONNECTED +（预留事件，暂未支持）表示低电平（ACL）连接已从远程蓝牙设备断开的普通事件的动作。 +- 值： 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 +（预留事件，暂未支持）远程蓝牙设备SDP状态公共事件的动作。 +- 值： usual.event.bluetooth.remotedevice.SDP_RESULT +- 订阅者所需权限： 无 + +## COMMON_EVENT_BLUETOOTH_REMOTEDEVICE_UUID_VALUE +（预留事件，暂未支持）远程蓝牙设备UUID连接状态公共事件的动作。 +- 值： 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 +- 订阅者所需权限： ohos.permission.USE_BLUETOOTH + +## 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 +（预留事件，暂未支持）表示蓝牙A2DP宿连接状态已更改的公共事件的动作。 +- 值： usual.event.bluetooth.a2dpsink.CONNECT_STATE_UPDATE +- 订阅者所需权限： ohos.permission.USE_BLUETOOTH + +## COMMON_EVENT_BLUETOOTH_A2DPSINK_PLAYING_STATE_UPDATE +（预留事件，暂未支持）蓝牙A2DP宿播放状态改变的普通事件的动作。 +- 值： usual.event.bluetooth.a2dpsink.PLAYING_STATE_UPDATE +- 订阅者所需权限： ohos.permission.USE_BLUETOOTH + +## COMMON_EVENT_BLUETOOTH_A2DPSINK_AUDIO_STATE_UPDATE +（预留事件，暂未支持）表示蓝牙A2DP宿的音频状态已更改的公共事件的动作。 +- 值： usual.event.bluetooth.a2dpsink.AUDIO_STATE_UPDATE +- 订阅者所需权限： ohos.permission.USE_BLUETOOTH + +## COMMON_EVENT_NFC_ACTION_ADAPTER_STATE_CHANGED +指示设备NFC适配器状态已更改的公共事件的操作。 +- 值： usual.event.nfc.action.ADAPTER_STATE_CHANGED +- 订阅者所需权限： 无 + +## COMMON_EVENT_NFC_ACTION_RF_FIELD_ON_DETECTED +（预留事件，暂未支持）检测到NFC RF字段处于使能状态的公共事件的动作。 +- 值： usual.event.nfc.action.RF_FIELD_ON_DETECTED +- 订阅者所需权限： ohos.permission.MANAGE_SECURE_SETTINGS + +## COMMON_EVENT_NFC_ACTION_RF_FIELD_OFF_DETECTED +（预留事件，暂未支持）检测到NFC RF字段处于关闭状态的公共事件的动作。 +- 值： 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_LOCAL_ACCOUNTS + +## COMMON_EVENT_USER_REMOVED +表示用户已从系统中删除的公共事件的动作。 +- 值： usual.event.USER_REMOVED +- 订阅者所需权限： ohos.permission.MANAGE_LOCAL_ACCOUNTS + +## COMMON_EVENT_ABILITY_ADDED +（预留事件，暂未支持）表示已添加能力的公共事件的动作。 +- 值： usual.event.ABILITY_ADDED +- 订阅者所需权限： ohos.permission.LISTEN_BUNDLE_CHANGE + +## COMMON_EVENT_ABILITY_REMOVED +（预留事件，暂未支持）表示已删除能力的公共事件的动作。 +- 值： usual.event.ABILITY_REMOVED +- 订阅者所需权限： ohos.permission.LISTEN_BUNDLE_CHANGE + +## COMMON_EVENT_ABILITY_UPDATED +（预留事件，暂未支持）表示能力已更新的公共事件的动作。 +- 值： usual.event.ABILITY_UPDATED +- 订阅者所需权限： ohos.permission.LISTEN_BUNDLE_CHANGE + +## COMMON_EVENT_LOCATION_MODE_STATE_CHANGED +（预留事件，暂未支持）表示系统定位模式已更改的公共事件的动作。 +- 值： usual.event.location.MODE_STATE_CHANGED +- 订阅者所需权限： 无 + +## COMMON_EVENT_IVI_SLEEP +（预留事件，暂未支持）表示表示车辆的车载信息娱乐（IVI）系统正在休眠的常见事件的动作。 +- 值： common.event.IVI_SLEEP +- 订阅者所需权限： 无 + +## COMMON_EVENT_IVI_PAUSE +（预留事件，暂未支持）表示IVI已休眠，并通知应用程序停止播放。 +- 值： 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 +（预留事件，暂未支持）表示IVI温度过高。 +- 值： common.event.IVI_HIGH_TEMPERATURE +- 订阅者所需权限： 无 + +## COMMON_EVENT_IVI_EXTREME_TEMPERATURE +（预留事件，暂未支持）表示IVI温度极高。 +- 值： 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_STATE9+ +表示USB设备状态发生变化的公共事件。 +- 值： usual.event.hardware.usb.action.USB_STATE +- 订阅者所需权限： 无 + +## COMMON_EVENT_USB_PORT_CHANGED9+ +表示用户设备的USB端口状态发生改变的公共事件。 +- 值： usual.event.hardware.usb.action.USB_PORT_CHANGED +- 订阅者所需权限： 无 + +## COMMON_EVENT_USB_DEVICE_ATTACHED +当用户设备作为USB主机时，USB设备已挂载的公共事件的动作。 +- 值： usual.event.hardware.usb.action.USB_DEVICE_ATTACHED +- 订阅者所需权限： 无 + +## COMMON_EVENT_USB_DEVICE_DETACHED +当用户设备作为USB主机时，USB设备被卸载的公共事件的动作。 +- 值： usual.event.hardware.usb.action.USB_DEVICE_DETACHED +- 订阅者所需权限： 无 + +## COMMON_EVENT_USB_ACCESSORY_ATTACHED +（预留事件，暂未支持）表示已连接USB附件的公共事件的动作。 +- 值： usual.event.hardware.usb.action.USB_ACCESSORY_ATTACHED +- 订阅者所需权限： 无 + +## COMMON_EVENT_USB_ACCESSORY_DETACHED +（预留事件，暂未支持）表示USB附件被卸载的公共事件的动作。 +- 值： usual.event.data.DISK_MOUNTED +- 订阅者所需权限： 无 + +## COMMON_EVENT_DISK_REMOVED +（预留事件，暂未支持）外部存储设备状态变更为移除时发送此公共事件。 +- 值： usual.event.data.DISK_BAD_REMOVAL +- 订阅者所需权限： ohos.permission.STORAGE_MANAGER + +## COMMON_EVENT_DISK_UNMOUNTED +（预留事件，暂未支持）部存储设备状态变更为卸载时发送此公共事件。 +- 值： usual.event.data.DISK_UNMOUNTABLE +- 订阅者所需权限： ohos.permission.STORAGE_MANAGER + +## COMMON_EVENT_DISK_MOUNTED +（预留事件，暂未支持）外部存储设备状态变更为挂载时发送此公共事件。 +- 值： usual.event.hardware.usb.action.USB_ACCESSORY_DETACHED +- 订阅者所需权限： ohos.permission.STORAGE_MANAGER + +## COMMON_EVENT_DISK_BAD_REMOVAL +（预留事件，暂未支持）外部存储设备状态变更为挂载状态下移除时发送此公共事件。 +- 值： usual.event.data.DISK_REMOVED +- 订阅者所需权限： ohos.permission.STORAGE_MANAGER + +## COMMON_EVENT_DISK_UNMOUNTABLE +（预留事件，暂未支持）外部存储设备状态变更为插卡情况下无法挂载时发送此公共事件。 +- 值： usual.event.data.DISK_UNMOUNTED +- 订阅者所需权限： ohos.permission.STORAGE_MANAGER + +## COMMON_EVENT_DISK_EJECT +（预留事件，暂未支持）用户已表示希望删除外部存储介质时发送此公共事件。 +- 值： usual.event.data.DISK_EJECT +- 订阅者所需权限： ohos.permission.STORAGE_MANAGER + +## COMMON_EVENT_VOLUME_REMOVED9+ +外部存储设备状态变更为移除时发送此公共事件。 +- 值： usual.event.data.VOLUME_REMOVED +- 订阅者所需权限： ohos.permission.STORAGE_MANAGER + +## COMMON_EVENT_VOLUME_UNMOUNTED9+ +外部存储设备状态变更为卸载时发送此公共事件。 +- 值： usual.event.data.VOLUME_UNMOUNTED +- 订阅者所需权限： ohos.permission.STORAGE_MANAGER + +## COMMON_EVENT_VOLUME_MOUNTED9+ +外部存储设备状态变更为挂载时发送此公共事件。 +- 值： usual.event.data.VOLUME_MOUNTED +- 订阅者所需权限： ohos.permission.STORAGE_MANAGER + +## COMMON_EVENT_VOLUME_BAD_REMOVAL9+ +外部存储设备状态变更为挂载状态下移除时发送此公共事件。 +- 值： usual.event.data.VOLUME_BAD_REMOVAL +- 订阅者所需权限： ohos.permission.STORAGE_MANAGER + +## COMMON_EVENT_VOLUME_EJECT9+ +用户已表示希望删除外部存储介质时发送此公共事件。 +- 值： usual.event.data.VOLUME_EJECT +- 订阅者所需权限： ohos.permission.STORAGE_MANAGER + +## 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 +（预留事件，暂未支持）表示foundation已准备好的公共事件的动作。 +- 值： usual.event.data.FOUNDATION_READY +- 订阅者所需权限： ohos.permission.RECEIVER_STARTUP_COMPLETED + +## COMMON_EVENT_AIRPLANE_MODE_CHANGED +表示设备飞行模式已更改的公共事件的动作。 +- 值： usual.event.AIRPLANE_MODE +- 订阅者所需权限： 无 + +## COMMON_EVENT_SPLIT_SCREEN +表示分屏的公共事件的动作。 +- 值： usual.event.SPLIT_SCREEN +- 订阅者所需权限： ohos.permission.RECEIVER_SPLIT_SCREEN + +## COMMON_EVENT_SLOT_CHANGE9+ +表示通知通道更新的动作。 +- 值： usual.event.SLOT_CHANGE +- 订阅者所需权限： ohos.permission.NOTIFICATION_CONTROLLER + +## COMMON_EVENT_SPN_INFO_CHANGED 9+ +表示spn显示信息已更新的公共事件的动作。 +- 值： usual.event.SPN_INFO_CHANGED +- 订阅者所需权限： 无 + +## COMMON_EVENT_QUICK_FIX_APPLY_RESULT 9+ +表示快速修复应用的动作。 +- 值： usual.event.QUICK_FIX_APPLY_RESULT +- 订阅者所需权限： 无 diff --git a/zh-cn/application-dev/reference/apis/js-apis-commonEvent.md b/zh-cn/application-dev/reference/apis/js-apis-commonEvent.md index c67c8d84cbe14286b9a0b0be57d90b20e5e9f782..75ae4a211bdd660231fc9818622098231d5328c4 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-commonEvent.md +++ b/zh-cn/application-dev/reference/apis/js-apis-commonEvent.md @@ -4,31 +4,30 @@ > **说明：** > - 从API Version 9开始，该接口不再维护，推荐使用新接口[@ohos.commonEventManager](js-apis-commonEventManager.md)。 +> > - 本模块首批接口从API version 7开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。 ## 导入模块 -```js +```ts import CommonEvent from '@ohos.commonEvent'; ``` ## Support -本枚举是CommonEvent模块所定义的公共事件类型枚举。名称为系统公共事件的宏；值为具体公共事件。 - -全部枚举定义请参见[系统公共事件定义](./commonEvent-definitions.md)。 - - -**系统能力：** SystemCapability.Notification.CommonEvent +系统公共事件是指由系统服务或系统应用发布的事件，订阅这些系统公共事件需要特定的权限。发布或订阅这些事件需要使用如下链接中的枚举定义。 +全部系统公共事件枚举定义请参见[系统公共事件定义](./commonEvent-definitions.md)。 ## CommonEvent.publish -publish(event: string, callback: AsyncCallback\): void +```ts +publish(event: string, callback: AsyncCallback): void +``` -发布公共事件（callback形式）。 +发布公共事件（回调形式）。 -**系统能力：** SystemCapability.Notification.CommonEvent +**系统能力：** `SystemCapability.Notification.CommonEvent` **参数：** @@ -39,7 +38,7 @@ publish(event: string, callback: AsyncCallback\): void **示例：** -```js +```ts //发布公共事件回调 function publishCallBack(err) { if (err.code) { @@ -53,15 +52,15 @@ function publishCallBack(err) { CommonEvent.publish("event", publishCallBack); ``` - - ## CommonEvent.publish -publish(event: string, options: CommonEventPublishData, callback: AsyncCallback\): void +```ts +publish(event: string, options: CommonEventPublishData, callback: AsyncCallback): void +``` -发布公共事件指定发布信息（callback形式）。 +以回调的形式发布公共事件。 -**系统能力：** SystemCapability.Notification.CommonEvent +**系统能力：** `SystemCapability.Notification.CommonEvent` **参数：** @@ -74,7 +73,7 @@ publish(event: string, options: CommonEventPublishData, callback: AsyncCallback\ **示例：** -```js +```ts //公共事件相关信息 let options = { code: 0, //公共事件的初始代码 @@ -95,15 +94,15 @@ function publishCallBack(err) { CommonEvent.publish("event", options, publishCallBack); ``` - - ## CommonEvent.publishAsUser8+ -publishAsUser(event: string, userId: number, callback: AsyncCallback\): void +```ts +publishAsUser(event: string, userId: number, callback: AsyncCallback): void +``` -向指定用户发布公共事件（callback形式）。 +以回调的形式向指定用户发布公共事件。 -**系统能力：** SystemCapability.Notification.CommonEvent +**系统能力：** `SystemCapability.Notification.CommonEvent` **系统API**：此接口为系统接口，三方应用不支持调用。 @@ -117,7 +116,7 @@ publishAsUser(event: string, userId: number, callback: AsyncCallback\): vo **示例：** -```js +```ts //发布公共事件回调 function publishAsUserCallBack(err) { if (err.code) { @@ -134,15 +133,15 @@ let userId = 100; CommonEvent.publishAsUser("event", userId, publishAsUserCallBack); ``` - - ## CommonEvent.publishAsUser8+ -publishAsUser(event: string, userId: number, options: CommonEventPublishData, callback: AsyncCallback\): void +```ts +publishAsUser(event: string, userId: number, options: CommonEventPublishData, callback: AsyncCallback): void +``` -向指定用户发布公共事件并指定发布信息（callback形式）。 +以回调形式向指定用户发布公共事件并指定发布信息。 -**系统能力：** SystemCapability.Notification.CommonEvent +**系统能力：** `SystemCapability.Notification.CommonEvent` **系统API**：此接口为系统接口，三方应用不支持调用。 @@ -158,7 +157,7 @@ publishAsUser(event: string, userId: number, options: CommonEventPublishData, ca **示例：** -```js +```ts //公共事件相关信息 let options = { code: 0, //公共事件的初始代码 @@ -181,15 +180,15 @@ let userId = 100; CommonEvent.publishAsUser("event", userId, options, publishAsUserCallBack); ``` - - ## CommonEvent.createSubscriber -createSubscriber(subscribeInfo: CommonEventSubscribeInfo, callback: AsyncCallback\): void +```ts +createSubscriber(subscribeInfo: CommonEventSubscribeInfo, callback: AsyncCallback): void +``` -创建订阅者（callback形式）。 +以回调形式创建订阅者。 -**系统能力：** SystemCapability.Notification.CommonEvent +**系统能力：** `SystemCapability.Notification.CommonEvent` **参数：** @@ -201,7 +200,7 @@ createSubscriber(subscribeInfo: CommonEventSubscribeInfo, callback: AsyncCallbac **示例：** -```js +```ts let subscriber; //用于保存创建成功的订阅者对象，后续使用其完成订阅及退订的动作 //订阅者信息 @@ -223,15 +222,15 @@ function createSubscriberCallBack(err, commonEventSubscriber) { CommonEvent.createSubscriber(subscribeInfo, createSubscriberCallBack); ``` - - ## CommonEvent.createSubscriber -createSubscriber(subscribeInfo: CommonEventSubscribeInfo): Promise\ +```ts +createSubscriber(subscribeInfo: CommonEventSubscribeInfo): Promise +``` -创建订阅者（Promise形式）。 +以Promise形式创建订阅者。 -**系统能力：** SystemCapability.Notification.CommonEvent +**系统能力：** `SystemCapability.Notification.CommonEvent` **参数：** @@ -246,7 +245,7 @@ createSubscriber(subscribeInfo: CommonEventSubscribeInfo): Promise\ { }); ``` - - ## CommonEvent.subscribe -subscribe(subscriber: CommonEventSubscriber, callback: AsyncCallback\): void +```ts +subscribe(subscriber: CommonEventSubscriber, callback: AsyncCallback): void +``` -订阅公共事件（callback形式）。 +以回调形式订阅公共事件。 -**系统能力：** SystemCapability.Notification.CommonEvent +**系统能力：** `SystemCapability.Notification.CommonEvent` **参数：** @@ -282,7 +281,7 @@ subscribe(subscriber: CommonEventSubscriber, callback: AsyncCallback\): void +```ts +unsubscribe(subscriber: CommonEventSubscriber, callback?: AsyncCallback): void +``` -取消订阅公共事件（callback形式）。 +以回调形式取消订阅公共事件。 -**系统能力：** SystemCapability.Notification.CommonEvent +**系统能力：** `SystemCapability.Notification.CommonEvent` **参数：** @@ -334,7 +333,7 @@ unsubscribe(subscriber: CommonEventSubscriber, callback?: AsyncCallback\): **示例：** -```js +```ts let subscriber; //用于保存创建成功的订阅者对象，后续使用其完成订阅及退订的动作 //订阅者信息 @@ -383,21 +382,23 @@ CommonEvent.unsubscribe(subscriber, unsubscribeCallBack); ### getCode -getCode(callback: AsyncCallback\): void +```ts +getCode(callback: AsyncCallback): void +``` -获取公共事件的结果代码（callback形式）。 +以回调形式获取公共事件代码。 -**系统能力**：SystemCapability.Notification.CommonEvent +**系统能力**：`SystemCapability.Notification.CommonEvent` **参数：** | 参数名 | 类型 | 必填 | 说明 | | -------- | ---------------------- | ---- | ------------------ | -| callback | AsyncCallback\ | 是 | 公共事件的结果代码。 | +| callback | AsyncCallback\ | 是 | 公共事件代码。 | **示例：** -```js +```ts let subscriber; //创建成功的订阅者对象 //获取有序公共事件的结果代码回调 @@ -413,21 +414,23 @@ subscriber.getCode(getCodeCallback); ### getCode -getCode(): Promise\ +```ts +getCode(): Promise +``` -获取公共事件的结果代码（Promise形式）。 +以Promise形式获取公共事件代码。 -**系统能力**：SystemCapability.Notification.CommonEvent +**系统能力**：`SystemCapability.Notification.CommonEvent` **返回值：** | 类型 | 说明 | | ---------------- | -------------------- | -| Promise\ | 公共事件的结果代码。 | +| Promise\ | 公共事件代码。 | **示例：** -```js +```ts let subscriber; //创建成功的订阅者对象 subscriber.getCode().then((Code) => { @@ -439,22 +442,24 @@ subscriber.getCode().then((Code) => { ### setCode -setCode(code: number, callback: AsyncCallback\): void +```ts +setCode(code: number, callback: AsyncCallback): void +``` -设置公共事件的结果代码（callback形式）。 +以回调形式设置公共事件的代码。 -**系统能力**：SystemCapability.Notification.CommonEvent +**系统能力**：`SystemCapability.Notification.CommonEvent` **参数：** | 参数名 | 类型 | 必填 | 说明 | | -------- | -------------------- | ---- | ---------------------- | -| code | number | 是 | 公共事件的结果代码。 | +| code | number | 是 | 公共事件的代码。 | | callback | AsyncCallback\ | 是 | 表示被指定的回调方法。 | **示例：** -```js +```ts let subscriber; //创建成功的订阅者对象 //设置有序公共事件的结果代码回调 @@ -470,17 +475,19 @@ subscriber.setCode(1, setCodeCallback); ### setCode -setCode(code: number): Promise\ +```ts +setCode(code: number): Promise +``` -设置公共事件的结果代码（Promise形式）。 +以Promise形式设置公共事件的代码。 -**系统能力**：SystemCapability.Notification.CommonEvent +**系统能力**：`SystemCapability.Notification.CommonEvent` **参数：** | 参数名 | 类型 | 必填 | 说明 | | ------ | ------ | ---- | ------------------ | -| code | number | 是 | 公共事件的结果代码。 | +| code | number | 是 | 公共事件的代码。 | **返回值：** @@ -490,7 +497,7 @@ setCode(code: number): Promise\ **示例：** -```js +```ts let subscriber; //创建成功的订阅者对象 subscriber.setCode(1).then(() => { @@ -502,21 +509,23 @@ subscriber.setCode(1).then(() => { ### getData -getData(callback: AsyncCallback\): void +```ts +getData(callback: AsyncCallback): void +``` -获取公共事件的结果数据（callback形式）。 +以回调形式获取公共事件的数据。 -**系统能力**：SystemCapability.Notification.CommonEvent +**系统能力**：`SystemCapability.Notification.CommonEvent` **参数：** | 参数名 | 类型 | 必填 | 说明 | | -------- | ---------------------- | ---- | -------------------- | -| callback | AsyncCallback\ | 是 | 公共事件的结果数据。 | +| callback | AsyncCallback\ | 是 | 公共事件的数据。 | **示例：** -```js +```ts let subscriber; //创建成功的订阅者对象 //获取有序公共事件的结果数据回调 @@ -527,26 +536,29 @@ function getDataCallback(err, Data) { console.info("getData " + JSON.stringify(Data)); } } + subscriber.getData(getDataCallback); ``` ### getData -getData(): Promise\ +```ts +getData(): Promise +``` -获取公共事件的结果数据（Promise形式）。 +以Promise形式获取公共事件的数据。 -**系统能力**：SystemCapability.Notification.CommonEvent +**系统能力**：`SystemCapability.Notification.CommonEvent` **返回值：** | 类型 | 说明 | | ---------------- | ------------------ | -| Promise\ | 公共事件的结果数据。 | +| Promise\ | 公共事件的数据。 | **示例：** -```js +```ts let subscriber; //创建成功的订阅者对象 subscriber.getData().then((Data) => { @@ -558,22 +570,24 @@ subscriber.getData().then((Data) => { ### setData -setData(data: string, callback: AsyncCallback\): void +```ts +setData(data: string, callback: AsyncCallback): void +``` -设置公共事件的结果数据（callback形式）。 +以回调形式设置公共事件的数据。 -**系统能力**：SystemCapability.Notification.CommonEvent +**系统能力**：`SystemCapability.Notification.CommonEvent` **参数：** | 参数名 | 类型 | 必填 | 说明 | | -------- | -------------------- | ---- | -------------------- | -| data | string | 是 | 公共事件的结果数据。 | +| data | string | 是 | 公共事件的数据。 | | callback | AsyncCallback\ | 是 | 表示被指定的回调方法。 | **示例：** -```js +```ts let subscriber; //创建成功的订阅者对象 //设置有序公共事件的结果数据回调 @@ -589,17 +603,19 @@ subscriber.setData("publish_data_changed", setDataCallback); ### setData -setData(data: string): Promise\ +```ts +setData(data: string): Promise +``` -设置公共事件的结果数据（Promise形式）。 +以Promise形式设置公共事件的果数据。 -**系统能力**：SystemCapability.Notification.CommonEvent +**系统能力**：`SystemCapability.Notification.CommonEvent` **参数：** | 参数名 | 类型 | 必填 | 说明 | | ------ | ------ | ---- | -------------------- | -| data | string | 是 | 公共事件的结果数据。 | +| data | string | 是 | 公共事件的数据。 | **返回值：** @@ -609,7 +625,7 @@ setData(data: string): Promise\ **示例：** -```js +```ts let subscriber; //创建成功的订阅者对象 subscriber.setData("publish_data_changed").then(() => { @@ -621,23 +637,25 @@ subscriber.setData("publish_data_changed").then(() => { ### setCodeAndData -setCodeAndData(code: number, data: string, callback:AsyncCallback\): void +```ts +setCodeAndData(code: number, data: string, callback:AsyncCallback): void +``` -设置公共事件的结果代码和结果数据（callback形式）。 +以回调形式设置公共事件代码和数据。 -**系统能力**：SystemCapability.Notification.CommonEvent +**系统能力**：`SystemCapability.Notification.CommonEvent` **参数：** | 参数名 | 类型 | 必填 | 说明 | | -------- | -------------------- | ---- | ---------------------- | -| code | number | 是 | 公共事件的结果代码。 | -| data | string | 是 | 公共事件的结果数据。 | +| code | number | 是 | 公共事件的代码。 | +| data | string | 是 | 公共事件的数据。 | | callback | AsyncCallback\ | 是 | 表示被指定的回调方法。 | **示例：** -```js +```ts let subscriber; //创建成功的订阅者对象 //设置有序公共事件的结果代码和结果数据回调 @@ -648,33 +666,36 @@ function setCodeDataCallback(err) { console.info("setCodeDataCallback"); } } + subscriber.setCodeAndData(1, "publish_data_changed", setCodeDataCallback); ``` ### setCodeAndData -setCodeAndData(code: number, data: string): Promise\ +```ts +setCodeAndData(code: number, data: string): Promise +``` -设置公共事件的结果代码和结果数据（Promise形式）。 +以Promise形式设置公共事件的代码和数据。 -**系统能力**：SystemCapability.Notification.CommonEvent +**系统能力**：`SystemCapability.Notification.CommonEvent` **参数：** | 参数名 | 类型 | 必填 | 说明 | | ------ | ------ | ---- | -------------------- | -| code | number | 是 | 公共事件的结果代码。 | -| data | string | 是 | 公共事件的结果数据。 | +| code | number | 是 | 公共事件的代码。 | +| data | string | 是 | 公共事件的数据。 | **返回值：** | 类型 | 说明 | | ---------------- | -------------------- | -| Promise\ | 返回一个Promise的结果。 | +| Promise\ | 返回一个Promise。 | **示例：** -```js +```ts let subscriber; //创建成功的订阅者对象 subscriber.setCodeAndData(1, "publish_data_changed").then(() => { @@ -686,13 +707,15 @@ subscriber.setCodeAndData(1, "publish_data_changed").then(() => { ### isOrderedCommonEvent -isOrderedCommonEvent(callback: AsyncCallback\): void +```ts +isOrderedCommonEvent(callback: AsyncCallback): void +``` -查询当前公共事件的是否为有序公共事件（callback形式）。 +以回调形式查询当前公共事件的是否为有序公共事件。 返回true代表是有序公共事件，false代表不是有序公共事件。 -**系统能力**：SystemCapability.Notification.CommonEvent +**系统能力**：`SystemCapability.Notification.CommonEvent` **参数：** @@ -702,7 +725,7 @@ isOrderedCommonEvent(callback: AsyncCallback\): void **示例：** -```js +```ts let subscriber; //创建成功的订阅者对象 //获取当前公共事件是否为有序事件的回调 @@ -718,13 +741,15 @@ subscriber.isOrderedCommonEvent(isOrderedCallback); ### isOrderedCommonEvent -isOrderedCommonEvent(): Promise\ +```ts +isOrderedCommonEvent(): Promise +``` -查询当前公共事件的是否为有序公共事件（Promise形式）。 +以Promise形式查询当前公共事件的是否为有序公共事件。 返回true代表是有序公共事件，false代表不是有序公共事件。 -**系统能力**：SystemCapability.Notification.CommonEvent +**系统能力**：`SystemCapability.Notification.CommonEvent` **返回值：** @@ -734,7 +759,7 @@ isOrderedCommonEvent(): Promise\ **示例：** -```js +```ts let subscriber; //创建成功的订阅者对象 subscriber.isOrderedCommonEvent().then((isOrdered) => { @@ -746,13 +771,15 @@ subscriber.isOrderedCommonEvent().then((isOrdered) => { ### isStickyCommonEvent -isStickyCommonEvent(callback: AsyncCallback\): void +```ts +isStickyCommonEvent(callback: AsyncCallback): void +``` -检查当前公共事件是否为一个粘性事件（callback形式）。 +以回调形式检查当前公共事件是否为一个粘性事件。 返回true代表是粘性公共事件，false代表不是粘性公共事件。 -**系统能力**：SystemCapability.Notification.CommonEvent +**系统能力**：`SystemCapability.Notification.CommonEvent` **参数：** @@ -762,7 +789,7 @@ isStickyCommonEvent(callback: AsyncCallback\): void **示例：** -```js +```ts let subscriber; //创建成功的订阅者对象 //获取当前公共事件是否为粘性事件的回调 @@ -778,13 +805,15 @@ subscriber.isStickyCommonEvent(isStickyCallback); ### isStickyCommonEvent -isStickyCommonEvent(): Promise\ +```ts +isStickyCommonEvent(): Promise +``` -检查当前公共事件是否为一个粘性事件（Promise形式）。 +以Promise形式检查当前公共事件是否为一个粘性事件。 返回true代表是粘性公共事件，false代表不是粘性公共事件。 -**系统能力**：SystemCapability.Notification.CommonEvent +**系统能力**：`SystemCapability.Notification.CommonEvent` **返回值：** @@ -794,7 +823,7 @@ isStickyCommonEvent(): Promise\ **示例：** -```js +```ts let subscriber; //创建成功的订阅者对象 subscriber.isStickyCommonEvent().then((isSticky) => { @@ -806,11 +835,13 @@ subscriber.isStickyCommonEvent().then((isSticky) => { ### abortCommonEvent -abortCommonEvent(callback: AsyncCallback\): void +```ts +abortCommonEvent(callback: AsyncCallback): void +``` -取消当前的公共事件，仅对有序公共事件有效，取消后，公共事件不再向下一个订阅者传递（callback形式）。 +以回调形式取消当前的有序公共事件，取消后，有序公共事件不再向下一个订阅者传递。 -**系统能力**：SystemCapability.Notification.CommonEvent +**系统能力**：`SystemCapability.Notification.CommonEvent` **参数：** @@ -820,7 +851,7 @@ abortCommonEvent(callback: AsyncCallback\): void **示例：** -```js +```ts let subscriber; //创建成功的订阅者对象 //取消当前有序公共事件的回调 @@ -831,16 +862,19 @@ function abortCallback(err) { console.info("abortCommonEvent"); } } + subscriber.abortCommonEvent(abortCallback); ``` ### abortCommonEvent -abortCommonEvent(): Promise\ +```ts +abortCommonEvent(): Promise +``` -取消当前的公共事件，仅对有序公共事件有效，取消后，公共事件不再向下一个订阅者传递（Promise形式）。 +以Promise形式取消当前的有序公共事件，取消后，公共事件不再向下一个订阅者传递。 -**系统能力**：SystemCapability.Notification.CommonEvent +**系统能力**：`SystemCapability.Notification.CommonEvent` **返回值：** @@ -850,7 +884,7 @@ abortCommonEvent(): Promise\ **示例：** -```js +```ts let subscriber; //创建成功的订阅者对象 subscriber.abortCommonEvent().then(() => { @@ -862,11 +896,13 @@ subscriber.abortCommonEvent().then(() => { ### clearAbortCommonEvent -clearAbortCommonEvent(callback: AsyncCallback\): void +```ts +clearAbortCommonEvent(callback: AsyncCallback): void +``` -清除当前公共事件的取消状态，仅对有序公共事件有效（callback形式）。 +以回调形式清除当前有序公共事件。 -**系统能力**：SystemCapability.Notification.CommonEvent +**系统能力**：`SystemCapability.Notification.CommonEvent` **参数：** @@ -876,7 +912,7 @@ clearAbortCommonEvent(callback: AsyncCallback\): void **示例：** -```js +```ts let subscriber; //创建成功的订阅者对象 //清除当前公共事件取消状态的回调 @@ -887,16 +923,19 @@ function clearAbortCallback(err) { console.info("clearAbortCommonEvent"); } } + subscriber.clearAbortCommonEvent(clearAbortCallback); ``` ### clearAbortCommonEvent -clearAbortCommonEvent(): Promise\ +```ts +clearAbortCommonEvent(): Promise +``` -清除当前公共事件的取消状态，仅对有序公共事件有效（Promise形式）。 +以Promise形式清除当前有序公共事件。 -**系统能力**：SystemCapability.Notification.CommonEvent +**系统能力**：`SystemCapability.Notification.CommonEvent` **返回值：** @@ -906,7 +945,7 @@ clearAbortCommonEvent(): Promise\ **示例：** -```js +```ts let subscriber; //创建成功的订阅者对象 subscriber.clearAbortCommonEvent().then(() => { @@ -918,11 +957,13 @@ subscriber.clearAbortCommonEvent().then(() => { ### getAbortCommonEvent -getAbortCommonEvent(callback: AsyncCallback\): void +```ts +getAbortCommonEvent(callback: AsyncCallback): void +``` -获取当前有序公共事件是否取消的状态（callback形式）。 +以回调形式获取当前有序公共事件是否取消的状态。 -**系统能力**：SystemCapability.Notification.CommonEvent +**系统能力**：`SystemCapability.Notification.CommonEvent` **参数：** @@ -932,7 +973,7 @@ getAbortCommonEvent(callback: AsyncCallback\): void **示例：** -```js +```ts let subscriber; //创建成功的订阅者对象 //获取当前有序公共事件是否取消的回调 @@ -943,16 +984,19 @@ function getAbortCallback(err, AbortCommonEvent) { console.info("AbortCommonEvent " + AbortCommonEvent) } } + subscriber.getAbortCommonEvent(getAbortCallback); ``` ### getAbortCommonEvent -getAbortCommonEvent(): Promise\ +```ts +getAbortCommonEvent(): Promise +``` -获取当前有序公共事件是否取消的状态（Promise形式）。 +以Promise形式获取当前有序公共事件是否取消的状态。 -**系统能力**：SystemCapability.Notification.CommonEvent +**系统能力**：`SystemCapability.Notification.CommonEvent` **返回值：** @@ -962,7 +1006,7 @@ getAbortCommonEvent(): Promise\ **示例：** -```js +```ts let subscriber; //创建成功的订阅者对象 subscriber.getAbortCommonEvent().then((AbortCommonEvent) => { @@ -974,11 +1018,13 @@ subscriber.getAbortCommonEvent().then((AbortCommonEvent) => { ### getSubscribeInfo -getSubscribeInfo(callback: AsyncCallback\): void +```ts +getSubscribeInfo(callback: AsyncCallback): void +``` -获取订阅者的订阅信息（callback形式）。 +以回调形式获取订阅者的订阅信息。 -**系统能力**：SystemCapability.Notification.CommonEvent +**系统能力**：`SystemCapability.Notification.CommonEvent` **参数：** @@ -988,7 +1034,7 @@ getSubscribeInfo(callback: AsyncCallback\): void **示例：** -```js +```ts let subscriber; //创建成功的订阅者对象 //获取订阅者信息回调 @@ -999,16 +1045,19 @@ function getSubscribeInfoCallback(err, SubscribeInfo) { console.info("SubscribeInfo " + JSON.stringify(SubscribeInfo)); } } + subscriber.getSubscribeInfo(getSubscribeInfoCallback); ``` ### getSubscribeInfo -getSubscribeInfo(): Promise\ +```ts +getSubscribeInfo(): Promise +``` -获取订阅者的订阅信息（Promise形式）。 +以Promise形式获取订阅者的订阅信息。 -**系统能力**：SystemCapability.Notification.CommonEvent +**系统能力**：`SystemCapability.Notification.CommonEvent` **返回值：** @@ -1018,7 +1067,7 @@ getSubscribeInfo(): Promise\ **示例：** -```js +```ts let subscriber; //创建成功的订阅者对象 subscriber.getSubscribeInfo().then((SubscribeInfo) => { @@ -1030,11 +1079,13 @@ subscriber.getSubscribeInfo().then((SubscribeInfo) => { ### finishCommonEvent9+ -finishCommonEvent(callback: AsyncCallback\): void +```ts +finishCommonEvent(callback: AsyncCallback): void +``` -结束当前有序公共事件（callback形式）。 +以回调形式结束当前有序公共事件。 -**系统能力**：SystemCapability.Notification.CommonEvent +**系统能力**：`SystemCapability.Notification.CommonEvent` **参数：** @@ -1044,27 +1095,30 @@ finishCommonEvent(callback: AsyncCallback\): void **示例：** -```js +```ts let subscriber; //创建成功的订阅者对象 //结束当前有序公共事件的回调 function finishCommonEventCallback(err) { - if (err.code) { - console.error("finishCommonEvent failed " + JSON.stringify(err)); -} else { - console.info("FinishCommonEvent"); -} + if (err.code) { + console.error("finishCommonEvent failed " + JSON.stringify(err)); + } else { + console.info("FinishCommonEvent"); + } } + subscriber.finishCommonEvent(finishCommonEventCallback); ``` ### finishCommonEvent9+ -finishCommonEvent(): Promise\ +```ts +finishCommonEvent(): Promise +``` -结束当前有序公共事件（Promise形式）。 +以Promise形式结束当前有序公共事件。 -**系统能力**：SystemCapability.Notification.CommonEvent +**系统能力**：`SystemCapability.Notification.CommonEvent` **返回值：** @@ -1074,7 +1128,7 @@ finishCommonEvent(): Promise\ **示例：** -```js +```ts let subscriber; //创建成功的订阅者对象 subscriber.finishCommonEvent().then(() => { @@ -1088,7 +1142,7 @@ subscriber.finishCommonEvent().then(() => { 公共事件数据体。 -**系统能力：** 以下各项对应的系统能力均为SystemCapability.Notification.CommonEvent +**系统能力：** `SystemCapability.Notification.CommonEvent` | 名称 | 类型 | 可读 | 可写 | 说明 | | ---------- |-------------------- | ---- | ---- | ------------------------------------------------------- | @@ -1103,14 +1157,14 @@ subscriber.finishCommonEvent().then(() => { 公共事件发送的数据体，包含公共事件内容和属性。 -**系统能力：** 以下各项对应的系统能力均为SystemCapability.Notification.CommonEvent +**系统能力：** `SystemCapability.Notification.CommonEvent` | 名称 | 类型 | 可读 | 可写 | 说明 | | --------------------- | -------------------- | ---- | ---- | ---------------------------- | | bundleName | string | 是 | 否 | 表示Bundle名称。 | | code | number | 是 | 否 | 表示公共事件的结果代码。 | | data | string | 是 | 否 | 表示公共事件的自定义结果数据。 | -| subscriberPermissions | Array\ | 是 | 否 | 表示订阅者的权限。 | +| subscriberPermissions | Array\ | 是 | 否 | 表示订阅者的权限。 | | isOrdered | boolean | 是 | 否 | 表示是否是有序事件。 | | isSticky | boolean | 是 | 否 | 表示是否是粘性事件。仅系统应用或系统服务允许发送粘性事件。 | | parameters | {[key: string]: any} | 是 | 否 | 表示公共事件的附加信息。 | @@ -1119,11 +1173,11 @@ subscriber.finishCommonEvent().then(() => { 订阅者信息。 -**系统能力：** 以下各项对应的系统能力均为SystemCapability.Notification.CommonEvent +**系统能力：** `SystemCapability.Notification.CommonEvent` | 名称 | 类型 | 可读 | 可写 | 说明 | | ------------------- | -------------- | ---- | ---- | ------------------------------------------------------------ | -| events | Array\ | 是 | 否 | 表示要发送的公共事件。 | +| events | Array\ | 是 | 否 | 表示要发送的公共事件。 | | publisherPermission | string | 是 | 否 | 表示发布者的权限。 | | publisherDeviceId | string | 是 | 否 | 表示设备ID，该值必须是同一ohos网络上的现有设备ID。 | | userId | number | 是 | 否 | 表示用户ID。此参数是可选的，默认值当前用户的ID。如果指定了此参数，则该值必须是系统中现有的用户ID。 | diff --git a/zh-cn/application-dev/reference/apis/js-apis-commonEventManager.md b/zh-cn/application-dev/reference/apis/js-apis-commonEventManager.md index 846991584dc3235723eba0911801abaa1dc25438..002b0410fb0c5632bb744b7136c1f7c4e7e6f777 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-commonEventManager.md +++ b/zh-cn/application-dev/reference/apis/js-apis-commonEventManager.md @@ -1,6 +1,6 @@ # @ohos.commonEventManager (公共事件模块) -本模块提供了公共事件的能力，包括公共事件的权限列表，发布公共事件，订阅或取消订阅公共事件，获取或修改公共事件结果代码、结果数据等。 +本模块提供了公共事件相关的能力，包括发布公共事件、订阅公共事件、以及退订公共事件。 > **说明：** > @@ -14,193 +14,30 @@ import CommonEventManager from '@ohos.commonEventManager'; ## Support -CommonEventManager模块支持的事件类型。名称指的是系统公共事件宏；值指的是系统公共事件。 - -**系统能力：** SystemCapability.Notification.CommonEvent - -| 名称 | 值 | 订阅者所需权限 | 说明 | -| ------------ | ------------------ | ---------------------- | -------------------- | -| 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_THERMAL_LEVEL_CHANGED | usual.event.THERMAL_LEVEL_CHANGED | 无 | 表示设备热状态的公共事件的动作。 | -| 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_BUNDLE_REMOVED | usual.event.BUNDLE_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_PACKAGE_CACHE_CLEARED9+ | usual.event.PACKAGE_CACHE_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 | 无 | 表示用户ID已从系统中删除的公共事件的动作。预留事件，暂未支持。 | -| 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 | 无 | 表示系统处于HOME模式的公共事件的动作。预留事件，暂未支持。 | -| 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_LOCAL_ACCOUNTS | 表示用户切换正在发生的公共事件的动作。 | -| COMMON_EVENT_USER_STARTING | usual.event.USER_STARTING | ohos.permission.INTERACT_ACROSS_LOCAL_ACCOUNTS | 表示要启动用户的公共事件的动作。预留事件，暂未支持。 | -| COMMON_EVENT_USER_UNLOCKED | usual.event.USER_UNLOCKED | 无 | 设备重启后解锁时，当前用户的凭据加密存储已解锁的公共事件的动作。预留事件，暂未支持。 | -| COMMON_EVENT_USER_STOPPING | usual.event.USER_STOPPING | ohos.permission.INTERACT_ACROSS_LOCAL_ACCOUNTS | 表示要停止用户的公共事件的动作。预留事件，暂未支持。 | -| COMMON_EVENT_USER_STOPPED | usual.event.USER_STOPPED | 无 | 表示用户已停止的公共事件的动作。预留事件，暂未支持。 | -| COMMON_EVENT_DISTRIBUTED_ACCOUNT_LOGIN | usual.event.DISTRIBUTED_ACCOUNT_LOGIN | 无 | 表示分布式账号登录成功的动作。预留事件，暂未支持。 | -| COMMON_EVENT_DISTRIBUTED_ACCOUNT_LOGOUT | usual.event.DISTRIBUTED_ACCOUNT_LOGOUT | 无 | 表示分布式账号登出成功的动作。预留事件，暂未支持。 | -| COMMON_EVENT_DISTRIBUTED_ACCOUNT_TOKEN_INVALID | usual.event.DISTRIBUTED_ACCOUNT_TOKEN_INVALID | 无 | 表示分布式账号token令牌无效的动作。预留事件，暂未支持。 | -| COMMON_EVENT_DISTRIBUTED_ACCOUNT_LOGOFF | usual.event.DISTRIBUTED_ACCOUNT_LOGOFF | 无 | 表示分布式账号注销的动作。预留事件，暂未支持。 | -| COMMON_EVENT_WIFI_POWER_STATE | usual.event.wifi.POWER_STATE | 无 | Wi-Fi状态公共事件的动作，如启用和禁用。 | -| COMMON_EVENT_WIFI_SCAN_FINISHED | usual.event.wifi.SCAN_FINISHED | ohos.permission.LOCATION | 表示Wi-Fi接入点已被扫描并证明可用的公共事件的操作。 | -| COMMON_EVENT_WIFI_RSSI_VALUE | usual.event.wifi.RSSI_VALUE | ohos.permission.GET_WIFI_INFO | 表示Wi-Fi信号强度（RSSI）改变的公共事件的动作。 | -| COMMON_EVENT_WIFI_CONN_STATE | usual.event.wifi.CONN_STATE | 无 | Wi-Fi连接状态发生改变的公共事件的动作。 | -| COMMON_EVENT_WIFI_HOTSPOT_STATE | usual.event.wifi.HOTSPOT_STATE | 无 | Wi-Fi热点状态的公共事件的动作，如启用或禁用。 | -| COMMON_EVENT_WIFI_AP_STA_JOIN | usual.event.wifi.WIFI_HS_STA_JOIN | ohos.permission.GET_WIFI_INFO | 客户端加入当前设备Wi-Fi热点的普通事件的动作。 | -| COMMON_EVENT_WIFI_AP_STA_LEAVE | usual.event.wifi.WIFI_HS_STA_LEAVE | ohos.permission.GET_WIFI_INFO |客户端已断开与当前设备Wi-Fi热点的连接的公共事件的动作。 | -| COMMON_EVENT_WIFI_MPLINK_STATE_CHANGE | usual.event.wifi.mplink.STATE_CHANGE | ohos.permission.MPLINK_CHANGE_STATE | 表示MPLink（增强Wi-Fi功能）状态已更改的公共事件的动作。 | -| COMMON_EVENT_WIFI_P2P_CONN_STATE | usual.event.wifi.p2p.CONN_STATE_CHANGE | ohos.permission.GET_WIFI_INFO and ohos.permission.LOCATION | Wi-Fi P2P连接状态改变的公共事件的动作。 | -| COMMON_EVENT_WIFI_P2P_STATE_CHANGED | usual.event.wifi.p2p.STATE_CHANGE | ohos.permission.GET_WIFI_INFO | Wi-Fi P2P状态公共事件的动作，如启用和禁用。 | -| COMMON_EVENT_WIFI_P2P_PEERS_STATE_CHANGED | usual.event.wifi.p2p.DEVICES_CHANGE | ohos.permission.GET_WIFI_INFO | Wi-Fi P2P对等体状态变化。 | -| COMMON_EVENT_WIFI_P2P_PEERS_DISCOVERY_STATE_CHANGED | usual.event.wifi.p2p.PEER_DISCOVERY_STATE_CHANGE | ohos.permission.GET_WIFI_INFO | Wi-Fi P2P发现状态变化。 | -| COMMON_EVENT_WIFI_P2P_CURRENT_DEVICE_STATE_CHANGED | usual.event.wifi.p2p.CURRENT_DEVICE_CHANGE | ohos.permission.GET_WIFI_INFO | Wi-Fi P2P当前设备状态变化。 | -| COMMON_EVENT_WIFI_P2P_GROUP_STATE_CHANGED | usual.event.wifi.p2p.GROUP_STATE_CHANGED | ohos.permission.GET_WIFI_INFO | Wi-Fi P2P群组信息已更改。 | -| 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 | 表示蓝牙A2DP连接状态已更改的公共事件的动作。预留事件，暂未支持。 | -| COMMON_EVENT_BLUETOOTH_A2DPSOURCE_CONNECT_STATE_UPDATE | usual.event.bluetooth.a2dpsource.CONNECT_STATE_UPDATE | ohos.permission.USE_BLUETOOTH | 蓝牙A2DP连接状态公共事件的动作。预留事件，暂未支持。 | -| COMMON_EVENT_BLUETOOTH_A2DPSOURCE_CURRENT_DEVICE_UPDATE | usual.event.bluetooth.a2dpsource.CURRENT_DEVICE_UPDATE | ohos.permission.USE_BLUETOOTH | 表示使用蓝牙A2DP连接的设备处于活动状态的公共事件的动作。预留事件，暂未支持。 | -| COMMON_EVENT_BLUETOOTH_A2DPSOURCE_PLAYING_STATE_UPDATE | usual.event.bluetooth.a2dpsource.PLAYING_STATE_UPDATE | ohos.permission.USE_BLUETOOTH | 蓝牙A2DP播放状态改变的普通事件的动作。预留事件，暂未支持。 | -| COMMON_EVENT_BLUETOOTH_A2DPSOURCE_AVRCP_CONNECT_STATE_UPDATE | usual.event.bluetooth.a2dpsource.AVRCP_CONNECT_STATE_UPDATE | ohos.permission.USE_BLUETOOTH | 表示蓝牙A2DP的AVRCP连接状态已更改的公共事件的动作。预留事件，暂未支持。 | -| COMMON_EVENT_BLUETOOTH_A2DPSOURCE_CODEC_VALUE_UPDATE | usual.event.bluetooth.a2dpsource.CODEC_VALUE_UPDATE | ohos.permission.USE_BLUETOOTH | 表示蓝牙A2DP音频编解码状态更改的公共事件的动作。预留事件，暂未支持。 | -| COMMON_EVENT_BLUETOOTH_REMOTEDEVICE_DISCOVERED | usual.event.bluetooth.remotedevice.DISCOVERED | ohos.permission.LOCATION and ohos.permission.USE_BLUETOOTH | 表示发现远程蓝牙设备的公共事件的动作。预留事件，暂未支持。 | -| 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 | 表示已与远程蓝牙设备建立低级别（ACL）连接的公共事件的动作。预留事件，暂未支持。 | -| COMMON_EVENT_BLUETOOTH_REMOTEDEVICE_ACL_DISCONNECTED | usual.event.bluetooth.remotedevice.ACL_DISCONNECTED | ohos.permission.USE_BLUETOOTH | 表示低电平（ACL）连接已从远程蓝牙设备断开的普通事件的动作。预留事件，暂未支持。 | -| 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 | 无 | 远程蓝牙设备SDP状态公共事件的动作。预留事件，暂未支持。 | -| COMMON_EVENT_BLUETOOTH_REMOTEDEVICE_UUID_VALUE | usual.event.bluetooth.remotedevice.UUID_VALUE | ohos.permission.DISCOVER_BLUETOOTH | 远程蓝牙设备UUID连接状态公共事件的动作。预留事件，暂未支持。 | -| 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 | ohos.permission.USE_BLUETOOTH | 表示蓝牙适配器状态已更改的公共事件的操作，例如蓝牙已打开或关闭。预留事件，暂未支持。 | -| 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 | 表示蓝牙A2DP宿连接状态已更改的公共事件的动作。预留事件，暂未支持。 | -| COMMON_EVENT_BLUETOOTH_A2DPSINK_PLAYING_STATE_UPDATE | usual.event.bluetooth.a2dpsink.PLAYING_STATE_UPDATE | ohos.permission.USE_BLUETOOTH | 蓝牙A2DP宿播放状态改变的普通事件的动作。预留事件，暂未支持。 | -| COMMON_EVENT_BLUETOOTH_A2DPSINK_AUDIO_STATE_UPDATE | usual.event.bluetooth.a2dpsink.AUDIO_STATE_UPDATE | ohos.permission.USE_BLUETOOTH | 表示蓝牙A2DP宿的音频状态已更改的公共事件的动作。预留事件，暂未支持。 | -| COMMON_EVENT_NFC_ACTION_ADAPTER_STATE_CHANGED | usual.event.nfc.action.ADAPTER_STATE_CHANGED | 无 | 指示设备NFC适配器状态已更改的公共事件的操作。 | -| COMMON_EVENT_NFC_ACTION_RF_FIELD_ON_DETECTED | usual.event.nfc.action.RF_FIELD_ON_DETECTED | ohos.permission.MANAGE_SECURE_SETTINGS | 检测到NFC RF字段处于使能状态的公共事件的动作。预留事件，暂未支持。 | -| COMMON_EVENT_NFC_ACTION_RF_FIELD_OFF_DETECTED | usual.event.nfc.action.RF_FIELD_OFF_DETECTED | ohos.permission.MANAGE_SECURE_SETTINGS | 检测到NFC RF字段处于关闭状态的公共事件的动作。预留事件，暂未支持。 | -| 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_LOCAL_ACCOUNTS | 表示用户已添加到系统中的公共事件的动作。 | -| COMMON_EVENT_USER_REMOVED | usual.event.USER_REMOVED | ohos.permission.MANAGE_LOCAL_ACCOUNTS | 表示用户已从系统中删除的公共事件的动作。 | -| COMMON_EVENT_ABILITY_ADDED | usual.event.ABILITY_ADDED | ohos.permission.LISTEN_BUNDLE_CHANGE | 表示已添加能力的公共事件的动作。预留事件，暂未支持。 | -| COMMON_EVENT_ABILITY_REMOVED | usual.event.ABILITY_REMOVED | ohos.permission.LISTEN_BUNDLE_CHANGE | 表示已删除能力的公共事件的动作。预留事件，暂未支持。 | -| COMMON_EVENT_ABILITY_UPDATED | usual.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 | 无 | 表示表示车辆的车载信息娱乐（IVI）系统正在休眠的常见事件的动作。预留事件，暂未支持。 | -| COMMON_EVENT_IVI_PAUSE | common.event.IVI_PAUSE | 无 | 表示IVI已休眠，并通知应用程序停止播放。预留事件，暂未支持。 | -| 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 | 无 | 表示IVI温度过高。预留事件，暂未支持。 | -| COMMON_EVENT_IVI_EXTREME_TEMPERATURE | common.event.IVI_EXTREME_TEMPERATURE | 无 | 表示IVI温度极高。预留事件，暂未支持。 | -| 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_STATE9+ | usual.event.hardware.usb.action.USB_STATE | 无 | 表示USB设备状态发生变化的公共事件。 | -|COMMON_EVENT_USB_PORT_CHANGED9+ | usual.event.hardware.usb.action.USB_PORT_CHANGED | 无 | 表示用户设备的USB端口状态发生改变的公共事件。 | -| COMMON_EVENT_USB_DEVICE_ATTACHED | usual.event.hardware.usb.action.USB_DEVICE_ATTACHED | 无 | 当用户设备作为USB主机时，USB设备已挂载的公共事件的动作。 | -| COMMON_EVENT_USB_DEVICE_DETACHED | usual.event.hardware.usb.action.USB_DEVICE_DETACHED | 无 | 当用户设备作为USB主机时，USB设备被卸载的公共事件的动作。 | -| COMMON_EVENT_USB_ACCESSORY_ATTACHED | usual.event.hardware.usb.action.USB_ACCESSORY_ATTACHED | 无 | 表示已连接USB附件的公共事件的动作。预留事件，暂未支持。 | -| COMMON_EVENT_USB_ACCESSORY_DETACHED | usual.event.hardware.usb.action.USB_ACCESSORY_DETACHED | 无 | 表示USB附件被卸载的公共事件的动作。预留事件，暂未支持。 | -| COMMON_EVENT_DISK_REMOVED | usual.event.data.DISK_REMOVED | ohos.permission.STORAGE_MANAGER | 外部存储设备状态变更为移除时发送此公共事件。预留事件，暂未支持。 | -| COMMON_EVENT_DISK_UNMOUNTED | usual.event.data.DISK_UNMOUNTED | ohos.permission.STORAGE_MANAGER | 外部存储设备状态变更为卸载时发送此公共事件。预留事件，暂未支持。 | -| COMMON_EVENT_DISK_MOUNTED | usual.event.data.DISK_MOUNTED | ohos.permission.STORAGE_MANAGER | 外部存储设备状态变更为挂载时发送此公共事件。预留事件，暂未支持。 | -| COMMON_EVENT_DISK_BAD_REMOVAL | usual.event.data.DISK_BAD_REMOVAL | ohos.permission.STORAGE_MANAGER | 外部存储设备状态变更为挂载状态下移除时发送此公共事件。预留事件，暂未支持。 | -| COMMON_EVENT_DISK_UNMOUNTABLE | usual.event.data.DISK_UNMOUNTABLE | ohos.permission.STORAGE_MANAGER | 外部存储设备状态变更为插卡情况下无法挂载时发送此公共事件。预留事件，暂未支持。 | -| COMMON_EVENT_DISK_EJECT | usual.event.data.DISK_EJECT | ohos.permission.STORAGE_MANAGER | 用户已表示希望删除外部存储介质时发送此公共事件。预留事件，暂未支持。 | -| COMMON_EVENT_VOLUME_REMOVED9+ | usual.event.data.VOLUME_REMOVED | ohos.permission.STORAGE_MANAGER | 外部存储设备状态变更为移除时发送此公共事件。 | -| COMMON_EVENT_VOLUME_UNMOUNTED9+ | usual.event.data.VOLUME_UNMOUNTED | ohos.permission.STORAGE_MANAGER | 外部存储设备状态变更为卸载时发送此公共事件。 | -| COMMON_EVENT_VOLUME_MOUNTED9+ | usual.event.data.VOLUME_MOUNTED | ohos.permission.STORAGE_MANAGER | 外部存储设备状态变更为挂载时发送此公共事件。 | -| COMMON_EVENT_VOLUME_BAD_REMOVAL9+ | usual.event.data.VOLUME_BAD_REMOVAL | ohos.permission.STORAGE_MANAGER | 外部存储设备状态变更为挂载状态下移除时发送此公共事件。 | -| COMMON_EVENT_VOLUME_EJECT9+ | usual.event.data.VOLUME_EJECT | ohos.permission.STORAGE_MANAGER | 用户已表示希望删除外部存储介质时发送此公共事件。 | -| 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 | usual.event.data.FOUNDATION_READY | ohos.permission.RECEIVER_STARTUP_COMPLETED | 表示foundation已准备好的公共事件的动作。预留事件，暂未支持。 | -| COMMON_EVENT_AIRPLANE_MODE_CHANGED | usual.event.AIRPLANE_MODE | 无 | 表示设备飞行模式已更改的公共事件的动作。 | -| COMMON_EVENT_SPLIT_SCREEN | usual.event.SPLIT_SCREEN | ohos.permission.RECEIVER_SPLIT_SCREEN | 表示分屏的公共事件的动作。 | -| COMMON_EVENT_SLOT_CHANGE9+ | usual.event.SLOT_CHANGE | ohos.permission.NOTIFICATION_CONTROLLER | 表示通知通道更新的动作。 | -| COMMON_EVENT_SPN_INFO_CHANGED 9+ | usual.event.SPN_INFO_CHANGED | 无 | 表示spn显示信息已更新的公共事件的动作。 | -| COMMON_EVENT_QUICK_FIX_APPLY_RESULT 9+ | usual.event.QUICK_FIX_APPLY_RESULT | 无 | 表示快速修复应用的动作。 | +系统公共事件是指由系统服务或系统应用发布的事件，订阅这些系统公共事件需要特定的权限。发布或订阅这些事件需要使用如下链接中的枚举定义。 +全部系统公共事件枚举定义请参见[系统公共事件定义](./commonEventManager-definitions.md)。 ## CommonEventManager.publish -publish(event: string, callback: AsyncCallback\): void +```ts +publish(event: string, callback: AsyncCallback): void +``` -发布公共事件（callback形式）。 +发布公共事件，并在发布后执行相应的回调函数。 -**系统能力：** SystemCapability.Notification.CommonEvent +**系统能力：** `SystemCapability.Notification.CommonEvent` **参数：** | 参数名 | 类型 | 必填 | 说明 | | -------- | -------------------- | ---- | ---------------------- | | event | string | 是 | 表示要发送的公共事件。 | -| callback | AsyncCallback\ | 是 | 表示被指定的回调方法。 | +| callback | AsyncCallback\ | 是 | 表示事件发布后将要执行的回调函数。 | **错误码：** -以下错误码详细介绍请参考[@ohos.commonEventManager(事件)](../errorcodes/errorcode-CommonEventService.md) -|错误码ID |错误信息 | -|-----------|--------------------| -|1500004 |not System services or System app| -|1500007 |message send error| -|1500008 |CEMS error| -|1500009 |system error| +错误码介绍请参考[@ohos.commonEventManager(事件)](../errorcodes/errorcode-CommonEventService.md) **示例：** @@ -224,11 +61,13 @@ try { ## CommonEventManager.publish -publish(event: string, options: CommonEventPublishData, callback: AsyncCallback\): void +```ts +publish(event: string, options: CommonEventPublishData, callback: AsyncCallback): void +``` -发布公共事件指定发布信息（callback形式）。 +以回调的形式发布公共事件。 -**系统能力：** SystemCapability.Notification.CommonEvent +**系统能力：** `SystemCapability.Notification.CommonEvent` **参数：** @@ -239,20 +78,14 @@ publish(event: string, options: CommonEventPublishData, callback: AsyncCallback\ | callback | syncCallback\ | 是 | 表示被指定的回调方法。 | **错误码：** -|错误码ID |错误信息 | -|-----------|--------------------| -|1500004 |not System services or System app| -|1500007 |message send error| -|1500008 |CEMS error| -|1500009 |system error| +错误码介绍请参考[@ohos.commonEventManager(事件)](../errorcodes/errorcode-CommonEventService.md) **示例：** - ```ts //公共事件相关信息 -var options = { +let options = { code: 0, //公共事件的初始代码 data: "initial data",//公共事件的初始数据 isOrdered: true //有序公共事件 @@ -275,15 +108,15 @@ try { } ``` - - ## CommonEventManager.publishAsUser -publishAsUser(event: string, userId: number, callback: AsyncCallback\): void +```ts +publishAsUser(event: string, userId: number, callback: AsyncCallback): void +``` -向指定用户发布公共事件（callback形式）。 +以回调的形式向指定用户发布公共事件。 -**系统能力：** SystemCapability.Notification.CommonEvent +**系统能力：** `SystemCapability.Notification.CommonEvent` **系统API**：此接口为系统接口，三方应用不支持调用。 @@ -296,12 +129,8 @@ publishAsUser(event: string, userId: number, callback: AsyncCallback\): vo | callback | AsyncCallback\ | 是 | 表示被指定的回调方法。 | **错误码：** -|错误码ID |错误信息 | -|-----------|--------------------| -|1500004 |not System services or System app| -|1500007 |message send error| -|1500008 |CEMS error| -|1500009 |system error| + +错误码介绍请参考[@ohos.commonEventManager(事件)](../errorcodes/errorcode-CommonEventService.md) **示例：** @@ -316,7 +145,7 @@ function publishAsUserCallBack(err) { } //指定发送的用户 -var userId = 100; +let userId = 100; //发布公共事件 try { @@ -326,15 +155,15 @@ try { } ``` - - ## CommonEventManager.publishAsUser -publishAsUser(event: string, userId: number, options: CommonEventPublishData, callback: AsyncCallback\): void +```ts +publishAsUser(event: string, userId: number, options: CommonEventPublishData, callback: AsyncCallback): void +``` -向指定用户发布公共事件并指定发布信息（callback形式）。 +以回调形式向指定用户发布公共事件并指定发布信息。 -**系统能力：** SystemCapability.Notification.CommonEvent +**系统能力：** `SystemCapability.Notification.CommonEvent` **系统API**：此接口为系统接口，三方应用不支持调用。 @@ -348,19 +177,15 @@ publishAsUser(event: string, userId: number, options: CommonEventPublishData, ca | callback | AsyncCallback\ | 是 | 表示被指定的回调方法。 | **错误码：** -|错误码ID |错误信息 | -|-----------|--------------------| -|1500004 |not System services or System app| -|1500007 |message send error| -|1500008 |CEMS error| -|1500009 |system error| + +错误码介绍请参考[@ohos.commonEventManager(事件)](../errorcodes/errorcode-CommonEventService.md) **示例：** ```ts //公共事件相关信息 -var options = { +let options = { code: 0, //公共事件的初始代码 data: "initial data",//公共事件的初始数据 } @@ -375,7 +200,7 @@ function publishAsUserCallBack(err) { } //指定发送的用户 -var userId = 100; +let userId = 100; //发布公共事件 try { @@ -385,15 +210,15 @@ try { } ``` - - ## CommonEventManager.createSubscriber -createSubscriber(subscribeInfo: CommonEventSubscribeInfo, callback: AsyncCallback\): void +```ts +createSubscriber(subscribeInfo: CommonEventSubscribeInfo, callback: AsyncCallback): void +``` -创建订阅者（callback形式）。 +以回调形式创建订阅者。 -**系统能力：** SystemCapability.Notification.CommonEvent +**系统能力：** `SystemCapability.Notification.CommonEvent` **参数：** @@ -406,10 +231,10 @@ createSubscriber(subscribeInfo: CommonEventSubscribeInfo, callback: AsyncCallbac ```ts -var subscriber; //用于保存创建成功的订阅者对象，后续使用其完成订阅及退订的动作 +let subscriber; //用于保存创建成功的订阅者对象，后续使用其完成订阅及退订的动作 //订阅者信息 -var subscribeInfo = { +let subscribeInfo = { events: ["event"] }; @@ -431,15 +256,15 @@ try { } ``` - - ## CommonEventManager.createSubscriber -createSubscriber(subscribeInfo: CommonEventSubscribeInfo): Promise\ +```ts +createSubscriber(subscribeInfo: CommonEventSubscribeInfo): Promise +``` -创建订阅者（Promise形式）。 +以Promise形式创建订阅者。 -**系统能力：** SystemCapability.Notification.CommonEvent +**系统能力：** `SystemCapability.Notification.CommonEvent` **参数：** @@ -455,36 +280,32 @@ createSubscriber(subscribeInfo: CommonEventSubscribeInfo): Promise\ { +CommonEventManager.createSubscriber(subscribeInfo).then((commonEventSubscriber) => { console.info("createSubscriber"); subscriber = commonEventSubscriber; }).catch((err) => { console.error("createSubscriber failed " + JSON.stringify(err)); }); -} catch(err) { - console.error('createSubscriber failed, catch error' + JSON.stringify(err)); -} ``` - - ## CommonEventManager.subscribe -subscribe(subscriber: CommonEventSubscriber, callback: AsyncCallback\): void +```ts +subscribe(subscriber: CommonEventSubscriber, callback: AsyncCallback): void +``` -订阅公共事件（callback形式）。 +以回调形式订阅公共事件。 -**系统能力：** SystemCapability.Notification.CommonEvent +**系统能力：** `SystemCapability.Notification.CommonEvent` **参数：** @@ -497,10 +318,10 @@ subscribe(subscriber: CommonEventSubscriber, callback: AsyncCallback\): void +```ts +unsubscribe(subscriber: CommonEventSubscriber, callback?: AsyncCallback): void +``` -取消订阅公共事件（callback形式）。 +以回调形式取消订阅公共事件。 -**系统能力：** SystemCapability.Notification.CommonEvent +**系统能力：** `SystemCapability.Notification.CommonEvent` **参数：** @@ -557,9 +378,9 @@ unsubscribe(subscriber: CommonEventSubscriber, callback?: AsyncCallback\): **示例：** ```ts -var subscriber; //用于保存创建成功的订阅者对象，后续使用其完成订阅及退订的动作 +let subscriber; //用于保存创建成功的订阅者对象，后续使用其完成订阅及退订的动作 //订阅者信息 -var subscribeInfo = { +let subscribeInfo = { events: ["event"] }; //订阅公共事件回调 @@ -612,24 +433,26 @@ try { ### getCode -getCode(callback: AsyncCallback\): void +```ts +getCode(callback: AsyncCallback): void +``` -获取公共事件的结果代码（callback形式）。 +以回调形式获取公共事件代码。 -**系统能力**：SystemCapability.Notification.CommonEvent +**系统能力**：`SystemCapability.Notification.CommonEvent` **参数：** | 参数名 | 类型 | 必填 | 说明 | | -------- | ---------------------- | ---- | ------------------ | -| callback | AsyncCallback\ | 是 | 公共事件的结果代码。 | +| callback | AsyncCallback\ | 是 | 公共事件代码。 | **示例：** ```ts -var subscriber; //创建成功的订阅者对象 +let subscriber; //创建成功的订阅者对象 -//获取有序公共事件的结果代码回调 +//获取有序公共事件代码回调 function getCodeCallback(err, Code) { if (err.code) { console.error("getCode failed " + JSON.stringify(err)); @@ -642,22 +465,24 @@ subscriber.getCode(getCodeCallback); ### getCode -getCode(): Promise\ +```ts +getCode(): Promise +``` -获取公共事件的结果代码（Promise形式）。 +以Promise形式获取公共事件代码。 -**系统能力**：SystemCapability.Notification.CommonEvent +**系统能力**：`SystemCapability.Notification.CommonEvent` **返回值：** | 类型 | 说明 | | ---------------- | -------------------- | -| Promise\ | 公共事件的结果代码。 | +| Promise\ | 公共事件代码。 | **示例：** ```ts -var subscriber; //创建成功的订阅者对象 +let subscriber; //创建成功的订阅者对象 subscriber.getCode().then((Code) => { console.info("getCode " + JSON.stringify(Code)); @@ -670,23 +495,23 @@ subscriber.getCode().then((Code) => { setCode(code: number, callback: AsyncCallback\): void -设置公共事件的结果代码（callback形式）。 +以回调形式设置公共事件的代码。 -**系统能力**：SystemCapability.Notification.CommonEvent +**系统能力**：`SystemCapability.Notification.CommonEvent` **参数：** | 参数名 | 类型 | 必填 | 说明 | | -------- | -------------------- | ---- | ---------------------- | -| code | number | 是 | 公共事件的结果代码。 | +| code | number | 是 | 公共事件的代码。 | | callback | AsyncCallback\ | 是 | 表示被指定的回调方法。 | **示例：** ```ts -var subscriber; //创建成功的订阅者对象 +let subscriber; //创建成功的订阅者对象 -//设置有序公共事件的结果代码回调 +//设置有序公共事件的代码回调 function setCodeCallback(err) { if (err.code) { console.error("setCode failed " + JSON.stringify(err)); @@ -699,17 +524,19 @@ subscriber.setCode(1, setCodeCallback); ### setCode -setCode(code: number): Promise\ +```ts +setCode(code: number): Promise +``` -设置公共事件的结果代码（Promise形式）。 +以Promise形式设置公共事件的代码。 -**系统能力**：SystemCapability.Notification.CommonEvent +**系统能力**：`SystemCapability.Notification.CommonEvent` **参数：** | 参数名 | 类型 | 必填 | 说明 | | ------ | ------ | ---- | ------------------ | -| code | number | 是 | 公共事件的结果代码。 | +| code | number | 是 | 公共事件的代码。 | **返回值：** @@ -720,7 +547,7 @@ setCode(code: number): Promise\ **示例：** ```ts -var subscriber; //创建成功的订阅者对象 +let subscriber; //创建成功的订阅者对象 subscriber.setCode(1).then(() => { console.info("setCode"); @@ -731,24 +558,26 @@ subscriber.setCode(1).then(() => { ### getData -getData(callback: AsyncCallback\): void +```ts +getData(callback: AsyncCallback): void +``` -获取公共事件的结果数据（callback形式）。 +以回调形式获取公共事件的数据。 -**系统能力**：SystemCapability.Notification.CommonEvent +**系统能力**：`SystemCapability.Notification.CommonEvent` **参数：** | 参数名 | 类型 | 必填 | 说明 | | -------- | ---------------------- | ---- | -------------------- | -| callback | AsyncCallback\ | 是 | 公共事件的结果数据。 | +| callback | AsyncCallback\ | 是 | 公共事件的数据。 | **示例：** ```ts -var subscriber; //创建成功的订阅者对象 +let subscriber; //创建成功的订阅者对象 -//获取有序公共事件的结果数据回调 +//获取有序公共事件代码数据回调 function getDataCallback(err, Data) { if (err.code) { console.error("getData failed " + JSON.stringify(err)); @@ -761,22 +590,24 @@ subscriber.getData(getDataCallback); ### getData -getData(): Promise\ +```ts +getData(): Promise +``` -获取公共事件的结果数据（Promise形式）。 +以Promise形式获取公共事件的数据。 -**系统能力**：SystemCapability.Notification.CommonEvent +**系统能力**：`SystemCapability.Notification.CommonEvent` **返回值：** | 类型 | 说明 | | ---------------- | ------------------ | -| Promise\ | 公共事件的结果数据。 | +| Promise\ | 公共事件的数据。 | **示例：** ```ts -var subscriber; //创建成功的订阅者对象 +let subscriber; //创建成功的订阅者对象 subscriber.getData().then((Data) => { console.info("getData " + JSON.stringify(Data)); @@ -789,21 +620,21 @@ subscriber.getData().then((Data) => { setData(data: string, callback: AsyncCallback\): void -设置公共事件的结果数据（callback形式）。 +以回调形式设置公共事件的数据。 -**系统能力**：SystemCapability.Notification.CommonEvent +**系统能力**：`SystemCapability.Notification.CommonEvent` **参数：** | 参数名 | 类型 | 必填 | 说明 | | -------- | -------------------- | ---- | -------------------- | -| data | string | 是 | 公共事件的结果数据。 | +| data | string | 是 | 公共事件的数据。 | | callback | AsyncCallback\ | 是 | 表示被指定的回调方法。 | **示例：** ```ts -var subscriber; //创建成功的订阅者对象 +let subscriber; //创建成功的订阅者对象 //设置有序公共事件的结果数据回调 function setDataCallback(err) { @@ -818,17 +649,19 @@ subscriber.setData("publish_data_changed", setDataCallback); ### setData -setData(data: string): Promise\ +```ts +setData(data: string): Promise +``` -设置公共事件的结果数据（Promise形式）。 +以Promise形式设置公共事件的果数据。 -**系统能力**：SystemCapability.Notification.CommonEvent +**系统能力**：`SystemCapability.Notification.CommonEvent` **参数：** | 参数名 | 类型 | 必填 | 说明 | | ------ | ------ | ---- | -------------------- | -| data | string | 是 | 公共事件的结果数据。 | +| data | string | 是 | 公共事件的数据。 | **返回值：** @@ -839,7 +672,7 @@ setData(data: string): Promise\ **示例：** ```ts -var subscriber; //创建成功的订阅者对象 +let subscriber; //创建成功的订阅者对象 subscriber.setData("publish_data_changed").then(() => { console.info("setData"); @@ -850,26 +683,28 @@ subscriber.setData("publish_data_changed").then(() => { ### setCodeAndData -setCodeAndData(code: number, data: string, callback:AsyncCallback\): void +```ts +setCodeAndData(code: number, data: string, callback:AsyncCallback): void +``` -设置公共事件的结果代码和结果数据（callback形式）。 +以回调形式设置公共事件代码和数据。 -**系统能力**：SystemCapability.Notification.CommonEvent +**系统能力**：`SystemCapability.Notification.CommonEvent` **参数：** | 参数名 | 类型 | 必填 | 说明 | | -------- | -------------------- | ---- | ---------------------- | -| code | number | 是 | 公共事件的结果代码。 | -| data | string | 是 | 公共事件的结果数据。 | +| code | number | 是 | 公共事件的代码。 | +| data | string | 是 | 公共事件的数据。 | | callback | AsyncCallback\ | 是 | 表示被指定的回调方法。 | **示例：** ```ts -var subscriber; //创建成功的订阅者对象 +let subscriber; //创建成功的订阅者对象 -//设置有序公共事件的结果代码和结果数据回调 +//设置有序公共事件的代码和数据回调 function setCodeDataCallback(err) { if (err.code) { console.error("setCodeAndData failed " + JSON.stringify(err)); @@ -882,29 +717,31 @@ subscriber.setCodeAndData(1, "publish_data_changed", setCodeDataCallback); ### setCodeAndData -setCodeAndData(code: number, data: string): Promise\ +```ts +setCodeAndData(code: number, data: string): Promise +``` -设置公共事件的结果代码和结果数据（Promise形式）。 +以Promise形式设置公共事件的代码和数据。 -**系统能力**：SystemCapability.Notification.CommonEvent +**系统能力**：`SystemCapability.Notification.CommonEvent` **参数：** | 参数名 | 类型 | 必填 | 说明 | | ------ | ------ | ---- | -------------------- | -| code | number | 是 | 公共事件的结果代码。 | -| data | string | 是 | 公共事件的结果数据。 | +| code | number | 是 | 公共事件的代码。 | +| data | string | 是 | 公共事件的数据。 | **返回值：** | 类型 | 说明 | | ---------------- | -------------------- | -| Promise\ | 返回一个Promise的结果。 | +| Promise\ | 返回一个Promise。 | **示例：** ```ts -var subscriber; //创建成功的订阅者对象 +let subscriber; //创建成功的订阅者对象 subscriber.setCodeAndData(1, "publish_data_changed").then(() => { console.info("setCodeAndData"); @@ -915,13 +752,15 @@ subscriber.setCodeAndData(1, "publish_data_changed").then(() => { ### isOrderedCommonEvent -isOrderedCommonEvent(callback: AsyncCallback\): void +```ts +isOrderedCommonEvent(callback: AsyncCallback): void +``` -查询当前公共事件的是否为有序公共事件（callback形式）。 +以回调形式查询当前公共事件的是否为有序公共事件。 返回true代表是有序公共事件，false代表不是有序公共事件。 -**系统能力**：SystemCapability.Notification.CommonEvent +**系统能力**：`SystemCapability.Notification.CommonEvent` **参数：** @@ -932,7 +771,7 @@ isOrderedCommonEvent(callback: AsyncCallback\): void **示例：** ```ts -var subscriber; //创建成功的订阅者对象 +let subscriber; //创建成功的订阅者对象 //获取当前公共事件是否为有序事件的回调 function isOrderedCallback(err, isOrdered) { @@ -947,13 +786,15 @@ subscriber.isOrderedCommonEvent(isOrderedCallback); ### isOrderedCommonEvent +```ts isOrderedCommonEvent(): Promise\ +``` -查询当前公共事件的是否为有序公共事件（Promise形式）。 +以Promise形式查询当前公共事件的是否为有序公共事件。 返回true代表是有序公共事件，false代表不是有序公共事件。 -**系统能力**：SystemCapability.Notification.CommonEvent +**系统能力**：`SystemCapability.Notification.CommonEvent` **返回值：** @@ -964,7 +805,7 @@ isOrderedCommonEvent(): Promise\ **示例：** ```ts -var subscriber; //创建成功的订阅者对象 +let subscriber; //创建成功的订阅者对象 subscriber.isOrderedCommonEvent().then((isOrdered) => { console.info("isOrdered " + JSON.stringify(isOrdered)); @@ -975,13 +816,15 @@ subscriber.isOrderedCommonEvent().then((isOrdered) => { ### isStickyCommonEvent -isStickyCommonEvent(callback: AsyncCallback\): void +```ts +isStickyCommonEvent(callback: AsyncCallback): void +``` -检查当前公共事件是否为一个粘性事件（callback形式）。 +以回调形式检查当前公共事件是否为一个粘性事件。 返回true代表是粘性公共事件，false代表不是粘性公共事件。 -**系统能力**：SystemCapability.Notification.CommonEvent +**系统能力**：`SystemCapability.Notification.CommonEvent` **参数：** @@ -992,7 +835,7 @@ isStickyCommonEvent(callback: AsyncCallback\): void **示例：** ```ts -var subscriber; //创建成功的订阅者对象 +let subscriber; //创建成功的订阅者对象 //获取当前公共事件是否为粘性事件的回调 function isStickyCallback(err, isSticky) { @@ -1007,13 +850,15 @@ subscriber.isStickyCommonEvent(isStickyCallback); ### isStickyCommonEvent -isStickyCommonEvent(): Promise\ +```ts +isStickyCommonEvent(): Promise +``` -检查当前公共事件是否为一个粘性事件（Promise形式）。 +以Promise形式检查当前公共事件是否为一个粘性事件。 返回true代表是粘性公共事件，false代表不是粘性公共事件。 -**系统能力**：SystemCapability.Notification.CommonEvent +**系统能力**：`SystemCapability.Notification.CommonEvent` **返回值：** @@ -1024,7 +869,7 @@ isStickyCommonEvent(): Promise\ **示例：** ```ts -var subscriber; //创建成功的订阅者对象 +let subscriber; //创建成功的订阅者对象 subscriber.isStickyCommonEvent().then((isSticky) => { console.info("isSticky " + JSON.stringify(isSticky)); @@ -1035,22 +880,24 @@ subscriber.isStickyCommonEvent().then((isSticky) => { ### abortCommonEvent -abortCommonEvent(callback: AsyncCallback\): void +```ts +abortCommonEvent(callback: AsyncCallback): void +``` -取消当前的公共事件，仅对有序公共事件有效，取消后，公共事件不再向下一个订阅者传递（callback形式）。 +以回调形式取消当前的有序公共事件，取消后，有序公共事件不再向下一个订阅者传递。 -**系统能力**：SystemCapability.Notification.CommonEvent +**系统能力**：`SystemCapability.Notification.CommonEvent` **参数：** | 参数名 | 类型 | 必填 | 说明 | | -------- | -------------------- | ---- | -------------------- | -| callback | AsyncCallback\ | 是 | 取消当前的公共事件。 | +| callback | AsyncCallback\ | 是 | 取消当前的有序公共事件。 | **示例：** ```ts -var subscriber; //创建成功的订阅者对象 +let subscriber; //创建成功的订阅者对象 //取消当前有序公共事件的回调 function abortCallback(err) { @@ -1065,11 +912,13 @@ subscriber.abortCommonEvent(abortCallback); ### abortCommonEvent -abortCommonEvent(): Promise\ +```ts +abortCommonEvent(): Promise +``` -取消当前的公共事件，仅对有序公共事件有效，取消后，公共事件不再向下一个订阅者传递（Promise形式）。 +以Promise形式取消当前的有序公共事件，取消后，公共事件不再向下一个订阅者传递。 -**系统能力**：SystemCapability.Notification.CommonEvent +**系统能力**：`SystemCapability.Notification.CommonEvent` **返回值：** @@ -1080,7 +929,7 @@ abortCommonEvent(): Promise\ **示例：** ```ts -var subscriber; //创建成功的订阅者对象 +let subscriber; //创建成功的订阅者对象 subscriber.abortCommonEvent().then(() => { console.info("abortCommonEvent"); @@ -1091,11 +940,13 @@ subscriber.abortCommonEvent().then(() => { ### clearAbortCommonEvent -clearAbortCommonEvent(callback: AsyncCallback\): void +```ts +clearAbortCommonEvent(callback: AsyncCallback): void +``` -清除当前公共事件的取消状态，仅对有序公共事件有效（callback形式）。 +以回调形式清除当前有序公共事件。 -**系统能力**：SystemCapability.Notification.CommonEvent +**系统能力**：`SystemCapability.Notification.CommonEvent` **参数：** @@ -1106,7 +957,7 @@ clearAbortCommonEvent(callback: AsyncCallback\): void **示例：** ```ts -var subscriber; //创建成功的订阅者对象 +let subscriber; //创建成功的订阅者对象 //清除当前公共事件取消状态的回调 function clearAbortCallback(err) { @@ -1121,11 +972,13 @@ subscriber.clearAbortCommonEvent(clearAbortCallback); ### clearAbortCommonEvent -clearAbortCommonEvent(): Promise\ +```ts +clearAbortCommonEvent(): Promise +``` -清除当前公共事件的取消状态，仅对有序公共事件有效（Promise形式）。 +以Promise形式清除当前有序公共事件。 -**系统能力**：SystemCapability.Notification.CommonEvent +**系统能力**：`SystemCapability.Notification.CommonEvent` **返回值：** @@ -1136,7 +989,7 @@ clearAbortCommonEvent(): Promise\ **示例：** ```ts -var subscriber; //创建成功的订阅者对象 +let subscriber; //创建成功的订阅者对象 subscriber.clearAbortCommonEvent().then(() => { console.info("clearAbortCommonEvent"); @@ -1147,11 +1000,13 @@ subscriber.clearAbortCommonEvent().then(() => { ### getAbortCommonEvent -getAbortCommonEvent(callback: AsyncCallback\): void +```ts +getAbortCommonEvent(callback: AsyncCallback): void +``` -获取当前有序公共事件是否取消的状态（callback形式）。 +以回调形式获取当前有序公共事件是否取消的状态。 -**系统能力**：SystemCapability.Notification.CommonEvent +**系统能力**：`SystemCapability.Notification.CommonEvent` **参数：** @@ -1162,7 +1017,7 @@ getAbortCommonEvent(callback: AsyncCallback\): void **示例：** ```ts -var subscriber; //创建成功的订阅者对象 +let subscriber; //创建成功的订阅者对象 //获取当前有序公共事件是否取消的回调 function getAbortCallback(err, AbortCommonEvent) { @@ -1177,11 +1032,13 @@ subscriber.getAbortCommonEvent(getAbortCallback); ### getAbortCommonEvent -getAbortCommonEvent(): Promise\ +```ts +getAbortCommonEvent(): Promise +``` -获取当前有序公共事件是否取消的状态（Promise形式）。 +以Promise形式获取当前有序公共事件是否取消的状态。 -**系统能力**：SystemCapability.Notification.CommonEvent +**系统能力**：`SystemCapability.Notification.CommonEvent` **返回值：** @@ -1192,7 +1049,7 @@ getAbortCommonEvent(): Promise\ **示例：** ```ts -var subscriber; //创建成功的订阅者对象 +let subscriber; //创建成功的订阅者对象 subscriber.getAbortCommonEvent().then((AbortCommonEvent) => { console.info("AbortCommonEvent " + JSON.stringify(AbortCommonEvent)); @@ -1205,9 +1062,9 @@ subscriber.getAbortCommonEvent().then((AbortCommonEvent) => { getSubscribeInfo(callback: AsyncCallback\): void -获取订阅者的订阅信息（callback形式）。 +以回调形式获取订阅者的订阅信息。 -**系统能力**：SystemCapability.Notification.CommonEvent +**系统能力**：`SystemCapability.Notification.CommonEvent` **参数：** @@ -1218,7 +1075,7 @@ getSubscribeInfo(callback: AsyncCallback\): void **示例：** ```ts -var subscriber; //创建成功的订阅者对象 +let subscriber; //创建成功的订阅者对象 //获取订阅者信息回调 function getSubscribeInfoCallback(err, SubscribeInfo) { @@ -1233,11 +1090,13 @@ subscriber.getSubscribeInfo(getSubscribeInfoCallback); ### getSubscribeInfo -getSubscribeInfo(): Promise\ +```ts +getSubscribeInfo(): Promise +``` -获取订阅者的订阅信息（Promise形式）。 +以Promise形式获取订阅者的订阅信息。 -**系统能力**：SystemCapability.Notification.CommonEvent +**系统能力**：`SystemCapability.Notification.CommonEvent` **返回值：** @@ -1248,7 +1107,7 @@ getSubscribeInfo(): Promise\ **示例：** ```ts -var subscriber; //创建成功的订阅者对象 +let subscriber; //创建成功的订阅者对象 subscriber.getSubscribeInfo().then((SubscribeInfo) => { console.info("SubscribeInfo " + JSON.stringify(SubscribeInfo)); @@ -1259,11 +1118,13 @@ subscriber.getSubscribeInfo().then((SubscribeInfo) => { ### finishCommonEvent9+ -finishCommonEvent(callback: AsyncCallback\): void +```ts +finishCommonEvent(callback: AsyncCallback): void +``` -结束当前有序公共事件（callback形式）。 +以回调形式结束当前有序公共事件。 -**系统能力**：SystemCapability.Notification.CommonEvent +**系统能力**：`SystemCapability.Notification.CommonEvent` **参数：** @@ -1274,7 +1135,7 @@ finishCommonEvent(callback: AsyncCallback\): void **示例：** ```ts -var subscriber; //创建成功的订阅者对象 +let subscriber; //创建成功的订阅者对象 //结束当前有序公共事件的回调 function finishCommonEventCallback(err) { @@ -1289,11 +1150,13 @@ subscriber.finishCommonEvent(finishCommonEventCallback); ### finishCommonEvent9+ -finishCommonEvent(): Promise\ +```ts +finishCommonEvent(): Promise +``` -结束当前有序公共事件（Promise形式）。 +以Promise形式结束当前有序公共事件。 -**系统能力**：SystemCapability.Notification.CommonEvent +**系统能力**：`SystemCapability.Notification.CommonEvent` **返回值：** @@ -1304,7 +1167,7 @@ finishCommonEvent(): Promise\ **示例：** ```ts -var subscriber; //创建成功的订阅者对象 +let subscriber; //创建成功的订阅者对象 subscriber.finishCommonEvent().then(() => { console.info("FinishCommonEvent"); @@ -1315,7 +1178,7 @@ subscriber.finishCommonEvent().then(() => { ## CommonEventData -**系统能力：** 以下各项对应的系统能力均为SystemCapability.Notification.CommonEvent +**系统能力：** `SystemCapability.Notification.CommonEvent` | 名称 | 类型 | 可读 | 可写 | 说明 | | ---------- |-------------------- | ---- | ---- | ------------------------------------------------------- | @@ -1328,7 +1191,7 @@ subscriber.finishCommonEvent().then(() => { ## CommonEventPublishData -**系统能力：** 以下各项对应的系统能力均为SystemCapability.Notification.CommonEvent +**系统能力：** `SystemCapability.Notification.CommonEvent` | 名称 | 类型 | 可读 | 可写 | 说明 | | --------------------- | -------------------- | ---- | ---- | ---------------------------- | @@ -1342,7 +1205,7 @@ subscriber.finishCommonEvent().then(() => { ## CommonEventSubscribeInfo -**系统能力：** 以下各项对应的系统能力均为SystemCapability.Notification.CommonEvent +**系统能力：** `SystemCapability.Notification.CommonEvent` | 名称 | 类型 | 可读 | 可写 | 说明 | | ------------------- | -------------- | ---- | ---- | ------------------------------------------------------------ | diff --git a/zh-cn/application-dev/reference/apis/js-apis-emitter.md b/zh-cn/application-dev/reference/apis/js-apis-emitter.md index 4786ae44ed466b70363b84b79a28c75378c95f16..f39eb0f958399207a3398e56cb67edb2cb2a4508 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-emitter.md +++ b/zh-cn/application-dev/reference/apis/js-apis-emitter.md @@ -1,10 +1,12 @@ # @ohos.events.emitter (Emitter) -本模块提供发送和处理进程内事件的能力，包括对持续订阅事件或单次订阅事件的处理，取消订阅事件，发送事件到事件队列。 +本模块提供了在同一进程不同线程间，或同一进程同一线程内，发送和处理事件的能力，包括持续订阅事件、单次订阅事件、取消订阅事件，以及发送事件到事件队列的能力。 > **说明：** > -> 本模块首批接口从API version 7开始支持。 +> 本模块首批接口从API version 7开始支持。后续版本新增接口，采用上角标单独标记接口的起始版本。 +> +> 本模块接口在FA模型及Stage模型下均可使用。 ## 导入模块 @@ -14,22 +16,22 @@ import emitter from '@ohos.events.emitter' ## 权限列表 -无 +无权限要求。 ## emitter.on on(event: [InnerEvent](#innerevent), callback: Callback\<[EventData](#eventdata)\>): void -持续订阅某个事件以及接收事件的回调处理。 +持续订阅指定的事件，并在接收到该事件时，执行对应的回调处理函数。 -**系统能力**: SystemCapability.Notification.Emitter +**系统能力**: `SystemCapability.Notification.Emitter` **参数：** -| 参数名 | 类型 | 必填 | 说明 | -| -------- | ----------------------------------- | ---- | --------------------------------------- | -| event | [InnerEvent](#innerevent) | 是 | 持续订阅的事件，其中EventPriority不生效 | -| callback | Callback\<[EventData](#eventdata)\> | 是 | 接收订阅事件时的回调处理 | +| 参数名 | 类型 | 必填 | 说明 | +| -------- | ----------------------------------- | ---- | ------------------------------------------------------ | +| event | [InnerEvent](#innerevent) | 是 | 持续订阅的事件，其中[EventPriority](#eventpriority)，在订阅事件时无需指定，也不生效 | +| callback | Callback\<[EventData](#eventdata)\> | 是 | 接收到该事件时需要执行的回调处理函数 | **示例：** @@ -37,26 +39,28 @@ on(event: [InnerEvent](#innerevent), callback: Callback\<[EventData](#eventdata) let innerEvent = { eventId: 1 }; -function EmitterCallback(eventData) { + +// 收到eventId为1的事件后执行该回调函数 +function emitterCallback() { console.info('callback'); } -emitter.on(innerEvent, EmitterCallback); +emitter.on(innerEvent, emitterCallback); ``` ## emitter.once once(event: [InnerEvent](#innerevent), callback: Callback\<[EventData](#eventdata)\>): void -单次订阅某个事件以及接收事件的回调处理，接收到回调处理后自动取消订阅。 +单次订阅指定的事件，并在接收到该事件并执行完相应的回调函数后，自动取消订阅。 -**系统能力**: SystemCapability.Notification.Emitter +**系统能力**: `SystemCapability.Notification.Emitter` **参数：** -| 参数名 | 类型 | 必填 | 说明 | -| -------- | ----------------------------------- | ---- | --------------------------------------- | -| event | [InnerEvent](#innerevent) | 是 | 单次订阅的事件，其中EventPriority不生效 | -| callback | Callback\<[EventData](#eventdata)\> | 是 | 接收订阅事件时的回调处理 | +| 参数名 | 类型 | 必填 | 说明 | +| -------- | ----------------------------------- | ---- | ------------------------------------------------------------------------------ | +| event | [InnerEvent](#innerevent) | 是 | 单次订阅的事件，其中[EventPriority](#eventpriority)，在订阅事件时无需指定，也不生效 | +| callback | Callback\<[EventData](#innerevent)\> | 是 | 接收到该事件时需要执行的回调处理函数 | **示例：** @@ -64,19 +68,21 @@ once(event: [InnerEvent](#innerevent), callback: Callback\<[EventData](#eventdat let innerEvent = { eventId: 1 }; -function EmitterCallback(eventData) { + +// 收到eventId为1的事件后执行该回调函数 +function emitterCallback() { console.info('once callback'); }; -emitter.once(innerEvent, EmitterCallback); +emitter.once(innerEvent, emitterCallback); ``` ## emitter.off off(eventId: number): void -取消订阅某个事件。 +取消所有针对该事件ID的订阅。 -**系统能力**: SystemCapability.Notification.Emitter +**系统能力**: `SystemCapability.Notification.Emitter` **参数：** @@ -92,17 +98,17 @@ emitter.off(1); ## emitter.emit -emit(event: InnerEvent, data?: EventData): void +emit(event: [InnerEvent](#innerevent), data?: [EventData](#eventdata)): void -发送一个事件到事件队列。 +发送指定的事件。 -**系统能力**: SystemCapability.Notification.Emitter +**系统能力**: `SystemCapability.Notification.Emitter` **参数：** | 参数名 | 类型 | 必填 | 说明 | -| ------ | ------------------------- | ---- | -------------- | -| event | [InnerEvent](#innerevent) | 是 | 发送的事件 | +| ------ | ------------------------- | ---- | ------------- | +| event | [InnerEvent](#innerevent) | 是 | 发送的事件，其中[EventPriority](#eventpriority)用于指定事件被发送的优先级 | | data | [EventData](#eventdata) | 否 | 事件携带的数据 | **示例：** @@ -112,43 +118,46 @@ let eventData = { data: { "content": "c", "id": 1, - }}; + } +}; + let innerEvent = { eventId: 1, priority: emitter.EventPriority.HIGH }; + emitter.emit(innerEvent, eventData); ``` ## EventPriority -用于表示事件被投递的优先级。 +用于表示事件被发送的优先级。 -**系统能力**: 以下各项对应的系统能力均为 SystemCapability.Notification.Emitter +**系统能力**: `SystemCapability.Notification.Emitter` -| 名称 | 值 | 说明 | +| 名称 | 值 | 说明 | | --------- | ---- | --------------------------------------------------- | -| IMMEDIATE | 0 | 表示事件被立即投递。 | -| HIGH | 1 | 表示事件先于LOW优先级投递。 | -| LOW | 2 | 表示事件优于IDLE优先级投递，事件的默认优先级是LOW。 | -| IDLE | 3 | 表示在没有其他事件的情况下，才投递该事件。 | +| IMMEDIATE | 0 | 表示事件被立即投递。 | +| HIGH | 1 | 表示事件先于LOW优先级投递。 | +| LOW | 2 | 表示事件优于IDLE优先级投递，事件的默认优先级是LOW。 | +| IDLE | 3 | 表示在没有其他事件的情况下，才投递该事件。 | ## InnerEvent -进程内的事件。 +订阅或发送的事件，订阅事件时`EventPriority`不生效。 -**系统能力**: 以下各项对应的系统能力均为 SystemCapability.Notification.Emitter +**系统能力**: `SystemCapability.Notification.Emitter` -| 名称 | 类型 | 可读 | 可写 | 说明 | -| -------- | ------------------------------- | ---- | ---- | ---------------------------------- | -| eventId | number | 是 | 是 | 事件的ID，由开发者定义用来辨别事件。 | -| priority | [EventPriority](#eventpriority) | 是 | 是 | 事件被投递的优先级。 | +| 名称 | 类型 | 可读 | 可写 | 说明 | +| -------- | ------------------------------- | ---- | ---- | ------------------------------ | +| eventId | number | 是 | 是 | 事件ID，由开发者定义用来辨别事件。 | +| priority | [EventPriority](#eventpriority) | 是 | 是 | 事件被投递的优先级。 | ## EventData 发送事件时传递的数据。 -**系统能力**: 以下各项对应的系统能力均为 SystemCapability.Notification.Emitter +**系统能力**: `SystemCapability.Notification.Emitter` | 名称 | 类型 | 可读 | 可写 | 说明 | | ---- | ------------------ | ---- | ---- | -------------- | diff --git a/zh-cn/application-dev/reference/apis/js-apis-reminderAgent.md b/zh-cn/application-dev/reference/apis/js-apis-reminderAgent.md index 8092ac7b926a187f7067b4c7fc79bb480f5e6056..31fc0ae471ca37a8872d4d4c7bb26837f3569cd8 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-reminderAgent.md +++ b/zh-cn/application-dev/reference/apis/js-apis-reminderAgent.md @@ -2,7 +2,7 @@ 本模块提供后台代理提醒的能力。 -开发应用时，开发者可以调用后台提醒发布的接口创建定时提醒，包括倒计时、日历、闹钟三种提醒类型。使用后台代理提醒能力后，应用可以被冻结或退出，计时和弹出提醒的功能将被后台系统服务代理。 +开发应用时，开发者可以调用相关接口创建定时提醒，包括倒计时、日历、闹钟这三类提醒类型。使用后台代理提醒能力后，应用被冻结或退出后，计时和弹出提醒的功能将被后台系统服务代理。 > **说明：** > @@ -13,34 +13,37 @@ ## 导入模块 -```js +```ts import reminderAgent from'@ohos.reminderAgent'; ``` ## reminderAgent.publishReminder -publishReminder(reminderReq: ReminderRequest, callback: AsyncCallback<number>): void +```ts +publishReminder(reminderReq: ReminderRequest, callback: AsyncCallback): void +``` -发布一个后台代理提醒，使用callback方式实现异步调用，该方法需要申请通知弹窗[Notification.requestEnableNotification](js-apis-notification.md#notificationrequestenablenotification8)后才能调用。 +发布一个后台代理提醒，使用回调的方式实现异步调用，该方法需要申请通知弹窗权限[Notification.requestEnableNotification](js-apis-notification.md#notificationrequestenablenotification8)后才能调用。 -**需要权限**： ohos.permission.PUBLISH_AGENT_REMINDER +**需要权限**： `ohos.permission.PUBLISH_AGENT_REMINDER` -**系统能力**： SystemCapability.Notification.ReminderAgent +**系统能力**： `SystemCapability.Notification.ReminderAgent` **参数**： | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | | reminderReq | [ReminderRequest](#reminderrequest) | 是 | 需要发布的提醒实例。 | - | callback | AsyncCallback<number> | 是 | 异步回调，返回当前发布的提醒的reminderId。 | + | callback | AsyncCallback\ | 是 | 异步回调，返回当前发布的提醒的id。 | **示例**： -```js +```ts let timer = { reminderType: reminderAgent.ReminderType.REMINDER_TYPE_TIMER, triggerTimeInSeconds: 10 } + reminderAgent.publishReminder(timer, (err, reminderId) => { console.log("callback, reminderId = " + reminderId); }); @@ -49,13 +52,15 @@ publishReminder(reminderReq: ReminderRequest, callback: AsyncCallback<number& ## reminderAgent.publishReminder -publishReminder(reminderReq: ReminderRequest): Promise<number> +```ts +publishReminder(reminderReq: ReminderRequest): Promise +``` -发布一个后台代理提醒，使用Promise方式实现异步调用，该方法需要申请通知弹窗[Notification.requestEnableNotification](js-apis-notification.md#notificationrequestenablenotification8)后才能调用。 +发布一个后台代理提醒，使用Promise方式实现异步调用，该方法需要申请通知弹窗权限[Notification.requestEnableNotification](js-apis-notification.md#notificationrequestenablenotification8)后才能调用。 -**需要权限**： ohos.permission.PUBLISH_AGENT_REMINDER +**需要权限**： `ohos.permission.PUBLISH_AGENT_REMINDER` -**系统能力**： SystemCapability.Notification.ReminderAgent +**系统能力**： `SystemCapability.Notification.ReminderAgent` **参数**： | 参数名 | 类型 | 必填 | 说明 | @@ -65,14 +70,15 @@ publishReminder(reminderReq: ReminderRequest): Promise<number> **返回值**： | 类型 | 说明 | | -------- | -------- | - | Promise<number> | 返回提醒的reminderId。 | + | Promise\ | 返回提醒的Id。 | **示例**： -```js +```ts let timer = { reminderType: reminderAgent.ReminderType.REMINDER_TYPE_TIMER, triggerTimeInSeconds: 10 } + reminderAgent.publishReminder(timer).then((reminderId) => { console.log("promise, reminderId = " + reminderId); }); @@ -81,22 +87,24 @@ publishReminder(reminderReq: ReminderRequest): Promise<number> ## reminderAgent.cancelReminder -cancelReminder(reminderId: number, callback: AsyncCallback<void>): void +```ts +cancelReminder(reminderId: number, callback: AsyncCallback): void +``` -取消指定id的提醒，使用callback方式实现异步调用。 +取消指定id的提醒，使用回调的方式实现异步调用。 -**系统能力**： SystemCapability.Notification.ReminderAgent +**系统能力**： `SystemCapability.Notification.ReminderAgent` **参数**： | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | | reminderId | number | 是 | 目标reminder的id号，[publishReminder](#reminderagentpublishreminder)方法调用成功后获得。 | -| callback | AsyncCallback<void> | 是 | 异步回调。 | +| callback | AsyncCallback\ | 是 | 异步回调。 | **示例**： -```js +```ts reminderAgent.cancelReminder(1, (err, data) => { console.log("cancelReminder callback"); }); @@ -105,11 +113,13 @@ reminderAgent.cancelReminder(1, (err, data) => { ## reminderAgent.cancelReminder -cancelReminder(reminderId: number): Promise<void> +```ts +cancelReminder(reminderId: number): Promise +``` 取消指定id的提醒，使用Promise方式实现异步调用。 -**系统能力**： SystemCapability.Notification.ReminderAgent +**系统能力**： `SystemCapability.Notification.ReminderAgent` **参数**： @@ -121,34 +131,35 @@ cancelReminder(reminderId: number): Promise<void> | 类型 | 说明 | | -------- | -------- | -| Promise<void> | Promise类型异步回调。 | +| Promise\ | Promise类型异步回调。 | **示例**： -```js +```ts reminderAgent.cancelReminder(1).then(() => { console.log("cancelReminder promise"); }); ``` - ## reminderAgent.getValidReminders -getValidReminders(callback: AsyncCallback<Array<ReminderRequest>>): void +```ts +getValidReminders(callback: AsyncCallback>): void +``` -获取当前应用已设置的所有有效（未过期）的提醒，使用callback方式实现异步调用。 +获取当前应用已设置的所有有效（未过期）的提醒，使用回调的方式实现异步调用。 -**系统能力**： SystemCapability.Notification.ReminderAgent +**系统能力**： `SystemCapability.Notification.ReminderAgent` **参数**： | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | -| callback | AsyncCallback<Array<[ReminderRequest](#reminderrequest)>> | 是 | 异步回调，返回当前应用已设置的所有有效（未过期）的提醒。 | +| callback | AsyncCallback\\> | 是 | 异步回调，返回当前应用已设置的所有有效（未过期）的提醒。 | **示例**： -```js +```ts reminderAgent.getValidReminders((err, reminders) => { console.log("callback, getValidReminders length = " + reminders.length); for (let i = 0; i < reminders.length; i++) { @@ -178,21 +189,23 @@ reminderAgent.getValidReminders((err, reminders) => { ## reminderAgent.getValidReminders -getValidReminders(): Promise<Array<ReminderRequest>> +```ts +getValidReminders(): Promise> +``` 获取当前应用已设置的所有有效（未过期）的提醒，使用Promise方式实现异步调用。 -**系统能力**： SystemCapability.Notification.ReminderAgent +**系统能力**： `SystemCapability.Notification.ReminderAgent` **返回值**： | 类型 | 说明 | | -------- | -------- | -| Promise<Array<[ReminderRequest](#reminderrequest)>> | 返回当前应用已设置的所有有效（未过期）的提醒。 | +| Promise\\> | 返回当前应用已设置的所有有效（未过期）的提醒。 | **示例**： -```js +```ts reminderAgent.getValidReminders().then((reminders) => { console.log("promise, getValidReminders length = " + reminders.length); for (let i = 0; i < reminders.length; i++) { @@ -222,21 +235,23 @@ reminderAgent.getValidReminders().then((reminders) => { ## reminderAgent.cancelAllReminders -cancelAllReminders(callback: AsyncCallback<void>): void +```ts +cancelAllReminders(callback: AsyncCallback): void +``` -取消当前应用所有的提醒，使用callback方式实现异步调用。 +取消当前应用所有的提醒，使用回调的方式实现异步调用。 -**系统能力**： SystemCapability.Notification.ReminderAgent +**系统能力**： `SystemCapability.Notification.ReminderAgent` **参数**： | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | -| callback | AsyncCallback<void> | 是 | 异步回调。 | +| callback | AsyncCallback\ | 是 | 异步回调。 | **示例**： -```js +```ts reminderAgent.cancelAllReminders((err, data) =>{ console.log("cancelAllReminders callback") }) @@ -245,45 +260,48 @@ reminderAgent.cancelAllReminders((err, data) =>{ ## reminderAgent.cancelAllReminders -cancelAllReminders(): Promise<void> +```ts +cancelAllReminders(): Promise +``` 取消当前应用所有的提醒，使用Promise方式实现异步调用。 -**系统能力**： SystemCapability.Notification.ReminderAgent +**系统能力**： `SystemCapability.Notification.ReminderAgent` **返回值**： | 类型 | 说明 | | -------- | -------- | -| Promise<void> | Promise类型异步回调。 | +| Promise\ | Promise类型异步回调。 | **示例**： -```js +```ts reminderAgent.cancelAllReminders().then(() => { console.log("cancelAllReminders promise") }) ``` - ## reminderAgent.addNotificationSlot -addNotificationSlot(slot: NotificationSlot, callback: AsyncCallback<void>): void +```ts +addNotificationSlot(slot: NotificationSlot, callback: AsyncCallback): void +``` -添加一个NotificationSlot，使用callback方式实现异步调用。 +添加一个NotificationSlot，使用回调的方式实现异步调用。 -**系统能力**： SystemCapability.Notification.ReminderAgent +**系统能力**： `SystemCapability.Notification.ReminderAgent` **参数**： | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | -| slot | [NotificationSlot](js-apis-notification.md#notificationslot) | 是 | notification slot实例，仅支持设置其type属性。 | -| callback | AsyncCallback<void> | 是 | 异步回调。 | +| slot | [NotificationSlot](js-apis-notification.md#notificationslot) | 是 | notification\.slot实例，仅支持设置其type属性。 | +| callback | AsyncCallback\ | 是 | 异步回调。 | **示例**： -```js +```ts import notification from '@ohos.notification' let mySlot = { @@ -297,27 +315,29 @@ reminderAgent.addNotificationSlot(mySlot, (err, data) => { ## reminderAgent.addNotificationSlot -addNotificationSlot(slot: NotificationSlot): Promise<void> +```ts +addNotificationSlot(slot: NotificationSlot): Promise +``` 添加一个NotificationSlot，使用Promise方式实现异步调用。 -**系统能力**： SystemCapability.Notification.ReminderAgent +**系统能力**： `SystemCapability.Notification.ReminderAgent` **参数**： | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | -| slot | [NotificationSlot](js-apis-notification.md#notificationslot) | 是 | notification slot实例，仅支持设置其type属性。 | +| slot | [NotificationSlot](js-apis-notification.md#notificationslot) | 是 | notification\.slot实例，仅支持设置其type属性。 | **返回值**： | 类型 | 说明 | | -------- | -------- | -| Promise<void> | Promise类型异步回调。 | +| Promise\ | Promise类型异步回调。 | **示例**： -```js +```ts import notification from '@ohos.notification' let mySlot = { @@ -331,22 +351,24 @@ reminderAgent.addNotificationSlot(mySlot).then(() => { ## reminderAgent.removeNotificationSlot -removeNotificationSlot(slotType: notification.SlotType, callback: AsyncCallback<void>): void +```ts +removeNotificationSlot(slotType: notification.SlotType, callback: AsyncCallback): void +``` 删除目标NotificationSlot，使用callback方式实现异步调用。 -**系统能力**： SystemCapability.Notification.ReminderAgent +**系统能力**： `SystemCapability.Notification.ReminderAgent` **参数**： | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | -| slotType | [notification.SlotType](js-apis-notification.md#slottype) | 是 | 目标notification slot的类型。 | -| callback | AsyncCallback<void> | 是 | 异步回调。 | +| slotType | [notification.SlotType](js-apis-notification.md#slottype) | 是 | 目标notification\.slot的类型。 | +| callback | AsyncCallback\ | 是 | 异步回调。 | **示例**： -```js +```ts import notification from '@ohos.notification' reminderAgent.removeNotificationSlot(notification.SlotType.CONTENT_INFORMATION, (err, data) => { @@ -357,27 +379,29 @@ reminderAgent.removeNotificationSlot(notification.SlotType.CONTENT_INFORMATION, ## reminderAgent.removeNotificationSlot -removeNotificationSlot(slotType: notification.SlotType): Promise<void> +```ts +removeNotificationSlot(slotType: notification.SlotType): Promise +``` 删除目标NotificationSlot，使用Promise方式实现异步调用。 -**系统能力**： SystemCapability.Notification.ReminderAgent +**系统能力**： `SystemCapability.Notification.ReminderAgent` **参数**： | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | -| slotType | [notification.SlotType](js-apis-notification.md#slottype) | 是 | 目标notification slot的类型。 | +| slotType | [notification.SlotType](js-apis-notification.md#slottype) | 是 | 目标notification\.slot的类型。 | **返回值**： | 类型 | 说明 | | -------- | -------- | -| Promise<void> | Promise类型异步回调。 | +| Promise\ | Promise类型异步回调。 | **示例**： -```js +```ts import notification from '@ohos.notification' reminderAgent.removeNotificationSlot(notification.SlotType.CONTENT_INFORMATION).then(() => { @@ -390,7 +414,7 @@ reminderAgent.removeNotificationSlot(notification.SlotType.CONTENT_INFORMATION). 按钮的类型。 -**系统能力**：以下各项对应的系统能力均为SystemCapability.Notification.ReminderAgent +**系统能力**：`SystemCapability.Notification.ReminderAgent` | 名称 | 值 | 说明 | | -------- | -------- | -------- | @@ -402,7 +426,7 @@ reminderAgent.removeNotificationSlot(notification.SlotType.CONTENT_INFORMATION). 提醒的类型。 -**系统能力**：以下各项对应的系统能力均为SystemCapability.Notification.ReminderAgent +**系统能力**：`SystemCapability.Notification.ReminderAgent` | 名称 | 值 | 说明 | | -------- | -------- | -------- | @@ -415,7 +439,7 @@ reminderAgent.removeNotificationSlot(notification.SlotType.CONTENT_INFORMATION). 用于设置弹出的提醒通知信息上显示的按钮类型和标题。 -**系统能力**：以下各项对应的系统能力均为SystemCapability.Notification.ReminderAgent +**系统能力**：`SystemCapability.Notification.ReminderAgent` | 名称 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | @@ -427,7 +451,7 @@ reminderAgent.removeNotificationSlot(notification.SlotType.CONTENT_INFORMATION). 点击提醒通知后跳转的目标ability信息。 -**系统能力**：以下各项对应的系统能力均为SystemCapability.Notification.ReminderAgent +**系统能力**：`SystemCapability.Notification.ReminderAgent` | 名称 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | @@ -439,7 +463,7 @@ reminderAgent.removeNotificationSlot(notification.SlotType.CONTENT_INFORMATION). 全屏显示提醒到达时自动拉起的目标ability信息，该接口预留。 -**系统能力**：以下各项对应的系统能力均为SystemCapability.Notification.ReminderAgent +**系统能力**：`SystemCapability.Notification.ReminderAgent` | 名称 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | @@ -451,7 +475,7 @@ reminderAgent.removeNotificationSlot(notification.SlotType.CONTENT_INFORMATION). 提醒实例对象，用于设置提醒类型、响铃时长等具体信息。 -**系统能力**：以下各项对应的系统能力均为SystemCapability.Notification.ReminderAgent +**系统能力**：`SystemCapability.Notification.ReminderAgent` | 名称 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | @@ -476,13 +500,13 @@ ReminderRequestCalendar extends ReminderRequest 日历实例对象，用于设置提醒的时间。 -**系统能力**：以下各项对应的系统能力均为SystemCapability.Notification.ReminderAgent +**系统能力**：`SystemCapability.Notification.ReminderAgent` | 名称 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | | dateTime | [LocalDateTime](#localdatetime) | 是 | 指明提醒的目标时间。 | -| repeatMonths | Array<number> | 否 | 指明重复提醒的月份。 | -| repeatDays | Array<number> | 否 | 指明重复提醒的日期。 | +| repeatMonths | Array\ | 否 | 指明重复提醒的月份。 | +| repeatDays | Array\ | 否 | 指明重复提醒的日期。 | ## ReminderRequestAlarm @@ -491,13 +515,13 @@ ReminderRequestAlarm extends ReminderRequest 闹钟实例对象，用于设置提醒的时间。 -**系统能力**：以下各项对应的系统能力均为SystemCapability.Notification.ReminderAgent +**系统能力**：`SystemCapability.Notification.ReminderAgent` | 名称 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | | hour | number | 是 | 指明提醒的目标时刻。 | | minute | number | 是 | 指明提醒的目标分钟。 | -| daysOfWeek | Array<number> | 否 | 指明每周哪几天需要重复提醒。范围为周一到周末，对应数字为1到7。 | +| daysOfWeek | Array\ | 否 | 指明每周哪几天需要重复提醒。范围为周一到周末，对应数字为1到7。 | ## ReminderRequestTimer @@ -506,7 +530,7 @@ ReminderRequestTimer extends ReminderRequest 倒计时实例对象，用于设置提醒的时间。 -**系统能力**：SystemCapability.Notification.ReminderAgent +**系统能力**：`SystemCapability.Notification.ReminderAgent` | 名称 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | @@ -517,7 +541,7 @@ ReminderRequestTimer extends ReminderRequest 用于日历类提醒设置时指定时间信息。 -**系统能力**：以下各项对应的系统能力均为SystemCapability.Notification.ReminderAgent +**系统能力**：`SystemCapability.Notification.ReminderAgent` | 名称 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | diff --git a/zh-cn/application-dev/reference/apis/js-apis-reminderAgentManager.md b/zh-cn/application-dev/reference/apis/js-apis-reminderAgentManager.md index bc10d5d090c7463b4bc75c5e2fc420385e560718..df65ad7e04d374e972c9a7a912a9d5829892a4b9 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-reminderAgentManager.md +++ b/zh-cn/application-dev/reference/apis/js-apis-reminderAgentManager.md @@ -2,7 +2,7 @@ 本模块提供后台代理提醒的能力。 -开发应用时，开发者可以调用后台提醒发布的接口创建定时提醒，包括倒计时、日历、闹钟三种提醒类型。使用后台代理提醒能力后，应用可以被冻结或退出，计时和弹出提醒的功能将被后台系统服务代理。 +开发应用时，开发者可以调用相关接口创建定时提醒，包括倒计时、日历、闹钟这三类提醒类型。使用后台代理提醒能力后，应用被冻结或退出后，计时和弹出提醒的功能将被后台系统服务代理。 > **说明：** > @@ -11,27 +11,29 @@ ## 导入模块 -``` +```ts import reminderAgentManager from'@ohos.reminderAgentManager'; ``` ## reminderAgentManager.publishReminder -publishReminder(reminderReq: ReminderRequest, callback: AsyncCallback<number>): void +```ts +publishReminder(reminderReq: ReminderRequest, callback: AsyncCallback): void +``` -发布一个后台代理提醒，使用callback方式实现异步调用，该方法需要申请通知弹窗[Notification.requestEnableNotification](js-apis-notification.md#notificationrequestenablenotification8)后才能调用。 +发布一个后台代理提醒，使用回调的方式实现异步调用，该方法需要申请通知弹窗权限[Notification.requestEnableNotification](js-apis-notification.md#notificationrequestenablenotification8)后才能调用。 -**需要权限**： ohos.permission.PUBLISH_AGENT_REMINDER +**需要权限**： `ohos.permission.PUBLISH_AGENT_REMINDER` -**系统能力**： SystemCapability.Notification.ReminderAgent +**系统能力**： `SystemCapability.Notification.ReminderAgent` **参数**： | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | | reminderReq | [ReminderRequest](#reminderrequest) | 是 | 需要发布的提醒实例。 | - | callback | AsyncCallback<number> | 是 | 异步回调，返回当前发布的提醒的reminderId。 | + | callback | AsyncCallback\ | 是 | 异步回调，返回当前发布的提醒的id。 | **错误码：** @@ -43,11 +45,12 @@ publishReminder(reminderReq: ReminderRequest, callback: AsyncCallback<number& | 1700002 | The number of reminders exceeds the limit. | **示例**： -```js +```ts let timer = { reminderType: reminderAgentManager.ReminderType.REMINDER_TYPE_TIMER, triggerTimeInSeconds: 10 } + try { reminderAgentManager.publishReminder(timer, (err, reminderId) => { if (err) { @@ -64,13 +67,15 @@ try { ## reminderAgentManager.publishReminder -publishReminder(reminderReq: ReminderRequest): Promise<number> +```ts +publishReminder(reminderReq: ReminderRequest): Promise +``` -发布一个后台代理提醒，使用Promise方式实现异步调用，该方法需要申请通知弹窗[Notification.requestEnableNotification](js-apis-notification.md#notificationrequestenablenotification8)后才能调用。 +发布一个后台代理提醒，使用`Promise`的方式实现异步调用，该方法需要申请通知弹窗权限[Notification.requestEnableNotification](js-apis-notification.md#notificationrequestenablenotification8)后才能调用。 -**需要权限**： ohos.permission.PUBLISH_AGENT_REMINDER +**需要权限**： `ohos.permission.PUBLISH_AGENT_REMINDER` -**系统能力**： SystemCapability.Notification.ReminderAgent +**系统能力**： `SystemCapability.Notification.ReminderAgent` **参数**： | 参数名 | 类型 | 必填 | 说明 | @@ -80,7 +85,7 @@ publishReminder(reminderReq: ReminderRequest): Promise<number> **返回值**： | 类型 | 说明 | | -------- | -------- | - | Promise<number> | 返回提醒的reminderId。 | + | Promise\ | 返回提醒的id。 | **错误码：** @@ -92,11 +97,12 @@ publishReminder(reminderReq: ReminderRequest): Promise<number> | 1700002 | The number of reminders exceeds the limit. | **示例**： -```js +```ts let timer = { reminderType: reminderAgentManager.ReminderType.REMINDER_TYPE_TIMER, triggerTimeInSeconds: 10 } + try { reminderAgentManager.publishReminder(timer).then((reminderId) => { console.log("promise, reminderId = " + reminderId); @@ -111,18 +117,20 @@ try { ## reminderAgentManager.cancelReminder -cancelReminder(reminderId: number, callback: AsyncCallback<void>): void +```ts +cancelReminder(reminderId: number, callback: AsyncCallback): void +``` -取消指定id的提醒，使用callback方式实现异步调用。 +取消指定id的提醒，使用回调的方式实现异步调用。 -**系统能力**： SystemCapability.Notification.ReminderAgent +**系统能力**： `SystemCapability.Notification.ReminderAgent` **参数**： | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | -| reminderId | number | 是 | 目标reminder的id号。 | -| callback | AsyncCallback<void> | 是 | 异步回调。 | +| reminderId | number | 是 | 目标提醒的id号。 | +| callback | AsyncCallback\ | 是 | 异步回调。 | **错误码：** @@ -135,7 +143,7 @@ cancelReminder(reminderId: number, callback: AsyncCallback<void>): void **示例**： -```js +```ts try { reminderAgentManager.cancelReminder(1, (err, data) => { if (err) { @@ -152,23 +160,25 @@ try { ## reminderAgentManager.cancelReminder -cancelReminder(reminderId: number): Promise<void> +```ts +cancelReminder(reminderId: number): Promise +``` -取消指定id的提醒，使用Promise方式实现异步调用。 +取消指定id的提醒，使用`Promise`方式实现异步调用。 -**系统能力**： SystemCapability.Notification.ReminderAgent +**系统能力**： `SystemCapability.Notification.ReminderAgent` **参数**： | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | -| reminderId | number | 是 | 目标reminder的id号。 | +| reminderId | number | 是 | 目标提醒的id号。 | **返回值**： | 类型 | 说明 | | -------- | -------- | -| Promise<void> | Promise类型异步回调。 | +| PPromise\ | Promise类型异步回调。 | **错误码：** @@ -181,7 +191,7 @@ cancelReminder(reminderId: number): Promise<void> **示例**： -```js +```ts try { reminderAgentManager.cancelReminder(1).then(() => { console.log("cancelReminder promise"); @@ -193,20 +203,22 @@ try { }; ``` - ## reminderAgentManager.getValidReminders -getValidReminders(callback: AsyncCallback<Array<ReminderRequest>>): void +```ts +getValidReminders(callback: AsyncCallback>): void + +``` -获取当前应用已设置的所有有效（未过期）的提醒，使用callback方式实现异步调用。 +获取当前应用已设置的所有有效（未过期）的提醒，使用回调方式实现异步调用。 -**系统能力**： SystemCapability.Notification.ReminderAgent +**系统能力**： `SystemCapability.Notification.ReminderAgent` **参数**： | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | -| callback | AsyncCallback<Array<[ReminderRequest](#reminderrequest)>> | 是 | 异步回调，返回当前应用已设置的所有有效（未过期）的提醒。 | +| callback | AsyncCallback\\> | 是 | 异步回调，返回当前应用已设置的所有有效（未过期）的提醒。 | **错误码：** @@ -218,7 +230,7 @@ getValidReminders(callback: AsyncCallback<Array<ReminderRequest>>): **示例**： -```js +```ts try { reminderAgentManager.getValidReminders((err, reminders) => { if (err) { @@ -253,20 +265,21 @@ try { }; ``` - ## reminderAgentManager.getValidReminders -getValidReminders(): Promise<Array<ReminderRequest>> +```ts +getValidReminders(): Promise> +``` 获取当前应用已设置的所有有效（未过期）的提醒，使用Promise方式实现异步调用。 -**系统能力**： SystemCapability.Notification.ReminderAgent +**系统能力**： `SystemCapability.Notification.ReminderAgent` **返回值**： | 类型 | 说明 | | -------- | -------- | -| Promise<Array<[ReminderRequest](#reminderrequest)>> | 返回当前应用已设置的所有有效（未过期）的提醒。 | +| Promise\\> | 返回当前应用已设置的所有有效（未过期）的提醒。 | **错误码：** @@ -278,7 +291,7 @@ getValidReminders(): Promise<Array<ReminderRequest>> **示例**： -```js +```ts try { reminderAgentManager.getValidReminders().then((reminders) => { console.log("promise, getValidReminders length = " + reminders.length); @@ -314,17 +327,19 @@ try { ## reminderAgentManager.cancelAllReminders -cancelAllReminders(callback: AsyncCallback<void>): void +```ts +cancelAllReminders(callback: AsyncCallback): void +``` -取消当前应用所有的提醒，使用callback方式实现异步调用。 +取消当前应用所有的提醒，使用回调的方式实现异步调用。 -**系统能力**： SystemCapability.Notification.ReminderAgent +**系统能力**： `SystemCapability.Notification.ReminderAgent` **参数**： | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | -| callback | AsyncCallback<void> | 是 | 异步回调。 | +| callback | AsyncCallback\ | 是 | 异步回调。 | **错误码：** @@ -336,7 +351,7 @@ cancelAllReminders(callback: AsyncCallback<void>): void **示例**： -```js +```ts try { reminderAgentManager.cancelAllReminders((err, data) =>{ if (err) { @@ -353,17 +368,19 @@ try { ## reminderAgentManager.cancelAllReminders -cancelAllReminders(): Promise<void> +```ts +cancelAllReminders(): Promise +``` 取消当前应用所有的提醒，使用Promise方式实现异步调用。 -**系统能力**： SystemCapability.Notification.ReminderAgent +**系统能力**： `SystemCapability.Notification.ReminderAgent` **返回值**： | 类型 | 说明 | | -------- | -------- | -| Promise<void> | Promise类型异步回调。 | +| Promise\ | Promise类型异步回调。 | **错误码：** @@ -375,7 +392,7 @@ cancelAllReminders(): Promise<void> **示例**： -```js +```ts try { reminderAgentManager.cancelAllReminders().then(() => { console.log("cancelAllReminders promise") @@ -390,22 +407,24 @@ try { ## reminderAgentManager.addNotificationSlot -addNotificationSlot(slot: NotificationSlot, callback: AsyncCallback<void>): void +```ts +addNotificationSlot(slot: NotificationSlot, callback: AsyncCallback): void +``` -添加一个NotificationSlot，使用callback方式实现异步调用。 +添加一个NotificationSlot，使用回调的方式实现异步调用。 -**系统能力**： SystemCapability.Notification.ReminderAgent +**系统能力**： `SystemCapability.Notification.ReminderAgent` **参数**： | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | -| slot | [NotificationSlot](js-apis-notification.md#notificationslot) | 是 | notification slot实例，仅支持设置其type属性。 | -| callback | AsyncCallback<void> | 是 | 异步回调。 | +| slot | [NotificationSlot](js-apis-notification.md#notificationslot) | 是 | notification\.slot实例，仅支持设置其type属性。 | +| callback | AsyncCallback\ | 是 | 异步回调。 | **示例**： -```js +```ts import notification from '@ohos.notification' let mySlot = { @@ -427,27 +446,29 @@ try { ## reminderAgentManager.addNotificationSlot -addNotificationSlot(slot: NotificationSlot): Promise<void> +```ts +addNotificationSlot(slot: NotificationSlot): Promise +``` 添加一个NotificationSlot，使用Promise方式实现异步调用。 -**系统能力**： SystemCapability.Notification.ReminderAgent +**系统能力**： `SystemCapability.Notification.ReminderAgent` **参数**： | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | -| slot | [NotificationSlot](js-apis-notification.md#notificationslot) | 是 | notification slot实例，仅支持设置其type属性。 | +| slot | [NotificationSlot](js-apis-notification.md#notificationslot) | 是 | notification\.slot实例，仅支持设置其type属性。 | **返回值**： | 类型 | 说明 | | -------- | -------- | -| Promise<void> | Promise类型异步回调。 | +| Promise\ | Promise类型异步回调。 | **示例**： -```js +```ts import notification from '@ohos.notification' let mySlot = { @@ -467,22 +488,24 @@ try { ## reminderAgentManager.removeNotificationSlot -removeNotificationSlot(slotType: notification.SlotType, callback: AsyncCallback<void>): void +```ts +removeNotificationSlot(slotType: notification.SlotType, callback: AsyncCallback): void +``` -删除目标NotificationSlot，使用callback方式实现异步调用。 +删除目标NotificationSlot，使用回调的方式实现异步调用。 -**系统能力**： SystemCapability.Notification.ReminderAgent +**系统能力**： `SystemCapability.Notification.ReminderAgent` **参数**： | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | -| slotType | [notification.SlotType](js-apis-notification.md#slottype) | 是 | 目标notification slot的类型。 | -| callback | AsyncCallback<void> | 是 | 异步回调。 | +| slotType | [notification.SlotType](js-apis-notification.md#slottype) | 是 | 目标notification\.slot的类型。 | +| callback | AsyncCallback\ | 是 | 异步回调。 | **示例**： -```js +```ts import notification from '@ohos.notification' try { @@ -501,27 +524,29 @@ try { ## reminderAgentManager.removeNotificationSlot -removeNotificationSlot(slotType: notification.SlotType): Promise<void> +```ts +removeNotificationSlot(slotType: notification.SlotType): Promise +``` 删除目标NotificationSlot，使用Promise方式实现异步调用。 -**系统能力**： SystemCapability.Notification.ReminderAgent +**系统能力**： `SystemCapability.Notification.ReminderAgent` **参数**： | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | -| slotType | [notification.SlotType](js-apis-notification.md#slottype) | 是 | 目标notification slot的类型。 | +| slotType | [notification.SlotType](js-apis-notification.md#slottype) | 是 | 目标notification\.slot的类型。 | **返回值**： | 类型 | 说明 | | -------- | -------- | -| Promise<void> | Promise类型异步回调。 | +| Promise\ | Promise类型异步回调。 | **示例**： -```js +```ts import notification from '@ohos.notification' try { @@ -539,7 +564,7 @@ try { 按钮的类型。 -**系统能力**：以下各项对应的系统能力均为SystemCapability.Notification.ReminderAgent +**系统能力**：`SystemCapability.Notification.ReminderAgent` | 名称 | 值 | 说明 | | -------- | -------- | -------- | @@ -551,7 +576,7 @@ try { 提醒的类型。 -**系统能力**：以下各项对应的系统能力均为SystemCapability.Notification.ReminderAgent +**系统能力**：`SystemCapability.Notification.ReminderAgent` | 名称 | 值 | 说明 | | -------- | -------- | -------- | @@ -564,7 +589,7 @@ try { 用于设置弹出的提醒通知信息上显示的按钮类型和标题。 -**系统能力**：以下各项对应的系统能力均为SystemCapability.Notification.ReminderAgent +**系统能力**：`SystemCapability.Notification.ReminderAgent` | 名称 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | @@ -574,9 +599,9 @@ try { ## WantAgent -点击提醒通知后跳转的目标ability信息。 +点击提醒通知后跳转的目标`ability`信息。 -**系统能力**：以下各项对应的系统能力均为SystemCapability.Notification.ReminderAgent +**系统能力**：`SystemCapability.Notification.ReminderAgent` | 名称 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | @@ -588,7 +613,7 @@ try { 全屏显示提醒到达时自动拉起的目标ability信息，该接口预留。 -**系统能力**：以下各项对应的系统能力均为SystemCapability.Notification.ReminderAgent +**系统能力**：`SystemCapability.Notification.ReminderAgent` | 名称 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | @@ -600,7 +625,7 @@ try { 提醒实例对象，用于设置提醒类型、响铃时长等具体信息。 -**系统能力**：以下各项对应的系统能力均为SystemCapability.Notification.ReminderAgent +**系统能力**：`SystemCapability.Notification.ReminderAgent` | 名称 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | @@ -625,13 +650,13 @@ ReminderRequestCalendar extends ReminderRequest 日历实例对象，用于设置提醒的时间。 -**系统能力**：以下各项对应的系统能力均为SystemCapability.Notification.ReminderAgent +**系统能力**：`SystemCapability.Notification.ReminderAgent` | 名称 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | | dateTime | [LocalDateTime](#localdatetime) | 是 | 指明提醒的目标时间。 | -| repeatMonths | Array<number> | 否 | 指明重复提醒的月份。 | -| repeatDays | Array<number> | 否 | 指明重复提醒的日期。 | +| repeatMonths | Array\ | 否 | 指明重复提醒的月份。 | +| repeatDays | Array\ | 否 | 指明重复提醒的日期。 | ## ReminderRequestAlarm @@ -640,13 +665,13 @@ ReminderRequestAlarm extends ReminderRequest 闹钟实例对象，用于设置提醒的时间。 -**系统能力**：以下各项对应的系统能力均为SystemCapability.Notification.ReminderAgent +**系统能力**：`SystemCapability.Notification.ReminderAgent` | 名称 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | | hour | number | 是 | 指明提醒的目标时刻。 | | minute | number | 是 | 指明提醒的目标分钟。 | -| daysOfWeek | Array<number> | 否 | 指明每周哪几天需要重复提醒。范围为周一到周末，对应数字为1到7。 | +| daysOfWeek | Array\ | 否 | 指明每周哪几天需要重复提醒。范围为周一到周末，对应数字为1到7。 | ## ReminderRequestTimer @@ -655,7 +680,7 @@ ReminderRequestTimer extends ReminderRequest 倒计时实例对象，用于设置提醒的时间。 -**系统能力**：SystemCapability.Notification.ReminderAgent +**系统能力**：`SystemCapability.Notification.ReminderAgent` | 名称 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | @@ -666,7 +691,7 @@ ReminderRequestTimer extends ReminderRequest 用于日历类提醒设置时指定时间信息。 -**系统能力**：以下各项对应的系统能力均为SystemCapability.Notification.ReminderAgent +**系统能力**：`SystemCapability.Notification.ReminderAgent` | 名称 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | diff --git a/zh-cn/application-dev/reference/errorcodes/errorcode-CommonEventService.md b/zh-cn/application-dev/reference/errorcodes/errorcode-CommonEventService.md index 9c5fe5a338ad282b66cced8a4ebe3ef477580545..369db30261597c2d31d45851358ced01d46d4057 100644 --- a/zh-cn/application-dev/reference/errorcodes/errorcode-CommonEventService.md +++ b/zh-cn/application-dev/reference/errorcodes/errorcode-CommonEventService.md @@ -6,27 +6,27 @@ Want action is null **错误描述** -发送事件的want中的Action属性为空时系统会产生此错误码。 +发送事件的`want`中的`Action`属性为空时系统会产生此错误码。 **可能原因** -发送事件的want中的Action属性为空。 +发送事件的`want`中的`Action`属性为空。 **处理步骤** -检查传入want的Action属性是否为空。 +检查传入`want`的`Action`属性是否为空。 -## 1500002 沙箱引用无法发送公共事件 +## 1500002 沙箱应用无法发送公共事件 **错误信息** sandbox application can not send common event **错误描述** -沙箱引用无法发送公共事件。 +沙箱应用无法发送公共事件。 **可能原因** 事件发送方应用为沙箱应用，发送事件会被拦截。 **处理步骤** -检查事件发送是否为沙箱应用，若是，则无法发送。请不要使用沙箱应用发送事件。 +沙箱应用无法发送公共事件，发送公共事件前确认是否为沙箱应用。 ## 1500003 事件发送频率过高 @@ -54,7 +54,7 @@ not System services or System app 非系统应用或非系统服务发送系统公共事件。 **处理步骤** -检查应用是否为系统应用或者系统服务；若不是，则无法发送。 +确认当前应用是否为系统应用，或当前服务是否为系统服务。 ## 1500005 未找到订阅者 @@ -73,24 +73,24 @@ subscriber can not found ## 1500006 无效userId **错误信息** -usreId is invalid +userId is invalid **错误描述** 无效的userId。 **可能原因** -和系统userId不一致或不是系统应用或子系统进程。 +和系统`userId`不一致或不是系统应用或系统服务进程。 **处理步骤** -检查当前userId是否和系统userId一致；若不一致，检查系统应用或子系统进程。 - +1. 检查当前`userId`是否和系统`userId`一致。 +2. 检查当前应用是否为系统应用或系统服务。 ## 1500007 IPC请求发送失败 **错误信息** message send error **错误描述** -IPC发送请求失败。 +`IPC`发送请求失败。 **可能原因** 没有成功创建连接对象。 diff --git a/zh-cn/application-dev/reference/errorcodes/errorcode-DistributedNotificationService.md b/zh-cn/application-dev/reference/errorcodes/errorcode-DistributedNotificationService.md index 5a11da27ec9beab9169156b370fa5ddbe6e9a000..2049cb646f6a757784bf52f93507e1c078a30e18 100644 --- a/zh-cn/application-dev/reference/errorcodes/errorcode-DistributedNotificationService.md +++ b/zh-cn/application-dev/reference/errorcodes/errorcode-DistributedNotificationService.md @@ -8,11 +8,11 @@ Internal Error. **错误描述** -当内存申请、多线程处理异常等内部处理错误，系统会报此错误码。 +当发生内存申请失败、多线程处理失败等异常时，系统会报此错误码。 **可能原因** -1. 内存申请、多线程处理等内核通用错误。 +1. 内存申请失败、多线程处理失败等内核通用错误。 **处理步骤** @@ -36,8 +36,9 @@ IPC Error. **处理步骤** -1. 确认参入参数是否超长。 -2. 确认通知子系统是否启动中。 +1. 确认输入参数是否超长。 +2. 确认输入参数是否合法。 +3. 确认通知子系统是否已启动。 ## 1600003 连接服务错误 @@ -47,7 +48,7 @@ Failed to connect to service. **错误描述** -当连接服务失败使通知子系统异常时，系统会报此错误码。 +当连接服务失败而导致通知子系统异常时，系统会报此错误码。 **可能原因** @@ -55,8 +56,8 @@ Failed to connect to service. **处理步骤** -1. 服务繁忙，请稍后重试。 -2. 确认通知子系统是否启动。 +1. 服务繁忙时，需要再次尝试。 +2. 确认通知子系统是否正常启动。 ## 1600004 通知使能未开启 @@ -70,7 +71,7 @@ Notification is not enabled. **可能原因** -1. 应用的通知使能是初始的未开启状态或者被用户关闭。 +1. 应用的通知使能是未开启状态或者被用户手动关闭。 **处理步骤** @@ -102,17 +103,17 @@ Notification is not allowed to remove. **错误描述** -当通知设置isUnremoveable=true标识时全清，当设置isRemoveAllowed=false时，删除时，系统会报此错误码。 +删除通知时不具有相应的权限。 **可能原因** -1. 通知上设置了isUnremoveable=true标识，不允许全清只允许单条删除。 -2. 通知上设置了isRemoveAllowed=false，不允许删除。 +1. 通知设置`isUnremovable`为`true`，只允许删除单条通知，而不允许删除全部通知。 +2. 通知设置`isRemoveAllowed`为`false`，不允许删除通知。 **处理步骤** -1. 检查通知是否设置了unremovable=true标识。 -2. 检查通知是否设置了isRemoveAllowed=false标识。 +1. 检查通知是否设置了`isUnremovable`为`true`。 +2. 检查通知是否设置了`isRemoveAllowed`为`false`。 ## 1600007 通知不存在 @@ -122,7 +123,7 @@ The notification is not exist. **错误描述** -当通知被删除或取消，不存在时，系统会报此错误码。 +当通知不存在时，系统会报此错误码。 **可能原因** @@ -141,7 +142,7 @@ The user is not exist. **错误描述** -用当用户ID错误，或设备用户未激活时，系统会报此错误码。 +当用户ID错误，或设备用户未激活时，系统会报此错误码。 **可能原因** @@ -206,8 +207,8 @@ Read template config failed. **处理步骤** -1. 检查系统/system/etc/notification_template/external.json文件是否存在。 -2. 升级版本到3.2及以上。 +1. 检查系统`/system/etc/notification_template/external.json`文件是否存在。 +2. 升级系统版本到3.2及以上。 ## 17700001 包名不存在 diff --git a/zh-cn/application-dev/reference/errorcodes/errorcode-reminderAgentManager.md b/zh-cn/application-dev/reference/errorcodes/errorcode-reminderAgentManager.md index faeac6fddca8d11815797258e7a44a1fa9a87edd..25ac918c2fc32f984f96e112f860ed122c8152c3 100644 --- a/zh-cn/application-dev/reference/errorcodes/errorcode-reminderAgentManager.md +++ b/zh-cn/application-dev/reference/errorcodes/errorcode-reminderAgentManager.md @@ -8,16 +8,16 @@ Notification is not enabled. **错误描述** -当调用发布提醒接口时，未允许应用发送通知。 +当调用发布提醒接口时，不允许应用发送通知。 **可能原因** -1. 未申请通知使能。 +1. 未申请通知使能权限。 2. 通知使能被关闭。 **处理步骤** -1. 申请通知使能弹窗[Notification.requestEnableNotification](../apis/js-apis-notification.md#notificationrequestenablenotification8)。 +1. 申请通知使能权限弹窗[Notification.requestEnableNotification](../apis/js-apis-notification.md#notificationrequestenablenotification8)。 2. 检查通知使能是否被关闭。 ## 1700002 提醒数量超出限制