blob: ea54d6bdb2e71a0d25a2882c32e44d9b1df2e2ea [file] [edit]
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<title>Class FetchAdapter </title>
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<meta name="title" content="Class FetchAdapter ">
<meta name="description" content="Represents an adapter for the Fetch domain to simplify the command interface.">
<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="docfx:docurl" content="https://github.com/SeleniumHQ/selenium/new/docfix/apiSpec/new?filename=OpenQA_Selenium_DevTools_V148_Fetch_FetchAdapter.md&amp;value=---%0Auid%3A%20OpenQA.Selenium.DevTools.V148.Fetch.FetchAdapter%0Asummary%3A%20&#39;*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax&#39;%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">
<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.FetchAdapter">
<h1 id="OpenQA_Selenium_DevTools_V148_Fetch_FetchAdapter" data-uid="OpenQA.Selenium.DevTools.V148.Fetch.FetchAdapter" class="text-break">
Class FetchAdapter <a class="header-action link-secondary" title="View source" href="https://github.com/SeleniumHQ/selenium/blob/docfix/bazel-bin/dotnet/src/webdriver/DevTools/v148/Fetch/FetchAdapter.cs/#L16"><i class="bi bi-code-slash"></i></a>
</h1>
<div class="facts text-secondary">
<dl><dt>Namespace</dt><dd><a class="xref" href="OpenQA.html">OpenQA</a>.<a class="xref" href="OpenQA.Selenium.html">Selenium</a>.<a class="xref" href="OpenQA.Selenium.DevTools.html">DevTools</a>.<a class="xref" href="OpenQA.Selenium.DevTools.V148.html">V148</a>.<a class="xref" href="OpenQA.Selenium.DevTools.V148.Fetch.html">Fetch</a></dd></dl>
<dl><dt>Assembly</dt><dd>Selenium.WebDriver.dll</dd></dl>
</div>
<div class="markdown summary"><p>Represents an adapter for the Fetch domain to simplify the command interface.</p>
</div>
<div class="markdown conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public class FetchAdapter</code></pre>
</div>
<dl class="typelist inheritance">
<dt>Inheritance</dt>
<dd>
<div><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object">object</a></div>
<div><span class="xref">FetchAdapter</span></div>
</dd>
</dl>
<dl class="typelist inheritedMembers">
<dt>Inherited Members</dt>
<dd>
<div>
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.tostring">object.ToString()</a>
</div>
<div>
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals(system-object)">object.Equals(object)</a>
</div>
<div>
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals(system-object-system-object)">object.Equals(object, object)</a>
</div>
<div>
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.referenceequals">object.ReferenceEquals(object, object)</a>
</div>
<div>
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.gethashcode">object.GetHashCode()</a>
</div>
<div>
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.gettype">object.GetType()</a>
</div>
<div>
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.memberwiseclone">object.MemberwiseClone()</a>
</div>
</dd></dl>
<h2 class="section" id="constructors">Constructors
</h2>
<a id="OpenQA_Selenium_DevTools_V148_Fetch_FetchAdapter__ctor_" data-uid="OpenQA.Selenium.DevTools.V148.Fetch.FetchAdapter.#ctor*"></a>
<h3 id="OpenQA_Selenium_DevTools_V148_Fetch_FetchAdapter__ctor_OpenQA_Selenium_DevTools_IDevToolsSession_" data-uid="OpenQA.Selenium.DevTools.V148.Fetch.FetchAdapter.#ctor(OpenQA.Selenium.DevTools.IDevToolsSession)">
FetchAdapter(IDevToolsSession)
<a class="header-action link-secondary" title="View source" href="https://github.com/SeleniumHQ/selenium/blob/docfix/bazel-bin/dotnet/src/webdriver/DevTools/v148/Fetch/FetchAdapter.cs/#L26"><i class="bi bi-code-slash"></i></a>
</h3>
<div class="markdown level1 summary"><p>Initializes a new instance of the FetchAdapter class.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public FetchAdapter(IDevToolsSession session)</code></pre>
</div>
<h4 class="section">Parameters</h4>
<dl class="parameters">
<dt><code>session</code> <a class="xref" href="OpenQA.Selenium.DevTools.IDevToolsSession.html">IDevToolsSession</a></dt>
<dd><p>The IDevToolsSession to be used with this adapter.</p>
</dd>
</dl>
<h4 class="section">Exceptions</h4>
<dl class="parameters">
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.argumentnullexception">ArgumentNullException</a></dt>
<dd><p>If <code class="paramref">session</code> is <a href="https://learn.microsoft.com/dotnet/csharp/language-reference/keywords/null">null</a>.</p>
</dd>
</dl>
<h2 class="section" id="properties">Properties
</h2>
<a id="OpenQA_Selenium_DevTools_V148_Fetch_FetchAdapter_Session_" data-uid="OpenQA.Selenium.DevTools.V148.Fetch.FetchAdapter.Session*"></a>
<h3 id="OpenQA_Selenium_DevTools_V148_Fetch_FetchAdapter_Session" data-uid="OpenQA.Selenium.DevTools.V148.Fetch.FetchAdapter.Session">
Session
<a class="header-action link-secondary" title="View source" href="https://github.com/SeleniumHQ/selenium/blob/docfix/bazel-bin/dotnet/src/webdriver/DevTools/v148/Fetch/FetchAdapter.cs/#L37"><i class="bi bi-code-slash"></i></a>
</h3>
<div class="markdown level1 summary"><p>Gets the DevToolsSession associated with the adapter.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public IDevToolsSession Session { get; }</code></pre>
</div>
<h4 class="section">Property Value</h4>
<dl class="parameters">
<dt><a class="xref" href="OpenQA.Selenium.DevTools.IDevToolsSession.html">IDevToolsSession</a></dt>
<dd></dd>
</dl>
<h2 class="section" id="methods">Methods
</h2>
<a id="OpenQA_Selenium_DevTools_V148_Fetch_FetchAdapter_ContinueRequest_" data-uid="OpenQA.Selenium.DevTools.V148.Fetch.FetchAdapter.ContinueRequest*"></a>
<h3 id="OpenQA_Selenium_DevTools_V148_Fetch_FetchAdapter_ContinueRequest_OpenQA_Selenium_DevTools_V148_Fetch_ContinueRequestCommandSettings_System_Threading_CancellationToken_System_Nullable_System_Int32__System_Boolean_" data-uid="OpenQA.Selenium.DevTools.V148.Fetch.FetchAdapter.ContinueRequest(OpenQA.Selenium.DevTools.V148.Fetch.ContinueRequestCommandSettings,System.Threading.CancellationToken,System.Nullable{System.Int32},System.Boolean)">
ContinueRequest(ContinueRequestCommandSettings, CancellationToken, int?, bool)
<a class="header-action link-secondary" title="View source" href="https://github.com/SeleniumHQ/selenium/blob/docfix/bazel-bin/dotnet/src/webdriver/DevTools/v148/Fetch/FetchAdapter.cs/#L98"><i class="bi bi-code-slash"></i></a>
</h3>
<div class="markdown level1 summary"><p>Continues the request, optionally modifying some of its parameters.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public Task&lt;ContinueRequestCommandResponse?&gt; ContinueRequest(ContinueRequestCommandSettings command, CancellationToken cancellationToken = default, int? millisecondsTimeout = null, bool throwExceptionIfResponseNotReceived = true)</code></pre>
</div>
<h4 class="section">Parameters</h4>
<dl class="parameters">
<dt><code>command</code> <a class="xref" href="OpenQA.Selenium.DevTools.V148.Fetch.ContinueRequestCommandSettings.html">ContinueRequestCommandSettings</a></dt>
<dd></dd>
<dt><code>cancellationToken</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.threading.cancellationtoken">CancellationToken</a></dt>
<dd></dd>
<dt><code>millisecondsTimeout</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.int32">int</a>?</dt>
<dd></dd>
<dt><code>throwExceptionIfResponseNotReceived</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.boolean">bool</a></dt>
<dd></dd>
</dl>
<h4 class="section">Returns</h4>
<dl class="parameters">
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.threading.tasks.task-1">Task</a>&lt;<a class="xref" href="OpenQA.Selenium.DevTools.V148.Fetch.ContinueRequestCommandResponse.html">ContinueRequestCommandResponse</a>&gt;</dt>
<dd></dd>
</dl>
<a id="OpenQA_Selenium_DevTools_V148_Fetch_FetchAdapter_ContinueResponse_" data-uid="OpenQA.Selenium.DevTools.V148.Fetch.FetchAdapter.ContinueResponse*"></a>
<h3 id="OpenQA_Selenium_DevTools_V148_Fetch_FetchAdapter_ContinueResponse_OpenQA_Selenium_DevTools_V148_Fetch_ContinueResponseCommandSettings_System_Threading_CancellationToken_System_Nullable_System_Int32__System_Boolean_" data-uid="OpenQA.Selenium.DevTools.V148.Fetch.FetchAdapter.ContinueResponse(OpenQA.Selenium.DevTools.V148.Fetch.ContinueResponseCommandSettings,System.Threading.CancellationToken,System.Nullable{System.Int32},System.Boolean)">
ContinueResponse(ContinueResponseCommandSettings, CancellationToken, int?, bool)
<a class="header-action link-secondary" title="View source" href="https://github.com/SeleniumHQ/selenium/blob/docfix/bazel-bin/dotnet/src/webdriver/DevTools/v148/Fetch/FetchAdapter.cs/#L116"><i class="bi bi-code-slash"></i></a>
</h3>
<div class="markdown level1 summary"><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>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public Task&lt;ContinueResponseCommandResponse?&gt; ContinueResponse(ContinueResponseCommandSettings command, CancellationToken cancellationToken = default, int? millisecondsTimeout = null, bool throwExceptionIfResponseNotReceived = true)</code></pre>
</div>
<h4 class="section">Parameters</h4>
<dl class="parameters">
<dt><code>command</code> <a class="xref" href="OpenQA.Selenium.DevTools.V148.Fetch.ContinueResponseCommandSettings.html">ContinueResponseCommandSettings</a></dt>
<dd></dd>
<dt><code>cancellationToken</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.threading.cancellationtoken">CancellationToken</a></dt>
<dd></dd>
<dt><code>millisecondsTimeout</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.int32">int</a>?</dt>
<dd></dd>
<dt><code>throwExceptionIfResponseNotReceived</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.boolean">bool</a></dt>
<dd></dd>
</dl>
<h4 class="section">Returns</h4>
<dl class="parameters">
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.threading.tasks.task-1">Task</a>&lt;<a class="xref" href="OpenQA.Selenium.DevTools.V148.Fetch.ContinueResponseCommandResponse.html">ContinueResponseCommandResponse</a>&gt;</dt>
<dd></dd>
</dl>
<a id="OpenQA_Selenium_DevTools_V148_Fetch_FetchAdapter_ContinueWithAuth_" data-uid="OpenQA.Selenium.DevTools.V148.Fetch.FetchAdapter.ContinueWithAuth*"></a>
<h3 id="OpenQA_Selenium_DevTools_V148_Fetch_FetchAdapter_ContinueWithAuth_OpenQA_Selenium_DevTools_V148_Fetch_ContinueWithAuthCommandSettings_System_Threading_CancellationToken_System_Nullable_System_Int32__System_Boolean_" data-uid="OpenQA.Selenium.DevTools.V148.Fetch.FetchAdapter.ContinueWithAuth(OpenQA.Selenium.DevTools.V148.Fetch.ContinueWithAuthCommandSettings,System.Threading.CancellationToken,System.Nullable{System.Int32},System.Boolean)">
ContinueWithAuth(ContinueWithAuthCommandSettings, CancellationToken, int?, bool)
<a class="header-action link-secondary" title="View source" href="https://github.com/SeleniumHQ/selenium/blob/docfix/bazel-bin/dotnet/src/webdriver/DevTools/v148/Fetch/FetchAdapter.cs/#L106"><i class="bi bi-code-slash"></i></a>
</h3>
<div class="markdown level1 summary"><p>Continues a request supplying authChallengeResponse following authRequired event.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public Task&lt;ContinueWithAuthCommandResponse?&gt; ContinueWithAuth(ContinueWithAuthCommandSettings command, CancellationToken cancellationToken = default, int? millisecondsTimeout = null, bool throwExceptionIfResponseNotReceived = true)</code></pre>
</div>
<h4 class="section">Parameters</h4>
<dl class="parameters">
<dt><code>command</code> <a class="xref" href="OpenQA.Selenium.DevTools.V148.Fetch.ContinueWithAuthCommandSettings.html">ContinueWithAuthCommandSettings</a></dt>
<dd></dd>
<dt><code>cancellationToken</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.threading.cancellationtoken">CancellationToken</a></dt>
<dd></dd>
<dt><code>millisecondsTimeout</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.int32">int</a>?</dt>
<dd></dd>
<dt><code>throwExceptionIfResponseNotReceived</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.boolean">bool</a></dt>
<dd></dd>
</dl>
<h4 class="section">Returns</h4>
<dl class="parameters">
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.threading.tasks.task-1">Task</a>&lt;<a class="xref" href="OpenQA.Selenium.DevTools.V148.Fetch.ContinueWithAuthCommandResponse.html">ContinueWithAuthCommandResponse</a>&gt;</dt>
<dd></dd>
</dl>
<a id="OpenQA_Selenium_DevTools_V148_Fetch_FetchAdapter_Disable_" data-uid="OpenQA.Selenium.DevTools.V148.Fetch.FetchAdapter.Disable*"></a>
<h3 id="OpenQA_Selenium_DevTools_V148_Fetch_FetchAdapter_Disable_OpenQA_Selenium_DevTools_V148_Fetch_DisableCommandSettings_System_Threading_CancellationToken_System_Nullable_System_Int32__System_Boolean_" data-uid="OpenQA.Selenium.DevTools.V148.Fetch.FetchAdapter.Disable(OpenQA.Selenium.DevTools.V148.Fetch.DisableCommandSettings,System.Threading.CancellationToken,System.Nullable{System.Int32},System.Boolean)">
Disable(DisableCommandSettings?, CancellationToken, int?, bool)
<a class="header-action link-secondary" title="View source" href="https://github.com/SeleniumHQ/selenium/blob/docfix/bazel-bin/dotnet/src/webdriver/DevTools/v148/Fetch/FetchAdapter.cs/#L65"><i class="bi bi-code-slash"></i></a>
</h3>
<div class="markdown level1 summary"><p>Disables the fetch domain.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public Task&lt;DisableCommandResponse?&gt; Disable(DisableCommandSettings? command = null, CancellationToken cancellationToken = default, int? millisecondsTimeout = null, bool throwExceptionIfResponseNotReceived = true)</code></pre>
</div>
<h4 class="section">Parameters</h4>
<dl class="parameters">
<dt><code>command</code> <a class="xref" href="OpenQA.Selenium.DevTools.V148.Fetch.DisableCommandSettings.html">DisableCommandSettings</a></dt>
<dd></dd>
<dt><code>cancellationToken</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.threading.cancellationtoken">CancellationToken</a></dt>
<dd></dd>
<dt><code>millisecondsTimeout</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.int32">int</a>?</dt>
<dd></dd>
<dt><code>throwExceptionIfResponseNotReceived</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.boolean">bool</a></dt>
<dd></dd>
</dl>
<h4 class="section">Returns</h4>
<dl class="parameters">
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.threading.tasks.task-1">Task</a>&lt;<a class="xref" href="OpenQA.Selenium.DevTools.V148.Fetch.DisableCommandResponse.html">DisableCommandResponse</a>&gt;</dt>
<dd></dd>
</dl>
<a id="OpenQA_Selenium_DevTools_V148_Fetch_FetchAdapter_Enable_" data-uid="OpenQA.Selenium.DevTools.V148.Fetch.FetchAdapter.Enable*"></a>
<h3 id="OpenQA_Selenium_DevTools_V148_Fetch_FetchAdapter_Enable_OpenQA_Selenium_DevTools_V148_Fetch_EnableCommandSettings_System_Threading_CancellationToken_System_Nullable_System_Int32__System_Boolean_" data-uid="OpenQA.Selenium.DevTools.V148.Fetch.FetchAdapter.Enable(OpenQA.Selenium.DevTools.V148.Fetch.EnableCommandSettings,System.Threading.CancellationToken,System.Nullable{System.Int32},System.Boolean)">
Enable(EnableCommandSettings, CancellationToken, int?, bool)
<a class="header-action link-secondary" title="View source" href="https://github.com/SeleniumHQ/selenium/blob/docfix/bazel-bin/dotnet/src/webdriver/DevTools/v148/Fetch/FetchAdapter.cs/#L74"><i class="bi bi-code-slash"></i></a>
</h3>
<div class="markdown level1 summary"><p>Enables issuing of requestPaused events. A request will be paused until client
calls one of failRequest, fulfillRequest or continueRequest/continueWithAuth.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public Task&lt;EnableCommandResponse?&gt; Enable(EnableCommandSettings command, CancellationToken cancellationToken = default, int? millisecondsTimeout = null, bool throwExceptionIfResponseNotReceived = true)</code></pre>
</div>
<h4 class="section">Parameters</h4>
<dl class="parameters">
<dt><code>command</code> <a class="xref" href="OpenQA.Selenium.DevTools.V148.Fetch.EnableCommandSettings.html">EnableCommandSettings</a></dt>
<dd></dd>
<dt><code>cancellationToken</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.threading.cancellationtoken">CancellationToken</a></dt>
<dd></dd>
<dt><code>millisecondsTimeout</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.int32">int</a>?</dt>
<dd></dd>
<dt><code>throwExceptionIfResponseNotReceived</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.boolean">bool</a></dt>
<dd></dd>
</dl>
<h4 class="section">Returns</h4>
<dl class="parameters">
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.threading.tasks.task-1">Task</a>&lt;<a class="xref" href="OpenQA.Selenium.DevTools.V148.Fetch.EnableCommandResponse.html">EnableCommandResponse</a>&gt;</dt>
<dd></dd>
</dl>
<a id="OpenQA_Selenium_DevTools_V148_Fetch_FetchAdapter_FailRequest_" data-uid="OpenQA.Selenium.DevTools.V148.Fetch.FetchAdapter.FailRequest*"></a>
<h3 id="OpenQA_Selenium_DevTools_V148_Fetch_FetchAdapter_FailRequest_OpenQA_Selenium_DevTools_V148_Fetch_FailRequestCommandSettings_System_Threading_CancellationToken_System_Nullable_System_Int32__System_Boolean_" data-uid="OpenQA.Selenium.DevTools.V148.Fetch.FetchAdapter.FailRequest(OpenQA.Selenium.DevTools.V148.Fetch.FailRequestCommandSettings,System.Threading.CancellationToken,System.Nullable{System.Int32},System.Boolean)">
FailRequest(FailRequestCommandSettings, CancellationToken, int?, bool)
<a class="header-action link-secondary" title="View source" href="https://github.com/SeleniumHQ/selenium/blob/docfix/bazel-bin/dotnet/src/webdriver/DevTools/v148/Fetch/FetchAdapter.cs/#L82"><i class="bi bi-code-slash"></i></a>
</h3>
<div class="markdown level1 summary"><p>Causes the request to fail with specified reason.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public Task&lt;FailRequestCommandResponse?&gt; FailRequest(FailRequestCommandSettings command, CancellationToken cancellationToken = default, int? millisecondsTimeout = null, bool throwExceptionIfResponseNotReceived = true)</code></pre>
</div>
<h4 class="section">Parameters</h4>
<dl class="parameters">
<dt><code>command</code> <a class="xref" href="OpenQA.Selenium.DevTools.V148.Fetch.FailRequestCommandSettings.html">FailRequestCommandSettings</a></dt>
<dd></dd>
<dt><code>cancellationToken</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.threading.cancellationtoken">CancellationToken</a></dt>
<dd></dd>
<dt><code>millisecondsTimeout</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.int32">int</a>?</dt>
<dd></dd>
<dt><code>throwExceptionIfResponseNotReceived</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.boolean">bool</a></dt>
<dd></dd>
</dl>
<h4 class="section">Returns</h4>
<dl class="parameters">
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.threading.tasks.task-1">Task</a>&lt;<a class="xref" href="OpenQA.Selenium.DevTools.V148.Fetch.FailRequestCommandResponse.html">FailRequestCommandResponse</a>&gt;</dt>
<dd></dd>
</dl>
<a id="OpenQA_Selenium_DevTools_V148_Fetch_FetchAdapter_FulfillRequest_" data-uid="OpenQA.Selenium.DevTools.V148.Fetch.FetchAdapter.FulfillRequest*"></a>
<h3 id="OpenQA_Selenium_DevTools_V148_Fetch_FetchAdapter_FulfillRequest_OpenQA_Selenium_DevTools_V148_Fetch_FulfillRequestCommandSettings_System_Threading_CancellationToken_System_Nullable_System_Int32__System_Boolean_" data-uid="OpenQA.Selenium.DevTools.V148.Fetch.FetchAdapter.FulfillRequest(OpenQA.Selenium.DevTools.V148.Fetch.FulfillRequestCommandSettings,System.Threading.CancellationToken,System.Nullable{System.Int32},System.Boolean)">
FulfillRequest(FulfillRequestCommandSettings, CancellationToken, int?, bool)
<a class="header-action link-secondary" title="View source" href="https://github.com/SeleniumHQ/selenium/blob/docfix/bazel-bin/dotnet/src/webdriver/DevTools/v148/Fetch/FetchAdapter.cs/#L90"><i class="bi bi-code-slash"></i></a>
</h3>
<div class="markdown level1 summary"><p>Provides response to the request.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public Task&lt;FulfillRequestCommandResponse?&gt; FulfillRequest(FulfillRequestCommandSettings command, CancellationToken cancellationToken = default, int? millisecondsTimeout = null, bool throwExceptionIfResponseNotReceived = true)</code></pre>
</div>
<h4 class="section">Parameters</h4>
<dl class="parameters">
<dt><code>command</code> <a class="xref" href="OpenQA.Selenium.DevTools.V148.Fetch.FulfillRequestCommandSettings.html">FulfillRequestCommandSettings</a></dt>
<dd></dd>
<dt><code>cancellationToken</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.threading.cancellationtoken">CancellationToken</a></dt>
<dd></dd>
<dt><code>millisecondsTimeout</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.int32">int</a>?</dt>
<dd></dd>
<dt><code>throwExceptionIfResponseNotReceived</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.boolean">bool</a></dt>
<dd></dd>
</dl>
<h4 class="section">Returns</h4>
<dl class="parameters">
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.threading.tasks.task-1">Task</a>&lt;<a class="xref" href="OpenQA.Selenium.DevTools.V148.Fetch.FulfillRequestCommandResponse.html">FulfillRequestCommandResponse</a>&gt;</dt>
<dd></dd>
</dl>
<a id="OpenQA_Selenium_DevTools_V148_Fetch_FetchAdapter_GetResponseBody_" data-uid="OpenQA.Selenium.DevTools.V148.Fetch.FetchAdapter.GetResponseBody*"></a>
<h3 id="OpenQA_Selenium_DevTools_V148_Fetch_FetchAdapter_GetResponseBody_OpenQA_Selenium_DevTools_V148_Fetch_GetResponseBodyCommandSettings_System_Threading_CancellationToken_System_Nullable_System_Int32__System_Boolean_" data-uid="OpenQA.Selenium.DevTools.V148.Fetch.FetchAdapter.GetResponseBody(OpenQA.Selenium.DevTools.V148.Fetch.GetResponseBodyCommandSettings,System.Threading.CancellationToken,System.Nullable{System.Int32},System.Boolean)">
GetResponseBody(GetResponseBodyCommandSettings, CancellationToken, int?, bool)
<a class="header-action link-secondary" title="View source" href="https://github.com/SeleniumHQ/selenium/blob/docfix/bazel-bin/dotnet/src/webdriver/DevTools/v148/Fetch/FetchAdapter.cs/#L133"><i class="bi bi-code-slash"></i></a>
</h3>
<div class="markdown level1 summary"><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>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public Task&lt;GetResponseBodyCommandResponse&gt; GetResponseBody(GetResponseBodyCommandSettings command, CancellationToken cancellationToken = default, int? millisecondsTimeout = null, bool throwExceptionIfResponseNotReceived = true)</code></pre>
</div>
<h4 class="section">Parameters</h4>
<dl class="parameters">
<dt><code>command</code> <a class="xref" href="OpenQA.Selenium.DevTools.V148.Fetch.GetResponseBodyCommandSettings.html">GetResponseBodyCommandSettings</a></dt>
<dd></dd>
<dt><code>cancellationToken</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.threading.cancellationtoken">CancellationToken</a></dt>
<dd></dd>
<dt><code>millisecondsTimeout</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.int32">int</a>?</dt>
<dd></dd>
<dt><code>throwExceptionIfResponseNotReceived</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.boolean">bool</a></dt>
<dd></dd>
</dl>
<h4 class="section">Returns</h4>
<dl class="parameters">
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.threading.tasks.task-1">Task</a>&lt;<a class="xref" href="OpenQA.Selenium.DevTools.V148.Fetch.GetResponseBodyCommandResponse.html">GetResponseBodyCommandResponse</a>&gt;</dt>
<dd></dd>
</dl>
<a id="OpenQA_Selenium_DevTools_V148_Fetch_FetchAdapter_TakeResponseBodyAsStream_" data-uid="OpenQA.Selenium.DevTools.V148.Fetch.FetchAdapter.TakeResponseBodyAsStream*"></a>
<h3 id="OpenQA_Selenium_DevTools_V148_Fetch_FetchAdapter_TakeResponseBodyAsStream_OpenQA_Selenium_DevTools_V148_Fetch_TakeResponseBodyAsStreamCommandSettings_System_Threading_CancellationToken_System_Nullable_System_Int32__System_Boolean_" data-uid="OpenQA.Selenium.DevTools.V148.Fetch.FetchAdapter.TakeResponseBodyAsStream(OpenQA.Selenium.DevTools.V148.Fetch.TakeResponseBodyAsStreamCommandSettings,System.Threading.CancellationToken,System.Nullable{System.Int32},System.Boolean)">
TakeResponseBodyAsStream(TakeResponseBodyAsStreamCommandSettings, CancellationToken, int?, bool)
<a class="header-action link-secondary" title="View source" href="https://github.com/SeleniumHQ/selenium/blob/docfix/bazel-bin/dotnet/src/webdriver/DevTools/v148/Fetch/FetchAdapter.cs/#L150"><i class="bi bi-code-slash"></i></a>
</h3>
<div class="markdown level1 summary"><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>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public Task&lt;TakeResponseBodyAsStreamCommandResponse&gt; TakeResponseBodyAsStream(TakeResponseBodyAsStreamCommandSettings command, CancellationToken cancellationToken = default, int? millisecondsTimeout = null, bool throwExceptionIfResponseNotReceived = true)</code></pre>
</div>
<h4 class="section">Parameters</h4>
<dl class="parameters">
<dt><code>command</code> <a class="xref" href="OpenQA.Selenium.DevTools.V148.Fetch.TakeResponseBodyAsStreamCommandSettings.html">TakeResponseBodyAsStreamCommandSettings</a></dt>
<dd></dd>
<dt><code>cancellationToken</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.threading.cancellationtoken">CancellationToken</a></dt>
<dd></dd>
<dt><code>millisecondsTimeout</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.int32">int</a>?</dt>
<dd></dd>
<dt><code>throwExceptionIfResponseNotReceived</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.boolean">bool</a></dt>
<dd></dd>
</dl>
<h4 class="section">Returns</h4>
<dl class="parameters">
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.threading.tasks.task-1">Task</a>&lt;<a class="xref" href="OpenQA.Selenium.DevTools.V148.Fetch.TakeResponseBodyAsStreamCommandResponse.html">TakeResponseBodyAsStreamCommandResponse</a>&gt;</dt>
<dd></dd>
</dl>
<h2 class="section" id="events">Events
</h2>
<h3 id="OpenQA_Selenium_DevTools_V148_Fetch_FetchAdapter_AuthRequired" data-uid="OpenQA.Selenium.DevTools.V148.Fetch.FetchAdapter.AuthRequired">
AuthRequired
<a class="header-action link-secondary" title="View source" href="https://github.com/SeleniumHQ/selenium/blob/docfix/bazel-bin/dotnet/src/webdriver/DevTools/v148/Fetch/FetchAdapter.cs/#L58"><i class="bi bi-code-slash"></i></a>
</h3>
<div class="markdown level1 summary"><p>Issued when the domain is enabled with handleAuthRequests set to true.
The request is paused until client responds with continueWithAuth.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public event EventHandler&lt;AuthRequiredEventArgs&gt;? AuthRequired</code></pre>
</div>
<h4 class="section">Event Type</h4>
<dl class="parameters">
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.eventhandler-1">EventHandler</a>&lt;<a class="xref" href="OpenQA.Selenium.DevTools.V148.Fetch.AuthRequiredEventArgs.html">AuthRequiredEventArgs</a>&gt;</dt>
<dd></dd>
</dl>
<h3 id="OpenQA_Selenium_DevTools_V148_Fetch_FetchAdapter_RequestPaused" data-uid="OpenQA.Selenium.DevTools.V148.Fetch.FetchAdapter.RequestPaused">
RequestPaused
<a class="header-action link-secondary" title="View source" href="https://github.com/SeleniumHQ/selenium/blob/docfix/bazel-bin/dotnet/src/webdriver/DevTools/v148/Fetch/FetchAdapter.cs/#L52"><i class="bi bi-code-slash"></i></a>
</h3>
<div class="markdown level1 summary"><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>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public event EventHandler&lt;RequestPausedEventArgs&gt;? RequestPaused</code></pre>
</div>
<h4 class="section">Event Type</h4>
<dl class="parameters">
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.eventhandler-1">EventHandler</a>&lt;<a class="xref" href="OpenQA.Selenium.DevTools.V148.Fetch.RequestPausedEventArgs.html">RequestPausedEventArgs</a>&gt;</dt>
<dd></dd>
</dl>
</article>
<div class="contribution d-print-none">
<a href="https://github.com/SeleniumHQ/selenium/blob/docfix/bazel-bin/dotnet/src/webdriver/DevTools/v148/Fetch/FetchAdapter.cs/#L16" class="edit-link">Edit this page</a>
</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>