广告
CommonEventManager.publish 方法允许开发者发布公共事件，其他应用或服务可以订阅并接收这些事件。这对于实现跨应用通信和系统级通知非常有用。
例如，一个社交应用可能在用户收到新消息时发布一个事件，而另一个应用（如一个桌面小部件或通知中心）可以订阅这个事件，以便在事件发生时更新用户界面。
方法详解
CommonEventManager.publish(event: string, options:
CommonEventPublishData, callback: AsyncCallback<void>): void- 参数:
- event: (string, 必填) 要发布的公共事件名称。
- options: (CommonEventPublishData, 必填) 发布公共事件的属性，包含以下字段:
- code: (number) 公共事件的初始代码。
- data: (string) 公共事件的初始数据。
- isOrdered: (boolean) 是否是有序公共事件。有序公共事件按照订阅顺序接收事件。
- callback: (AsyncCallback, 必填) 回调函数，用于处理发布结果。
- 系统能力: SystemCapability.Notification.CommonEvent
- 错误码:
- 1500004: not System services or System app (非系统服务或系统应用)
- 1500007: message send error (消息发送错误)
- 1500008: CEMS error (公共事件管理服务错误)
- 1500009: system error (系统错误)
示例代码
下面是一个完整的示例代码，展示了如何使用CommonEventManager.publish方法发布一个公共事件：
// 定义公共事件相关信息
var options = {
code: 0, // 公共事件的初始代码
data: "initial data", // 公共事件的初始数据
isOrdered: true // 设置为有序公共事件
};
// 定义发布公共事件的回调函数
function publishCallBack(err) {
if (err) {
console.error("发布失败: " + JSON.stringify(err));
} else {
console.info("事件已成功发布");
}
}
// 发布公共事件
try {
CommonEventManager.publish("myCustomEvent", options, publishCallBack);
} catch (err) {
console.error('发布过程中发生错误: ' + JSON.stringify(err));
}代码解释：
- 定义公共事件信息： 首先，需要定义一个
options对象，它包含公共事件的详细信息，如事件代码、数据和是否是有序事件。这些信息将随事件一起发布，供订阅者使用。 - 编写回调函数： 这个函数将在事件发布后被调用，你可以在其中处理成功或失败的情况。
- 发布公共事件： 使用
CommonEventManager.publish方法来发布你的公共事件。你需要提供事件的名称、前面定义的options对象和回调函数。 - 错误处理： 使用
try...catch语句来捕获并处理可能出现的错误。
总结
CommonEventManager.publish 提供了一种灵活的方式在HarmonyOS应用之间传递信息。开发者可以利用公共事件实现各种功能，例如跨应用数据同步、系统级通知和事件驱动架构。