已合并
8分资料需求问题单修改 #156055
wangsen1994创建于 7月16日
8分资料需求问题单修改 #156055
已合并
共 6 个文件变更+57-56
| @@ -6,7 +6,7 @@ | |||
| 6 | <!--Tester: @wanghong1997--> | 6 | <!--Tester: @wanghong1997--> |
| 7 | <!--Adviser: @fang-jinxu--> | 7 | <!--Adviser: @fang-jinxu--> |
| 8 | 8 | ||
| 9 | -本模块提供了公共事件相关的系统接口能力，包括发布公共事件到指定用户、移除粘性公共事件以及设置静态订阅公共事件的使能状态。粘性公共事件是指发布后会被系统保留的公共事件，当新的订阅者注册后仍可接收到该事件；非粘性事件仅投递给发布时已注册的订阅者。 | 9 | +本模块提供了公共事件相关的系统接口能力，包括发布公共事件到指定用户、移除粘性公共事件以及设置静态订阅公共事件的使能状态。 |
| 10 | 10 | ||
| 11 | > **说明：** | 11 | > **说明：** |
| 12 | > | 12 | > |
| @@ -9,8 +9,9 @@ | |||||||
| 9 | 本模块提供公共事件的发布、订阅、取消订阅等能力。公共事件是一种系统级的事件通知机制，允许应用在系统状态变化（如开机完成、电量变化、屏幕亮灭等）或业务自定义事件发生时，向订阅了该事件的应用发送通知，实现跨组件、跨应用的信息传递。 | 9 | 本模块提供公共事件的发布、订阅、取消订阅等能力。公共事件是一种系统级的事件通知机制，允许应用在系统状态变化（如开机完成、电量变化、屏幕亮灭等）或业务自定义事件发生时，向订阅了该事件的应用发送通知，实现跨组件、跨应用的信息传递。 | ||||
| 10 | 10 | ||||||
| 11 | 本模块涉及的关键概念： | 11 | 本模块涉及的关键概念： | ||||
| 12 | -- 系统公共事件：是由系统服务或系统应用发布的预置公共事件，对应`Support`枚举中定义的事件名称，部分系统公共事件的订阅需要特定权限。 | 12 | +- 无序公共事件：CES在转发公共事件时，不考虑订阅者是否接收到该事件，也不保证订阅者接收到该事件的顺序与其订阅顺序一致。 | ||||
| 13 | -- 有序公共事件：是按订阅者优先级依次投递的公共事件，高优先级订阅者先收到事件，可通过修改事件数据将信息传递给后续订阅者，也可中止向低优先级订阅者投递事件。 | 13 | +- 有序公共事件：CES在转发公共事件时，根据订阅者设置的优先级等级，优先将公共事件发送给优先级较高的订阅者，等待其成功接收该公共事件之后再将事件发送给优先级较低的订阅者。如果有多个订阅者具有相同的优先级，则他们将随机接收到公共事件。 | ||||
| 14 | +- 粘性公共事件：能够让订阅者收到在订阅前已经发送的公共事件就是粘性公共事件。普通的公共事件只能在订阅后发送才能收到，而粘性公共事件的特殊性就是可以先发送后订阅，同时也支持先订阅后发送。发送粘性公共事件必须是系统应用或系统服务。 | ||||||
| 14 | 15 | ||||||
| 15 | **API 组合使用关系说明：** | 16 | **API 组合使用关系说明：** | ||||
| 16 | 17 | ||||||
| @@ -63,7 +64,7 @@ publish(event: string, callback: AsyncCallback\<void>): void | |||||||
| 63 | | 参数名 | 类型 | 必填 | 说明 | | 64 | | 参数名 | 类型 | 必填 | 说明 | | ||||
| 64 | | -------- | -------------------- | ---- | ---------------------- | | 65 | | -------- | -------------------- | ---- | ---------------------- | | ||||
| 65 | | event | string | 是 | 表示要发布的公共事件。详见[系统定义的公共事件](./common_event/commonEventManager-definitions.md)。 | | 66 | | event | string | 是 | 表示要发布的公共事件。详见[系统定义的公共事件](./common_event/commonEventManager-definitions.md)。 | | ||||
| 66 | -| callback | AsyncCallback\<void> | 是 | 回调函数。当公共事件发布成功时，err为undefined，否则为错误对象。 | | 67 | +| callback | AsyncCallback\<void> | 是 | 回调函数。当公共事件发布成功时，err为undefined；发布失败时，err为错误对象。 | | ||||
| 67 | 68 | ||||||
| 68 | **错误码：** | 69 | **错误码：** | ||||
| 69 | 70 | ||||||
| @@ -112,7 +113,7 @@ publish(event: string, options: CommonEventPublishData, callback: AsyncCallback\ | |||||||
| 112 | | -------- | ---------------------- | ---- | ---------------------- | | 113 | | -------- | ---------------------- | ---- | ---------------------- | | ||||
| 113 | | event | string | 是 | 表示要发布的公共事件。详见[系统定义的公共事件](./common_event/commonEventManager-definitions.md)。 | | 114 | | event | string | 是 | 表示要发布的公共事件。详见[系统定义的公共事件](./common_event/commonEventManager-definitions.md)。 | | ||||
| 114 | | options | [CommonEventPublishData](./js-apis-inner-commonEvent-commonEventPublishData.md) | 是 | 表示发布公共事件的属性。 | | 115 | | options | [CommonEventPublishData](./js-apis-inner-commonEvent-commonEventPublishData.md) | 是 | 表示发布公共事件的属性。 | | ||||
| 115 | -| callback | AsyncCallback\<void> | 是 | 回调函数。当公共事件发布成功时，err为undefined，否则为错误对象。 | | 116 | +| callback | AsyncCallback\<void> | 是 | 回调函数。当公共事件发布成功时，err为undefined；发布失败时，err为错误对象。 | | ||||
| 116 | 117 | ||||||
| 117 | **错误码：** | 118 | **错误码：** | ||||
| 118 | 119 | ||||||
| @@ -167,7 +168,7 @@ createSubscriber(subscribeInfo: CommonEventSubscribeInfo, callback: AsyncCallbac | |||||||
| 167 | | 参数名 | 类型 | 必填 | 说明 | | 168 | | 参数名 | 类型 | 必填 | 说明 | | ||||
| 168 | | ------------- | ------------------------------------------------------------ | ---- | -------------------------- | | 169 | | ------------- | ------------------------------------------------------------ | ---- | -------------------------- | | ||||
| 169 | | subscribeInfo | [CommonEventSubscribeInfo](./js-apis-inner-commonEvent-commonEventSubscribeInfo.md) | 是 | 表示订阅信息。 | | 170 | | subscribeInfo | [CommonEventSubscribeInfo](./js-apis-inner-commonEvent-commonEventSubscribeInfo.md) | 是 | 表示订阅信息。 | | ||||
| 170 | -| callback | AsyncCallback\<[CommonEventSubscriber](./js-apis-inner-commonEvent-commonEventSubscriber.md#commoneventsubscriber-1)> | 是 | 回调函数，用于接收创建的订阅者对象。当公共事件订阅者创建成功时，err为undefined，data为创建成功的CommonEventSubscriber订阅者对象；否则err为错误对象 | | 171 | +| callback | AsyncCallback\<[CommonEventSubscriber](./js-apis-inner-commonEvent-commonEventSubscriber.md#commoneventsubscriber-1)> | 是 | 回调函数，用于接收创建的订阅者对象。当公共事件订阅者创建成功时，err为undefined，data为创建成功的CommonEventSubscriber订阅者对象；创建失败时，err为错误对象。 | | ||||
| 171 | 172 | ||||||
| 172 | **错误码：** | 173 | **错误码：** | ||||
| 173 | 174 | ||||||
| @@ -330,7 +331,7 @@ subscribe(subscriber: CommonEventSubscriber, callback: AsyncCallback\<CommonEven | |||||||
| 330 | | 801 | Capability not supported. | | 331 | | 801 | Capability not supported. | | ||||
| 331 | | 1500007 | Failed to send the message to the common event service. | | 332 | | 1500007 | Failed to send the message to the common event service. | | ||||
| 332 | | 1500008 | Failed to initialize the common event service. | | 333 | | 1500008 | Failed to initialize the common event service. | | ||||
A | |||||||
| 333 | -| 1500010 | The count of subscriber exceed system specification. <br> 适用版本：20+| | 334 | +| 1500010 | The count of subscriber exceeds system specification. <br> 适用版本：20+| | ||||
| 334 | 335 | ||||||
| 335 | **示例：** | 336 | **示例：** | ||||
| 336 | 337 | ||||||
| @@ -389,7 +390,7 @@ unsubscribe(subscriber: CommonEventSubscriber, callback?: AsyncCallback\<void>): | |||||||
| 389 | | 参数名 | 类型 | 必填 | 说明 | | 390 | | 参数名 | 类型 | 必填 | 说明 | | ||||
| 390 | | ---------- | ----------------------------------------------- | ---- | ------------------------ | | 391 | | ---------- | ----------------------------------------------- | ---- | ------------------------ | | ||||
| 391 | | subscriber | [CommonEventSubscriber](./js-apis-inner-commonEvent-commonEventSubscriber.md#commoneventsubscriber-1) | 是 | 表示订阅者对象。 | | 392 | | subscriber | [CommonEventSubscriber](./js-apis-inner-commonEvent-commonEventSubscriber.md#commoneventsubscriber-1) | 是 | 表示订阅者对象。 | | ||||
| 392 | -| callback | AsyncCallback\<void> | 否 | 回调函数。当取消公共事件订阅成功时，err为undefined，否则为错误对象。不传该参数时，默认取消订阅且不返回结果。 | | 393 | +| callback | AsyncCallback\<void> | 否 | 回调函数。当取消公共事件订阅成功时，err为undefined；取消失败时，err为错误对象。不传该参数时，默认取消订阅且不返回结果。 | | ||||
| 393 | 394 | ||||||
| 394 | **错误码：** | 395 | **错误码：** | ||||
| 395 | 396 | ||||||
| @@ -494,7 +495,7 @@ subscribeToEvent(subscriber: CommonEventSubscriber, callback: Callback\<CommonEv | |||||||
| 494 | | 801 | Capability not supported. | | 495 | | 801 | Capability not supported. | | ||||
| 495 | | 1500007 | Failed to send the message to the common event service. | | 496 | | 1500007 | Failed to send the message to the common event service. | | ||||
| 496 | | 1500008 | Failed to initialize the common event service. | | 497 | | 1500008 | Failed to initialize the common event service. | | ||||
A ❌疑似检测出拼写问题 错误原因："exceed"应为"exceeds"（第三人称单数形式） 建议修改为： 改动建议
  | |||||||
| 497 | -| 1500010 | The count of subscriber exceed system specification. | | 498 | +| 1500010 | The count of subscriber exceeds system specification. | | ||||
| 498 | 499 | ||||||
| 499 | **示例：** | 500 | **示例：** | ||||
| 500 | 501 | ||||||
| @@ -6,7 +6,7 @@ | |||
| 6 | <!--Tester: @wanghong1997--> | 6 | <!--Tester: @wanghong1997--> |
| 7 | <!--Adviser: @fang-jinxu--> | 7 | <!--Adviser: @fang-jinxu--> |
| 8 | 8 | ||
| 9 | -本模块提供进程内线程间或线程内事件的发送与处理能力。开发者可以使用本模块的 API，订阅事件（持续订阅或单次订阅）、取消订阅事件，发送事件到事件队列中，以及查询事件的订阅数量，从而实现同一进程内不同线程之间、以及同一线程内的事件通信。 | 9 | +本模块提供进程内线程间或线程内事件的发送与处理能力。开发者可以使用本模块的 API，订阅事件（持续订阅或单次订阅）、取消订阅事件，发送事件到事件队列中，以及查询事件的订阅数量，从而实现同一进程内不同线程之间、以及同一线程内的事件通信。适用于跨线程通信、模块解耦、事件驱动等场景，能够帮助开发者实现轻量级的发布-订阅模式，降低组件间的耦合度，提升代码的可维护性和可扩展性。 |
| 10 | 10 | ||
| 11 | 提供两种事件处理入口，开发者可根据隔离需求选择： | 11 | 提供两种事件处理入口，开发者可根据隔离需求选择： |
| 12 | 12 | ||
| @@ -289,7 +289,7 @@ off(eventId: string): void | |||
| 289 | 289 | ||
| 290 | ```ts | 290 | ```ts |
| 291 | // 取消eventId为"eventId1"的所有事件回调处理函数 | 291 | // 取消eventId为"eventId1"的所有事件回调处理函数 |
| 292 | -emitter.off("eventId1"); | 292 | +emitter.off('eventId1'); |
| 293 | ``` | 293 | ``` |
| 294 | 294 | ||
| 295 | ## emitter.off<sup>10+</sup> | 295 | ## emitter.off<sup>10+</sup> |
| @@ -353,7 +353,7 @@ let callback: Callback<emitter.EventData> = (eventData: emitter.EventData) => { | |||
| 353 | }; | 353 | }; |
| 354 | // 取消eventId为"eventId1"的事件回调处理函数，callback对象应使用订阅时的对象 | 354 | // 取消eventId为"eventId1"的事件回调处理函数，callback对象应使用订阅时的对象 |
| 355 | // 如果该回调处理函数没有被订阅，则不做任何处理 | 355 | // 如果该回调处理函数没有被订阅，则不做任何处理 |
| 356 | -emitter.off("eventId1", callback); | 356 | +emitter.off('eventId1', callback); |
| 357 | ``` | 357 | ``` |
| 358 | 358 | ||
| 359 | ## emitter.off<sup>12+</sup> | 359 | ## emitter.off<sup>12+</sup> |
| @@ -399,7 +399,7 @@ let callback: Callback<emitter.GenericEventData<Sample>> = (eventData: emitter.G | |||
| 399 | }; | 399 | }; |
| 400 | // 取消eventId为"eventId1"的事件回调处理函数，callback对象应使用订阅时的对象 | 400 | // 取消eventId为"eventId1"的事件回调处理函数，callback对象应使用订阅时的对象 |
| 401 | // 如果该回调处理函数没有被订阅，则不做任何处理 | 401 | // 如果该回调处理函数没有被订阅，则不做任何处理 |
| 402 | -emitter.off("eventId1", callback); | 402 | +emitter.off('eventId1', callback); |
| 403 | ``` | 403 | ``` |
| 404 | 404 | ||
| 405 | ## emitter.emit | 405 | ## emitter.emit |
| @@ -1061,7 +1061,7 @@ emitter1.emit('eventId', eventData); | |||
| 1061 | 1061 | ||
| 1062 | emit(eventId: string, options: Options, data?: EventData): void | 1062 | emit(eventId: string, options: Options, data?: EventData): void |
| 1063 | 1063 | ||
| 1064 | -发送指定优先级事件到当前Emitter类实例。。 | 1064 | +发送指定优先级事件到当前Emitter类实例。 |
| 1065 | 1065 | ||
| 1066 | 该接口支持跨线程传输数据对象，需要遵循数据跨线程传输的规格约束，详见[线程间通信对象](../../arkts-utils/serializable-overview.md)。目前不支持使用[@State装饰器](../../ui/state-management/arkts-state.md)、[@Observed装饰器](../../ui/state-management/arkts-observed-and-objectlink.md)等装饰器修饰的复杂类型数据。 | 1066 | 该接口支持跨线程传输数据对象，需要遵循数据跨线程传输的规格约束，详见[线程间通信对象](../../arkts-utils/serializable-overview.md)。目前不支持使用[@State装饰器](../../ui/state-management/arkts-state.md)、[@Observed装饰器](../../ui/state-management/arkts-observed-and-objectlink.md)等装饰器修饰的复杂类型数据。 |
| 1067 | 1067 | ||
| @@ -20,10 +20,10 @@ | |||
| 20 | 20 | ||
| 21 | | 名称 | 类型 | 只读 | 可选 | 说明 | | 21 | | 名称 | 类型 | 只读 | 可选 | 说明 | |
| 22 | | --------------------- | -------------------- | ---- | ---- | ---------------------------- | | 22 | | --------------------- | -------------------- | ---- | ---- | ---------------------------- | |
| 23 | -| bundleName | string | 否 | 是 | 表示订阅者包名，用于限定将公共事件发布给指定包名的订阅者。<br>**原子化服务API：** 从API version 11开始，该接口支持在原子化服务中使用。 | | 23 | +| bundleName | string | 否 | 是 | 表示订阅者包名，用于限定将公共事件发布给指定包名的订阅者。默认为空。当该参数为空时，表示不限制订阅者包名，所有订阅者都可以接收该公共事件。<br>**原子化服务API：** 从API version 11开始，该接口支持在原子化服务中使用。 | |
| 24 | | code | number | 否 | 是 | 表示发布方传递的公共事件数据（number类型）。默认值为0。<br>**原子化服务API：** 从API version 11开始，该接口支持在原子化服务中使用。 | | 24 | | code | number | 否 | 是 | 表示发布方传递的公共事件数据（number类型）。默认值为0。<br>**原子化服务API：** 从API version 11开始，该接口支持在原子化服务中使用。 | |
| 25 | -| data | string | 否 | 是 | 表示发布方传递的公共事件数据（string类型）。数据大小不超过64KB。<br>**原子化服务API：** 从API version 11开始，该接口支持在原子化服务中使用。 | | 25 | +| data | string | 否 | 是 | 表示发布方传递的公共事件数据（string类型）。数据大小不超过64KB，超出限制时，事件发布失败。默认为空。<br>**原子化服务API：** 从API version 11开始，该接口支持在原子化服务中使用。 | |
| 26 | -| subscriberPermissions | Array\<string> | 否 | 是 | 表示订阅者的权限，只有具备该权限的订阅者才能收到该公共事件。<br>**原子化服务API：** 从API version 11开始，该接口支持在原子化服务中使用。 | | 26 | +| subscriberPermissions | Array\<string> | 否 | 是 | 表示订阅者的权限，只有具备该权限的订阅者才能收到该公共事件。默认为空。当该参数为空时，表示不限制订阅者的权限，所有订阅者都可以接收该公共事件。<br>**原子化服务API：** 从API version 11开始，该接口支持在原子化服务中使用。 | |
| 27 | | isOrdered | boolean | 否 | 是 | 表示是否是有序公共事件。默认为false。<br> - true：有序公共事件，根据订阅者设置的优先级等级，优先将公共事件发送给优先级较高的订阅者，等待其成功接收该公共事件之后再将事件发送给优先级较低的订阅者。如果有多个订阅者具有相同的优先级，则他们将随机接收到公共事件。<br> - false：无序公共事件，不考虑订阅者是否接收到该事件，也不保证订阅者接收到该事件的顺序与其订阅顺序一致。 | | 27 | | isOrdered | boolean | 否 | 是 | 表示是否是有序公共事件。默认为false。<br> - true：有序公共事件，根据订阅者设置的优先级等级，优先将公共事件发送给优先级较高的订阅者，等待其成功接收该公共事件之后再将事件发送给优先级较低的订阅者。如果有多个订阅者具有相同的优先级，则他们将随机接收到公共事件。<br> - false：无序公共事件，不考虑订阅者是否接收到该事件，也不保证订阅者接收到该事件的顺序与其订阅顺序一致。 | |
| 28 | | isSticky | boolean | 否 | 是 | 表示是否是粘性公共事件。默认为false。<br> - true：粘性公共事件，能够让订阅者收到在订阅前已经发送的公共事件。<br> - false：普通公共事件，只能让订阅者收到在订阅后才发送的公共事件。<br>仅系统应用或系统服务允许发送粘性事件。<br>**需要权限：**[ohos.permission.COMMONEVENT_STICKY](../../security/AccessToken/permissions-for-all.md#ohospermissioncommonevent_sticky) | | 28 | | isSticky | boolean | 否 | 是 | 表示是否是粘性公共事件。默认为false。<br> - true：粘性公共事件，能够让订阅者收到在订阅前已经发送的公共事件。<br> - false：普通公共事件，只能让订阅者收到在订阅后才发送的公共事件。<br>仅系统应用或系统服务允许发送粘性事件。<br>**需要权限：**[ohos.permission.COMMONEVENT_STICKY](../../security/AccessToken/permissions-for-all.md#ohospermissioncommonevent_sticky) | |
| 29 | -| parameters | {[key: string]: any} | 否 | 是 | 表示发布方传递的公共事件的附加信息，以键值对形式携带自定义参数。<br>**原子化服务API：** 从API version 11开始，该接口支持在原子化服务中使用。 | | 29 | +| parameters | {[key: string]: any} | 否 | 是 | 表示发布方传递的公共事件的附加信息，以键值对形式携带自定义参数。默认为空。<br>**原子化服务API：** 从API version 11开始，该接口支持在原子化服务中使用。 | |
| @@ -23,8 +23,8 @@ | |||
| 23 | | 名称 | 类型 | 只读 | 可选 | 说明 | | 23 | | 名称 | 类型 | 只读 | 可选 | 说明 | |
| 24 | | ------------------- | -------------- | ---- | ---- | ------------------------------------------------------------ | | 24 | | ------------------- | -------------- | ---- | ---- | ------------------------------------------------------------ | |
| 25 | | events | Array\<string> | 否 | 否 | 表示要订阅的公共事件列表。 | | 25 | | events | Array\<string> | 否 | 否 | 表示要订阅的公共事件列表。 | |
| 26 | -| publisherPermission | string | 否 | 是 | 表示发布者的权限，取值为系统已定义的权限名，订阅方将只能接收到具有该权限的发送方发布的事件。不设置时，可接收所有发送方发布的事件。 | | 26 | +| publisherPermission | string | 否 | 是 | 表示发布者的权限，取值为系统已定义的权限名。用于限制订阅方只接收具有该权限的发布方发布的公共事件。不设置时，可接收所有发布方发布的公共事件。 | |
| 27 | | publisherDeviceId | string | 否 | 是 | 表示设备ID，用于限制订阅者只接收来自指定设备发布的公共事件。通过[@ohos.deviceInfo](js-apis-device-info.md)获取udid，作为发布者的设备ID。预留能力，暂不支持。 | | 27 | | publisherDeviceId | string | 否 | 是 | 表示设备ID，用于限制订阅者只接收来自指定设备发布的公共事件。通过[@ohos.deviceInfo](js-apis-device-info.md)获取udid，作为发布者的设备ID。预留能力，暂不支持。 | |
| 28 | | userId | number | 否 | 是 | 表示用户ID，用于限制订阅者只接收指定用户ID相关的公共事件。此参数是可选的，默认值为当前用户的ID。如果指定了此参数，则该值必须是系统中现有的用户ID。通过[getOsAccountLocalId](./js-apis-osAccount.md#getosaccountlocalid9)获取系统用户ID，作为发布者的用户ID。 | | 28 | | userId | number | 否 | 是 | 表示用户ID，用于限制订阅者只接收指定用户ID相关的公共事件。此参数是可选的，默认值为当前用户的ID。如果指定了此参数，则该值必须是系统中现有的用户ID。通过[getOsAccountLocalId](./js-apis-osAccount.md#getosaccountlocalid9)获取系统用户ID，作为发布者的用户ID。 | |
| 29 | -| priority | number | 否 | 是 | 表示订阅者的优先级，优先级越高的订阅者，越优先接收到有序公共事件。取值范围是-100到1000，超过上下限的优先级将被设置为对应的上下限值，默认优先级为0。 | | 29 | +| priority | number | 否 | 是 | 表示订阅者的优先级，数值越大，订阅者优先级越高，越优先接收到有序公共事件。取值范围是-100到1000，超过上下限的优先级将被设置为对应的上下限值，默认优先级为0。 | |
| 30 | | publisherBundleName<sup>11+</sup> | string | 否 | 是 | 表示要订阅的发布者的bundleName，用于限制订阅方只接收该bundleName的发布者发布的公共事件。不设置时，可接收所有应用发布的公共事件。 | | 30 | | publisherBundleName<sup>11+</sup> | string | 否 | 是 | 表示要订阅的发布者的bundleName，用于限制订阅方只接收该bundleName的发布者发布的公共事件。不设置时，可接收所有应用发布的公共事件。 | |
| @@ -12,7 +12,7 @@ | |||
| 12 | 12 | ||
| 13 | ## CommonEventSubscriber | 13 | ## CommonEventSubscriber |
| 14 | 14 | ||
| 15 | -表示公共事件的订阅者。CommonEventSubscriber提供了对有序公共事件的处理能力，包括获取和设置事件传递的Code和Data数据、查询当前公共事件是否为有序或粘性事件、中止或清理有序公共事件的中止状态、结束对当前有序公共事件的处理，以及获取订阅者的订阅信息等，适用于订阅者需要对接收到的公共事件进行数据处理和流程控制的场景。 | 15 | +表示公共事件的订阅者。CommonEventSubscriber提供了对有序公共事件的处理能力，包括获取和设置事件传递的Code和Data数据、查询当前公共事件是否为有序或粘性公共事件、中止或清理有序公共事件的中止状态、结束对当前有序公共事件的处理，以及获取订阅者的订阅信息等，适用于订阅者需要对接收到的公共事件进行数据处理和流程控制的场景。 |
| 16 | 16 | ||
| 17 | **原子化服务API：** 从API version 11开始，该接口支持在原子化服务中使用。 | 17 | **原子化服务API：** 从API version 11开始，该接口支持在原子化服务中使用。 |
| 18 | 18 | ||
| @@ -41,7 +41,7 @@ subscriber = commonEventManager.createSubscriberSync(subscribeInfo); | |||
| 41 | 41 | ||
| 42 | getCode(callback: AsyncCallback\<number>): void | 42 | getCode(callback: AsyncCallback\<number>): void |
| 43 | 43 | ||
| 44 | -获取有序公共事件传递的数据（number类型）。使用callback异步回调。 | 44 | +获取有序公共事件传递的数据。使用callback异步回调。 |
| 45 | 45 | ||
| 46 | **原子化服务API：** 从API version 11开始，该接口支持在原子化服务中使用。 | 46 | **原子化服务API：** 从API version 11开始，该接口支持在原子化服务中使用。 |
| 47 | 47 | ||
| @@ -79,7 +79,7 @@ subscriber.getCode((err: BusinessError, code: number) => { | |||
| 79 | 79 | ||
| 80 | getCode(): Promise\<number> | 80 | getCode(): Promise\<number> |
| 81 | 81 | ||
| 82 | -获取有序公共事件传递的数据（number类型）。使用Promise异步回调。 | 82 | +获取有序公共事件传递的数据。使用Promise异步回调。 |
| 83 | 83 | ||
| 84 | **原子化服务API：** 从API version 11开始，该接口支持在原子化服务中使用。 | 84 | **原子化服务API：** 从API version 11开始，该接口支持在原子化服务中使用。 |
| 85 | 85 | ||
| @@ -107,7 +107,7 @@ subscriber.getCode().then((code: number) => { | |||
| 107 | 107 | ||
| 108 | getCodeSync(): number | 108 | getCodeSync(): number |
| 109 | 109 | ||
| 110 | -同步获取有序公共事件传递的数据（number类型）。 | 110 | +同步获取有序公共事件传递的数据。 |
| 111 | 111 | ||
| 112 | **原子化服务API：** 从API version 11开始，该接口支持在原子化服务中使用。 | 112 | **原子化服务API：** 从API version 11开始，该接口支持在原子化服务中使用。 |
| 113 | 113 | ||
| @@ -117,7 +117,7 @@ getCodeSync(): number | |||
| 117 | 117 | ||
| 118 | | 类型 | 说明 | | 118 | | 类型 | 说明 | |
| 119 | | ---------------- | -------------------- | | 119 | | ---------------- | -------------------- | |
| 120 | -| number | 有序公共事件传递的数据（number类型）。 | | 120 | +| number | 有序公共事件传递的数据。 | |
| 121 | 121 | ||
| 122 | **示例：** | 122 | **示例：** |
| 123 | 123 | ||
| @@ -132,7 +132,7 @@ console.info(`Succeeded in getting code, code is ${JSON.stringify(code)}`); | |||
| 132 | 132 | ||
| 133 | setCode(code: number, callback: AsyncCallback\<void>): void | 133 | setCode(code: number, callback: AsyncCallback\<void>): void |
| 134 | 134 | ||
| 135 | -设置有序公共事件传递的数据（number类型）。使用callback异步回调。 | 135 | +设置有序公共事件传递的数据。使用callback异步回调。 |
| 136 | 136 | ||
| 137 | **原子化服务API：** 从API version 11开始，该接口支持在原子化服务中使用。 | 137 | **原子化服务API：** 从API version 11开始，该接口支持在原子化服务中使用。 |
| 138 | 138 | ||
| @@ -142,7 +142,7 @@ setCode(code: number, callback: AsyncCallback\<void>): void | |||
| 142 | 142 | ||
| 143 | | 参数名 | 类型 | 必填 | 说明 | | 143 | | 参数名 | 类型 | 必填 | 说明 | |
| 144 | | -------- | -------------------- | ---- | ---------------------- | | 144 | | -------- | -------------------- | ---- | ---------------------- | |
| 145 | -| code | number | 是 | 有序公共事件传递的数据（number类型）。 | | 145 | +| code | number | 是 | 有序公共事件传递的数据。 | |
| 146 | | callback | AsyncCallback\<void> | 是 | 回调函数。当设置有序公共事件传递的数据（number类型）成功时，err为undefined，否则为错误对象。 | | 146 | | callback | AsyncCallback\<void> | 是 | 回调函数。当设置有序公共事件传递的数据（number类型）成功时，err为undefined，否则为错误对象。 | |
| 147 | 147 | ||
| 148 | **错误码：** | 148 | **错误码：** |
| @@ -171,7 +171,7 @@ subscriber.setCode(1, (err: BusinessError) => { | |||
| 171 | 171 | ||
| 172 | setCode(code: number): Promise\<void> | 172 | setCode(code: number): Promise\<void> |
| 173 | 173 | ||
| 174 | -设置有序公共事件传递的数据（number类型）。使用Promise异步回调。 | 174 | +设置有序公共事件传递的数据。使用Promise异步回调。 |
| 175 | 175 | ||
| 176 | **原子化服务API：** 从API version 11开始，该接口支持在原子化服务中使用。 | 176 | **原子化服务API：** 从API version 11开始，该接口支持在原子化服务中使用。 |
| 177 | 177 | ||
| @@ -181,7 +181,7 @@ setCode(code: number): Promise\<void> | |||
| 181 | 181 | ||
| 182 | | 参数名 | 类型 | 必填 | 说明 | | 182 | | 参数名 | 类型 | 必填 | 说明 | |
| 183 | | ------ | ------ | ---- | ------------------ | | 183 | | ------ | ------ | ---- | ------------------ | |
| 184 | -| code | number | 是 | 有序公共事件传递的数据（number类型）。 | | 184 | +| code | number | 是 | 有序公共事件传递的数据。 | |
| 185 | 185 | ||
| 186 | **返回值：** | 186 | **返回值：** |
| 187 | 187 | ||
| @@ -213,7 +213,7 @@ subscriber.setCode(1).then(() => { | |||
| 213 | 213 | ||
| 214 | setCodeSync(code: number): void | 214 | setCodeSync(code: number): void |
| 215 | 215 | ||
| 216 | -设置有序公共事件传递的数据（number类型）。 | 216 | +同步设置有序公共事件传递的数据。 |
| 217 | 217 | ||
| 218 | **原子化服务API：** 从API version 11开始，该接口支持在原子化服务中使用。 | 218 | **原子化服务API：** 从API version 11开始，该接口支持在原子化服务中使用。 |
| 219 | 219 | ||
| @@ -223,7 +223,7 @@ setCodeSync(code: number): void | |||
| 223 | 223 | ||
| 224 | | 参数名 | 类型 | 必填 | 说明 | | 224 | | 参数名 | 类型 | 必填 | 说明 | |
| 225 | | ------ | ------ | ---- | ------------------ | | 225 | | ------ | ------ | ---- | ------------------ | |
| 226 | -| code | number | 是 | 有序公共事件传递的数据（number类型）。 | | 226 | +| code | number | 是 | 有序公共事件传递的数据。 | |
| 227 | 227 | ||
| 228 | **错误码：** | 228 | **错误码：** |
| 229 | 229 | ||
| @@ -250,7 +250,7 @@ try { | |||
| 250 | 250 | ||
| 251 | getData(callback: AsyncCallback\<string>): void | 251 | getData(callback: AsyncCallback\<string>): void |
| 252 | 252 | ||
| 253 | -获取有序公共事件传递的数据（string类型）。使用callback异步回调。 | 253 | +获取有序公共事件传递的数据。使用callback异步回调。 |
| 254 | 254 | ||
| 255 | **原子化服务API：** 从API version 11开始，该接口支持在原子化服务中使用。 | 255 | **原子化服务API：** 从API version 11开始，该接口支持在原子化服务中使用。 |
| 256 | 256 | ||
| @@ -289,7 +289,7 @@ subscriber.getData((err: BusinessError, data: string) => { | |||
| 289 | 289 | ||
| 290 | getData(): Promise\<string> | 290 | getData(): Promise\<string> |
| 291 | 291 | ||
| 292 | -获取有序公共事件传递的数据（string类型）。使用Promise异步回调。 | 292 | +获取有序公共事件传递的数据。使用Promise异步回调。 |
| 293 | 293 | ||
| 294 | **原子化服务API：** 从API version 11开始，该接口支持在原子化服务中使用。 | 294 | **原子化服务API：** 从API version 11开始，该接口支持在原子化服务中使用。 |
| 295 | 295 | ||
| @@ -317,7 +317,7 @@ subscriber.getData().then((data: string) => { | |||
| 317 | 317 | ||
| 318 | getDataSync(): string | 318 | getDataSync(): string |
| 319 | 319 | ||
| 320 | -获取有序公共事件传递的数据（string类型）。 | 320 | +同步获取有序公共事件传递的数据。 |
| 321 | 321 | ||
| 322 | **原子化服务API：** 从API version 11开始，该接口支持在原子化服务中使用。 | 322 | **原子化服务API：** 从API version 11开始，该接口支持在原子化服务中使用。 |
| 323 | 323 | ||
| @@ -327,7 +327,7 @@ getDataSync(): string | |||
| 327 | 327 | ||
| 328 | | 类型 | 说明 | | 328 | | 类型 | 说明 | |
| 329 | | ---------------- | ------------------ | | 329 | | ---------------- | ------------------ | |
| 330 | -| string | 有序公共事件传递的数据（string类型）。 | | 330 | +| string | 有序公共事件传递的数据。 | |
| 331 | 331 | ||
| 332 | **示例：** | 332 | **示例：** |
| 333 | 333 | ||
| @@ -342,7 +342,7 @@ console.info(`Succeeded in getting data, data is ${data}`); | |||
| 342 | 342 | ||
| 343 | setData(data: string, callback: AsyncCallback\<void>): void | 343 | setData(data: string, callback: AsyncCallback\<void>): void |
| 344 | 344 | ||
| 345 | -设置有序公共事件传递的数据（string类型）。使用callback异步回调。 | 345 | +设置有序公共事件传递的数据。使用callback异步回调。 |
| 346 | 346 | ||
| 347 | **原子化服务API：** 从API version 11开始，该接口支持在原子化服务中使用。 | 347 | **原子化服务API：** 从API version 11开始，该接口支持在原子化服务中使用。 |
| 348 | 348 | ||
| @@ -381,7 +381,7 @@ subscriber.setData('publish_data_changed', (err: BusinessError) => { | |||
| 381 | 381 | ||
| 382 | setData(data: string): Promise\<void> | 382 | setData(data: string): Promise\<void> |
| 383 | 383 | ||
| 384 | -设置有序公共事件传递的数据（string类型）。使用Promise异步回调。 | 384 | +设置有序公共事件传递的数据。使用Promise异步回调。 |
| 385 | 385 | ||
| 386 | **原子化服务API：** 从API version 11开始，该接口支持在原子化服务中使用。 | 386 | **原子化服务API：** 从API version 11开始，该接口支持在原子化服务中使用。 |
| 387 | 387 | ||
| @@ -391,7 +391,7 @@ setData(data: string): Promise\<void> | |||
| 391 | 391 | ||
| 392 | | 参数名 | 类型 | 必填 | 说明 | | 392 | | 参数名 | 类型 | 必填 | 说明 | |
| 393 | | ------ | ------ | ---- | -------------------- | | 393 | | ------ | ------ | ---- | -------------------- | |
| 394 | -| data | string | 是 | 有序公共事件传递的数据（string类型）。 | | 394 | +| data | string | 是 | 有序公共事件传递的数据，长度不超过65536字符，若超过限制，接口设置失效。 | |
| 395 | 395 | ||
| 396 | **返回值：** | 396 | **返回值：** |
| 397 | 397 | ||
| @@ -423,7 +423,7 @@ subscriber.setData('publish_data_changed').then(() => { | |||
| 423 | 423 | ||
| 424 | setDataSync(data: string): void | 424 | setDataSync(data: string): void |
| 425 | 425 | ||
| 426 | -设置有序公共事件传递的数据（string类型）。 | 426 | +同步设置有序公共事件传递的数据。 |
| 427 | 427 | ||
| 428 | **原子化服务API：** 从API version 11开始，该接口支持在原子化服务中使用。 | 428 | **原子化服务API：** 从API version 11开始，该接口支持在原子化服务中使用。 |
| 429 | 429 | ||
| @@ -433,7 +433,7 @@ setDataSync(data: string): void | |||
| 433 | 433 | ||
| 434 | | 参数名 | 类型 | 必填 | 说明 | | 434 | | 参数名 | 类型 | 必填 | 说明 | |
| 435 | | ------ | ------ | ---- | -------------------- | | 435 | | ------ | ------ | ---- | -------------------- | |
| 436 | -| data | string | 是 | 有序公共事件传递的数据（string类型），长度不超过65536字符，若超过限制，接口设置失效。 | | 436 | +| data | string | 是 | 有序公共事件传递的数据，长度不超过65536字符，若超过限制，接口设置失效。 | |
| 437 | 437 | ||
| 438 | **错误码：** | 438 | **错误码：** |
| 439 | 439 | ||
| @@ -470,8 +470,8 @@ setCodeAndData(code: number, data: string, callback: AsyncCallback\<void\>): voi | |||
| 470 | 470 | ||
| 471 | | 参数名 | 类型 | 必填 | 说明 | | 471 | | 参数名 | 类型 | 必填 | 说明 | |
| 472 | | -------- | -------------------- | ---- | ---------------------- | | 472 | | -------- | -------------------- | ---- | ---------------------- | |
| 473 | -| code | number | 是 | 有序公共事件传递的数据（number类型）。 | | 473 | +| code | number | 是 | 有序公共事件传递的数据。 | |
| 474 | -| data | string | 是 | 有序公共事件传递的数据（string类型），长度不超过65536字符，若超过限制，接口设置失效。 | | 474 | +| data | string | 是 | 有序公共事件传递的数据，长度不超过65536字符，若超过限制，接口设置失效。 | |
| 475 | | callback | AsyncCallback\<void> | 是 | 回调函数。当设置有序公共事件传递的数据成功时，err为undefined，否则为错误对象。 | | 475 | | callback | AsyncCallback\<void> | 是 | 回调函数。当设置有序公共事件传递的数据成功时，err为undefined，否则为错误对象。 | |
| 476 | 476 | ||
| 477 | **错误码：** | 477 | **错误码：** |
| @@ -510,8 +510,8 @@ setCodeAndData(code: number, data: string): Promise\<void> | |||
| 510 | 510 | ||
| 511 | | 参数名 | 类型 | 必填 | 说明 | | 511 | | 参数名 | 类型 | 必填 | 说明 | |
| 512 | | ------ | ------ | ---- | -------------------- | | 512 | | ------ | ------ | ---- | -------------------- | |
| 513 | -| code | number | 是 | 有序公共事件传递的数据（number类型）。 | | 513 | +| code | number | 是 | 有序公共事件传递的数据。 | |
| 514 | -| data | string | 是 | 有序公共事件传递的数据（string类型），长度不超过65536字符，若超过限制，接口设置失效。 | | 514 | +| data | string | 是 | 有序公共事件传递的数据，长度不超过65536字符，若超过限制，接口设置失效。 | |
| 515 | 515 | ||
| 516 | **返回值：** | 516 | **返回值：** |
| 517 | 517 | ||
| @@ -543,7 +543,7 @@ subscriber.setCodeAndData(1, 'publish_data_changed').then(() => { | |||
| 543 | 543 | ||
| 544 | setCodeAndDataSync(code: number, data: string): void | 544 | setCodeAndDataSync(code: number, data: string): void |
| 545 | 545 | ||
| 546 | -设置有序公共事件传递的数据。 | 546 | +同步设置有序公共事件传递的数据。 |
| 547 | 547 | ||
| 548 | **原子化服务API：** 从API version 11开始，该接口支持在原子化服务中使用。 | 548 | **原子化服务API：** 从API version 11开始，该接口支持在原子化服务中使用。 |
| 549 | 549 | ||
| @@ -553,8 +553,8 @@ setCodeAndDataSync(code: number, data: string): void | |||
| 553 | 553 | ||
| 554 | | 参数名 | 类型 | 必填 | 说明 | | 554 | | 参数名 | 类型 | 必填 | 说明 | |
| 555 | | ------ | ------ | ---- | -------------------- | | 555 | | ------ | ------ | ---- | -------------------- | |
| 556 | -| code | number | 是 | 有序公共事件传递的数据（number类型）。 | | 556 | +| code | number | 是 | 有序公共事件传递的数据。 | |
| 557 | -| data | string | 是 | 有序公共事件传递的数据（string类型），长度不超过65536字符，若超过限制，接口设置失效。 | | 557 | +| data | string | 是 | 有序公共事件传递的数据，长度不超过65536字符，若超过限制，接口设置失效。 | |
| 558 | 558 | ||
| 559 | **错误码：** | 559 | **错误码：** |
| 560 | 560 | ||
| @@ -644,7 +644,7 @@ subscriber.isOrderedCommonEvent().then((isOrdered: boolean) => { | |||
| 644 | 644 | ||
| 645 | isOrderedCommonEventSync(): boolean | 645 | isOrderedCommonEventSync(): boolean |
| 646 | 646 | ||
| 647 | -查询当前公共事件是否为有序公共事件。 | 647 | +同步查询当前公共事件是否为有序公共事件。 |
| 648 | 648 | ||
| 649 | **系统能力：** SystemCapability.Notification.CommonEvent | 649 | **系统能力：** SystemCapability.Notification.CommonEvent |
| 650 | 650 | ||
| @@ -729,7 +729,7 @@ subscriber.isStickyCommonEvent().then((isSticky: boolean) => { | |||
| 729 | 729 | ||
| 730 | isStickyCommonEventSync(): boolean | 730 | isStickyCommonEventSync(): boolean |
| 731 | 731 | ||
| 732 | -检查当前公共事件是否为一个粘性事件。 | 732 | +同步检查当前公共事件是否为一个粘性公共事件。 |
| 733 | 733 | ||
| 734 | **系统能力：** SystemCapability.Notification.CommonEvent | 734 | **系统能力：** SystemCapability.Notification.CommonEvent |
| 735 | 735 | ||
| @@ -826,7 +826,7 @@ subscriber.finishCommonEvent().then(() => { | |||
| 826 | 826 | ||
| 827 | abortCommonEventSync(): void | 827 | abortCommonEventSync(): void |
| 828 | 828 | ||
| 829 | -添加有序公共事件的中止状态。当该接口与[finishCommonEvent](#finishcommonevent9)配合使用时，可以中止当前的有序公共事件，使该公共事件不再向下一个订阅者传递。 | 829 | +同步添加有序公共事件的中止状态。当该接口与[finishCommonEvent](#finishcommonevent9)配合使用时，可以中止当前的有序公共事件，使该公共事件不再向下一个订阅者传递。 |
| 830 | 830 | ||
| 831 | **系统能力：** SystemCapability.Notification.CommonEvent | 831 | **系统能力：** SystemCapability.Notification.CommonEvent |
| 832 | 832 | ||
| @@ -921,7 +921,7 @@ subscriber.finishCommonEvent().then(() => { | |||
| 921 | 921 | ||
| 922 | clearAbortCommonEventSync(): void | 922 | clearAbortCommonEventSync(): void |
| 923 | 923 | ||
| 924 | -清理有序公共事件的中止状态。当该接口与[finishCommonEvent](#finishcommonevent9)配合使用时，可以使该公共事件继续向下一个订阅者传递。 | 924 | +同步清理有序公共事件的中止状态。当该接口与[finishCommonEvent](#finishcommonevent9)配合使用时，可以使该公共事件继续向下一个订阅者传递。 |
| 925 | 925 | ||
| 926 | **系统能力：** SystemCapability.Notification.CommonEvent | 926 | **系统能力：** SystemCapability.Notification.CommonEvent |
| 927 | 927 | ||
| @@ -950,7 +950,7 @@ getAbortCommonEvent(callback: AsyncCallback\<boolean>): void | |||
| 950 | 950 | ||
| 951 | | 参数名 | 类型 | 必填 | 说明 | | 951 | | 参数名 | 类型 | 必填 | 说明 | |
| 952 | | -------- | ----------------------- | ---- | ---------------------------------- | | 952 | | -------- | ----------------------- | ---- | ---------------------------------- | |
| 953 | -| callback | AsyncCallback\<boolean> | 是 | 当查询成功时，err为undefined，data为true表示当前有序公共事件处于中止状态，data为false表示当前有序公共事件没有处于中止状态；否则err为错误对象。 | | 953 | +| callback | AsyncCallback\<boolean> | 是 | 当查询成功时，err为undefined，data为true表示当前有序公共事件处于中止状态，data为false表示当前有序公共事件未处于中止状态；否则err为错误对象。 | |
| 954 | 954 | ||
| 955 | **错误码：** | 955 | **错误码：** |
| 956 | 956 | ||
| @@ -986,7 +986,7 @@ getAbortCommonEvent(): Promise\<boolean> | |||
| 986 | 986 | ||
| 987 | | 类型 | 说明 | | 987 | | 类型 | 说明 | |
| 988 | | ----------------- | ---------------------------------- | | 988 | | ----------------- | ---------------------------------- | |
| 989 | -| Promise\<boolean> | Promise对象。返回true表示当前有序公共事件处于中止状态；返回false表示当前有序公共事件没有处于中止状态。 | | 989 | +| Promise\<boolean> | Promise对象。返回true表示当前有序公共事件处于中止状态；返回false表示当前有序公共事件未处于中止状态。 | |
| 990 | 990 | ||
| 991 | **示例：** | 991 | **示例：** |
| 992 | 992 | ||
| @@ -1004,7 +1004,7 @@ subscriber.getAbortCommonEvent().then((abortEvent: boolean) => { | |||
| 1004 | 1004 | ||
| 1005 | getAbortCommonEventSync(): boolean | 1005 | getAbortCommonEventSync(): boolean |
| 1006 | 1006 | ||
| 1007 | -获取当前有序公共事件是否处于中止状态。 | 1007 | +同步获取当前有序公共事件是否处于中止状态。 |
| 1008 | 1008 | ||
| 1009 | **系统能力：** SystemCapability.Notification.CommonEvent | 1009 | **系统能力：** SystemCapability.Notification.CommonEvent |
| 1010 | 1010 | ||
| @@ -1012,7 +1012,7 @@ getAbortCommonEventSync(): boolean | |||
| 1012 | 1012 | ||
| 1013 | | 类型 | 说明 | | 1013 | | 类型 | 说明 | |
| 1014 | | ----------------- | ---------------------------------- | | 1014 | | ----------------- | ---------------------------------- | |
| 1015 | -| boolean | 返回true表示当前有序公共事件处于中止状态；返回false表示当前有序公共事件没有处于中止状态。 | | 1015 | +| boolean | 返回true表示当前有序公共事件处于中止状态；返回false表示当前有序公共事件未处于中止状态。 | |
| 1016 | 1016 | ||
| 1017 | **示例：** | 1017 | **示例：** |
| 1018 | 1018 | ||
| @@ -1093,7 +1093,7 @@ subscriber.getSubscribeInfo().then((subscribeInfo: commonEventManager.CommonEven | |||
| 1093 | 1093 | ||
| 1094 | getSubscribeInfoSync(): CommonEventSubscribeInfo | 1094 | getSubscribeInfoSync(): CommonEventSubscribeInfo |
| 1095 | 1095 | ||
| 1096 | -获取订阅者的订阅信息。 | 1096 | +同步获取订阅者的订阅信息。 |
| 1097 | 1097 | ||
| 1098 | **原子化服务API：** 从API version 11开始，该接口支持在原子化服务中使用。 | 1098 | **原子化服务API：** 从API version 11开始，该接口支持在原子化服务中使用。 |
| 1099 | 1099 | ||
❌疑似检测出拼写问题
错误原因："exceed"应为"exceeds"（第三人称单数形式） 建议修改为：
8|Failedto initializetheommonevent service. |操作日志