blob: 06434d8c2a9112be24ec8f3f2b5612817f86f37e [file] [log] [blame] [edit]
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<title>Class ScriptModule </title>
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<meta name="title" content="Class ScriptModule ">
<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_BiDi_Modules_Script_ScriptModule.md&amp;value=---%0Auid%3A%20OpenQA.Selenium.BiDi.Modules.Script.ScriptModule%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.Modules.Script.ScriptModule">
<h1 id="OpenQA_Selenium_BiDi_Modules_Script_ScriptModule" data-uid="OpenQA.Selenium.BiDi.Modules.Script.ScriptModule" class="text-break">
Class ScriptModule <a class="header-action link-secondary" title="View source" href="https://github.com/SeleniumHQ/selenium/blob/trunk/dotnet/src/webdriver/BiDi/Modules/Script/ScriptModule.cs/#L26"><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.Modules.html">Modules</a>.<a class="xref" href="OpenQA.Selenium.BiDi.Modules.Script.html">Script</a></dd></dl>
<dl><dt>Assembly</dt><dd>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 sealed class ScriptModule : Module</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.BiDi.Modules.Module.html">Module</a></div>
<div><span class="xref">ScriptModule</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.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.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_BiDi_Modules_Script_ScriptModule__ctor_" data-uid="OpenQA.Selenium.BiDi.Modules.Script.ScriptModule.#ctor*"></a>
<h3 id="OpenQA_Selenium_BiDi_Modules_Script_ScriptModule__ctor_OpenQA_Selenium_BiDi_Communication_Broker_" data-uid="OpenQA.Selenium.BiDi.Modules.Script.ScriptModule.#ctor(OpenQA.Selenium.BiDi.Communication.Broker)">
ScriptModule(Broker)
<a class="header-action link-secondary" title="View source" href="https://github.com/SeleniumHQ/selenium/blob/trunk/dotnet/src/webdriver/BiDi/Modules/Script/ScriptModule.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">public ScriptModule(Broker broker)</code></pre>
</div>
<h4 class="section">Parameters</h4>
<dl class="parameters">
<dt><code>broker</code> <a class="xref" href="OpenQA.Selenium.BiDi.Communication.Broker.html">Broker</a></dt>
<dd></dd>
</dl>
<h2 class="section" id="methods">Methods
</h2>
<a id="OpenQA_Selenium_BiDi_Modules_Script_ScriptModule_AddPreloadScriptAsync_" data-uid="OpenQA.Selenium.BiDi.Modules.Script.ScriptModule.AddPreloadScriptAsync*"></a>
<h3 id="OpenQA_Selenium_BiDi_Modules_Script_ScriptModule_AddPreloadScriptAsync_System_String_OpenQA_Selenium_BiDi_Modules_Script_AddPreloadScriptOptions_" data-uid="OpenQA.Selenium.BiDi.Modules.Script.ScriptModule.AddPreloadScriptAsync(System.String,OpenQA.Selenium.BiDi.Modules.Script.AddPreloadScriptOptions)">
AddPreloadScriptAsync(string, AddPreloadScriptOptions?)
<a class="header-action link-secondary" title="View source" href="https://github.com/SeleniumHQ/selenium/blob/trunk/dotnet/src/webdriver/BiDi/Modules/Script/ScriptModule.cs/#L77"><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">public Task&lt;PreloadScript&gt; AddPreloadScriptAsync(string functionDeclaration, AddPreloadScriptOptions? options = null)</code></pre>
</div>
<h4 class="section">Parameters</h4>
<dl class="parameters">
<dt><code>functionDeclaration</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></dt>
<dd></dd>
<dt><code>options</code> <a class="xref" href="OpenQA.Selenium.BiDi.Modules.Script.AddPreloadScriptOptions.html">AddPreloadScriptOptions</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.Modules.Script.PreloadScript.html">PreloadScript</a>&gt;</dt>
<dd></dd>
</dl>
<a id="OpenQA_Selenium_BiDi_Modules_Script_ScriptModule_CallFunctionAsync_" data-uid="OpenQA.Selenium.BiDi.Modules.Script.ScriptModule.CallFunctionAsync*"></a>
<h3 id="OpenQA_Selenium_BiDi_Modules_Script_ScriptModule_CallFunctionAsync_System_String_System_Boolean_OpenQA_Selenium_BiDi_Modules_Script_Target_OpenQA_Selenium_BiDi_Modules_Script_CallFunctionOptions_" data-uid="OpenQA.Selenium.BiDi.Modules.Script.ScriptModule.CallFunctionAsync(System.String,System.Boolean,OpenQA.Selenium.BiDi.Modules.Script.Target,OpenQA.Selenium.BiDi.Modules.Script.CallFunctionOptions)">
CallFunctionAsync(string, bool, Target, CallFunctionOptions?)
<a class="header-action link-secondary" title="View source" href="https://github.com/SeleniumHQ/selenium/blob/trunk/dotnet/src/webdriver/BiDi/Modules/Script/ScriptModule.cs/#L49"><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">public Task&lt;EvaluateResult.Success&gt; CallFunctionAsync(string functionDeclaration, bool awaitPromise, Target target, CallFunctionOptions? options = null)</code></pre>
</div>
<h4 class="section">Parameters</h4>
<dl class="parameters">
<dt><code>functionDeclaration</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></dt>
<dd></dd>
<dt><code>awaitPromise</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.boolean">bool</a></dt>
<dd></dd>
<dt><code>target</code> <a class="xref" href="OpenQA.Selenium.BiDi.Modules.Script.Target.html">Target</a></dt>
<dd></dd>
<dt><code>options</code> <a class="xref" href="OpenQA.Selenium.BiDi.Modules.Script.CallFunctionOptions.html">CallFunctionOptions</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.Modules.Script.EvaluateResult.html">EvaluateResult</a>.<a class="xref" href="OpenQA.Selenium.BiDi.Modules.Script.EvaluateResult.Success.html">Success</a>&gt;</dt>
<dd></dd>
</dl>
<a id="OpenQA_Selenium_BiDi_Modules_Script_ScriptModule_CallFunctionAsync_" data-uid="OpenQA.Selenium.BiDi.Modules.Script.ScriptModule.CallFunctionAsync*"></a>
<h3 id="OpenQA_Selenium_BiDi_Modules_Script_ScriptModule_CallFunctionAsync__1_System_String_System_Boolean_OpenQA_Selenium_BiDi_Modules_Script_Target_OpenQA_Selenium_BiDi_Modules_Script_CallFunctionOptions_" data-uid="OpenQA.Selenium.BiDi.Modules.Script.ScriptModule.CallFunctionAsync``1(System.String,System.Boolean,OpenQA.Selenium.BiDi.Modules.Script.Target,OpenQA.Selenium.BiDi.Modules.Script.CallFunctionOptions)">
CallFunctionAsync&lt;TResult&gt;(string, bool, Target, CallFunctionOptions?)
<a class="header-action link-secondary" title="View source" href="https://github.com/SeleniumHQ/selenium/blob/trunk/dotnet/src/webdriver/BiDi/Modules/Script/ScriptModule.cs/#L63"><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">public Task&lt;TResult?&gt; CallFunctionAsync&lt;TResult&gt;(string functionDeclaration, bool awaitPromise, Target target, CallFunctionOptions? options = null)</code></pre>
</div>
<h4 class="section">Parameters</h4>
<dl class="parameters">
<dt><code>functionDeclaration</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></dt>
<dd></dd>
<dt><code>awaitPromise</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.boolean">bool</a></dt>
<dd></dd>
<dt><code>target</code> <a class="xref" href="OpenQA.Selenium.BiDi.Modules.Script.Target.html">Target</a></dt>
<dd></dd>
<dt><code>options</code> <a class="xref" href="OpenQA.Selenium.BiDi.Modules.Script.CallFunctionOptions.html">CallFunctionOptions</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;TResult&gt;</dt>
<dd></dd>
</dl>
<h4 class="section">Type Parameters</h4>
<dl class="parameters">
<dt><code>TResult</code></dt>
<dd></dd>
</dl>
<a id="OpenQA_Selenium_BiDi_Modules_Script_ScriptModule_EvaluateAsync_" data-uid="OpenQA.Selenium.BiDi.Modules.Script.ScriptModule.EvaluateAsync*"></a>
<h3 id="OpenQA_Selenium_BiDi_Modules_Script_ScriptModule_EvaluateAsync_System_String_System_Boolean_OpenQA_Selenium_BiDi_Modules_Script_Target_OpenQA_Selenium_BiDi_Modules_Script_EvaluateOptions_" data-uid="OpenQA.Selenium.BiDi.Modules.Script.ScriptModule.EvaluateAsync(System.String,System.Boolean,OpenQA.Selenium.BiDi.Modules.Script.Target,OpenQA.Selenium.BiDi.Modules.Script.EvaluateOptions)">
EvaluateAsync(string, bool, Target, EvaluateOptions?)
<a class="header-action link-secondary" title="View source" href="https://github.com/SeleniumHQ/selenium/blob/trunk/dotnet/src/webdriver/BiDi/Modules/Script/ScriptModule.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">public Task&lt;EvaluateResult.Success&gt; EvaluateAsync(string expression, bool awaitPromise, Target target, EvaluateOptions? options = null)</code></pre>
</div>
<h4 class="section">Parameters</h4>
<dl class="parameters">
<dt><code>expression</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></dt>
<dd></dd>
<dt><code>awaitPromise</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.boolean">bool</a></dt>
<dd></dd>
<dt><code>target</code> <a class="xref" href="OpenQA.Selenium.BiDi.Modules.Script.Target.html">Target</a></dt>
<dd></dd>
<dt><code>options</code> <a class="xref" href="OpenQA.Selenium.BiDi.Modules.Script.EvaluateOptions.html">EvaluateOptions</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.Modules.Script.EvaluateResult.html">EvaluateResult</a>.<a class="xref" href="OpenQA.Selenium.BiDi.Modules.Script.EvaluateResult.Success.html">Success</a>&gt;</dt>
<dd></dd>
</dl>
<a id="OpenQA_Selenium_BiDi_Modules_Script_ScriptModule_EvaluateAsync_" data-uid="OpenQA.Selenium.BiDi.Modules.Script.ScriptModule.EvaluateAsync*"></a>
<h3 id="OpenQA_Selenium_BiDi_Modules_Script_ScriptModule_EvaluateAsync__1_System_String_System_Boolean_OpenQA_Selenium_BiDi_Modules_Script_Target_OpenQA_Selenium_BiDi_Modules_Script_EvaluateOptions_" data-uid="OpenQA.Selenium.BiDi.Modules.Script.ScriptModule.EvaluateAsync``1(System.String,System.Boolean,OpenQA.Selenium.BiDi.Modules.Script.Target,OpenQA.Selenium.BiDi.Modules.Script.EvaluateOptions)">
EvaluateAsync&lt;TResult&gt;(string, bool, Target, EvaluateOptions?)
<a class="header-action link-secondary" title="View source" href="https://github.com/SeleniumHQ/selenium/blob/trunk/dotnet/src/webdriver/BiDi/Modules/Script/ScriptModule.cs/#L42"><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">public Task&lt;TResult?&gt; EvaluateAsync&lt;TResult&gt;(string expression, bool awaitPromise, Target target, EvaluateOptions? options = null)</code></pre>
</div>
<h4 class="section">Parameters</h4>
<dl class="parameters">
<dt><code>expression</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></dt>
<dd></dd>
<dt><code>awaitPromise</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.boolean">bool</a></dt>
<dd></dd>
<dt><code>target</code> <a class="xref" href="OpenQA.Selenium.BiDi.Modules.Script.Target.html">Target</a></dt>
<dd></dd>
<dt><code>options</code> <a class="xref" href="OpenQA.Selenium.BiDi.Modules.Script.EvaluateOptions.html">EvaluateOptions</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;TResult&gt;</dt>
<dd></dd>
</dl>
<h4 class="section">Type Parameters</h4>
<dl class="parameters">
<dt><code>TResult</code></dt>
<dd></dd>
</dl>
<a id="OpenQA_Selenium_BiDi_Modules_Script_ScriptModule_GetRealmsAsync_" data-uid="OpenQA.Selenium.BiDi.Modules.Script.ScriptModule.GetRealmsAsync*"></a>
<h3 id="OpenQA_Selenium_BiDi_Modules_Script_ScriptModule_GetRealmsAsync_OpenQA_Selenium_BiDi_Modules_Script_GetRealmsOptions_" data-uid="OpenQA.Selenium.BiDi.Modules.Script.ScriptModule.GetRealmsAsync(OpenQA.Selenium.BiDi.Modules.Script.GetRealmsOptions)">
GetRealmsAsync(GetRealmsOptions?)
<a class="header-action link-secondary" title="View source" href="https://github.com/SeleniumHQ/selenium/blob/trunk/dotnet/src/webdriver/BiDi/Modules/Script/ScriptModule.cs/#L70"><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">public Task&lt;GetRealmsResult&gt; GetRealmsAsync(GetRealmsOptions? options = null)</code></pre>
</div>
<h4 class="section">Parameters</h4>
<dl class="parameters">
<dt><code>options</code> <a class="xref" href="OpenQA.Selenium.BiDi.Modules.Script.GetRealmsOptions.html">GetRealmsOptions</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.Modules.Script.GetRealmsResult.html">GetRealmsResult</a>&gt;</dt>
<dd></dd>
</dl>
<a id="OpenQA_Selenium_BiDi_Modules_Script_ScriptModule_OnMessageAsync_" data-uid="OpenQA.Selenium.BiDi.Modules.Script.ScriptModule.OnMessageAsync*"></a>
<h3 id="OpenQA_Selenium_BiDi_Modules_Script_ScriptModule_OnMessageAsync_System_Action_OpenQA_Selenium_BiDi_Modules_Script_MessageEventArgs__OpenQA_Selenium_BiDi_SubscriptionOptions_" data-uid="OpenQA.Selenium.BiDi.Modules.Script.ScriptModule.OnMessageAsync(System.Action{OpenQA.Selenium.BiDi.Modules.Script.MessageEventArgs},OpenQA.Selenium.BiDi.SubscriptionOptions)">
OnMessageAsync(Action&lt;MessageEventArgs&gt;, SubscriptionOptions?)
<a class="header-action link-secondary" title="View source" href="https://github.com/SeleniumHQ/selenium/blob/trunk/dotnet/src/webdriver/BiDi/Modules/Script/ScriptModule.cs/#L98"><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">public Task&lt;Subscription&gt; OnMessageAsync(Action&lt;MessageEventArgs&gt; handler, SubscriptionOptions? options = null)</code></pre>
</div>
<h4 class="section">Parameters</h4>
<dl class="parameters">
<dt><code>handler</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.action-1">Action</a>&lt;<a class="xref" href="OpenQA.Selenium.BiDi.Modules.Script.MessageEventArgs.html">MessageEventArgs</a>&gt;</dt>
<dd></dd>
<dt><code>options</code> <a class="xref" href="OpenQA.Selenium.BiDi.SubscriptionOptions.html">SubscriptionOptions</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.Subscription.html">Subscription</a>&gt;</dt>
<dd></dd>
</dl>
<a id="OpenQA_Selenium_BiDi_Modules_Script_ScriptModule_OnMessageAsync_" data-uid="OpenQA.Selenium.BiDi.Modules.Script.ScriptModule.OnMessageAsync*"></a>
<h3 id="OpenQA_Selenium_BiDi_Modules_Script_ScriptModule_OnMessageAsync_System_Func_OpenQA_Selenium_BiDi_Modules_Script_MessageEventArgs_System_Threading_Tasks_Task__OpenQA_Selenium_BiDi_SubscriptionOptions_" data-uid="OpenQA.Selenium.BiDi.Modules.Script.ScriptModule.OnMessageAsync(System.Func{OpenQA.Selenium.BiDi.Modules.Script.MessageEventArgs,System.Threading.Tasks.Task},OpenQA.Selenium.BiDi.SubscriptionOptions)">
OnMessageAsync(Func&lt;MessageEventArgs, Task&gt;, SubscriptionOptions?)
<a class="header-action link-secondary" title="View source" href="https://github.com/SeleniumHQ/selenium/blob/trunk/dotnet/src/webdriver/BiDi/Modules/Script/ScriptModule.cs/#L93"><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">public Task&lt;Subscription&gt; OnMessageAsync(Func&lt;MessageEventArgs, Task&gt; handler, SubscriptionOptions? options = null)</code></pre>
</div>
<h4 class="section">Parameters</h4>
<dl class="parameters">
<dt><code>handler</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.func-2">Func</a>&lt;<a class="xref" href="OpenQA.Selenium.BiDi.Modules.Script.MessageEventArgs.html">MessageEventArgs</a>, <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.threading.tasks.task">Task</a>&gt;</dt>
<dd></dd>
<dt><code>options</code> <a class="xref" href="OpenQA.Selenium.BiDi.SubscriptionOptions.html">SubscriptionOptions</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.Subscription.html">Subscription</a>&gt;</dt>
<dd></dd>
</dl>
<a id="OpenQA_Selenium_BiDi_Modules_Script_ScriptModule_OnRealmCreatedAsync_" data-uid="OpenQA.Selenium.BiDi.Modules.Script.ScriptModule.OnRealmCreatedAsync*"></a>
<h3 id="OpenQA_Selenium_BiDi_Modules_Script_ScriptModule_OnRealmCreatedAsync_System_Action_OpenQA_Selenium_BiDi_Modules_Script_RealmInfo__OpenQA_Selenium_BiDi_SubscriptionOptions_" data-uid="OpenQA.Selenium.BiDi.Modules.Script.ScriptModule.OnRealmCreatedAsync(System.Action{OpenQA.Selenium.BiDi.Modules.Script.RealmInfo},OpenQA.Selenium.BiDi.SubscriptionOptions)">
OnRealmCreatedAsync(Action&lt;RealmInfo&gt;, SubscriptionOptions?)
<a class="header-action link-secondary" title="View source" href="https://github.com/SeleniumHQ/selenium/blob/trunk/dotnet/src/webdriver/BiDi/Modules/Script/ScriptModule.cs/#L108"><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">public Task&lt;Subscription&gt; OnRealmCreatedAsync(Action&lt;RealmInfo&gt; handler, SubscriptionOptions? options = null)</code></pre>
</div>
<h4 class="section">Parameters</h4>
<dl class="parameters">
<dt><code>handler</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.action-1">Action</a>&lt;<a class="xref" href="OpenQA.Selenium.BiDi.Modules.Script.RealmInfo.html">RealmInfo</a>&gt;</dt>
<dd></dd>
<dt><code>options</code> <a class="xref" href="OpenQA.Selenium.BiDi.SubscriptionOptions.html">SubscriptionOptions</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.Subscription.html">Subscription</a>&gt;</dt>
<dd></dd>
</dl>
<a id="OpenQA_Selenium_BiDi_Modules_Script_ScriptModule_OnRealmCreatedAsync_" data-uid="OpenQA.Selenium.BiDi.Modules.Script.ScriptModule.OnRealmCreatedAsync*"></a>
<h3 id="OpenQA_Selenium_BiDi_Modules_Script_ScriptModule_OnRealmCreatedAsync_System_Func_OpenQA_Selenium_BiDi_Modules_Script_RealmInfo_System_Threading_Tasks_Task__OpenQA_Selenium_BiDi_SubscriptionOptions_" data-uid="OpenQA.Selenium.BiDi.Modules.Script.ScriptModule.OnRealmCreatedAsync(System.Func{OpenQA.Selenium.BiDi.Modules.Script.RealmInfo,System.Threading.Tasks.Task},OpenQA.Selenium.BiDi.SubscriptionOptions)">
OnRealmCreatedAsync(Func&lt;RealmInfo, Task&gt;, SubscriptionOptions?)
<a class="header-action link-secondary" title="View source" href="https://github.com/SeleniumHQ/selenium/blob/trunk/dotnet/src/webdriver/BiDi/Modules/Script/ScriptModule.cs/#L103"><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">public Task&lt;Subscription&gt; OnRealmCreatedAsync(Func&lt;RealmInfo, Task&gt; handler, SubscriptionOptions? options = null)</code></pre>
</div>
<h4 class="section">Parameters</h4>
<dl class="parameters">
<dt><code>handler</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.func-2">Func</a>&lt;<a class="xref" href="OpenQA.Selenium.BiDi.Modules.Script.RealmInfo.html">RealmInfo</a>, <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.threading.tasks.task">Task</a>&gt;</dt>
<dd></dd>
<dt><code>options</code> <a class="xref" href="OpenQA.Selenium.BiDi.SubscriptionOptions.html">SubscriptionOptions</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.Subscription.html">Subscription</a>&gt;</dt>
<dd></dd>
</dl>
<a id="OpenQA_Selenium_BiDi_Modules_Script_ScriptModule_OnRealmDestroyedAsync_" data-uid="OpenQA.Selenium.BiDi.Modules.Script.ScriptModule.OnRealmDestroyedAsync*"></a>
<h3 id="OpenQA_Selenium_BiDi_Modules_Script_ScriptModule_OnRealmDestroyedAsync_System_Action_OpenQA_Selenium_BiDi_Modules_Script_RealmDestroyedEventArgs__OpenQA_Selenium_BiDi_SubscriptionOptions_" data-uid="OpenQA.Selenium.BiDi.Modules.Script.ScriptModule.OnRealmDestroyedAsync(System.Action{OpenQA.Selenium.BiDi.Modules.Script.RealmDestroyedEventArgs},OpenQA.Selenium.BiDi.SubscriptionOptions)">
OnRealmDestroyedAsync(Action&lt;RealmDestroyedEventArgs&gt;, SubscriptionOptions?)
<a class="header-action link-secondary" title="View source" href="https://github.com/SeleniumHQ/selenium/blob/trunk/dotnet/src/webdriver/BiDi/Modules/Script/ScriptModule.cs/#L118"><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">public Task&lt;Subscription&gt; OnRealmDestroyedAsync(Action&lt;RealmDestroyedEventArgs&gt; handler, SubscriptionOptions? options = null)</code></pre>
</div>
<h4 class="section">Parameters</h4>
<dl class="parameters">
<dt><code>handler</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.action-1">Action</a>&lt;<a class="xref" href="OpenQA.Selenium.BiDi.Modules.Script.RealmDestroyedEventArgs.html">RealmDestroyedEventArgs</a>&gt;</dt>
<dd></dd>
<dt><code>options</code> <a class="xref" href="OpenQA.Selenium.BiDi.SubscriptionOptions.html">SubscriptionOptions</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.Subscription.html">Subscription</a>&gt;</dt>
<dd></dd>
</dl>
<a id="OpenQA_Selenium_BiDi_Modules_Script_ScriptModule_OnRealmDestroyedAsync_" data-uid="OpenQA.Selenium.BiDi.Modules.Script.ScriptModule.OnRealmDestroyedAsync*"></a>
<h3 id="OpenQA_Selenium_BiDi_Modules_Script_ScriptModule_OnRealmDestroyedAsync_System_Func_OpenQA_Selenium_BiDi_Modules_Script_RealmDestroyedEventArgs_System_Threading_Tasks_Task__OpenQA_Selenium_BiDi_SubscriptionOptions_" data-uid="OpenQA.Selenium.BiDi.Modules.Script.ScriptModule.OnRealmDestroyedAsync(System.Func{OpenQA.Selenium.BiDi.Modules.Script.RealmDestroyedEventArgs,System.Threading.Tasks.Task},OpenQA.Selenium.BiDi.SubscriptionOptions)">
OnRealmDestroyedAsync(Func&lt;RealmDestroyedEventArgs, Task&gt;, SubscriptionOptions?)
<a class="header-action link-secondary" title="View source" href="https://github.com/SeleniumHQ/selenium/blob/trunk/dotnet/src/webdriver/BiDi/Modules/Script/ScriptModule.cs/#L113"><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">public Task&lt;Subscription&gt; OnRealmDestroyedAsync(Func&lt;RealmDestroyedEventArgs, Task&gt; handler, SubscriptionOptions? options = null)</code></pre>
</div>
<h4 class="section">Parameters</h4>
<dl class="parameters">
<dt><code>handler</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.func-2">Func</a>&lt;<a class="xref" href="OpenQA.Selenium.BiDi.Modules.Script.RealmDestroyedEventArgs.html">RealmDestroyedEventArgs</a>, <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.threading.tasks.task">Task</a>&gt;</dt>
<dd></dd>
<dt><code>options</code> <a class="xref" href="OpenQA.Selenium.BiDi.SubscriptionOptions.html">SubscriptionOptions</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.Subscription.html">Subscription</a>&gt;</dt>
<dd></dd>
</dl>
<a id="OpenQA_Selenium_BiDi_Modules_Script_ScriptModule_RemovePreloadScriptAsync_" data-uid="OpenQA.Selenium.BiDi.Modules.Script.ScriptModule.RemovePreloadScriptAsync*"></a>
<h3 id="OpenQA_Selenium_BiDi_Modules_Script_ScriptModule_RemovePreloadScriptAsync_OpenQA_Selenium_BiDi_Modules_Script_PreloadScript_OpenQA_Selenium_BiDi_Modules_Script_RemovePreloadScriptOptions_" data-uid="OpenQA.Selenium.BiDi.Modules.Script.ScriptModule.RemovePreloadScriptAsync(OpenQA.Selenium.BiDi.Modules.Script.PreloadScript,OpenQA.Selenium.BiDi.Modules.Script.RemovePreloadScriptOptions)">
RemovePreloadScriptAsync(PreloadScript, RemovePreloadScriptOptions?)
<a class="header-action link-secondary" title="View source" href="https://github.com/SeleniumHQ/selenium/blob/trunk/dotnet/src/webdriver/BiDi/Modules/Script/ScriptModule.cs/#L86"><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">public Task RemovePreloadScriptAsync(PreloadScript script, RemovePreloadScriptOptions? options = null)</code></pre>
</div>
<h4 class="section">Parameters</h4>
<dl class="parameters">
<dt><code>script</code> <a class="xref" href="OpenQA.Selenium.BiDi.Modules.Script.PreloadScript.html">PreloadScript</a></dt>
<dd></dd>
<dt><code>options</code> <a class="xref" href="OpenQA.Selenium.BiDi.Modules.Script.RemovePreloadScriptOptions.html">RemovePreloadScriptOptions</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">Task</a></dt>
<dd></dd>
</dl>
</article>
<div class="contribution d-print-none">
<a href="https://github.com/SeleniumHQ/selenium/blob/trunk/dotnet/src/webdriver/BiDi/Modules/Script/ScriptModule.cs/#L26" 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>