Class (WebMessageExt)

Implements a WebMessageExt object that received and sent by the WebMessagePort API.

NOTE

• The initial APIs of this module are supported since API version 9. Updates will be marked with a superscript to indicate their earliest API version.

• The initial APIs of this class are supported since API version 10.

• The sample effect is subject to the actual device.

getType¹⁰⁺

getType(): WebMessageType

Obtains the type of the data object. For details about the sample code, see onMessageEventExt.

System capability: SystemCapability.Web.Webview.Core

Return value

Type	Description
WebMessageType	Data types supported by the webMessagePort API.

getString¹⁰⁺

getString(): string

Obtains string-type data of the data object. For details about the sample code, see onMessageEventExt.

System capability: SystemCapability.Web.Webview.Core

Return value

Type	Description
string	Data of the string type.

Error codes

For details about the error codes, see Webview Error Codes.

ID	Error Message
17100014	The type and value of the message do not match.

getNumber¹⁰⁺

getNumber(): number

Obtains number-type data of the data object. For details about the sample code, see onMessageEventExt.

System capability: SystemCapability.Web.Webview.Core

Return value

Type	Description
number	Data of the number type.

Error codes

For details about the error codes, see Webview Error Codes.

ID	Error Message
17100014	The type and value of the message do not match.

getBoolean¹⁰⁺

getBoolean(): boolean

Obtains Boolean-type data of the data object. For details about the sample code, see onMessageEventExt.

System capability: SystemCapability.Web.Webview.Core

Return value

Type	Description
boolean	Data of the Boolean type.

Error codes

For details about the error codes, see Webview Error Codes.

ID	Error Message
17100014	The type and value of the message do not match.

getArrayBuffer¹⁰⁺

getArrayBuffer(): ArrayBuffer

Obtains raw binary data of the data object. For details about the sample code, see onMessageEventExt.

System capability: SystemCapability.Web.Webview.Core

Return value

Type	Description
ArrayBuffer	Raw binary data.

Error codes

For details about the error codes, see Webview Error Codes.

ID	Error Message
17100014	The type and value of the message do not match.

getArray¹⁰⁺

getArray(): Array<string|number|boolean>

Obtains array-type data of the data object. For details about the sample code, see onMessageEventExt.

System capability: SystemCapability.Web.Webview.Core

Return value

Type	Description
Array<string |number |boolean>	Data of the array type.

Error codes

For details about the error codes, see Webview Error Codes.

ID	Error Message
17100014	The type and value of the message do not match.

getError¹⁰⁺

getError(): Error

Obtains the error-object-type data of the data object. For details about the sample code, see onMessageEventExt.

System capability: SystemCapability.Web.Webview.Core

Return value

Type	Description
Error	Data of the error object type.

Error codes

For details about the error codes, see Webview Error Codes.

ID	Error Message
17100014	The type and value of the message do not match.

setType¹⁰⁺

setType(type: WebMessageType): void

Sets the type for the data object. For details about the sample code, see onMessageEventExt.

System capability: SystemCapability.Web.Webview.Core

Parameters

Name	Type	Mandatory	Description
type	WebMessageType	Yes	Data types supported by the webMessagePort API.

Error codes

For details about the error codes, see Webview Error Codes and Universal Error Codes.

ID	Error Message
17100014	The type and value of the message do not match.
401	Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. 2. Incorrect parameter types. 3.Parameter verification failed.

setString¹⁰⁺

setString(message: string): void

Sets the string-type data of the data object. For details about the sample code, see onMessageEventExt.

System capability: SystemCapability.Web.Webview.Core

Parameters

Name	Type	Mandatory	Description
message	string	Yes	String type.

Error codes

For details about the error codes, see Webview Error Codes and Universal Error Codes.

ID	Error Message
17100014	The type and value of the message do not match.
401	Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. 2. Incorrect parameter types. 3.Parameter verification failed.

setNumber¹⁰⁺

setNumber(message: number): void

Sets the number-type data of the data object. For details about the sample code, see onMessageEventExt.

System capability: SystemCapability.Web.Webview.Core

Parameters

Name	Type	Mandatory	Description
message	number	Yes	Data of the number type.

Error codes

For details about the error codes, see Webview Error Codes and Universal Error Codes.

ID	Error Message
17100014	The type and value of the message do not match.
401	Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. 2. Incorrect parameter types. 3.Parameter verification failed.

setBoolean¹⁰⁺

setBoolean(message: boolean): void

Sets the Boolean-type data for the data object. For details about the sample code, see onMessageEventExt.

System capability: SystemCapability.Web.Webview.Core

Parameters

Name	Type	Mandatory	Description
message	boolean	Yes	Data of the Boolean type.

Error codes

For details about the error codes, see Webview Error Codes and Universal Error Codes.

ID	Error Message
17100014	The type and value of the message do not match.
401	Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. 2. Incorrect parameter types. 3.Parameter verification failed.

setArrayBuffer¹⁰⁺

setArrayBuffer(message: ArrayBuffer): void

Sets the raw binary data for the data object. For details about the sample code, see onMessageEventExt.

System capability: SystemCapability.Web.Webview.Core

Parameters

Name	Type	Mandatory	Description
message	ArrayBuffer	Yes	Raw binary data.

Error codes

For details about the error codes, see Webview Error Codes and Universal Error Codes.

ID	Error Message
17100014	The type and value of the message do not match.
401	Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. 2. Incorrect parameter types. 3.Parameter verification failed.

setArray¹⁰⁺

setArray(message: Array<string|number|boolean>): void

Sets the array-type data for the data object. For details about the sample code, see onMessageEventExt.

System capability: SystemCapability.Web.Webview.Core

Parameters

Name	Type	Mandatory	Description
message	Array<string |number |boolean>	Yes	Data of the array type.

Error codes

For details about the error codes, see Webview Error Codes and Universal Error Codes.

ID	Error Message
17100014	The type and value of the message do not match.
401	Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. 2. Incorrect parameter types. 3.Parameter verification failed.

setError¹⁰⁺

setError(message: Error): void

Sets the error-object-type data for the data object. For details about the sample code, see onMessageEventExt.

System capability: SystemCapability.Web.Webview.Core

Parameters

Name	Type	Mandatory	Description
message	Error	Yes	Data of the error object type.

Error codes

For details about the error codes, see Webview Error Codes and Universal Error Codes.

ID	Error Message
17100014	The type and value of the message do not match.
401	Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. 2. Incorrect parameter types. 3.Parameter verification failed.

你可能感兴趣的鸿蒙文章

openharmony 鸿蒙 arkts-apis-webview-WebviewController

openharmony 鸿蒙 arkts-apis-webview-t

openharmony 鸿蒙 arkts-apis-webview

openharmony 鸿蒙 capi-arkweb-type-h

openharmony 鸿蒙 arkts-basic-components-web-FullScreenExitHandler

openharmony 鸿蒙 arkts-apis-webview-WebDownloadManager

openharmony 鸿蒙 arkts-basic-components-web-VerifyPinHandler

openharmony 鸿蒙 capi-web-arkweb-webmessage8h

openharmony 鸿蒙 arkts-apis-webview-NativeMediaPlayerHandler

openharmony 鸿蒙 capi-web-arkweb-proxymethodwithresult