blob: 9debf6f90ea750c6e6e23ab37d2f39a2915e0d03 [file] [edit]
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<title>Interface IBrowserModule </title>
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<meta name="title" content="Interface IBrowserModule ">
<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_BiDi_Browser_IBrowserModule.md&amp;value=---%0Auid%3A%20OpenQA.Selenium.BiDi.Browser.IBrowserModule%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.BiDi.Browser.IBrowserModule">
<h1 id="OpenQA_Selenium_BiDi_Browser_IBrowserModule" data-uid="OpenQA.Selenium.BiDi.Browser.IBrowserModule" class="text-break">
Interface IBrowserModule <a class="header-action link-secondary" title="View source" href="https://github.com/SeleniumHQ/selenium/blob/docfix/dotnet/src/webdriver/BiDi/Browser/IBrowserModule.cs/#L22"><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.BiDi.html">BiDi</a>.<a class="xref" href="OpenQA.Selenium.BiDi.Browser.html">Browser</a></dd></dl>
<dl><dt>Assembly</dt><dd>Selenium.WebDriver.dll</dd></dl>
</div>
<div class="markdown summary"></div>
<div class="markdown conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public interface IBrowserModule</code></pre>
</div>
<h2 class="section" id="methods">Methods
</h2>
<a id="OpenQA_Selenium_BiDi_Browser_IBrowserModule_CloseAsync_" data-uid="OpenQA.Selenium.BiDi.Browser.IBrowserModule.CloseAsync*"></a>
<h3 id="OpenQA_Selenium_BiDi_Browser_IBrowserModule_CloseAsync_OpenQA_Selenium_BiDi_Browser_CloseOptions_System_Threading_CancellationToken_" data-uid="OpenQA.Selenium.BiDi.Browser.IBrowserModule.CloseAsync(OpenQA.Selenium.BiDi.Browser.CloseOptions,System.Threading.CancellationToken)">
CloseAsync(CloseOptions?, CancellationToken)
<a class="header-action link-secondary" title="View source" href="https://github.com/SeleniumHQ/selenium/blob/docfix/dotnet/src/webdriver/BiDi/Browser/IBrowserModule.cs/#L24"><i class="bi bi-code-slash"></i></a>
</h3>
<div class="markdown level1 summary"></div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">Task&lt;CloseResult&gt; CloseAsync(CloseOptions? options = null, CancellationToken cancellationToken = default)</code></pre>
</div>
<h4 class="section">Parameters</h4>
<dl class="parameters">
<dt><code>options</code> <a class="xref" href="OpenQA.Selenium.BiDi.Browser.CloseOptions.html">CloseOptions</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>
</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.BiDi.Browser.CloseResult.html">CloseResult</a>&gt;</dt>
<dd></dd>
</dl>
<a id="OpenQA_Selenium_BiDi_Browser_IBrowserModule_CreateUserContextAsync_" data-uid="OpenQA.Selenium.BiDi.Browser.IBrowserModule.CreateUserContextAsync*"></a>
<h3 id="OpenQA_Selenium_BiDi_Browser_IBrowserModule_CreateUserContextAsync_OpenQA_Selenium_BiDi_Browser_CreateUserContextOptions_System_Threading_CancellationToken_" data-uid="OpenQA.Selenium.BiDi.Browser.IBrowserModule.CreateUserContextAsync(OpenQA.Selenium.BiDi.Browser.CreateUserContextOptions,System.Threading.CancellationToken)">
CreateUserContextAsync(CreateUserContextOptions?, CancellationToken)
<a class="header-action link-secondary" title="View source" href="https://github.com/SeleniumHQ/selenium/blob/docfix/dotnet/src/webdriver/BiDi/Browser/IBrowserModule.cs/#L25"><i class="bi bi-code-slash"></i></a>
</h3>
<div class="markdown level1 summary"></div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">Task&lt;CreateUserContextResult&gt; CreateUserContextAsync(CreateUserContextOptions? options = null, CancellationToken cancellationToken = default)</code></pre>
</div>
<h4 class="section">Parameters</h4>
<dl class="parameters">
<dt><code>options</code> <a class="xref" href="OpenQA.Selenium.BiDi.Browser.CreateUserContextOptions.html">CreateUserContextOptions</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>
</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.BiDi.Browser.CreateUserContextResult.html">CreateUserContextResult</a>&gt;</dt>
<dd></dd>
</dl>
<a id="OpenQA_Selenium_BiDi_Browser_IBrowserModule_GetClientWindowsAsync_" data-uid="OpenQA.Selenium.BiDi.Browser.IBrowserModule.GetClientWindowsAsync*"></a>
<h3 id="OpenQA_Selenium_BiDi_Browser_IBrowserModule_GetClientWindowsAsync_OpenQA_Selenium_BiDi_Browser_GetClientWindowsOptions_System_Threading_CancellationToken_" data-uid="OpenQA.Selenium.BiDi.Browser.IBrowserModule.GetClientWindowsAsync(OpenQA.Selenium.BiDi.Browser.GetClientWindowsOptions,System.Threading.CancellationToken)">
GetClientWindowsAsync(GetClientWindowsOptions?, CancellationToken)
<a class="header-action link-secondary" title="View source" href="https://github.com/SeleniumHQ/selenium/blob/docfix/dotnet/src/webdriver/BiDi/Browser/IBrowserModule.cs/#L26"><i class="bi bi-code-slash"></i></a>
</h3>
<div class="markdown level1 summary"></div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">Task&lt;GetClientWindowsResult&gt; GetClientWindowsAsync(GetClientWindowsOptions? options = null, CancellationToken cancellationToken = default)</code></pre>
</div>
<h4 class="section">Parameters</h4>
<dl class="parameters">
<dt><code>options</code> <a class="xref" href="OpenQA.Selenium.BiDi.Browser.GetClientWindowsOptions.html">GetClientWindowsOptions</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>
</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.BiDi.Browser.GetClientWindowsResult.html">GetClientWindowsResult</a>&gt;</dt>
<dd></dd>
</dl>
<a id="OpenQA_Selenium_BiDi_Browser_IBrowserModule_GetUserContextsAsync_" data-uid="OpenQA.Selenium.BiDi.Browser.IBrowserModule.GetUserContextsAsync*"></a>
<h3 id="OpenQA_Selenium_BiDi_Browser_IBrowserModule_GetUserContextsAsync_OpenQA_Selenium_BiDi_Browser_GetUserContextsOptions_System_Threading_CancellationToken_" data-uid="OpenQA.Selenium.BiDi.Browser.IBrowserModule.GetUserContextsAsync(OpenQA.Selenium.BiDi.Browser.GetUserContextsOptions,System.Threading.CancellationToken)">
GetUserContextsAsync(GetUserContextsOptions?, CancellationToken)
<a class="header-action link-secondary" title="View source" href="https://github.com/SeleniumHQ/selenium/blob/docfix/dotnet/src/webdriver/BiDi/Browser/IBrowserModule.cs/#L27"><i class="bi bi-code-slash"></i></a>
</h3>
<div class="markdown level1 summary"></div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">Task&lt;GetUserContextsResult&gt; GetUserContextsAsync(GetUserContextsOptions? options = null, CancellationToken cancellationToken = default)</code></pre>
</div>
<h4 class="section">Parameters</h4>
<dl class="parameters">
<dt><code>options</code> <a class="xref" href="OpenQA.Selenium.BiDi.Browser.GetUserContextsOptions.html">GetUserContextsOptions</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>
</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.BiDi.Browser.GetUserContextsResult.html">GetUserContextsResult</a>&gt;</dt>
<dd></dd>
</dl>
<a id="OpenQA_Selenium_BiDi_Browser_IBrowserModule_RemoveUserContextAsync_" data-uid="OpenQA.Selenium.BiDi.Browser.IBrowserModule.RemoveUserContextAsync*"></a>
<h3 id="OpenQA_Selenium_BiDi_Browser_IBrowserModule_RemoveUserContextAsync_OpenQA_Selenium_BiDi_Browser_UserContext_OpenQA_Selenium_BiDi_Browser_RemoveUserContextOptions_System_Threading_CancellationToken_" data-uid="OpenQA.Selenium.BiDi.Browser.IBrowserModule.RemoveUserContextAsync(OpenQA.Selenium.BiDi.Browser.UserContext,OpenQA.Selenium.BiDi.Browser.RemoveUserContextOptions,System.Threading.CancellationToken)">
RemoveUserContextAsync(UserContext, RemoveUserContextOptions?, CancellationToken)
<a class="header-action link-secondary" title="View source" href="https://github.com/SeleniumHQ/selenium/blob/docfix/dotnet/src/webdriver/BiDi/Browser/IBrowserModule.cs/#L28"><i class="bi bi-code-slash"></i></a>
</h3>
<div class="markdown level1 summary"></div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">Task&lt;RemoveUserContextResult&gt; RemoveUserContextAsync(UserContext userContext, RemoveUserContextOptions? options = null, CancellationToken cancellationToken = default)</code></pre>
</div>
<h4 class="section">Parameters</h4>
<dl class="parameters">
<dt><code>userContext</code> <a class="xref" href="OpenQA.Selenium.BiDi.Browser.UserContext.html">UserContext</a></dt>
<dd></dd>
<dt><code>options</code> <a class="xref" href="OpenQA.Selenium.BiDi.Browser.RemoveUserContextOptions.html">RemoveUserContextOptions</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>
</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.BiDi.Browser.RemoveUserContextResult.html">RemoveUserContextResult</a>&gt;</dt>
<dd></dd>
</dl>
<a id="OpenQA_Selenium_BiDi_Browser_IBrowserModule_SetDownloadBehaviorAsync_" data-uid="OpenQA.Selenium.BiDi.Browser.IBrowserModule.SetDownloadBehaviorAsync*"></a>
<h3 id="OpenQA_Selenium_BiDi_Browser_IBrowserModule_SetDownloadBehaviorAsync_OpenQA_Selenium_BiDi_Browser_DownloadBehavior_OpenQA_Selenium_BiDi_Browser_SetDownloadBehaviorOptions_System_Threading_CancellationToken_" data-uid="OpenQA.Selenium.BiDi.Browser.IBrowserModule.SetDownloadBehaviorAsync(OpenQA.Selenium.BiDi.Browser.DownloadBehavior,OpenQA.Selenium.BiDi.Browser.SetDownloadBehaviorOptions,System.Threading.CancellationToken)">
SetDownloadBehaviorAsync(DownloadBehavior?, SetDownloadBehaviorOptions?, CancellationToken)
<a class="header-action link-secondary" title="View source" href="https://github.com/SeleniumHQ/selenium/blob/docfix/dotnet/src/webdriver/BiDi/Browser/IBrowserModule.cs/#L29"><i class="bi bi-code-slash"></i></a>
</h3>
<div class="markdown level1 summary"></div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">Task&lt;SetDownloadBehaviorResult&gt; SetDownloadBehaviorAsync(DownloadBehavior? downloadBehavior, SetDownloadBehaviorOptions? options = null, CancellationToken cancellationToken = default)</code></pre>
</div>
<h4 class="section">Parameters</h4>
<dl class="parameters">
<dt><code>downloadBehavior</code> <a class="xref" href="OpenQA.Selenium.BiDi.Browser.DownloadBehavior.html">DownloadBehavior</a></dt>
<dd></dd>
<dt><code>options</code> <a class="xref" href="OpenQA.Selenium.BiDi.Browser.SetDownloadBehaviorOptions.html">SetDownloadBehaviorOptions</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>
</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.BiDi.Browser.SetDownloadBehaviorResult.html">SetDownloadBehaviorResult</a>&gt;</dt>
<dd></dd>
</dl>
</article>
<div class="contribution d-print-none">
<a href="https://github.com/SeleniumHQ/selenium/blob/docfix/dotnet/src/webdriver/BiDi/Browser/IBrowserModule.cs/#L22" 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>