Interfaces (Others)

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 sample effect is subject to the actual device.

WebStorageOrigin

Provides usage information of the Web SQL Database.

System capability: SystemCapability.Web.Webview.Core

Name	Type	Read-Only	Optional	Description
origin	string	No	No	Index of the origin.
usage	number	No	No	Storage usage of the origin.
quota	number	No	No	Storage quota of the origin.

WebHeader

Describes the request/response header returned by the Web component.

System capability: SystemCapability.Web.Webview.Core

Name	Type	Read-Only	Optional	Description
headerKey	string	No	No	Key of the request/response header.
headerValue	string	No	No	Value of the request/response header.

WebCustomScheme

Defines a custom URL scheme.

System capability: SystemCapability.Web.Webview.Core

Name	Type	Read-Only	Optional	Description
schemeName	string	No	No	Name of the custom URL scheme. The value can contain a maximum of 32 characters, including lowercase letters, digits, periods (.), plus signs (+), and hyphens (-), and must start with a letter.
isSupportCORS	boolean	No	No	Whether to support cross-origin resource sharing (CORS). The value true means to support cross-origin resource sharing (CORS), and false means the opposite. Default value: true.
isSupportFetch	boolean	No	No	Whether to support fetch requests. The value true means to support fetch requests, and false means the opposite. Default value: true.
isStandard12+	boolean	No	Yes	Whether the scheme is processed as a standard scheme. The standard scheme must comply with the URL normalization and parsing rules defined in section 3.1 of RFC 1738. The value true indicates that the scheme is processed as a standard scheme, and false indicates the opposite. Default value: true.
isLocal12+	boolean	No	Yes	Whether the scheme is treated with the same security rules as those applied to file URLs. The value true indicates that the scheme is treated with the same security rules as those applied to file URLs, and the value false indicates the opposite. Default value: true.
isDisplayIsolated12+	boolean	No	Yes	Whether the content of the scheme can be displayed or accessed from other content that uses the same scheme. The value true indicates that the content of the scheme can only be displayed or accessed from other content that uses the same scheme, and false indicates the opposite. Default value: true.
isSecure12+	boolean	No	Yes	Whether the scheme is treated with the same security rules as those applied to HTTPS URLs. The value true indicates that the scheme is treated with the same security rules as those applied to HTTPS URLs, and false indicates the opposite. Default value: true.
isCspBypassing12+	boolean	No	Yes	Whether the scheme can bypass the content security policy (CSP) checks. The value true indicates that the scheme can bypass the content security policy (CSP) checks, and false indicates the opposite. Default value: true. In most cases, this value should not be set when isStandard is set to true.
isCodeCacheSupported12+	boolean	No	Yes	Whether JavaScript resources loaded with the scheme can be used to create a code cache. The value true indicates that JavaScript resources loaded with the scheme can be used to create a code cache, and false indicates the opposite. Default value: false.

RequestInfo¹²⁺

Describes the information about the resource request sent by the Web component.

System capability: SystemCapability.Web.Webview.Core

Name	Type	Read-Only	Optional	Description
url	string	No	No	URL of the request.
method	string	No	No	Method of the request.
formData	string	No	No	Form data in the request body.

CacheOptions¹²⁺

Represents a configuration object for precompiling JavaScript in the Web component to generate bytecode cache, which is designed to control the updating of the bytecode cache.

System capability: SystemCapability.Web.Webview.Core

Name	Type	Read-Only	Optional	Description
responseHeaders	Array<WebHeader>	No	No	Array of response headers from the server when a JavaScript file is requested. They include information such as E-Tag or Last-Modified to identify the file version and determine whether the bytecode cache needs to be refreshed.

SnapshotInfo¹²⁺

Provides information used to obtain a full drawing result.

System capability: SystemCapability.Web.Webview.Core

Name	Type	Read-Only	Optional	Description
id	string	No	Yes	Snapshot ID.
size	SizeOptions	No	Yes	Size for web rendering. The maximum size is 16000 px × 16000 px. The length unit can be px, vp, or %. The length unit must be the consistent across parameters. The default unit is vp. If the size exceeds the specifications, the maximum size is returned. Example: width: '100px', height: '200px' or width: '20%', height'30%'. If only digits are written, the unit is vp.

SnapshotResult¹²⁺

Represents a full drawing result.

System capability: SystemCapability.Web.Webview.Core

Name	Type	Read-Only	Optional	Description
id	string	No	Yes	Snapshot ID.
status	boolean	No	Yes	Snapshot status. The value can be true (normal) or false (failure). If the full drawing result fails to be obtained, the width and height of the returned size are both 0, and the map is empty.
size	SizeOptions	No	Yes	Actual size drawn on the web page. The value is of the number type, and the unit is vp.
imagePixelMap	image.PixelMap	No	Yes	The image.PixelMap format.

OfflineResourceMap¹²⁺

Implements an OfflineResourceMap object, which is used to set information related to local offline resources that will be injected into memory cache through the injectOfflineResources API. The ArkWeb engine will generate resource caches based on this information and control the validity period of the cache accordingly.

System capability: SystemCapability.Web.Webview.Core

Name	Type	Read-Only	Optional	Description
urlList	Array<string>	No	No	List of network addresses of the local offline resources. The first item in the list is used as the resources' origin. If only one network address is provided, this single address is used for the resources' origin. The URL supports only the HTTP and HTTPS protocols and contains a maximum of 2048 characters.
resource	Uint8Array	No	No	Content of a local offline resource.
responseHeaders	Array<WebHeader>	No	No	HTTP response headers corresponding to the resources. The Cache-Control or Expires response header is used to control the validity period of the resource in the memory cache. If neither of the headers is provided, a default validity time of 86400 seconds (1 day) will be applied. The Content-Type response header is used to define the MIME type of the resource. For resources of type MODULE_JS, a valid MIME type must be provided. For other types, the MIME type is optional, with no default value. A non-standard MIME type can lead to the resource being invalidated in the memory cache. If a script tag on the web page uses the crossorigin attribute, the Cross-Origin response header must be set in the responseHeaders parameter of the API. The value for this header should be anonymous or use-credentials.
type	OfflineResourceType	No	No	Resource type. Currently, only the JavaScript, image, and CSS types are supported.

PdfConfiguration¹⁴⁺

Specifies the input parameters of createPdf().

NOTE

The number of pixels is calculated as follows: Number of pixels = 96 x Number of inches.

System capability: SystemCapability.Web.Webview.Core

Name	Type	Read-Only	Optional	Description
width	number	No	No	Page width, in inches. Recommended value: 8.27 inches of A4 paper width.
height	number	No	No	Page height, in inches. Recommended value: 11.69 inches of A4 paper height.
scale	number	No	Yes	Scale multiple. The value range is [0.0, 2.0]. If the value is less than 0.0, set it to 0.0. If the value is greater than 2.0, set it to 2.0. Default value: 1.0
marginTop	number	No	No	Top margin. The value range is [0.0, half of the page height). If the value is not within the value range, set it to 0.0. Unit: inch.
marginBottom	number	No	No	Bottom margin. The value range is [0.0, half of the page height). If the value is not within the value range, set it to 0.0. Unit: inch.
marginRight	number	No	No	Right margin. The value range is [0.0, half of the page width). If the value is not within the value range, set it to 0.0. Unit: inch.
marginLeft	number	No	No	Left margin. The value range is [0.0, half of the page width). If the value is not within the value range, set it to 0.0. Unit: inch.
shouldPrintBackground	boolean	No	Yes	Whether to print the background color. The value true means to print the background color, and false means the opposite. Default value: false.

ScrollOffset¹³⁺

Represents the current scrolling offset of a web page.

System capability: SystemCapability.Web.Webview.Core

Name	Type	Read-Only	Optional	Description
x	number	No	No	Horizontal scrolling offset of a web page. The value is the difference between the x-coordinate of the left boundary of the web page and that of the left boundary of the Web component. When the web page is scrolled rightwards, the value is negative. When the web page is not scrolled or scrolled leftwards, the value is 0 or positive. Unit: vp
y	number	No	No	Vertical scrolling offset of a web page. The value is the difference between the y-coordinate of the upper boundary of the web page and that of the upper boundary of the Web component. When the web page is scrolled downwards, the value is negative. When the web page is not scrolled or scrolled upwards, the value is 0 or positive. Unit: vp

HitTestValue

Provides the element information of the area being clicked. For the sample code, see getLastHitTest.

System capability: SystemCapability.Web.Webview.Core

Name	Type	Read-Only	Optional	Description
type	WebHitTestType	No	No	Element type of the area being clicked.
extra	string	No	No	Extra information of the area being clicked. If the area being clicked is an image or a link, the extra information is the URL of the image or link.

ControllerAttachState²⁰⁺

Describes the attach status of WebViewController and the Web component.

System capability: SystemCapability.Web.Webview.Core

Name	Value	Description
UNATTACHED	0	Unattached.
ATTACHED	1	Attached.

BlanklessInfo²⁰⁺

Describes the prediction information about blankless loading, including the first screen similarity, first screen loading duration, and error code. The application determines whether to enable the blankless loading solution based on the prediction information.

System capability: SystemCapability.Web.Webview.Core

Name	Type	Read-Only	Optional	Description
errCode	WebBlanklessErrorCode	No	No	Error code of blankless loading. For details, see WebBlanklessErrorCode.
similarity	number	No	No	First screen similarity, which is calculated based on the historical first screen content. The value ranges from 0 to 1.0. 1.0 indicates that the content is the same. A value closer to 1 indicates a higher similarity. This value is lagging, and the similarity of local loading is displayed in the next loading. You are advised not to enable the blankless loading solution when the similarity is low.
loadingTime	number	No	No	Loading duration estimated based on the historical first screen loading durations, in milliseconds. The value must be greater than 0.

BlanklessFrameInterpolationInfo²³⁺

Describes the blankless loading frame interpolation status information, which is used as the callback input parameter in BlanklessLoadingParam.

System capability: SystemCapability.Web.Webview.Core

Model restriction: This API can be used only in the stage model.

Name	Type	Read-Only	Optional	Description
key	string	No	No	Key value that uniquely identifies the page where the frame is interpolated. The value is the same as the key value of setBlanklessLoadingWithParams.
state	BlanklessFrameInterpolationState	No	No	Current frame interpolation state.
timestamp	number	No	No	Time when the frame interpolation is successful, fails, or removed, in ms (UTC time).
reason	string	No	No	Reason for the frame interpolation failure.

BlanklessLoadingParam²³⁺

Describes the blankless loading frame interpolation parameters.

System capability: SystemCapability.Web.Webview.Core

Model restriction: This API can be used only in the stage model.

Name	Type	Read-Only	Optional	Description
enable	boolean	No	No	Whether to enable blankless loading frame interpolation. The value true means to enable blankless loading frame interpolation, and false means the opposite.
duration	number	No	Yes	Duration of frame interpolation. The value range is the union of [200, 2000] and {0}, where 0 indicates that the duration is not specified and the system automatically sets a proper duration. Unit: ms.
expirationTime	number	No	Yes	Expiration time of the historical frame, in UTC time. T indicates the current UTC time. If the expiration time is 30 days, the value is 2592000000 ms. The value range is the union of (T, T + 2592000000] and {0}. 0 indicates that the expiration time is not specified and the default expiration time (7 days) is used. Unit: ms.
callback	Callback<BlanklessFrameInterpolationInfo>	No	Yes	Callback executed after frame interpolation is successful, fails, or removed. This parameter takes effect only when enable is set to true. It is optional. If it is not set, no operation is performed.

HistoryItem

Describes a historical page record.

System capability: SystemCapability.Web.Webview.Core

Name	Type	Read-Only	Optional	Description
icon	image.PixelMap	No	No	PixelMap object of the icon on the historical page.
historyUrl	string	No	No	URL of the historical page.
historyRawUrl	string	No	No	Original URL of the historical page.
title	string	No	No	Title of the historical page.

MediaInfo¹²⁺

Represents a MediaInfo object used as a parameter of the CreateNativeMediaPlayerCallback callback. The object contains information about media on the web page. The application may create, based on the information, a player that takes over media playback of the web page.

System capability: SystemCapability.Web.Webview.Core

Name	Type	Read-Only	Optional	Description
embedID	string	No	No	ID of <video> or <audio> on the web page.
mediaType	MediaType	No	No	Type of the media.
mediaSrcList	MediaSourceInfo[]	No	No	Source of the media. There may be multiple sources. The application needs to select a supported source to play.
surfaceInfo	NativeMediaPlayerSurfaceInfo	No	No	Surface information used for same-layer rendering.
controlsShown	boolean	No	No	Whether the controls attribute exists in <video> or <audio>. The value true means that the controls attribute exists in <video> or <audio>, and false means the opposite.
controlList	string[]	No	No	Value of the controlslist attribute in <video> or <audio>.
muted	boolean	No	No	Whether to mute the player. The value true means to mute the player, and false means the opposite.
posterUrl	string	No	No	URL of a poster.
preload	Preload	No	No	Whether preloading is required.
headers	Record<string, string>	No	No	HTTP headers that need to be included in the player's request for media resources.
attributes	Record<string, string>	No	No	Attributes in <video> or <audio>.

RectEvent¹²⁺

Defines a rectangle.

System capability: SystemCapability.Web.Webview.Core

Name	Type	Read-Only	Optional	Description
x	number	No	No	X-axis coordinate of the upper left corner of the rectangle.
y	number	No	No	Y-axis coordinate of the upper left corner of the rectangle.
width	number	No	No	Width of the rectangle. Unit: px.
height	number	No	No	Height of the rectangle. Unit: px.

WebHttpCookie²³⁺

Defines cookie-related fields.

System capability: SystemCapability.Web.Webview.Core

Name	Type	Read-Only	Optional	Description
samesitePolicy	WebHttpCookieSameSitePolicy	No	No	Same-site policy of the cookie.
expiresDate	string	No	No	Expiration time of the cookie. For details about the time format, see Date.
name	string	No	No	Name of the cookie.
isSessionCookie	boolean	No	No	Whether the cookie is a session cookie. The value true indicates that the cookie is a session cookie, and false indicates the opposite.
value	string	No	No	Value of the cookie.
path	string	No	No	Path of the cookie.
isHttpOnly	boolean	No	No	Whether the cookie can be accessed only through HTTP requests. The value true indicates that the cookie can be accessed only through HTTP requests, and false indicates the opposite.
isSecure	boolean	No	No	Whether the cookie can be sent only through HTTPS. The value true indicates that the cookie can be sent only through HTTPS, and false indicates that the cookie can be sent through HTTP.
domain	string	No	No	Domain names that can access the cookie.

你可能感兴趣的鸿蒙文章

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