• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1# Class (WebSchemeHandlerRequest)
2<!--Kit: ArkWeb-->
3<!--Subsystem: Web-->
4<!--Owner: @aohui-->
5<!--Designer: @yaomingliu-->
6<!--Tester: @ghiker-->
7<!--Adviser: @HelloCrease-->
8
9通过WebSchemeHandler拦截到的请求。
10
11> **说明:**
12>
13> - 本模块首批接口从API version 9开始支持。后续版本如有新增内容,则采用上角标单独标记该内容的起始版本。
14>
15> - 本Class首批接口从API version 12开始支持。
16>
17> - 示例效果请以真机运行为准,当前DevEco Studio预览器不支持。
18
19## getHeader<sup>12+</sup>
20
21getHeader(): Array\<WebHeader\>
22
23获取资源请求头信息。
24
25**系统能力:** SystemCapability.Web.Webview.Core
26
27**返回值:**
28
29| 类型                         | 说明         |
30| -------------------------- | ---------- |
31| Array\<[WebHeader](./arkts-apis-webview-i.md#webheader)\> | 返回资源请求头信息。 |
32
33**示例:**
34
35完整示例代码参考[onRequestStart](./arkts-apis-webview-WebSchemeHandler.md#onrequeststart12)。
36
37## getRequestUrl<sup>12+</sup>
38
39getRequestUrl(): string
40
41获取资源请求的URL信息。
42
43**系统能力:** SystemCapability.Web.Webview.Core
44
45**返回值:**
46
47| 类型     | 说明            |
48| ------ | ------------- |
49| string | 返回资源请求的URL信息。 |
50
51**示例:**
52
53完整示例代码参考[onRequestStart](./arkts-apis-webview-WebSchemeHandler.md#onrequeststart12)。
54
55## getRequestMethod<sup>12+</sup>
56
57getRequestMethod(): string
58
59获取请求方法。
60
61**系统能力:** SystemCapability.Web.Webview.Core
62
63**返回值:**
64
65| 类型     | 说明            |
66| ------ | ------------- |
67| string | 返回请求方法。 |
68
69**示例:**
70
71完整示例代码参考[onRequestStart](./arkts-apis-webview-WebSchemeHandler.md#onrequeststart12)。
72
73## getReferrer<sup>12+</sup>
74
75getReferrer(): string
76
77获取referrer。
78
79**系统能力:** SystemCapability.Web.Webview.Core
80
81**返回值:**
82
83| 类型     | 说明            |
84| ------ | ------------- |
85| string | 获取到的referrer。 |
86
87**示例:**
88
89完整示例代码参考[onRequestStart](./arkts-apis-webview-WebSchemeHandler.md#onrequeststart12)。
90
91## isMainFrame<sup>12+</sup>
92
93isMainFrame(): boolean
94
95判断资源请求是否为主frame。
96
97**系统能力:** SystemCapability.Web.Webview.Core
98
99**返回值:**
100
101| 类型     | 说明            |
102| ------ | ------------- |
103| boolean | 判断资源请求是否为主frame,如果资源请求是主frame则返回true,否则返回false。 |
104
105**示例:**
106
107完整示例代码参考[onRequestStart](./arkts-apis-webview-WebSchemeHandler.md#onrequeststart12)。
108
109## hasGesture<sup>12+</sup>
110
111hasGesture(): boolean
112
113获取资源请求是否与手势(如点击)相关联。
114
115**系统能力:** SystemCapability.Web.Webview.Core
116
117**返回值:**
118
119| 类型     | 说明            |
120| ------ | ------------- |
121| boolean | 返回资源请求是否与手势(如点击)相关联,如果返回资源请求与手势相关联则返回true,否则返回false。 |
122
123**示例:**
124
125完整示例代码参考[onRequestStart](./arkts-apis-webview-WebSchemeHandler.md#onrequeststart12)。
126
127## getHttpBodyStream<sup>12+</sup>
128
129getHttpBodyStream(): WebHttpBodyStream | null
130
131获取资源请求中的WebHttpBodyStream。
132
133**系统能力:** SystemCapability.Web.Webview.Core
134
135**返回值:**
136
137| 类型     | 说明            |
138| ------ | ------------- |
139| [WebHttpBodyStream](./arkts-apis-webview-WebSchemeHandler.md) \| null | 返回资源请求中的WebHttpBodyStream,如果没有则返回null。 |
140
141**示例:**
142
143完整示例代码参考[onRequestStart](./arkts-apis-webview-WebSchemeHandler.md#onrequeststart12)。
144
145## getRequestResourceType<sup>12+</sup>
146
147getRequestResourceType(): WebResourceType
148
149获取资源请求的资源类型。
150
151**系统能力:** SystemCapability.Web.Webview.Core
152
153**返回值:**
154
155| 类型     | 说明            |
156| ------ | ------------- |
157| [WebResourceType](./arkts-apis-webview-e.md#webresourcetype12) | 返回资源请求的资源类型。 |
158
159**示例:**
160
161完整示例代码参考[onRequestStart](./arkts-apis-webview-WebSchemeHandler.md#onrequeststart12)。
162
163## getFrameUrl<sup>12+</sup>
164
165getFrameUrl(): string
166
167获取触发此请求的Frame的URL。
168
169**系统能力:** SystemCapability.Web.Webview.Core
170
171**返回值:**
172
173| 类型     | 说明            |
174| ------ | ------------- |
175| string | 返回触发此请求的Frame的URL。 |
176
177**示例:**
178
179完整示例代码参考[onRequestStart](./arkts-apis-webview-WebSchemeHandler.md#onrequeststart12)。