blob: 196298556026bfc9be247f34e72d6d17831c18ae [file] [edit]
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<title>Class ProfilerAdapter </title>
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<meta name="title" content="Class ProfilerAdapter ">
<meta name="description" content="Represents an adapter for the Profiler 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_V147_Profiler_ProfilerAdapter.md&amp;value=---%0Auid%3A%20OpenQA.Selenium.DevTools.V147.Profiler.ProfilerAdapter%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.V147.Profiler.ProfilerAdapter">
<h1 id="OpenQA_Selenium_DevTools_V147_Profiler_ProfilerAdapter" data-uid="OpenQA.Selenium.DevTools.V147.Profiler.ProfilerAdapter" class="text-break">
Class ProfilerAdapter <a class="header-action link-secondary" title="View source" href="https://github.com/SeleniumHQ/selenium/blob/docfix/bazel-bin/dotnet/src/webdriver/DevTools/v147/Profiler/ProfilerAdapter.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.V147.html">V147</a>.<a class="xref" href="OpenQA.Selenium.DevTools.V147.Profiler.html">Profiler</a></dd></dl>
<dl><dt>Assembly</dt><dd>Selenium.WebDriver.dll</dd></dl>
</div>
<div class="markdown summary"><p>Represents an adapter for the Profiler domain to simplify the command interface.</p>
</div>
<div class="markdown conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public class ProfilerAdapter</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">ProfilerAdapter</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_V147_Profiler_ProfilerAdapter__ctor_" data-uid="OpenQA.Selenium.DevTools.V147.Profiler.ProfilerAdapter.#ctor*"></a>
<h3 id="OpenQA_Selenium_DevTools_V147_Profiler_ProfilerAdapter__ctor_OpenQA_Selenium_DevTools_IDevToolsSession_" data-uid="OpenQA.Selenium.DevTools.V147.Profiler.ProfilerAdapter.#ctor(OpenQA.Selenium.DevTools.IDevToolsSession)">
ProfilerAdapter(IDevToolsSession)
<a class="header-action link-secondary" title="View source" href="https://github.com/SeleniumHQ/selenium/blob/docfix/bazel-bin/dotnet/src/webdriver/DevTools/v147/Profiler/ProfilerAdapter.cs/#L26"><i class="bi bi-code-slash"></i></a>
</h3>
<div class="markdown level1 summary"><p>Initializes a new instance of the ProfilerAdapter class.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public ProfilerAdapter(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_V147_Profiler_ProfilerAdapter_Session_" data-uid="OpenQA.Selenium.DevTools.V147.Profiler.ProfilerAdapter.Session*"></a>
<h3 id="OpenQA_Selenium_DevTools_V147_Profiler_ProfilerAdapter_Session" data-uid="OpenQA.Selenium.DevTools.V147.Profiler.ProfilerAdapter.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/v147/Profiler/ProfilerAdapter.cs/#L38"><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_V147_Profiler_ProfilerAdapter_Disable_" data-uid="OpenQA.Selenium.DevTools.V147.Profiler.ProfilerAdapter.Disable*"></a>
<h3 id="OpenQA_Selenium_DevTools_V147_Profiler_ProfilerAdapter_Disable_OpenQA_Selenium_DevTools_V147_Profiler_DisableCommandSettings_System_Threading_CancellationToken_System_Nullable_System_Int32__System_Boolean_" data-uid="OpenQA.Selenium.DevTools.V147.Profiler.ProfilerAdapter.Disable(OpenQA.Selenium.DevTools.V147.Profiler.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/v147/Profiler/ProfilerAdapter.cs/#L63"><i class="bi bi-code-slash"></i></a>
</h3>
<div class="markdown level1 summary"><p>disable</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.V147.Profiler.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.V147.Profiler.DisableCommandResponse.html">DisableCommandResponse</a>&gt;</dt>
<dd></dd>
</dl>
<a id="OpenQA_Selenium_DevTools_V147_Profiler_ProfilerAdapter_Enable_" data-uid="OpenQA.Selenium.DevTools.V147.Profiler.ProfilerAdapter.Enable*"></a>
<h3 id="OpenQA_Selenium_DevTools_V147_Profiler_ProfilerAdapter_Enable_OpenQA_Selenium_DevTools_V147_Profiler_EnableCommandSettings_System_Threading_CancellationToken_System_Nullable_System_Int32__System_Boolean_" data-uid="OpenQA.Selenium.DevTools.V147.Profiler.ProfilerAdapter.Enable(OpenQA.Selenium.DevTools.V147.Profiler.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/v147/Profiler/ProfilerAdapter.cs/#L71"><i class="bi bi-code-slash"></i></a>
</h3>
<div class="markdown level1 summary"><p>enable</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 = 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.V147.Profiler.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.V147.Profiler.EnableCommandResponse.html">EnableCommandResponse</a>&gt;</dt>
<dd></dd>
</dl>
<a id="OpenQA_Selenium_DevTools_V147_Profiler_ProfilerAdapter_GetBestEffortCoverage_" data-uid="OpenQA.Selenium.DevTools.V147.Profiler.ProfilerAdapter.GetBestEffortCoverage*"></a>
<h3 id="OpenQA_Selenium_DevTools_V147_Profiler_ProfilerAdapter_GetBestEffortCoverage_OpenQA_Selenium_DevTools_V147_Profiler_GetBestEffortCoverageCommandSettings_System_Threading_CancellationToken_System_Nullable_System_Int32__System_Boolean_" data-uid="OpenQA.Selenium.DevTools.V147.Profiler.ProfilerAdapter.GetBestEffortCoverage(OpenQA.Selenium.DevTools.V147.Profiler.GetBestEffortCoverageCommandSettings,System.Threading.CancellationToken,System.Nullable{System.Int32},System.Boolean)">
GetBestEffortCoverage(GetBestEffortCoverageCommandSettings?, 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/v147/Profiler/ProfilerAdapter.cs/#L80"><i class="bi bi-code-slash"></i></a>
</h3>
<div class="markdown level1 summary"><p>Collect coverage data for the current isolate. The coverage data may be incomplete due to
garbage collection.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public Task&lt;GetBestEffortCoverageCommandResponse&gt; GetBestEffortCoverage(GetBestEffortCoverageCommandSettings? 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.V147.Profiler.GetBestEffortCoverageCommandSettings.html">GetBestEffortCoverageCommandSettings</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.V147.Profiler.GetBestEffortCoverageCommandResponse.html">GetBestEffortCoverageCommandResponse</a>&gt;</dt>
<dd></dd>
</dl>
<a id="OpenQA_Selenium_DevTools_V147_Profiler_ProfilerAdapter_SetSamplingInterval_" data-uid="OpenQA.Selenium.DevTools.V147.Profiler.ProfilerAdapter.SetSamplingInterval*"></a>
<h3 id="OpenQA_Selenium_DevTools_V147_Profiler_ProfilerAdapter_SetSamplingInterval_OpenQA_Selenium_DevTools_V147_Profiler_SetSamplingIntervalCommandSettings_System_Threading_CancellationToken_System_Nullable_System_Int32__System_Boolean_" data-uid="OpenQA.Selenium.DevTools.V147.Profiler.ProfilerAdapter.SetSamplingInterval(OpenQA.Selenium.DevTools.V147.Profiler.SetSamplingIntervalCommandSettings,System.Threading.CancellationToken,System.Nullable{System.Int32},System.Boolean)">
SetSamplingInterval(SetSamplingIntervalCommandSettings, 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/v147/Profiler/ProfilerAdapter.cs/#L88"><i class="bi bi-code-slash"></i></a>
</h3>
<div class="markdown level1 summary"><p>Changes CPU profiler sampling interval. Must be called before CPU profiles recording started.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public Task&lt;SetSamplingIntervalCommandResponse?&gt; SetSamplingInterval(SetSamplingIntervalCommandSettings 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.V147.Profiler.SetSamplingIntervalCommandSettings.html">SetSamplingIntervalCommandSettings</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.V147.Profiler.SetSamplingIntervalCommandResponse.html">SetSamplingIntervalCommandResponse</a>&gt;</dt>
<dd></dd>
</dl>
<a id="OpenQA_Selenium_DevTools_V147_Profiler_ProfilerAdapter_Start_" data-uid="OpenQA.Selenium.DevTools.V147.Profiler.ProfilerAdapter.Start*"></a>
<h3 id="OpenQA_Selenium_DevTools_V147_Profiler_ProfilerAdapter_Start_OpenQA_Selenium_DevTools_V147_Profiler_StartCommandSettings_System_Threading_CancellationToken_System_Nullable_System_Int32__System_Boolean_" data-uid="OpenQA.Selenium.DevTools.V147.Profiler.ProfilerAdapter.Start(OpenQA.Selenium.DevTools.V147.Profiler.StartCommandSettings,System.Threading.CancellationToken,System.Nullable{System.Int32},System.Boolean)">
Start(StartCommandSettings?, 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/v147/Profiler/ProfilerAdapter.cs/#L96"><i class="bi bi-code-slash"></i></a>
</h3>
<div class="markdown level1 summary"><p>start</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public Task&lt;StartCommandResponse?&gt; Start(StartCommandSettings? 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.V147.Profiler.StartCommandSettings.html">StartCommandSettings</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.V147.Profiler.StartCommandResponse.html">StartCommandResponse</a>&gt;</dt>
<dd></dd>
</dl>
<a id="OpenQA_Selenium_DevTools_V147_Profiler_ProfilerAdapter_StartPreciseCoverage_" data-uid="OpenQA.Selenium.DevTools.V147.Profiler.ProfilerAdapter.StartPreciseCoverage*"></a>
<h3 id="OpenQA_Selenium_DevTools_V147_Profiler_ProfilerAdapter_StartPreciseCoverage_OpenQA_Selenium_DevTools_V147_Profiler_StartPreciseCoverageCommandSettings_System_Threading_CancellationToken_System_Nullable_System_Int32__System_Boolean_" data-uid="OpenQA.Selenium.DevTools.V147.Profiler.ProfilerAdapter.StartPreciseCoverage(OpenQA.Selenium.DevTools.V147.Profiler.StartPreciseCoverageCommandSettings,System.Threading.CancellationToken,System.Nullable{System.Int32},System.Boolean)">
StartPreciseCoverage(StartPreciseCoverageCommandSettings, 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/v147/Profiler/ProfilerAdapter.cs/#L106"><i class="bi bi-code-slash"></i></a>
</h3>
<div class="markdown level1 summary"><p>Enable precise code coverage. Coverage data for JavaScript executed before enabling precise code
coverage may be incomplete. Enabling prevents running optimized code and resets execution
counters.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public Task&lt;StartPreciseCoverageCommandResponse&gt; StartPreciseCoverage(StartPreciseCoverageCommandSettings 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.V147.Profiler.StartPreciseCoverageCommandSettings.html">StartPreciseCoverageCommandSettings</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.V147.Profiler.StartPreciseCoverageCommandResponse.html">StartPreciseCoverageCommandResponse</a>&gt;</dt>
<dd></dd>
</dl>
<a id="OpenQA_Selenium_DevTools_V147_Profiler_ProfilerAdapter_Stop_" data-uid="OpenQA.Selenium.DevTools.V147.Profiler.ProfilerAdapter.Stop*"></a>
<h3 id="OpenQA_Selenium_DevTools_V147_Profiler_ProfilerAdapter_Stop_OpenQA_Selenium_DevTools_V147_Profiler_StopCommandSettings_System_Threading_CancellationToken_System_Nullable_System_Int32__System_Boolean_" data-uid="OpenQA.Selenium.DevTools.V147.Profiler.ProfilerAdapter.Stop(OpenQA.Selenium.DevTools.V147.Profiler.StopCommandSettings,System.Threading.CancellationToken,System.Nullable{System.Int32},System.Boolean)">
Stop(StopCommandSettings?, 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/v147/Profiler/ProfilerAdapter.cs/#L114"><i class="bi bi-code-slash"></i></a>
</h3>
<div class="markdown level1 summary"><p>stop</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public Task&lt;StopCommandResponse&gt; Stop(StopCommandSettings? 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.V147.Profiler.StopCommandSettings.html">StopCommandSettings</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.V147.Profiler.StopCommandResponse.html">StopCommandResponse</a>&gt;</dt>
<dd></dd>
</dl>
<a id="OpenQA_Selenium_DevTools_V147_Profiler_ProfilerAdapter_StopPreciseCoverage_" data-uid="OpenQA.Selenium.DevTools.V147.Profiler.ProfilerAdapter.StopPreciseCoverage*"></a>
<h3 id="OpenQA_Selenium_DevTools_V147_Profiler_ProfilerAdapter_StopPreciseCoverage_OpenQA_Selenium_DevTools_V147_Profiler_StopPreciseCoverageCommandSettings_System_Threading_CancellationToken_System_Nullable_System_Int32__System_Boolean_" data-uid="OpenQA.Selenium.DevTools.V147.Profiler.ProfilerAdapter.StopPreciseCoverage(OpenQA.Selenium.DevTools.V147.Profiler.StopPreciseCoverageCommandSettings,System.Threading.CancellationToken,System.Nullable{System.Int32},System.Boolean)">
StopPreciseCoverage(StopPreciseCoverageCommandSettings?, 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/v147/Profiler/ProfilerAdapter.cs/#L123"><i class="bi bi-code-slash"></i></a>
</h3>
<div class="markdown level1 summary"><p>Disable precise code coverage. Disabling releases unnecessary execution count records and allows
executing optimized code.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public Task&lt;StopPreciseCoverageCommandResponse?&gt; StopPreciseCoverage(StopPreciseCoverageCommandSettings? 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.V147.Profiler.StopPreciseCoverageCommandSettings.html">StopPreciseCoverageCommandSettings</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.V147.Profiler.StopPreciseCoverageCommandResponse.html">StopPreciseCoverageCommandResponse</a>&gt;</dt>
<dd></dd>
</dl>
<a id="OpenQA_Selenium_DevTools_V147_Profiler_ProfilerAdapter_TakePreciseCoverage_" data-uid="OpenQA.Selenium.DevTools.V147.Profiler.ProfilerAdapter.TakePreciseCoverage*"></a>
<h3 id="OpenQA_Selenium_DevTools_V147_Profiler_ProfilerAdapter_TakePreciseCoverage_OpenQA_Selenium_DevTools_V147_Profiler_TakePreciseCoverageCommandSettings_System_Threading_CancellationToken_System_Nullable_System_Int32__System_Boolean_" data-uid="OpenQA.Selenium.DevTools.V147.Profiler.ProfilerAdapter.TakePreciseCoverage(OpenQA.Selenium.DevTools.V147.Profiler.TakePreciseCoverageCommandSettings,System.Threading.CancellationToken,System.Nullable{System.Int32},System.Boolean)">
TakePreciseCoverage(TakePreciseCoverageCommandSettings?, 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/v147/Profiler/ProfilerAdapter.cs/#L132"><i class="bi bi-code-slash"></i></a>
</h3>
<div class="markdown level1 summary"><p>Collect coverage data for the current isolate, and resets execution counters. Precise code
coverage needs to have started.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public Task&lt;TakePreciseCoverageCommandResponse&gt; TakePreciseCoverage(TakePreciseCoverageCommandSettings? 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.V147.Profiler.TakePreciseCoverageCommandSettings.html">TakePreciseCoverageCommandSettings</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.V147.Profiler.TakePreciseCoverageCommandResponse.html">TakePreciseCoverageCommandResponse</a>&gt;</dt>
<dd></dd>
</dl>
<h2 class="section" id="events">Events
</h2>
<h3 id="OpenQA_Selenium_DevTools_V147_Profiler_ProfilerAdapter_ConsoleProfileFinished" data-uid="OpenQA.Selenium.DevTools.V147.Profiler.ProfilerAdapter.ConsoleProfileFinished">
ConsoleProfileFinished
<a class="header-action link-secondary" title="View source" href="https://github.com/SeleniumHQ/selenium/blob/docfix/bazel-bin/dotnet/src/webdriver/DevTools/v147/Profiler/ProfilerAdapter.cs/#L43"><i class="bi bi-code-slash"></i></a>
</h3>
<div class="markdown level1 summary"><p>consoleProfileFinished</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public event EventHandler&lt;ConsoleProfileFinishedEventArgs&gt;? ConsoleProfileFinished</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.V147.Profiler.ConsoleProfileFinishedEventArgs.html">ConsoleProfileFinishedEventArgs</a>&gt;</dt>
<dd></dd>
</dl>
<h3 id="OpenQA_Selenium_DevTools_V147_Profiler_ProfilerAdapter_ConsoleProfileStarted" data-uid="OpenQA.Selenium.DevTools.V147.Profiler.ProfilerAdapter.ConsoleProfileStarted">
ConsoleProfileStarted
<a class="header-action link-secondary" title="View source" href="https://github.com/SeleniumHQ/selenium/blob/docfix/bazel-bin/dotnet/src/webdriver/DevTools/v147/Profiler/ProfilerAdapter.cs/#L48"><i class="bi bi-code-slash"></i></a>
</h3>
<div class="markdown level1 summary"><p>Sent when new profile recording is started using console.profile() call.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public event EventHandler&lt;ConsoleProfileStartedEventArgs&gt;? ConsoleProfileStarted</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.V147.Profiler.ConsoleProfileStartedEventArgs.html">ConsoleProfileStartedEventArgs</a>&gt;</dt>
<dd></dd>
</dl>
<h3 id="OpenQA_Selenium_DevTools_V147_Profiler_ProfilerAdapter_PreciseCoverageDeltaUpdate" data-uid="OpenQA.Selenium.DevTools.V147.Profiler.ProfilerAdapter.PreciseCoverageDeltaUpdate">
PreciseCoverageDeltaUpdate
<a class="header-action link-secondary" title="View source" href="https://github.com/SeleniumHQ/selenium/blob/docfix/bazel-bin/dotnet/src/webdriver/DevTools/v147/Profiler/ProfilerAdapter.cs/#L56"><i class="bi bi-code-slash"></i></a>
</h3>
<div class="markdown level1 summary"><p>Reports coverage delta since the last poll (either from an event like this, or from
<code>takePreciseCoverage</code> for the current isolate. May only be sent if precise code
coverage has been started. This event can be trigged by the embedder to, for example,
trigger collection of coverage data immediately at a certain point in time.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public event EventHandler&lt;PreciseCoverageDeltaUpdateEventArgs&gt;? PreciseCoverageDeltaUpdate</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.V147.Profiler.PreciseCoverageDeltaUpdateEventArgs.html">PreciseCoverageDeltaUpdateEventArgs</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/v147/Profiler/ProfilerAdapter.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>