blob: bc053a9ae9938ef05477edf6919be210da6556d8 [file] [log] [blame] [edit]
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<title>Interface IDevTools </title>
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<meta name="title" content="Interface IDevTools ">
<meta name="description" content="Interface indicating the driver supports the Chrome DevTools Protocol.">
<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_DevTools_IDevTools.md&amp;value=---%0Auid%3A%20OpenQA.Selenium.DevTools.IDevTools%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.IDevTools">
<h1 id="OpenQA_Selenium_DevTools_IDevTools" data-uid="OpenQA.Selenium.DevTools.IDevTools" class="text-break">
Interface IDevTools <a class="header-action link-secondary" title="View source" href="https://github.com/SeleniumHQ/selenium/blob/trunk/dotnet/src/webdriver/DevTools/IDevTools.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.DevTools.html">DevTools</a></dd></dl>
<dl><dt>Assembly</dt><dd>WebDriver.dll</dd></dl>
</div>
<div class="markdown summary"><p>Interface indicating the driver supports the Chrome DevTools Protocol.</p>
</div>
<div class="markdown conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public interface IDevTools</code></pre>
</div>
<h2 class="section" id="properties">Properties
</h2>
<a id="OpenQA_Selenium_DevTools_IDevTools_HasActiveDevToolsSession_" data-uid="OpenQA.Selenium.DevTools.IDevTools.HasActiveDevToolsSession*"></a>
<h3 id="OpenQA_Selenium_DevTools_IDevTools_HasActiveDevToolsSession" data-uid="OpenQA.Selenium.DevTools.IDevTools.HasActiveDevToolsSession">
HasActiveDevToolsSession
<a class="header-action link-secondary" title="View source" href="https://github.com/SeleniumHQ/selenium/blob/trunk/dotnet/src/webdriver/DevTools/IDevTools.cs/#L33"><i class="bi bi-code-slash"></i></a>
</h3>
<div class="markdown level1 summary"><p>Gets a value indicating whether a DevTools session is active.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">bool HasActiveDevToolsSession { 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.boolean">bool</a></dt>
<dd></dd>
</dl>
<h2 class="section" id="methods">Methods
</h2>
<a id="OpenQA_Selenium_DevTools_IDevTools_CloseDevToolsSession_" data-uid="OpenQA.Selenium.DevTools.IDevTools.CloseDevToolsSession*"></a>
<h3 id="OpenQA_Selenium_DevTools_IDevTools_CloseDevToolsSession" data-uid="OpenQA.Selenium.DevTools.IDevTools.CloseDevToolsSession">
CloseDevToolsSession()
<a class="header-action link-secondary" title="View source" href="https://github.com/SeleniumHQ/selenium/blob/trunk/dotnet/src/webdriver/DevTools/IDevTools.cs/#L66"><i class="bi bi-code-slash"></i></a>
</h3>
<div class="markdown level1 summary"><p>Closes a DevTools session</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">void CloseDevToolsSession()</code></pre>
</div>
<a id="OpenQA_Selenium_DevTools_IDevTools_GetDevToolsSession_" data-uid="OpenQA.Selenium.DevTools.IDevTools.GetDevToolsSession*"></a>
<h3 id="OpenQA_Selenium_DevTools_IDevTools_GetDevToolsSession" data-uid="OpenQA.Selenium.DevTools.IDevTools.GetDevToolsSession">
GetDevToolsSession()
<a class="header-action link-secondary" title="View source" href="https://github.com/SeleniumHQ/selenium/blob/trunk/dotnet/src/webdriver/DevTools/IDevTools.cs/#L39"><i class="bi bi-code-slash"></i></a>
</h3>
<div class="markdown level1 summary"><p>Creates a session to communicate with a browser using a Developer Tools debugging protocol.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">DevToolsSession GetDevToolsSession()</code></pre>
</div>
<h4 class="section">Returns</h4>
<dl class="parameters">
<dt><a class="xref" href="OpenQA.Selenium.DevTools.DevToolsSession.html">DevToolsSession</a></dt>
<dd><p>The active session to use to communicate with the Developer Tools debugging protocol.</p>
</dd>
</dl>
<a id="OpenQA_Selenium_DevTools_IDevTools_GetDevToolsSession_" data-uid="OpenQA.Selenium.DevTools.IDevTools.GetDevToolsSession*"></a>
<h3 id="OpenQA_Selenium_DevTools_IDevTools_GetDevToolsSession_OpenQA_Selenium_DevTools_DevToolsOptions_" data-uid="OpenQA.Selenium.DevTools.IDevTools.GetDevToolsSession(OpenQA.Selenium.DevTools.DevToolsOptions)">
GetDevToolsSession(DevToolsOptions)
<a class="header-action link-secondary" title="View source" href="https://github.com/SeleniumHQ/selenium/blob/trunk/dotnet/src/webdriver/DevTools/IDevTools.cs/#L49"><i class="bi bi-code-slash"></i></a>
</h3>
<div class="markdown level1 summary"><p>Creates a session to communicate with a browser using a specific version of the Developer Tools debugging protocol.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">DevToolsSession GetDevToolsSession(DevToolsOptions options)</code></pre>
</div>
<h4 class="section">Parameters</h4>
<dl class="parameters">
<dt><code>options</code> <a class="xref" href="OpenQA.Selenium.DevTools.DevToolsOptions.html">DevToolsOptions</a></dt>
<dd><p>The options for the DevToolsSession to use.</p>
</dd>
</dl>
<h4 class="section">Returns</h4>
<dl class="parameters">
<dt><a class="xref" href="OpenQA.Selenium.DevTools.DevToolsSession.html">DevToolsSession</a></dt>
<dd><p>The active session to use to communicate with the Developer Tools debugging protocol.</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">options</code> is <a href="https://learn.microsoft.com/dotnet/csharp/language-reference/keywords/null">null</a>.</p>
</dd>
</dl>
<a id="OpenQA_Selenium_DevTools_IDevTools_GetDevToolsSession_" data-uid="OpenQA.Selenium.DevTools.IDevTools.GetDevToolsSession*"></a>
<h3 id="OpenQA_Selenium_DevTools_IDevTools_GetDevToolsSession_System_Int32_" data-uid="OpenQA.Selenium.DevTools.IDevTools.GetDevToolsSession(System.Int32)">
GetDevToolsSession(int)
<a class="header-action link-secondary" title="View source" href="https://github.com/SeleniumHQ/selenium/blob/trunk/dotnet/src/webdriver/DevTools/IDevTools.cs/#L58"><i class="bi bi-code-slash"></i></a>
</h3>
<div class="markdown level1 summary"><p>Creates a session to communicate with a browser using a specific version of the Developer Tools debugging protocol.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">[Obsolete(&quot;Use GetDevToolsSession(DevToolsOptions options)&quot;)]
DevToolsSession GetDevToolsSession(int protocolVersion)</code></pre>
</div>
<h4 class="section">Parameters</h4>
<dl class="parameters">
<dt><code>protocolVersion</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.int32">int</a></dt>
<dd><p>The specific version of the Developer Tools debugging protocol to use.</p>
</dd>
</dl>
<h4 class="section">Returns</h4>
<dl class="parameters">
<dt><a class="xref" href="OpenQA.Selenium.DevTools.DevToolsSession.html">DevToolsSession</a></dt>
<dd><p>The active session to use to communicate with the Developer Tools debugging protocol.</p>
</dd>
</dl>
</article>
<div class="contribution d-print-none">
<a href="https://github.com/SeleniumHQ/selenium/blob/trunk/dotnet/src/webdriver/DevTools/IDevTools.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>