提交 1a683510 编写于 作者: Z zhuhan

ces doc

Signed-off-by: Nzhuhan <zhuhan10@huawei.com>
Change-Id: Ifc8143fdc161ed5177ad3ddcf9caea6067532e40
上级 7600856f
......@@ -61,6 +61,7 @@
- continuation/[ContinuationResult (ContinuationResult)](js-apis-continuation-continuationResult.md)
- 公共事件与通知
- [@ohos.commonEvent (公共事件模块)](js-apis-commonEvent.md)
- [@ohos.commonEventManager (新公共事件模块)](js-apis-commonEventManager.md)
- [@ohos.events.emitter (Emitter)](js-apis-emitter.md)
- [@ohos.notification (Notification模块)](js-apis-notification.md)
- [@ohos.reminderAgent (后台代理提醒)](js-apis-reminderAgent.md)
......
# 公共事件模块
本模块提供了公共事件的能力,包括公共事件的权限列表,发布公共事件,订阅或取消订阅公共事件,获取或修改公共事件结果代码、结果数据等。
本模块提供了公共事件的能力,包括公共事件的权限列表,发布公共事件,订阅或取消订阅公共事件,获取或修改公共事件结果代码、结果数据等。本模块将被commonEventManager模块取代,建议优先使用[commonEventManager](js-apis-commonEventManager.md)模块。
> **说明:**
>
......@@ -1237,6 +1237,8 @@ subscriber.finishCommonEvent().then(() => {
## CommonEventData
公共事件数据体。
**系统能力:** 以下各项对应的系统能力均为SystemCapability.Notification.CommonEvent
| 名称 | 可读 | 可写 | 类型 | 描述 |
......@@ -1250,6 +1252,8 @@ subscriber.finishCommonEvent().then(() => {
## CommonEventPublishData
公共事件发送的数据体,包含公共事件内容和属性。
**系统能力:** 以下各项对应的系统能力均为SystemCapability.Notification.CommonEvent
| 名称 | 可读 | 可写 | 类型 | 描述 |
......@@ -1264,6 +1268,8 @@ subscriber.finishCommonEvent().then(() => {
## CommonEventSubscribeInfo
订阅者信息。
**系统能力:** 以下各项对应的系统能力均为SystemCapability.Notification.CommonEvent
| 名称 | 可读 | 可写 | 类型 | 描述 |
......
......@@ -3206,6 +3206,8 @@ Notification.getSyncNotificationEnabledWithoutApp(userId)
## NotificationSubscriber
提供订阅者接收到新通知或取消通知时的回调方法。
**系统API**:此接口为系统接口,三方应用不支持调用。
### onConsume
......@@ -3216,7 +3218,7 @@ onConsume?: (data: [SubscribeCallbackData](#subscribecallbackdata)) => void
**系统能力**:SystemCapability.Notification.Notification
**系统API**: 此接口为系统接口,三方应用不支持调用。
**系统接口**: 此接口为系统接口,三方应用不支持调用。
**参数:**
......@@ -3626,6 +3628,8 @@ Notification.subscribe(subscriber, subscribeCallback);
## NotificationActionButton
描述通知中显示的操作按钮。
**系统能力**:以下各项对应的系统能力均为SystemCapability.Notification.Notification
| 名称 | 可读 | 可写 | 类型 | 描述 |
......@@ -3638,6 +3642,8 @@ Notification.subscribe(subscriber, subscribeCallback);
## NotificationBasicContent
描述普通文本通知。
**系统能力**:以下各项对应的系统能力均为SystemCapability.Notification.Notification
| 名称 | 可读 | 可写 | 类型 | 描述 |
......@@ -3649,6 +3655,8 @@ Notification.subscribe(subscriber, subscribeCallback);
## NotificationLongTextContent
描述长文本通知。
**系统能力**:以下各项对应的系统能力均为SystemCapability.Notification.Notification
| 名称 | 可读 | 可写 | 类型 | 描述 |
......@@ -3663,6 +3671,8 @@ Notification.subscribe(subscriber, subscribeCallback);
## NotificationMultiLineContent
描述多行文本通知。
**系统能力**:以下各项对应的系统能力均为SystemCapability.Notification.Notification
| 名称 | 可读 | 可写 | 类型 | 描述 |
......@@ -3677,6 +3687,8 @@ Notification.subscribe(subscriber, subscribeCallback);
## NotificationPictureContent
描述附有图片的通知。
**系统能力**:以下各项对应的系统能力均为SystemCapability.Notification.Notification
| 名称 | 可读 | 可写 | 类型 | 描述 |
......@@ -3691,6 +3703,8 @@ Notification.subscribe(subscriber, subscribeCallback);
## NotificationContent
描述通知类型。
**系统能力**:以下各项对应的系统能力均为SystemCapability.Notification.Notification
| 名称 | 可读 | 可写 | 类型 | 描述 |
......@@ -3704,9 +3718,11 @@ Notification.subscribe(subscriber, subscribeCallback);
## NotificationFlagStatus<sup>8+</sup>
描述通知标志状态。
**系统能力**:以下各项对应的系统能力均为SystemCapability.Notification.Notification
**系统API**:此接口为系统接口,三方应用不支持调用。
**系统接口**:此接口为系统接口,三方应用不支持调用。
| 名称 | 值 | 描述 |
| -------------- | --- | --------------------------------- |
......@@ -3717,6 +3733,8 @@ Notification.subscribe(subscriber, subscribeCallback);
## NotificationFlags<sup>8+</sup>
描述通知标志的实例。
**系统能力**:以下各项对应的系统能力均为SystemCapability.Notification.Notification
| 名称 | 可读 | 可写 | 类型 | 描述 |
......@@ -3727,6 +3745,8 @@ Notification.subscribe(subscriber, subscribeCallback);
## NotificationRequest
描述通知的请求。
**系统能力**:以下各项对应的系统能力均为SystemCapability.Notification.Notification
| 名称 | 可读 | 可写 | 类型 | 描述 |
......@@ -3772,6 +3792,8 @@ Notification.subscribe(subscriber, subscribeCallback);
## DistributedOptions<sup>8+</sup>
描述分布式选项。
**系统能力**:以下各项对应的系统能力均为SystemCapability.Notification.Notification
| 名称 | 可读 | 可写 | 类型 | 描述 |
......@@ -3784,6 +3806,8 @@ Notification.subscribe(subscriber, subscribeCallback);
## NotificationSlot
描述通知槽
**系统能力**:以下各项对应的系统能力均为SystemCapability.Notification.Notification
| 名称 | 可读 | 可写 | 类型 | 描述 |
......@@ -3804,6 +3828,8 @@ Notification.subscribe(subscriber, subscribeCallback);
## NotificationSorting
提供有关活动通知的排序信息。
**系统能力**:以下各项对应的系统能力均为SystemCapability.Notification.Notification
**系统API**: 此接口为系统接口,三方应用不支持调用。
......@@ -3817,6 +3843,8 @@ Notification.subscribe(subscriber, subscribeCallback);
## NotificationSortingMap
提供关于已订阅的所有通知中活动通知的排序信息
**系统能力**:以下各项对应的系统能力均为SystemCapability.Notification.Notification
**系统API**:此接口为系统接口,三方应用不支持调用。
......@@ -3829,6 +3857,8 @@ Notification.subscribe(subscriber, subscribeCallback);
## NotificationSubscribeInfo
设置订阅所需通知的发布者的信息。
**系统能力**:以下各项对应的系统能力均为SystemCapability.Notification.Notification
**系统API**: 此接口为系统接口,三方应用不支持调用。
......@@ -3841,6 +3871,8 @@ Notification.subscribe(subscriber, subscribeCallback);
## NotificationTemplate<sup>8+</sup>
通知模板。
**系统能力**:以下各项对应的系统能力均为SystemCapability.Notification.Notification
| 名称 | 参数类型 | 可读 | 可写 | 说明 |
......@@ -3851,6 +3883,8 @@ Notification.subscribe(subscriber, subscribeCallback);
## NotificationUserInput<sup>8+</sup>
保存用户输入的通知消息。
**系统能力**:SystemCapability.Notification.Notification
| 名称 | 可读 | 可写 | 类型 | 描述 |
......
# 事件错误码
## 201 权限校验失败
### 错误信息
Permission denied
### 错误描述
开发者的应用没有权限时调用事件的接口会产生此错误码。
### 可能原因
调用目标接口时,未申请权限。
### 处理步骤
申请相应接口要求的权限。
## 401 参数检查失败
### 错误信息
Invalid parameter
### 错误描述
调用接口时非法入参系统会产生此错误码。
### 可能原因
入参数与调用接口规定的参数不符。
### 处理步骤
检查入参是否与调用接口规定参数吻合,例如参数类型、取值范围、空指针等。
## 801 设备不支持该API
### 错误信息
SystemCapability not found
### 错误描述
当前设备支持该SysCap但不支持此API时系统会产生此错误码。
### 可能原因
暂无
### 处理步骤
取消调用该接口或者用其他接口代替。
## 1500001 want中Action为空
### 错误信息
**错误信息**
Want action is null
### 错误描述
**错误描述**
发送事件的want中的Action属性为空时系统会产生此错误码。
### 可能原因
**可能原因**
发送事件的want中的Action属性为空。
### 处理步骤
**处理步骤**
检查传入want的Action属性是否为空。
## 1500002 沙箱引用无法发送公共事件
### 错误信息
**错误信息**
sandbox application can not send common event
### 错误描述
**错误描述**
沙箱引用无法发送公共事件。
### 可能原因
**可能原因**
事件发送方应用为沙箱应用,发送事件会被拦截。
### 处理步骤
**处理步骤**
检查事件发送是否为沙箱应用,若是,则无法发送。请不要使用沙箱应用发送事件。
## 1500003 事件发送频率过高
### 错误信息
**错误信息**
common event send frequency too high
### 错误描述
**错误描述**
应用发送事件过于频繁。
### 可能原因
**可能原因**
短时间内应用发送过多事件。
### 处理步骤
**处理步骤**
检查应用是否过于频繁地发送事件。
## 1500004 无法发送系统公共事件
### 错误信息
**错误信息**
not System services or System app
### 错误描述
**错误描述**
当前应用无法发送系统公共事件。
### 可能原因
**可能原因**
非系统应用或非系统服务发送系统公共事件。
### 处理步骤
**处理步骤**
检查应用是否为系统应用或者系统服务;若不是,则无法发送。
## 1500005 未找到订阅者
### 错误信息
**错误信息**
subscriber can not found
### 错误描述
**错误描述**
找不到订阅者。
### 可能原因
**可能原因**
订阅者被删除。
### 处理步骤
**处理步骤**
检查是否有重复取消订阅。
## 1500006 无效userId
### 错误信息
**错误信息**
usreId is invalid
### 错误描述
**错误描述**
无效的userId。
### 可能原因
**可能原因**
和系统userId不一致或不是系统应用或子系统进程。
### 处理步骤
**处理步骤**
检查当前userId是否和系统userId一致;若不一致,检查系统应用或子系统进程。
## 1500007 IPC请求发送失败
### 错误信息
**错误信息**
message send error
### 错误描述
**错误描述**
IPC发送请求失败。
### 可能原因
**可能原因**
没有成功创建连接对象。
### 处理步骤
**处理步骤**
请勿频繁建立链接,稍后重新尝试。
## 1500008 读取数据失败
### 错误信息
**错误信息**
CEMS error
### 错误描述
**错误描述**
服务端发生错误。
### 可能原因
**可能原因**
服务端处理数据时发现业务异常。
### 处理步骤
**处理步骤**
稍后重新尝试。
## 1500009 system error
### 错误信息
**错误信息**
system error
### 错误描述
处理业务时系统发生异常。
**错误描述**
处理业务时系统发生异常,如获取系统当前时间失败
### 可能原因
系统故障。
**可能原因**
系统故障,获取系统当前时间发生异常
### 处理步骤
**处理步骤**
稍后重新尝试。
Markdown is supported
0% .
You are about to add 0 people to the discussion. Proceed with caution.
先完成此消息的编辑!
想要评论请 注册