Skip to content

Latest commit

 

History

History
142 lines (124 loc) · 7.21 KB

NavigateWithWebResourceRequest.md

File metadata and controls

142 lines (124 loc) · 7.21 KB
Raw

Background

Consumers of the old WebBrowser control that relied on the Navigate API that allowed them to specify HTTP POST data and extra headers as part of navigation, requested same ability in WebView2.

Description

We propose adding NavigateWithWebResourceRequest to CoreWebView2 as the API that allows a WebView2 to navigate with a specified CoreWebView2WebResourceRequest. This allows the developer to specify extra headers and POST data as part of their request for navigation. We also propose adding a CreateWebResourceRequest API to CoreWebView2Environment so that developers can create the WebResourceRequest object they'd like to use with NavigateWithWebResourceRequest.

Examples

    // Need to convert post data to UTF-8 as required by the application/x-www-form-urlencoded Content-Type 
    std::wstring postData = std::wstring(L"input=Hello");
    int sizeNeededForMultiByte = WideCharToMultiByte(
        CP_UTF8, 0, postData.c_str(), postData.size(), nullptr,
        0, nullptr, nullptr);

    std::unique_ptr<char[]> postDataBytes = std::make_unique<char[]>(sizeNeededForMultiByte);
    WideCharToMultiByte(
        CP_UTF8, 0, postData.c_str(), postData.size(), postDataBytes.get(),
        sizeNeededForMultiByte, nullptr, nullptr);

    wil::com_ptr<ICoreWebView2WebResourceRequest> webResourceRequest;
    wil::com_ptr<IStream> postDataStream = SHCreateMemStream(
            reinterpret_cast<const BYTE*>(postDataBytes.get()), sizeNeededForMultiByte);

    // This acts as a HTML form submit to https://www.w3schools.com/action_page.php
    CHECK_FAILURE(webviewEnvironment->CreateWebResourceRequest(
        L"https://www.w3schools.com/action_page.php", L"POST", postDataStream.get(),
        L"Content-Type: application/x-www-form-urlencoded", &webResourceRequest));
    CHECK_FAILURE(webview->NavigateWithWebResourceRequest(webResourceRequest.get()));
    UTF8Encoding utfEncoding = new UTF8Encoding();
    byte[] postData = utfEncoding.GetBytes("input=Hello");

    MemoryStream postDataStream = new MemoryStream(postData.Length);
    postDataStream.Write(postData, 0, postData.Length);
    postDataStream.Seek(0, SeekOrigin.Begin);
    CoreWebView2WebResourceRequest webResourceRequest = 
      environment.CreateWebResourceRequest(
        "https://www.w3schools.com/action_page.php",
        "POST",
        postDataStream,
        "Content-Type: application/x-www-form-urlencoded");
    webView.CoreWebView2.NavigateWithWebResourceRequest(webResourceRequest);

Remarks

API Notes

API Details

[uuid(7fbad153-fb94-452e-acab-3cbb9ab341ec), object, pointer_default(unique)]
interface ICoreWebView2_2 : ICoreWebView2 {
 ....
  /// Navigate using a constructed WebResourceRequest object. This lets you
  /// provide post data or additional request headers during navigation.
  /// The headers in the WebResourceRequest override headers
  /// added by WebView2 runtime except for Cookie headers.
  /// Method can only be either "GET" or "POST". Provided post data will only
  /// be sent only if the method is "POST" and the uri scheme is HTTP(S).
  /// \snippet ScenarioNavigateWithWebResourceRequest.cpp NavigateWithWebResourceRequest
  HRESULT NavigateWithWebResourceRequest([in] ICoreWebView2WebResourceRequest* request);
}

[uuid(1c11735a-d57d-4614-a9e1-8b48d81da38c), object, pointer_default(unique)]
interface ICoreWebView2Environment_2 : ICoreWebView2Environment {
  /// Create a new web resource request object.
  /// URI parameter must be absolute URI.
  /// The headers string is the raw request header string delimited by CRLF
  /// (optional in last header).
  /// It's also possible to create this object with null headers string
  /// and then use the ICoreWebView2HttpRequestHeaders to construct the headers
  /// line by line.
  /// For information on other parameters see ICoreWebView2WebResourceRequest.
  ///
  /// \snippet ScenarioNavigateWithWebResourceRequest.cpp NavigateWithWebResourceRequest
  HRESULT CreateWebResourceRequest([in] LPCWSTR uri,
                                   [in] LPCWSTR method,
                                   [in] IStream* postData,
                                   [in] LPCWSTR headers,
                                   [out, retval] ICoreWebView2WebResourceRequest** request);
}
namespace Microsoft.Web.WebView2.Core
{
    runtimeclass CoreWebView2Environment
    {
        ...
        /// Create a new web resource request object.
        /// URI parameter must be absolute URI.
        /// The headers string is the raw request header string delimited by CRLF
        /// (optional in last header).
        /// It's also possible to create this object with null headers string
        /// and then use the CoreWebView2HttpRequestHeaders to construct the headers
        /// line by line.
        /// For information on other parameters see ICoreWebView2WebResourceRequest.
        ///
        public CoreWebView2WebResourceRequest CreateWebResourceRequest(String uri,
                                                                String method,
                                                                Stream postData,
                                                                String headers);
    }
    runtimeclass CoreWebView2
    {
        ...
        /// Navigate using a constructed WebResourceRequest object. This let's you
        /// provide post data or additional request headers during navigation.
        /// The headers in the WebResourceRequest override headers
        /// added by WebView2 runtime except for Cookie headers.
        /// Method can only be either "GET" or "POST". Provided post data will only
        /// be sent only if the method is "POST" and the uri scheme is HTTP(S).
        public void NavigateWithWebResourceRequest(CoreWebView2WebResourceRequest request);
    }
}

Appendix