blob: 1fee9a9b7c4ec967b3f694afe06c5e30285f96c6 [file] [edit]
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<title>Namespace OpenQA.Selenium.DevTools.V148.Fetch </title>
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<meta name="title" content="Namespace OpenQA.Selenium.DevTools.V148.Fetch ">
<link rel="icon" href="../images/favicon.ico">
<link rel="stylesheet" href="../public/docfx.min.css">
<link rel="stylesheet" href="../public/main.css">
<meta name="docfx:navrel" content="../toc.html">
<meta name="docfx:tocrel" content="toc.html">
<meta name="docfx:rel" content="../">
<meta name="loc:inThisArticle" content="In this article">
<meta name="loc:searchResultsCount" content="{count} results for &quot;{query}&quot;">
<meta name="loc:searchNoResults" content="No results for &quot;{query}&quot;">
<meta name="loc:tocFilter" content="Filter by title">
<meta name="loc:nextArticle" content="Next">
<meta name="loc:prevArticle" content="Previous">
<meta name="loc:themeLight" content="Light">
<meta name="loc:themeDark" content="Dark">
<meta name="loc:themeAuto" content="Auto">
<meta name="loc:changeTheme" content="Change theme">
<meta name="loc:copy" content="Copy">
<meta name="loc:downloadPdf" content="Download PDF">
<script type="module" src="./../public/docfx.min.js"></script>
<script>
const theme = localStorage.getItem('theme') || 'auto'
document.documentElement.setAttribute('data-bs-theme', theme === 'auto' ? (window.matchMedia('(prefers-color-scheme: dark)').matches ? 'dark' : 'light') : theme)
</script>
</head>
<body class="tex2jax_ignore" data-layout="" data-yaml-mime="ManagedReference">
<header class="bg-body border-bottom">
<nav id="autocollapse" class="navbar navbar-expand-md" role="navigation">
<div class="container-xxl flex-nowrap">
<a class="navbar-brand" href="../index.html">
<img id="logo" class="svg" src="../images/logo.svg" alt="Selenium .NET API">
Selenium .NET API
</a>
<button class="btn btn-lg d-md-none border-0" type="button" data-bs-toggle="collapse" data-bs-target="#navpanel" aria-controls="navpanel" aria-expanded="false" aria-label="Toggle navigation">
<i class="bi bi-three-dots"></i>
</button>
<div class="collapse navbar-collapse" id="navpanel">
<div id="navbar">
<form class="search" role="search" id="search">
<i class="bi bi-search"></i>
<input class="form-control" id="search-query" type="search" disabled placeholder="Search" autocomplete="off" aria-label="Search">
</form>
</div>
</div>
</div>
</nav>
</header>
<main class="container-xxl">
<div class="toc-offcanvas">
<div class="offcanvas-md offcanvas-start" tabindex="-1" id="tocOffcanvas" aria-labelledby="tocOffcanvasLabel">
<div class="offcanvas-header">
<h5 class="offcanvas-title" id="tocOffcanvasLabel">Table of Contents</h5>
<button type="button" class="btn-close" data-bs-dismiss="offcanvas" data-bs-target="#tocOffcanvas" aria-label="Close"></button>
</div>
<div class="offcanvas-body">
<nav class="toc" id="toc"></nav>
</div>
</div>
</div>
<div class="content">
<div class="actionbar">
<button class="btn btn-lg border-0 d-md-none" type="button" data-bs-toggle="offcanvas" data-bs-target="#tocOffcanvas" aria-controls="tocOffcanvas" aria-expanded="false" aria-label="Show table of contents">
<i class="bi bi-list"></i>
</button>
<nav id="breadcrumb"></nav>
</div>
<article data-uid="OpenQA.Selenium.DevTools.V148.Fetch">
<h1 id="OpenQA_Selenium_DevTools_V148_Fetch" data-uid="OpenQA.Selenium.DevTools.V148.Fetch" class="text-break">Namespace OpenQA.Selenium.DevTools.V148.Fetch</h1>
<div class="markdown level0 summary"></div>
<div class="markdown level0 conceptual"></div>
<div class="markdown level0 remarks"></div>
<h3 id="classes">
Classes
</h3>
<dl class="jumplist">
<dt><a class="xref" href="OpenQA.Selenium.DevTools.V148.Fetch.AuthChallenge.html">AuthChallenge</a></dt>
<dd><p>Authorization challenge for HTTP status code 401 or 407.</p>
</dd>
</dl>
<dl class="jumplist">
<dt><a class="xref" href="OpenQA.Selenium.DevTools.V148.Fetch.AuthChallengeResponse.html">AuthChallengeResponse</a></dt>
<dd><p>Response to an AuthChallenge.</p>
</dd>
</dl>
<dl class="jumplist">
<dt><a class="xref" href="OpenQA.Selenium.DevTools.V148.Fetch.AuthRequiredEventArgs.html">AuthRequiredEventArgs</a></dt>
<dd><p>Issued when the domain is enabled with handleAuthRequests set to true.
The request is paused until client responds with continueWithAuth.</p>
</dd>
</dl>
<dl class="jumplist">
<dt><a class="xref" href="OpenQA.Selenium.DevTools.V148.Fetch.ContinueRequestCommandResponse.html">ContinueRequestCommandResponse</a></dt>
<dd><p>Response for Continues the request, optionally modifying some of its parameters.</p>
</dd>
</dl>
<dl class="jumplist">
<dt><a class="xref" href="OpenQA.Selenium.DevTools.V148.Fetch.ContinueRequestCommandSettings.html">ContinueRequestCommandSettings</a></dt>
<dd><p>Continues the request, optionally modifying some of its parameters.</p>
</dd>
</dl>
<dl class="jumplist">
<dt><a class="xref" href="OpenQA.Selenium.DevTools.V148.Fetch.ContinueResponseCommandResponse.html">ContinueResponseCommandResponse</a></dt>
<dd><p>Response for Continues loading of the paused response, optionally modifying the
response headers. If either responseCode or headers are modified, all of them
must be present.</p>
</dd>
</dl>
<dl class="jumplist">
<dt><a class="xref" href="OpenQA.Selenium.DevTools.V148.Fetch.ContinueResponseCommandSettings.html">ContinueResponseCommandSettings</a></dt>
<dd><p>Continues loading of the paused response, optionally modifying the
response headers. If either responseCode or headers are modified, all of them
must be present.</p>
</dd>
</dl>
<dl class="jumplist">
<dt><a class="xref" href="OpenQA.Selenium.DevTools.V148.Fetch.ContinueWithAuthCommandResponse.html">ContinueWithAuthCommandResponse</a></dt>
<dd><p>Response for Continues a request supplying authChallengeResponse following authRequired event.</p>
</dd>
</dl>
<dl class="jumplist">
<dt><a class="xref" href="OpenQA.Selenium.DevTools.V148.Fetch.ContinueWithAuthCommandSettings.html">ContinueWithAuthCommandSettings</a></dt>
<dd><p>Continues a request supplying authChallengeResponse following authRequired event.</p>
</dd>
</dl>
<dl class="jumplist">
<dt><a class="xref" href="OpenQA.Selenium.DevTools.V148.Fetch.DisableCommandResponse.html">DisableCommandResponse</a></dt>
<dd><p>Response for Disables the fetch domain.</p>
</dd>
</dl>
<dl class="jumplist">
<dt><a class="xref" href="OpenQA.Selenium.DevTools.V148.Fetch.DisableCommandSettings.html">DisableCommandSettings</a></dt>
<dd><p>Disables the fetch domain.</p>
</dd>
</dl>
<dl class="jumplist">
<dt><a class="xref" href="OpenQA.Selenium.DevTools.V148.Fetch.EnableCommandResponse.html">EnableCommandResponse</a></dt>
<dd><p>Response for Enables issuing of requestPaused events. A request will be paused until client
calls one of failRequest, fulfillRequest or continueRequest/continueWithAuth.</p>
</dd>
</dl>
<dl class="jumplist">
<dt><a class="xref" href="OpenQA.Selenium.DevTools.V148.Fetch.EnableCommandSettings.html">EnableCommandSettings</a></dt>
<dd><p>Enables issuing of requestPaused events. A request will be paused until client
calls one of failRequest, fulfillRequest or continueRequest/continueWithAuth.</p>
</dd>
</dl>
<dl class="jumplist">
<dt><a class="xref" href="OpenQA.Selenium.DevTools.V148.Fetch.FailRequestCommandResponse.html">FailRequestCommandResponse</a></dt>
<dd><p>Response for Causes the request to fail with specified reason.</p>
</dd>
</dl>
<dl class="jumplist">
<dt><a class="xref" href="OpenQA.Selenium.DevTools.V148.Fetch.FailRequestCommandSettings.html">FailRequestCommandSettings</a></dt>
<dd><p>Causes the request to fail with specified reason.</p>
</dd>
</dl>
<dl class="jumplist">
<dt><a class="xref" href="OpenQA.Selenium.DevTools.V148.Fetch.FetchAdapter.html">FetchAdapter</a></dt>
<dd><p>Represents an adapter for the Fetch domain to simplify the command interface.</p>
</dd>
</dl>
<dl class="jumplist">
<dt><a class="xref" href="OpenQA.Selenium.DevTools.V148.Fetch.FulfillRequestCommandResponse.html">FulfillRequestCommandResponse</a></dt>
<dd><p>Response for Provides response to the request.</p>
</dd>
</dl>
<dl class="jumplist">
<dt><a class="xref" href="OpenQA.Selenium.DevTools.V148.Fetch.FulfillRequestCommandSettings.html">FulfillRequestCommandSettings</a></dt>
<dd><p>Provides response to the request.</p>
</dd>
</dl>
<dl class="jumplist">
<dt><a class="xref" href="OpenQA.Selenium.DevTools.V148.Fetch.GetResponseBodyCommandResponse.html">GetResponseBodyCommandResponse</a></dt>
<dd><p>Response for Causes the body of the response to be received from the server and
returned as a single string. May only be issued for a request that
is paused in the Response stage and is mutually exclusive with
takeResponseBodyForInterceptionAsStream. Calling other methods that
affect the request or disabling fetch domain before body is received
results in an undefined behavior.
Note that the response body is not available for redirects. Requests
paused in the <em>redirect received</em> state may be differentiated by
<code>responseCode</code> and presence of <code>location</code> response header, see
comments to <code>requestPaused</code> for details.</p>
</dd>
</dl>
<dl class="jumplist">
<dt><a class="xref" href="OpenQA.Selenium.DevTools.V148.Fetch.GetResponseBodyCommandSettings.html">GetResponseBodyCommandSettings</a></dt>
<dd><p>Causes the body of the response to be received from the server and
returned as a single string. May only be issued for a request that
is paused in the Response stage and is mutually exclusive with
takeResponseBodyForInterceptionAsStream. Calling other methods that
affect the request or disabling fetch domain before body is received
results in an undefined behavior.
Note that the response body is not available for redirects. Requests
paused in the <em>redirect received</em> state may be differentiated by
<code>responseCode</code> and presence of <code>location</code> response header, see
comments to <code>requestPaused</code> for details.</p>
</dd>
</dl>
<dl class="jumplist">
<dt><a class="xref" href="OpenQA.Selenium.DevTools.V148.Fetch.HeaderEntry.html">HeaderEntry</a></dt>
<dd><p>Response HTTP header entry</p>
</dd>
</dl>
<dl class="jumplist">
<dt><a class="xref" href="OpenQA.Selenium.DevTools.V148.Fetch.RequestPattern.html">RequestPattern</a></dt>
<dd><p>RequestPattern</p>
</dd>
</dl>
<dl class="jumplist">
<dt><a class="xref" href="OpenQA.Selenium.DevTools.V148.Fetch.RequestPausedEventArgs.html">RequestPausedEventArgs</a></dt>
<dd><p>Issued when the domain is enabled and the request URL matches the
specified filter. The request is paused until the client responds
with one of continueRequest, failRequest or fulfillRequest.
The stage of the request can be determined by presence of responseErrorReason
and responseStatusCode -- the request is at the response stage if either
of these fields is present and in the request stage otherwise.
Redirect responses and subsequent requests are reported similarly to regular
responses and requests. Redirect responses may be distinguished by the value
of <code>responseStatusCode</code> (which is one of 301, 302, 303, 307, 308) along with
presence of the <code>location</code> header. Requests resulting from a redirect will
have <code>redirectedRequestId</code> field set.</p>
</dd>
</dl>
<dl class="jumplist">
<dt><a class="xref" href="OpenQA.Selenium.DevTools.V148.Fetch.TakeResponseBodyAsStreamCommandResponse.html">TakeResponseBodyAsStreamCommandResponse</a></dt>
<dd><p>Response for Returns a handle to the stream representing the response body.
The request must be paused in the HeadersReceived stage.
Note that after this command the request can't be continued
as is -- client either needs to cancel it or to provide the
response body.
The stream only supports sequential read, IO.read will fail if the position
is specified.
This method is mutually exclusive with getResponseBody.
Calling other methods that affect the request or disabling fetch
domain before body is received results in an undefined behavior.</p>
</dd>
</dl>
<dl class="jumplist">
<dt><a class="xref" href="OpenQA.Selenium.DevTools.V148.Fetch.TakeResponseBodyAsStreamCommandSettings.html">TakeResponseBodyAsStreamCommandSettings</a></dt>
<dd><p>Returns a handle to the stream representing the response body.
The request must be paused in the HeadersReceived stage.
Note that after this command the request can't be continued
as is -- client either needs to cancel it or to provide the
response body.
The stream only supports sequential read, IO.read will fail if the position
is specified.
This method is mutually exclusive with getResponseBody.
Calling other methods that affect the request or disabling fetch
domain before body is received results in an undefined behavior.</p>
</dd>
</dl>
<h3 id="enums">
Enums
</h3>
<dl class="jumplist">
<dt><a class="xref" href="OpenQA.Selenium.DevTools.V148.Fetch.AuthChallengeResponseResponseValues.html">AuthChallengeResponseResponseValues</a></dt>
<dd><p>Enumerated values for Fetch.AuthChallengeResponse.response</p>
</dd>
</dl>
<dl class="jumplist">
<dt><a class="xref" href="OpenQA.Selenium.DevTools.V148.Fetch.AuthChallengeSourceValues.html">AuthChallengeSourceValues</a></dt>
<dd><p>Enumerated values for Fetch.AuthChallenge.source</p>
</dd>
</dl>
<dl class="jumplist">
<dt><a class="xref" href="OpenQA.Selenium.DevTools.V148.Fetch.RequestStage.html">RequestStage</a></dt>
<dd><p>Stages of the request to handle. Request will intercept before the request is
sent. Response will intercept after the response is received (but before response
body is received).</p>
</dd>
</dl>
</article>
<div class="contribution d-print-none">
</div>
</div>
<div class="affix">
<nav id="affix"></nav>
</div>
</main>
<div class="container-xxl search-results" id="search-results"></div>
<footer class="border-top text-secondary">
<div class="container-xxl">
<div class="flex-fill">
<span>Made with <a href="https://dotnet.github.io/docfx">docfx</a></span>
</div>
</div>
</footer>
</body>
</html>