harmony 鸿蒙ArkWeb_WebMessagePortAPI

2025-06-12
浏览 (4)

ArkWeb_WebMessagePortAPI

概述

Post Message相关的Native API结构体。在调用接口前建议通过ARKWEB_MEMBER_MISSING校验该函数结构体是否有对应函数指针，避免SDK与设备ROM不匹配导致crash问题。

起始版本： 12

相关模块：Web

所在头文件： arkweb_type.h

汇总

成员变量

名称	描述
size_t size	结构体的大小。
ArkWeb_ErrorCode(* postMessage )(const ArkWeb_WebMessagePortPtr webMessagePort, const char *webTag, const ArkWeb_WebMessagePtr webMessage)	发送消息到HTML。
void(* close )(const ArkWeb_WebMessagePortPtr webMessagePort, const char *webTag)	关闭消息端口。
void(* setMessageEventHandler )(const ArkWeb_WebMessagePortPtr webMessagePort, const char webTag, ArkWeb_OnMessageEventHandler messageEventHandler, void userData)	设置接收HTML消息的回调。

结构体成员变量说明

close

void(* ArkWeb_WebMessagePortAPI::close) (const ArkWeb_WebMessagePortPtr webMessagePort, const char *webTag)

描述：

关闭消息端口。

参数:

名称	描述
webMessagePort	Post Message端口结构体指针。
webTag	Web组件名称。

postMessage

ArkWeb_ErrorCode(* ArkWeb_WebMessagePortAPI::postMessage) (const ArkWeb_WebMessagePortPtr webMessagePort, const char *webTag, const ArkWeb_WebMessagePtr webMessage)

描述：

发送消息到HTML。

参数:

名称	描述
webMessagePort	Post Message端口结构体指针。
webTag	Web组件名称。
webMessage	需要发送的消息。

返回：

返回值错误码。 ARKWEB_SUCCESS 执行成功。 ARKWEB_INVALID_PARAM 参数无效。 ARKWEB_INIT_ERROR 初始化失败，没有找到与webTag绑定的Web组件。

setMessageEventHandler

void(* ArkWeb_WebMessagePortAPI::setMessageEventHandler) (const ArkWeb_WebMessagePortPtr webMessagePort, const char *webTag, ArkWeb_OnMessageEventHandler messageEventHandler, void *userData)

描述：

设置接收HTML消息的回调。

参数: