blob: 38af9c7ddd61bbcb8b81f513e46131819d4f38d4 [file] [edit]
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<title>Class SendingRemoteHttpRequestEventArgs </title>
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<meta name="title" content="Class SendingRemoteHttpRequestEventArgs ">
<meta name="description" content="Provides data for the SendingRemoteHttpRequest event of a object.">
<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/trunk/apiSpec/new?filename=OpenQA_Selenium_Remote_SendingRemoteHttpRequestEventArgs.md&amp;value=---%0Auid%3A%20OpenQA.Selenium.Remote.SendingRemoteHttpRequestEventArgs%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.Remote.SendingRemoteHttpRequestEventArgs">
<h1 id="OpenQA_Selenium_Remote_SendingRemoteHttpRequestEventArgs" data-uid="OpenQA.Selenium.Remote.SendingRemoteHttpRequestEventArgs" class="text-break">
Class SendingRemoteHttpRequestEventArgs <a class="header-action link-secondary" title="View source" href="https://github.com/SeleniumHQ/selenium/blob/trunk/dotnet/src/webdriver/Remote/SendingRemoteHttpRequestEventArgs.cs/#L28"><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.Remote.html">Remote</a></dd></dl>
<dl><dt>Assembly</dt><dd>WebDriver.dll</dd></dl>
</div>
<div class="markdown summary"><p>Provides data for the SendingRemoteHttpRequest event of a <a class="xref" href="OpenQA.Selenium.Remote.HttpCommandExecutor.html">HttpCommandExecutor</a> object.</p>
</div>
<div class="markdown conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public class SendingRemoteHttpRequestEventArgs : EventArgs</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><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.eventargs">EventArgs</a></div>
<div><span class="xref">SendingRemoteHttpRequestEventArgs</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.eventargs.empty">EventArgs.Empty</a>
</div>
<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_Remote_SendingRemoteHttpRequestEventArgs__ctor_" data-uid="OpenQA.Selenium.Remote.SendingRemoteHttpRequestEventArgs.#ctor*"></a>
<h3 id="OpenQA_Selenium_Remote_SendingRemoteHttpRequestEventArgs__ctor_System_String_System_String_System_String_" data-uid="OpenQA.Selenium.Remote.SendingRemoteHttpRequestEventArgs.#ctor(System.String,System.String,System.String)">
SendingRemoteHttpRequestEventArgs(string, string, string?)
<a class="header-action link-secondary" title="View source" href="https://github.com/SeleniumHQ/selenium/blob/trunk/dotnet/src/webdriver/Remote/SendingRemoteHttpRequestEventArgs.cs/#L39"><i class="bi bi-code-slash"></i></a>
</h3>
<div class="markdown level1 summary"><p>Initializes a new instance of the <a class="xref" href="OpenQA.Selenium.Remote.SendingRemoteHttpRequestEventArgs.html">SendingRemoteHttpRequestEventArgs</a> class.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public SendingRemoteHttpRequestEventArgs(string method, string fullUrl, string? requestBody)</code></pre>
</div>
<h4 class="section">Parameters</h4>
<dl class="parameters">
<dt><code>method</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></dt>
<dd><p>The HTTP method of the request being sent.</p>
</dd>
<dt><code>fullUrl</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></dt>
<dd><p>The full URL of the request being sent.</p>
</dd>
<dt><code>requestBody</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></dt>
<dd><p>The body of the request.</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">method</code>, <code class="paramref">fullUrl</code> are null.</p>
</dd>
</dl>
<h2 class="section" id="properties">Properties
</h2>
<a id="OpenQA_Selenium_Remote_SendingRemoteHttpRequestEventArgs_FullUrl_" data-uid="OpenQA.Selenium.Remote.SendingRemoteHttpRequestEventArgs.FullUrl*"></a>
<h3 id="OpenQA_Selenium_Remote_SendingRemoteHttpRequestEventArgs_FullUrl" data-uid="OpenQA.Selenium.Remote.SendingRemoteHttpRequestEventArgs.FullUrl">
FullUrl
<a class="header-action link-secondary" title="View source" href="https://github.com/SeleniumHQ/selenium/blob/trunk/dotnet/src/webdriver/Remote/SendingRemoteHttpRequestEventArgs.cs/#L54"><i class="bi bi-code-slash"></i></a>
</h3>
<div class="markdown level1 summary"><p>Gets the full URL of the HTTP request.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public string FullUrl { get; }</code></pre>
</div>
<h4 class="section">Property Value</h4>
<dl class="parameters">
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></dt>
<dd></dd>
</dl>
<a id="OpenQA_Selenium_Remote_SendingRemoteHttpRequestEventArgs_Headers_" data-uid="OpenQA.Selenium.Remote.SendingRemoteHttpRequestEventArgs.Headers*"></a>
<h3 id="OpenQA_Selenium_Remote_SendingRemoteHttpRequestEventArgs_Headers" data-uid="OpenQA.Selenium.Remote.SendingRemoteHttpRequestEventArgs.Headers">
Headers
<a class="header-action link-secondary" title="View source" href="https://github.com/SeleniumHQ/selenium/blob/trunk/dotnet/src/webdriver/Remote/SendingRemoteHttpRequestEventArgs.cs/#L65"><i class="bi bi-code-slash"></i></a>
</h3>
<div class="markdown level1 summary"><p>Gets a read-only dictionary of the headers of the HTTP request.
Does not include default headers of the web client making the request.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public IReadOnlyDictionary&lt;string, string&gt; Headers { get; }</code></pre>
</div>
<h4 class="section">Property Value</h4>
<dl class="parameters">
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.collections.generic.ireadonlydictionary-2">IReadOnlyDictionary</a>&lt;<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a>, <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a>&gt;</dt>
<dd></dd>
</dl>
<a id="OpenQA_Selenium_Remote_SendingRemoteHttpRequestEventArgs_Method_" data-uid="OpenQA.Selenium.Remote.SendingRemoteHttpRequestEventArgs.Method*"></a>
<h3 id="OpenQA_Selenium_Remote_SendingRemoteHttpRequestEventArgs_Method" data-uid="OpenQA.Selenium.Remote.SendingRemoteHttpRequestEventArgs.Method">
Method
<a class="header-action link-secondary" title="View source" href="https://github.com/SeleniumHQ/selenium/blob/trunk/dotnet/src/webdriver/Remote/SendingRemoteHttpRequestEventArgs.cs/#L49"><i class="bi bi-code-slash"></i></a>
</h3>
<div class="markdown level1 summary"><p>Gets the HTTP method for the HTTP request.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public string Method { get; }</code></pre>
</div>
<h4 class="section">Property Value</h4>
<dl class="parameters">
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></dt>
<dd></dd>
</dl>
<a id="OpenQA_Selenium_Remote_SendingRemoteHttpRequestEventArgs_RequestBody_" data-uid="OpenQA.Selenium.Remote.SendingRemoteHttpRequestEventArgs.RequestBody*"></a>
<h3 id="OpenQA_Selenium_Remote_SendingRemoteHttpRequestEventArgs_RequestBody" data-uid="OpenQA.Selenium.Remote.SendingRemoteHttpRequestEventArgs.RequestBody">
RequestBody
<a class="header-action link-secondary" title="View source" href="https://github.com/SeleniumHQ/selenium/blob/trunk/dotnet/src/webdriver/Remote/SendingRemoteHttpRequestEventArgs.cs/#L59"><i class="bi bi-code-slash"></i></a>
</h3>
<div class="markdown level1 summary"><p>Gets the body of the HTTP request as a string.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public string? RequestBody { get; }</code></pre>
</div>
<h4 class="section">Property Value</h4>
<dl class="parameters">
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></dt>
<dd></dd>
</dl>
<h2 class="section" id="methods">Methods
</h2>
<a id="OpenQA_Selenium_Remote_SendingRemoteHttpRequestEventArgs_AddHeader_" data-uid="OpenQA.Selenium.Remote.SendingRemoteHttpRequestEventArgs.AddHeader*"></a>
<h3 id="OpenQA_Selenium_Remote_SendingRemoteHttpRequestEventArgs_AddHeader_System_String_System_String_" data-uid="OpenQA.Selenium.Remote.SendingRemoteHttpRequestEventArgs.AddHeader(System.String,System.String)">
AddHeader(string, string)
<a class="header-action link-secondary" title="View source" href="https://github.com/SeleniumHQ/selenium/blob/trunk/dotnet/src/webdriver/Remote/SendingRemoteHttpRequestEventArgs.cs/#L79"><i class="bi bi-code-slash"></i></a>
</h3>
<div class="markdown level1 summary"><p>Adds a header to the HTTP request.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public void AddHeader(string headerName, string headerValue)</code></pre>
</div>
<h4 class="section">Parameters</h4>
<dl class="parameters">
<dt><code>headerName</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></dt>
<dd><p>The name of the header to add.</p>
</dd>
<dt><code>headerValue</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></dt>
<dd><p>The value of the header to add.</p>
</dd>
</dl>
<h4 class="section" id="OpenQA_Selenium_Remote_SendingRemoteHttpRequestEventArgs_AddHeader_System_String_System_String__remarks">Remarks</h4>
<div class="markdown level1 remarks"><p>Adding headers here will attempt to add them to the headers for the
HTTP request being sent; however, be aware they may be overwritten by
the client raising the event.</p>
</div>
<h4 class="section">Exceptions</h4>
<dl class="parameters">
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.argumentexception">ArgumentException</a></dt>
<dd><p>If <code class="paramref">headerName</code> is <a href="https://learn.microsoft.com/dotnet/csharp/language-reference/keywords/null">null</a> or <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string.empty">Empty</a>.</p>
</dd>
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.argumentnullexception">ArgumentNullException</a></dt>
<dd><p>If <code class="paramref">headerValue</code> is <a href="https://learn.microsoft.com/dotnet/csharp/language-reference/keywords/null">null</a>.</p>
</dd>
</dl>
</article>
<div class="contribution d-print-none">
<a href="https://github.com/SeleniumHQ/selenium/blob/trunk/dotnet/src/webdriver/Remote/SendingRemoteHttpRequestEventArgs.cs/#L28" 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>