blob: bbb1305a5846fe642acd01675a8f563eb23938a5 [file] [log] [blame] [edit]
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<title>Class RemoteSessionSettings </title>
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<meta name="title" content="Class RemoteSessionSettings ">
<meta name="description" content="Base class for managing options specific to a browser driver.">
<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_RemoteSessionSettings.md&amp;value=---%0Auid%3A%20OpenQA.Selenium.RemoteSessionSettings%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.RemoteSessionSettings">
<h1 id="OpenQA_Selenium_RemoteSessionSettings" data-uid="OpenQA.Selenium.RemoteSessionSettings" class="text-break">
Class RemoteSessionSettings <a class="header-action link-secondary" title="View source" href="https://github.com/SeleniumHQ/selenium/blob/trunk/dotnet/src/webdriver/Remote/RemoteSessionSettings.cs/#L30"><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></dd></dl>
<dl><dt>Assembly</dt><dd>WebDriver.dll</dd></dl>
</div>
<div class="markdown summary"><p>Base class for managing options specific to a browser driver.</p>
</div>
<div class="markdown conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public class RemoteSessionSettings : ICapabilities</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">RemoteSessionSettings</span></div>
</dd>
</dl>
<dl class="typelist implements">
<dt>Implements</dt>
<dd>
<div><a class="xref" href="OpenQA.Selenium.ICapabilities.html">ICapabilities</a></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_RemoteSessionSettings__ctor_" data-uid="OpenQA.Selenium.RemoteSessionSettings.#ctor*"></a>
<h3 id="OpenQA_Selenium_RemoteSessionSettings__ctor" data-uid="OpenQA.Selenium.RemoteSessionSettings.#ctor">
RemoteSessionSettings()
<a class="header-action link-secondary" title="View source" href="https://github.com/SeleniumHQ/selenium/blob/trunk/dotnet/src/webdriver/Remote/RemoteSessionSettings.cs/#L43"><i class="bi bi-code-slash"></i></a>
</h3>
<div class="markdown level1 summary"><p>Creates a new instance of the <a class="xref" href="OpenQA.Selenium.RemoteSessionSettings.html">RemoteSessionSettings</a> class.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public RemoteSessionSettings()</code></pre>
</div>
<a id="OpenQA_Selenium_RemoteSessionSettings__ctor_" data-uid="OpenQA.Selenium.RemoteSessionSettings.#ctor*"></a>
<h3 id="OpenQA_Selenium_RemoteSessionSettings__ctor_OpenQA_Selenium_DriverOptions_OpenQA_Selenium_DriverOptions___" data-uid="OpenQA.Selenium.RemoteSessionSettings.#ctor(OpenQA.Selenium.DriverOptions,OpenQA.Selenium.DriverOptions[])">
RemoteSessionSettings(DriverOptions, params DriverOptions[])
<a class="header-action link-secondary" title="View source" href="https://github.com/SeleniumHQ/selenium/blob/trunk/dotnet/src/webdriver/Remote/RemoteSessionSettings.cs/#L60"><i class="bi bi-code-slash"></i></a>
</h3>
<div class="markdown level1 summary"><p>Creates a new instance of the <a class="xref" href="OpenQA.Selenium.RemoteSessionSettings.html">RemoteSessionSettings</a> class,
containing the specified <a class="xref" href="OpenQA.Selenium.DriverOptions.html">DriverOptions</a> to use in the remote
session.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public RemoteSessionSettings(DriverOptions mustMatchDriverOptions, params DriverOptions[] firstMatchDriverOptions)</code></pre>
</div>
<h4 class="section">Parameters</h4>
<dl class="parameters">
<dt><code>mustMatchDriverOptions</code> <a class="xref" href="OpenQA.Selenium.DriverOptions.html">DriverOptions</a></dt>
<dd><p>A <a class="xref" href="OpenQA.Selenium.DriverOptions.html">DriverOptions</a> object that contains values that must be matched
by the remote end to create the remote session.</p>
</dd>
<dt><code>firstMatchDriverOptions</code> <a class="xref" href="OpenQA.Selenium.DriverOptions.html">DriverOptions</a>[]</dt>
<dd><p>A list of <a class="xref" href="OpenQA.Selenium.DriverOptions.html">DriverOptions</a> objects that contain values that may be matched
by the remote end to create the remote session.</p>
</dd>
</dl>
<h2 class="section" id="properties">Properties
</h2>
<a id="OpenQA_Selenium_RemoteSessionSettings_Item_" data-uid="OpenQA.Selenium.RemoteSessionSettings.Item*"></a>
<h3 id="OpenQA_Selenium_RemoteSessionSettings_Item_System_String_" data-uid="OpenQA.Selenium.RemoteSessionSettings.Item(System.String)">
this[string]
<a class="header-action link-secondary" title="View source" href="https://github.com/SeleniumHQ/selenium/blob/trunk/dotnet/src/webdriver/Remote/RemoteSessionSettings.cs/#L88"><i class="bi bi-code-slash"></i></a>
</h3>
<div class="markdown level1 summary"><p>Gets the capability value with the specified name.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public object this[string capabilityName] { get; }</code></pre>
</div>
<h4 class="section">Parameters</h4>
<dl class="parameters">
<dt><code>capabilityName</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></dt>
<dd><p>The name of the capability to get.</p>
</dd>
</dl>
<h4 class="section">Property Value</h4>
<dl class="parameters">
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object">object</a></dt>
<dd><p>The value of the capability.</p>
</dd>
</dl>
<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>The specified capability name is not in the set of capabilities.</p>
</dd>
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.argumentnullexception">ArgumentNullException</a></dt>
<dd><p>If <code class="paramref">capabilityName</code> is null.</p>
</dd>
</dl>
<h2 class="section" id="methods">Methods
</h2>
<a id="OpenQA_Selenium_RemoteSessionSettings_AddFirstMatchDriverOption_" data-uid="OpenQA.Selenium.RemoteSessionSettings.AddFirstMatchDriverOption*"></a>
<h3 id="OpenQA_Selenium_RemoteSessionSettings_AddFirstMatchDriverOption_OpenQA_Selenium_DriverOptions_" data-uid="OpenQA.Selenium.RemoteSessionSettings.AddFirstMatchDriverOption(OpenQA.Selenium.DriverOptions)">
AddFirstMatchDriverOption(DriverOptions)
<a class="header-action link-secondary" title="View source" href="https://github.com/SeleniumHQ/selenium/blob/trunk/dotnet/src/webdriver/Remote/RemoteSessionSettings.cs/#L143"><i class="bi bi-code-slash"></i></a>
</h3>
<div class="markdown level1 summary"><p>Adds a <a class="xref" href="OpenQA.Selenium.DriverOptions.html">DriverOptions</a> object to the list of options containing values to be
&quot;first matched&quot; by the remote end.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public void AddFirstMatchDriverOption(DriverOptions options)</code></pre>
</div>
<h4 class="section">Parameters</h4>
<dl class="parameters">
<dt><code>options</code> <a class="xref" href="OpenQA.Selenium.DriverOptions.html">DriverOptions</a></dt>
<dd><p>The <a class="xref" href="OpenQA.Selenium.DriverOptions.html">DriverOptions</a> to add to the list of &quot;first matched&quot; options.</p>
</dd>
</dl>
<a id="OpenQA_Selenium_RemoteSessionSettings_AddMetadataSetting_" data-uid="OpenQA.Selenium.RemoteSessionSettings.AddMetadataSetting*"></a>
<h3 id="OpenQA_Selenium_RemoteSessionSettings_AddMetadataSetting_System_String_System_Object_" data-uid="OpenQA.Selenium.RemoteSessionSettings.AddMetadataSetting(System.String,System.Object)">
AddMetadataSetting(string, object)
<a class="header-action link-secondary" title="View source" href="https://github.com/SeleniumHQ/selenium/blob/trunk/dotnet/src/webdriver/Remote/RemoteSessionSettings.cs/#L123"><i class="bi bi-code-slash"></i></a>
</h3>
<div class="markdown level1 summary"><p>Add a metadata setting to this set of remote session settings.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public void AddMetadataSetting(string settingName, object settingValue)</code></pre>
</div>
<h4 class="section">Parameters</h4>
<dl class="parameters">
<dt><code>settingName</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></dt>
<dd><p>The name of the setting to set.</p>
</dd>
<dt><code>settingValue</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object">object</a></dt>
<dd><p>The value of the setting.</p>
</dd>
</dl>
<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 the setting name is null or empty.</p>
<p>-or-</p>
<p>If one of the reserved names of metadata settings.</p>
</dd>
</dl>
<a id="OpenQA_Selenium_RemoteSessionSettings_GetCapability_" data-uid="OpenQA.Selenium.RemoteSessionSettings.GetCapability*"></a>
<h3 id="OpenQA_Selenium_RemoteSessionSettings_GetCapability_System_String_" data-uid="OpenQA.Selenium.RemoteSessionSettings.GetCapability(System.String)">
GetCapability(string)
<a class="header-action link-secondary" title="View source" href="https://github.com/SeleniumHQ/selenium/blob/trunk/dotnet/src/webdriver/Remote/RemoteSessionSettings.cs/#L207"><i class="bi bi-code-slash"></i></a>
</h3>
<div class="markdown level1 summary"><p>Gets a capability of the browser.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public object? GetCapability(string capability)</code></pre>
</div>
<h4 class="section">Parameters</h4>
<dl class="parameters">
<dt><code>capability</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></dt>
<dd><p>The capability to get.</p>
</dd>
</dl>
<h4 class="section">Returns</h4>
<dl class="parameters">
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object">object</a></dt>
<dd><p>An object associated with the capability, or <a href="https://learn.microsoft.com/dotnet/csharp/language-reference/keywords/null">null</a>
if the capability is not set in this set of capabilities.</p>
</dd>
</dl>
<a id="OpenQA_Selenium_RemoteSessionSettings_HasCapability_" data-uid="OpenQA.Selenium.RemoteSessionSettings.HasCapability*"></a>
<h3 id="OpenQA_Selenium_RemoteSessionSettings_HasCapability_System_String_" data-uid="OpenQA.Selenium.RemoteSessionSettings.HasCapability(System.String)">
HasCapability(string)
<a class="header-action link-secondary" title="View source" href="https://github.com/SeleniumHQ/selenium/blob/trunk/dotnet/src/webdriver/Remote/RemoteSessionSettings.cs/#L191"><i class="bi bi-code-slash"></i></a>
</h3>
<div class="markdown level1 summary"><p>Gets a value indicating whether the browser has a given capability.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public bool HasCapability(string capability)</code></pre>
</div>
<h4 class="section">Parameters</h4>
<dl class="parameters">
<dt><code>capability</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></dt>
<dd><p>The capability to get.</p>
</dd>
</dl>
<h4 class="section">Returns</h4>
<dl class="parameters">
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.boolean">bool</a></dt>
<dd><p>Returns <a href="https://learn.microsoft.com/dotnet/csharp/language-reference/builtin-types/bool">true</a> if this set of capabilities has the capability;
otherwise, <a href="https://learn.microsoft.com/dotnet/csharp/language-reference/builtin-types/bool">false</a>.</p>
</dd>
</dl>
<a id="OpenQA_Selenium_RemoteSessionSettings_SetMustMatchDriverOptions_" data-uid="OpenQA.Selenium.RemoteSessionSettings.SetMustMatchDriverOptions*"></a>
<h3 id="OpenQA_Selenium_RemoteSessionSettings_SetMustMatchDriverOptions_OpenQA_Selenium_DriverOptions_" data-uid="OpenQA.Selenium.RemoteSessionSettings.SetMustMatchDriverOptions(OpenQA.Selenium.DriverOptions)">
SetMustMatchDriverOptions(DriverOptions)
<a class="header-action link-secondary" title="View source" href="https://github.com/SeleniumHQ/selenium/blob/trunk/dotnet/src/webdriver/Remote/RemoteSessionSettings.cs/#L164"><i class="bi bi-code-slash"></i></a>
</h3>
<div class="markdown level1 summary"><p>Adds a <a class="xref" href="OpenQA.Selenium.DriverOptions.html">DriverOptions</a> object containing values that must be matched
by the remote end to successfully create a session.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public void SetMustMatchDriverOptions(DriverOptions options)</code></pre>
</div>
<h4 class="section">Parameters</h4>
<dl class="parameters">
<dt><code>options</code> <a class="xref" href="OpenQA.Selenium.DriverOptions.html">DriverOptions</a></dt>
<dd><p>The <a class="xref" href="OpenQA.Selenium.DriverOptions.html">DriverOptions</a> that must be matched by
the remote end to successfully create a session.</p>
</dd>
</dl>
<a id="OpenQA_Selenium_RemoteSessionSettings_ToDictionary_" data-uid="OpenQA.Selenium.RemoteSessionSettings.ToDictionary*"></a>
<h3 id="OpenQA_Selenium_RemoteSessionSettings_ToDictionary" data-uid="OpenQA.Selenium.RemoteSessionSettings.ToDictionary">
ToDictionary()
<a class="header-action link-secondary" title="View source" href="https://github.com/SeleniumHQ/selenium/blob/trunk/dotnet/src/webdriver/Remote/RemoteSessionSettings.cs/#L231"><i class="bi bi-code-slash"></i></a>
</h3>
<div class="markdown level1 summary"><p>Return a dictionary representation of this <a class="xref" href="OpenQA.Selenium.RemoteSessionSettings.html">RemoteSessionSettings</a>.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public Dictionary&lt;string, object?&gt; ToDictionary()</code></pre>
</div>
<h4 class="section">Returns</h4>
<dl class="parameters">
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.collections.generic.dictionary-2">Dictionary</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.object">object</a>&gt;</dt>
<dd><p>A <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.collections.generic.dictionary-2">Dictionary&lt;TKey, TValue&gt;</a> representation of this <a class="xref" href="OpenQA.Selenium.RemoteSessionSettings.html">RemoteSessionSettings</a>.</p>
</dd>
</dl>
</article>
<div class="contribution d-print-none">
<a href="https://github.com/SeleniumHQ/selenium/blob/trunk/dotnet/src/webdriver/Remote/RemoteSessionSettings.cs/#L30" 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>