提交 5603c0f9 编写于 作者: E echoorchid

update docs for web message port

Signed-off-by: Nechoorchid <huweidong2@huawei.com>
上级 22b1aa9b
...@@ -26,7 +26,7 @@ import web_webview from '@ohos.web.webview'; ...@@ -26,7 +26,7 @@ import web_webview from '@ohos.web.webview';
close(): void close(): void
关闭该息端口。 关闭该息端口。
**系统能力:** **系统能力:**
SystemCapability.Web.Webview.Core SystemCapability.Web.Webview.Core
...@@ -59,7 +59,7 @@ struct WebComponent { ...@@ -59,7 +59,7 @@ struct WebComponent {
postMessageEvent(message: string): void postMessageEvent(message: string): void
发送消息。 发送消息。完整示例代码参考[postMessage](#postmessage)
**系统能力:** **系统能力:**
SystemCapability.Web.Webview.Core SystemCapability.Web.Webview.Core
...@@ -112,7 +112,7 @@ struct WebComponent { ...@@ -112,7 +112,7 @@ struct WebComponent {
onMessageEvent(callback: (result: string) => void): void onMessageEvent(callback: (result: string) => void): void
注册回调函数,接收HTML5侧发送过来的消息。 注册回调函数,接收HTML5侧发送过来的消息。完整示例代码参考[postMessage](#postmessage)
**系统能力:** **系统能力:**
SystemCapability.Web.Webview.Core SystemCapability.Web.Webview.Core
...@@ -1293,7 +1293,7 @@ struct WebComponent { ...@@ -1293,7 +1293,7 @@ struct WebComponent {
createWebMessagePorts(): Array\<WebMessagePort> createWebMessagePorts(): Array\<WebMessagePort>
创建Web息端口。 创建Web息端口。
**系统能力:** **系统能力:**
SystemCapability.Web.Webview.Core SystemCapability.Web.Webview.Core
...@@ -1302,7 +1302,7 @@ SystemCapability.Web.Webview.Core ...@@ -1302,7 +1302,7 @@ SystemCapability.Web.Webview.Core
| 类型 | 说明 | | 类型 | 说明 |
| ---------------------- | ----------------- | | ---------------------- | ----------------- |
| Array\<WebMessagePort> | web息端口列表。 | | Array\<WebMessagePort> | web息端口列表。 |
**错误码** **错误码**
...@@ -1345,7 +1345,7 @@ struct WebComponent { ...@@ -1345,7 +1345,7 @@ struct WebComponent {
postMessage(name: string, ports: Array\<WebMessagePort>, uri: string): void postMessage(name: string, ports: Array\<WebMessagePort>, uri: string): void
发送Web息端口到HTML5。 发送Web息端口到HTML5。
**系统能力:** **系统能力:**
SystemCapability.Web.Webview.Core SystemCapability.Web.Webview.Core
...@@ -1354,7 +1354,7 @@ SystemCapability.Web.Webview.Core ...@@ -1354,7 +1354,7 @@ SystemCapability.Web.Webview.Core
| 参数名 | 类型 | 必填 | 默认值 | 说明 | | 参数名 | 类型 | 必填 | 默认值 | 说明 |
| ------ | ---------------------- | ---- | ------ | :------------------------------- | | ------ | ---------------------- | ---- | ------ | :------------------------------- |
| name | string | 是 | - | 要发送的信息,包含数据和息端口 | | name | string | 是 | - | 要发送的信息,包含数据和息端口 |
| ports | Array\<WebMessagePort> | 是 | - | 接收该信息的URI。 | | ports | Array\<WebMessagePort> | 是 | - | 接收该信息的URI。 |
| uri | string | 是 | - | 接收该信息的URI。 | | uri | string | 是 | - | 接收该信息的URI。 |
......
...@@ -3597,14 +3597,14 @@ getCookieManager(): WebCookie ...@@ -3597,14 +3597,14 @@ getCookieManager(): WebCookie
createWebMessagePorts(): Array\<WebMessagePort\> createWebMessagePorts(): Array\<WebMessagePort\>
创建Web息端口。 创建Web息端口。
**返回值:** **返回值:**
| 类型 | 说明 | | 类型 | 说明 |
| ------------------------------- | ------------- | | ------------------------------- | ------------- |
| Array\<[WebMessagePort](#webmessageport9)\> | web息端口列表。 | | Array\<[WebMessagePort](#webmessageport9)\> | web息端口列表。 |
**示例:** **示例:**
...@@ -3632,13 +3632,13 @@ createWebMessagePorts(): Array\<WebMessagePort\> ...@@ -3632,13 +3632,13 @@ createWebMessagePorts(): Array\<WebMessagePort\>
postMessage(options: { message: WebMessageEvent, uri: string}): void postMessage(options: { message: WebMessageEvent, uri: string}): void
发送Web息端口到HTML5。 发送Web息端口到HTML5。
**参数:** **参数:**
| 参数名 | 参数类型 | 必填 | 默认值 | 参数描述 | | 参数名 | 参数类型 | 必填 | 默认值 | 参数描述 |
| ---------- | --------------- | ---- | ---- | ------------------------- | | ---------- | --------------- | ---- | ---- | ------------------------- |
| message | [WebMessageEvent](#webmessageevent9) | 是 | - |要发送的信息,包含数据和息端口 。 | | message | [WebMessageEvent](#webmessageevent9) | 是 | - |要发送的信息,包含数据和息端口 。 |
| uri | string | 是 | - | 接收该信息的URI。 | | uri | string | 是 | - | 接收该信息的URI。 |
**示例:** **示例:**
...@@ -5361,7 +5361,7 @@ storeWebArchive(baseName: string, autoName: boolean): Promise<string> ...@@ -5361,7 +5361,7 @@ storeWebArchive(baseName: string, autoName: boolean): Promise<string>
### close<sup>9+</sup> ### close<sup>9+</sup>
close(): void close(): void
关闭该息端口。 关闭该息端口。
### postMessageEvent<sup>9+</sup> ### postMessageEvent<sup>9+</sup>
postMessageEvent(message: WebMessageEvent): void postMessageEvent(message: WebMessageEvent): void
......
Markdown is supported
0% .
You are about to add 0 people to the discussion. Proceed with caution.
先完成此消息的编辑!
想要评论请 注册