ArkWeb_WebMessagePortAPI

typedef struct {...} ArkWeb_WebMessagePortAPI

概述

Post Message相关的Native API结构体。在调用接口前建议通过ARKWEB_MEMBER_MISSING校验该函数结构体是否有对应函数指针，避免SDK与设备ROM不匹配导致崩溃。WebMessagePort相关接口需在UI线程中调用OH_ArkWeb_GetNativeAPI方法获取。

起始版本： 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消息的回调。

成员函数说明

postMessage()

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

描述：

发送消息到HTML。

参数：

参数项	描述
const ArkWeb_WebMessagePortPtr webMessagePort	Post Message端口结构体指针。
const char* webTag	Web组件名称。
const ArkWeb_WebMessagePtr webMessage	需要发送的消息。

返回：

类型	说明
ArkWeb_ErrorCode	ARKWEB_SUCCESS 执行成功。 ARKWEB_INVALID_PARAM 参数无效。 ARKWEB_INIT_ERROR 初始化失败，没有找到与webTag绑定的Web组件。

close()

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

描述：

关闭消息端口。

参数：

参数项	描述
const ArkWeb_WebMessagePortPtr webMessagePort	Post Message端口结构体指针。
const char* webTag	Web组件名称。

setMessageEventHandler()

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

描述：

设置接收HTML消息的回调。

参数：

参数项	描述
const ArkWeb_WebMessagePortPtr webMessagePort	Post Message端口结构体指针。
const char* webTag	Web组件名称。
ArkWeb_OnMessageEventHandler messageEventHandler	处理消息的回调。
void* userData	用户自定义数据。