Class (JsMessageExt)

Implements a JsMessageExt object that is returned after the runJavaScriptExt API is invoked.

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(): JsMessageType

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

System capability: SystemCapability.Web.Webview.Core

Return value

Type	Description
JsMessageType	Data type of the result returned after the runJavaScriptExt API is executed.

getString¹⁰⁺

getString(): string

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

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.

Error Code	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 runJavaScriptExt.

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.

Error Code	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 runJavaScriptExt.

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.

Error Code	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 runJavaScriptExt.

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.

Error Code	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 runJavaScriptExt.

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.

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

getErrorDescription²²⁺

getErrorDescription(): string |null

Obtains the error information about the JavaScript execution. For details about the sample code, see runJavaScriptExt.

System capability: SystemCapability.Web.Webview.Core

Return value

Type	Description
string \|null	If an exception occurs during JavaScript execution or the return value is of the object type, "Not support type: <{exception\object}>" is returned.