blob: 15046fde14f4737c2f3d50b24ff94a9976a7ccdc [file] [log] [blame]
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<title>Class V130JavaScript </title>
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<meta name="title" content="Class V130JavaScript ">
<meta name="description" content="Class containing the JavaScript implementation for version 130 of the 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_V130_V130JavaScript.md&amp;value=---%0Auid%3A%20OpenQA.Selenium.DevTools.V130.V130JavaScript%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.V130.V130JavaScript">
<h1 id="OpenQA_Selenium_DevTools_V130_V130JavaScript" data-uid="OpenQA.Selenium.DevTools.V130.V130JavaScript" class="text-break">
Class V130JavaScript <a class="header-action link-secondary" title="View source" href="https://github.com/SeleniumHQ/selenium/blob/trunk/dotnet/src/webdriver/DevTools/v130/V130JavaScript.cs/#L31"><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.V130.html">V130</a></dd></dl>
<dl><dt>Assembly</dt><dd>WebDriver.dll</dd></dl>
</div>
<div class="markdown summary"><p>Class containing the JavaScript implementation for version 130 of the DevTools Protocol.</p>
</div>
<div class="markdown conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public class V130JavaScript : JavaScript</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="OpenQA.Selenium.DevTools.JavaScript.html">JavaScript</a></div>
<div><span class="xref">V130JavaScript</span></div>
</dd>
</dl>
<dl class="typelist inheritedMembers">
<dt>Inherited Members</dt>
<dd>
<div>
<a class="xref" href="OpenQA.Selenium.DevTools.JavaScript.html#OpenQA_Selenium_DevTools_JavaScript_BindingCalled">JavaScript.BindingCalled</a>
</div>
<div>
<a class="xref" href="OpenQA.Selenium.DevTools.JavaScript.html#OpenQA_Selenium_DevTools_JavaScript_ConsoleApiCalled">JavaScript.ConsoleApiCalled</a>
</div>
<div>
<a class="xref" href="OpenQA.Selenium.DevTools.JavaScript.html#OpenQA_Selenium_DevTools_JavaScript_ExceptionThrown">JavaScript.ExceptionThrown</a>
</div>
<div>
<a class="xref" href="OpenQA.Selenium.DevTools.JavaScript.html#OpenQA_Selenium_DevTools_JavaScript_OnBindingCalled_OpenQA_Selenium_DevTools_BindingCalledEventArgs_">JavaScript.OnBindingCalled(BindingCalledEventArgs)</a>
</div>
<div>
<a class="xref" href="OpenQA.Selenium.DevTools.JavaScript.html#OpenQA_Selenium_DevTools_JavaScript_OnConsoleApiCalled_OpenQA_Selenium_DevTools_ConsoleApiCalledEventArgs_">JavaScript.OnConsoleApiCalled(ConsoleApiCalledEventArgs)</a>
</div>
<div>
<a class="xref" href="OpenQA.Selenium.DevTools.JavaScript.html#OpenQA_Selenium_DevTools_JavaScript_OnExceptionThrown_OpenQA_Selenium_DevTools_ExceptionThrownEventArgs_">JavaScript.OnExceptionThrown(ExceptionThrownEventArgs)</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.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>
<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.tostring">object.ToString()</a>
</div>
</dd></dl>
<h2 class="section" id="constructors">Constructors
</h2>
<a id="OpenQA_Selenium_DevTools_V130_V130JavaScript__ctor_" data-uid="OpenQA.Selenium.DevTools.V130.V130JavaScript.#ctor*"></a>
<h3 id="OpenQA_Selenium_DevTools_V130_V130JavaScript__ctor_OpenQA_Selenium_DevTools_V130_Runtime_RuntimeAdapter_OpenQA_Selenium_DevTools_V130_Page_PageAdapter_" data-uid="OpenQA.Selenium.DevTools.V130.V130JavaScript.#ctor(OpenQA.Selenium.DevTools.V130.Runtime.RuntimeAdapter,OpenQA.Selenium.DevTools.V130.Page.PageAdapter)">
V130JavaScript(RuntimeAdapter, PageAdapter)
<a class="header-action link-secondary" title="View source" href="https://github.com/SeleniumHQ/selenium/blob/trunk/dotnet/src/webdriver/DevTools/v130/V130JavaScript.cs/#L41"><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.DevTools.V130.V130JavaScript.html">V130JavaScript</a> class.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public V130JavaScript(RuntimeAdapter runtime, PageAdapter page)</code></pre>
</div>
<h4 class="section">Parameters</h4>
<dl class="parameters">
<dt><code>runtime</code> <a class="xref" href="OpenQA.Selenium.DevTools.V130.Runtime.RuntimeAdapter.html">RuntimeAdapter</a></dt>
<dd><p>The DevTools Protocol adapter for the Runtime domain.</p>
</dd>
<dt><code>page</code> <a class="xref" href="OpenQA.Selenium.DevTools.V130.Page.PageAdapter.html">PageAdapter</a></dt>
<dd><p>The DevTools Protocol adapter for the Page domain.</p>
</dd>
</dl>
<h2 class="section" id="methods">Methods
</h2>
<a id="OpenQA_Selenium_DevTools_V130_V130JavaScript_AddBinding_" data-uid="OpenQA.Selenium.DevTools.V130.V130JavaScript.AddBinding*"></a>
<h3 id="OpenQA_Selenium_DevTools_V130_V130JavaScript_AddBinding_System_String_" data-uid="OpenQA.Selenium.DevTools.V130.V130JavaScript.AddBinding(System.String)">
AddBinding(string)
<a class="header-action link-secondary" title="View source" href="https://github.com/SeleniumHQ/selenium/blob/trunk/dotnet/src/webdriver/DevTools/v130/V130JavaScript.cs/#L91"><i class="bi bi-code-slash"></i></a>
</h3>
<div class="markdown level1 summary"><p>Adds a binding to a specific JavaScript name.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public override Task AddBinding(string name)</code></pre>
</div>
<h4 class="section">Parameters</h4>
<dl class="parameters">
<dt><code>name</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></dt>
<dd><p>The name to which to bind to.</p>
</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">Task</a></dt>
<dd><p>A task that represents the asynchronous operation.</p>
</dd>
</dl>
<a id="OpenQA_Selenium_DevTools_V130_V130JavaScript_AddScriptToEvaluateOnNewDocument_" data-uid="OpenQA.Selenium.DevTools.V130.V130JavaScript.AddScriptToEvaluateOnNewDocument*"></a>
<h3 id="OpenQA_Selenium_DevTools_V130_V130JavaScript_AddScriptToEvaluateOnNewDocument_System_String_" data-uid="OpenQA.Selenium.DevTools.V130.V130JavaScript.AddScriptToEvaluateOnNewDocument(System.String)">
AddScriptToEvaluateOnNewDocument(string)
<a class="header-action link-secondary" title="View source" href="https://github.com/SeleniumHQ/selenium/blob/trunk/dotnet/src/webdriver/DevTools/v130/V130JavaScript.cs/#L111"><i class="bi bi-code-slash"></i></a>
</h3>
<div class="markdown level1 summary"><p>Adds a JavaScript snippet to evaluate when a new document is opened.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public override Task&lt;string&gt; AddScriptToEvaluateOnNewDocument(string script)</code></pre>
</div>
<h4 class="section">Parameters</h4>
<dl class="parameters">
<dt><code>script</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></dt>
<dd><p>The script to add to be evaluated when a new document is opened.</p>
</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="https://learn.microsoft.com/dotnet/api/system.string">string</a>&gt;</dt>
<dd><p>A task that represents the asynchronous operation. The task result contains the internal ID of the script.</p>
</dd>
</dl>
<a id="OpenQA_Selenium_DevTools_V130_V130JavaScript_DisablePage_" data-uid="OpenQA.Selenium.DevTools.V130.V130JavaScript.DisablePage*"></a>
<h3 id="OpenQA_Selenium_DevTools_V130_V130JavaScript_DisablePage" data-uid="OpenQA.Selenium.DevTools.V130.V130JavaScript.DisablePage">
DisablePage()
<a class="header-action link-secondary" title="View source" href="https://github.com/SeleniumHQ/selenium/blob/trunk/dotnet/src/webdriver/DevTools/v130/V130JavaScript.cs/#L81"><i class="bi bi-code-slash"></i></a>
</h3>
<div class="markdown level1 summary"><p>Asynchronously disables the Page domain in the DevTools Protocol.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public override Task DisablePage()</code></pre>
</div>
<h4 class="section">Returns</h4>
<dl class="parameters">
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.threading.tasks.task">Task</a></dt>
<dd><p>A task that represents the asynchronous operation.</p>
</dd>
</dl>
<a id="OpenQA_Selenium_DevTools_V130_V130JavaScript_DisableRuntime_" data-uid="OpenQA.Selenium.DevTools.V130.V130JavaScript.DisableRuntime*"></a>
<h3 id="OpenQA_Selenium_DevTools_V130_V130JavaScript_DisableRuntime" data-uid="OpenQA.Selenium.DevTools.V130.V130JavaScript.DisableRuntime">
DisableRuntime()
<a class="header-action link-secondary" title="View source" href="https://github.com/SeleniumHQ/selenium/blob/trunk/dotnet/src/webdriver/DevTools/v130/V130JavaScript.cs/#L63"><i class="bi bi-code-slash"></i></a>
</h3>
<div class="markdown level1 summary"><p>Asynchronously disables the Runtime domain in the DevTools Protocol.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public override Task DisableRuntime()</code></pre>
</div>
<h4 class="section">Returns</h4>
<dl class="parameters">
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.threading.tasks.task">Task</a></dt>
<dd><p>A task that represents the asynchronous operation.</p>
</dd>
</dl>
<a id="OpenQA_Selenium_DevTools_V130_V130JavaScript_EnablePage_" data-uid="OpenQA.Selenium.DevTools.V130.V130JavaScript.EnablePage*"></a>
<h3 id="OpenQA_Selenium_DevTools_V130_V130JavaScript_EnablePage" data-uid="OpenQA.Selenium.DevTools.V130.V130JavaScript.EnablePage">
EnablePage()
<a class="header-action link-secondary" title="View source" href="https://github.com/SeleniumHQ/selenium/blob/trunk/dotnet/src/webdriver/DevTools/v130/V130JavaScript.cs/#L72"><i class="bi bi-code-slash"></i></a>
</h3>
<div class="markdown level1 summary"><p>Asynchronously enables the Page domain in the DevTools Protocol.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public override Task EnablePage()</code></pre>
</div>
<h4 class="section">Returns</h4>
<dl class="parameters">
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.threading.tasks.task">Task</a></dt>
<dd><p>A task that represents the asynchronous operation.</p>
</dd>
</dl>
<a id="OpenQA_Selenium_DevTools_V130_V130JavaScript_EnableRuntime_" data-uid="OpenQA.Selenium.DevTools.V130.V130JavaScript.EnableRuntime*"></a>
<h3 id="OpenQA_Selenium_DevTools_V130_V130JavaScript_EnableRuntime" data-uid="OpenQA.Selenium.DevTools.V130.V130JavaScript.EnableRuntime">
EnableRuntime()
<a class="header-action link-secondary" title="View source" href="https://github.com/SeleniumHQ/selenium/blob/trunk/dotnet/src/webdriver/DevTools/v130/V130JavaScript.cs/#L54"><i class="bi bi-code-slash"></i></a>
</h3>
<div class="markdown level1 summary"><p>Asynchronously enables the Runtime domain in the DevTools Protocol.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public override Task EnableRuntime()</code></pre>
</div>
<h4 class="section">Returns</h4>
<dl class="parameters">
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.threading.tasks.task">Task</a></dt>
<dd><p>A task that represents the asynchronous operation.</p>
</dd>
</dl>
<a id="OpenQA_Selenium_DevTools_V130_V130JavaScript_RemoveBinding_" data-uid="OpenQA.Selenium.DevTools.V130.V130JavaScript.RemoveBinding*"></a>
<h3 id="OpenQA_Selenium_DevTools_V130_V130JavaScript_RemoveBinding_System_String_" data-uid="OpenQA.Selenium.DevTools.V130.V130JavaScript.RemoveBinding(System.String)">
RemoveBinding(string)
<a class="header-action link-secondary" title="View source" href="https://github.com/SeleniumHQ/selenium/blob/trunk/dotnet/src/webdriver/DevTools/v130/V130JavaScript.cs/#L101"><i class="bi bi-code-slash"></i></a>
</h3>
<div class="markdown level1 summary"><p>Removes a binding from a specific JavaScript name.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public override Task RemoveBinding(string name)</code></pre>
</div>
<h4 class="section">Parameters</h4>
<dl class="parameters">
<dt><code>name</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></dt>
<dd><p>The name to which to remove the bind from.</p>
</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">Task</a></dt>
<dd><p>A task that represents the asynchronous operation.</p>
</dd>
</dl>
<a id="OpenQA_Selenium_DevTools_V130_V130JavaScript_RemoveScriptToEvaluateOnNewDocument_" data-uid="OpenQA.Selenium.DevTools.V130.V130JavaScript.RemoveScriptToEvaluateOnNewDocument*"></a>
<h3 id="OpenQA_Selenium_DevTools_V130_V130JavaScript_RemoveScriptToEvaluateOnNewDocument_System_String_" data-uid="OpenQA.Selenium.DevTools.V130.V130JavaScript.RemoveScriptToEvaluateOnNewDocument(System.String)">
RemoveScriptToEvaluateOnNewDocument(string)
<a class="header-action link-secondary" title="View source" href="https://github.com/SeleniumHQ/selenium/blob/trunk/dotnet/src/webdriver/DevTools/v130/V130JavaScript.cs/#L122"><i class="bi bi-code-slash"></i></a>
</h3>
<div class="markdown level1 summary"><p>Removes a JavaScript snippet from evaluate when a new document is opened.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public override Task RemoveScriptToEvaluateOnNewDocument(string scriptId)</code></pre>
</div>
<h4 class="section">Parameters</h4>
<dl class="parameters">
<dt><code>scriptId</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></dt>
<dd><p>The ID of the script to be removed.</p>
</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">Task</a></dt>
<dd><p>A task that represents the asynchronous operation.</p>
</dd>
</dl>
</article>
<div class="contribution d-print-none">
<a href="https://github.com/SeleniumHQ/selenium/blob/trunk/dotnet/src/webdriver/DevTools/v130/V130JavaScript.cs/#L31" 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>