1 /*
2  * Copyright (c) 2024 Huawei Device Co., Ltd.
3  * Licensed under the Apache License, Version 2.0 (the "License");
4  * you may not use this file except in compliance with the License.
5  * You may obtain a copy of the License at
6  *
7  *     http://www.apache.org/licenses/LICENSE-2.0
8  *
9  * Unless required by applicable law or agreed to in writing, software
10  * distributed under the License is distributed on an "AS IS" BASIS,
11  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12  * See the License for the specific language governing permissions and
13  * limitations under the License.
14  */
15 
16 #ifndef ARK_WEB_URL_RESOURCE_REQUEST_H_
17 #define ARK_WEB_URL_RESOURCE_REQUEST_H_
18 #pragma once
19 
20 #include "base/include/ark_web_base_ref_counted.h"
21 #include "base/include/ark_web_types.h"
22 
23 namespace OHOS::ArkWeb {
24 
25 /*--ark web(source=webcore)--*/
26 class ArkWebUrlResourceRequest : public virtual ArkWebBaseRefCounted {
27 public:
28     /**
29      * @brief Gets the URL for which the resource request was made.
30      *
31      * @return URL url string
32      */
33     /*--ark web()--*/
34     virtual ArkWebString Url() = 0;
35 
36     /**
37      * @brief Gets the method associated with the request, for example "GET".
38      *
39      * @return method the method associated with the request.
40      */
41     /*--ark web()--*/
42     virtual ArkWebString Method() = 0;
43 
44     /**
45      * @brief Gets whether a gesture (such as a click) was associated with the
46      *        request.
47      *
48      * @return gesture whether was associated with the request.
49      */
50     /*--ark web()--*/
51     virtual bool FromGesture() = 0;
52 
53     /**
54      * @brief Gets the headers associated with the request.
55      *
56      * @return the headers associated with the request.
57      */
58     /*--ark web()--*/
59     virtual ArkWebStringMap RequestHeaders() = 0;
60 
61     /**
62      * @brief Gets whether the request was made in order to fetch the main frame's
63      *        document.
64      *
65      * @return Is main frame
66      */
67     /*--ark web()--*/
68     virtual bool IsAboutMainFrame() = 0;
69 
70     /**
71      * @brief Gets whether the request was a result of a server-side redirect.
72      *
73      * @return is redirect
74      */
75     /*--ark web()--*/
76     virtual bool IsRequestRedirect() = 0;
77 };
78 
79 } // namespace OHOS::ArkWeb
80 
81 #endif // ARK_WEB_URL_RESOURCE_REQUEST_H_
82