blob: f861c3fbb69d8a0fd56b9ca4503c4915b8683976 [file] [edit]
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<title>Class Broker </title>
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<meta name="title" content="Class Broker ">
<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_Broker.md&amp;value=---%0Auid%3A%20OpenQA.Selenium.BiDi.Broker%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.Broker">
<h1 id="OpenQA_Selenium_BiDi_Broker" data-uid="OpenQA.Selenium.BiDi.Broker" class="text-break">
Class Broker <a class="header-action link-secondary" title="View source" href="https://github.com/SeleniumHQ/selenium/blob/trunk/dotnet/src/webdriver/BiDi/Broker.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.BiDi.html">BiDi</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 Broker : IAsyncDisposable</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">Broker</span></div>
</dd>
</dl>
<dl class="typelist implements">
<dt>Implements</dt>
<dd>
<div><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.iasyncdisposable">IAsyncDisposable</a></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>
</dd></dl>
<h2 class="section" id="methods">Methods
</h2>
<a id="OpenQA_Selenium_BiDi_Broker_ConnectAsync_" data-uid="OpenQA.Selenium.BiDi.Broker.ConnectAsync*"></a>
<h3 id="OpenQA_Selenium_BiDi_Broker_ConnectAsync_System_Threading_CancellationToken_" data-uid="OpenQA.Selenium.BiDi.Broker.ConnectAsync(System.Threading.CancellationToken)">
ConnectAsync(CancellationToken)
<a class="header-action link-secondary" title="View source" href="https://github.com/SeleniumHQ/selenium/blob/trunk/dotnet/src/webdriver/BiDi/Broker.cs/#L58"><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 ConnectAsync(CancellationToken cancellationToken)</code></pre>
</div>
<h4 class="section">Parameters</h4>
<dl class="parameters">
<dt><code>cancellationToken</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.threading.cancellationtoken">CancellationToken</a></dt>
<dd></dd>
</dl>
<h4 class="section">Returns</h4>
<dl class="parameters">
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.threading.tasks.task">Task</a></dt>
<dd></dd>
</dl>
<a id="OpenQA_Selenium_BiDi_Broker_DisposeAsync_" data-uid="OpenQA.Selenium.BiDi.Broker.DisposeAsync*"></a>
<h3 id="OpenQA_Selenium_BiDi_Broker_DisposeAsync" data-uid="OpenQA.Selenium.BiDi.Broker.DisposeAsync">
DisposeAsync()
<a class="header-action link-secondary" title="View source" href="https://github.com/SeleniumHQ/selenium/blob/trunk/dotnet/src/webdriver/BiDi/Broker.cs/#L189"><i class="bi bi-code-slash"></i></a>
</h3>
<div class="markdown level1 summary"><p>Performs application-defined tasks associated with freeing, releasing, or
resetting unmanaged resources asynchronously.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public ValueTask DisposeAsync()</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.valuetask">ValueTask</a></dt>
<dd></dd>
</dl>
<a id="OpenQA_Selenium_BiDi_Broker_ExecuteCommandAsync_" data-uid="OpenQA.Selenium.BiDi.Broker.ExecuteCommandAsync*"></a>
<h3 id="OpenQA_Selenium_BiDi_Broker_ExecuteCommandAsync__2___0_OpenQA_Selenium_BiDi_CommandOptions_System_Text_Json_Serialization_Metadata_JsonTypeInfo___0__System_Text_Json_Serialization_Metadata_JsonTypeInfo___1__" data-uid="OpenQA.Selenium.BiDi.Broker.ExecuteCommandAsync``2(``0,OpenQA.Selenium.BiDi.CommandOptions,System.Text.Json.Serialization.Metadata.JsonTypeInfo{``0},System.Text.Json.Serialization.Metadata.JsonTypeInfo{``1})">
ExecuteCommandAsync&lt;TCommand, TResult&gt;(TCommand, CommandOptions?, JsonTypeInfo&lt;TCommand&gt;, JsonTypeInfo&lt;TResult&gt;)
<a class="header-action link-secondary" title="View source" href="https://github.com/SeleniumHQ/selenium/blob/trunk/dotnet/src/webdriver/BiDi/Broker.cs/#L130"><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; ExecuteCommandAsync&lt;TCommand, TResult&gt;(TCommand command, CommandOptions? options, JsonTypeInfo&lt;TCommand&gt; jsonCommandTypeInfo, JsonTypeInfo&lt;TResult&gt; jsonResultTypeInfo) where TCommand : Command where TResult : EmptyResult</code></pre>
</div>
<h4 class="section">Parameters</h4>
<dl class="parameters">
<dt><code>command</code> <span class="xref">TCommand</span></dt>
<dd></dd>
<dt><code>options</code> <a class="xref" href="OpenQA.Selenium.BiDi.CommandOptions.html">CommandOptions</a></dt>
<dd></dd>
<dt><code>jsonCommandTypeInfo</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.text.json.serialization.metadata.jsontypeinfo-1">JsonTypeInfo</a>&lt;TCommand&gt;</dt>
<dd></dd>
<dt><code>jsonResultTypeInfo</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.text.json.serialization.metadata.jsontypeinfo-1">JsonTypeInfo</a>&lt;TResult&gt;</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>TCommand</code></dt>
<dd></dd>
<dt><code>TResult</code></dt>
<dd></dd>
</dl>
<a id="OpenQA_Selenium_BiDi_Broker_SubscribeAsync_" data-uid="OpenQA.Selenium.BiDi.Broker.SubscribeAsync*"></a>
<h3 id="OpenQA_Selenium_BiDi_Broker_SubscribeAsync__1_System_String_System_Action___0__OpenQA_Selenium_BiDi_SubscriptionOptions_System_Text_Json_Serialization_Metadata_JsonTypeInfo___0__" data-uid="OpenQA.Selenium.BiDi.Broker.SubscribeAsync``1(System.String,System.Action{``0},OpenQA.Selenium.BiDi.SubscriptionOptions,System.Text.Json.Serialization.Metadata.JsonTypeInfo{``0})">
SubscribeAsync&lt;TEventArgs&gt;(string, Action&lt;TEventArgs&gt;, SubscriptionOptions?, JsonTypeInfo&lt;TEventArgs&gt;)
<a class="header-action link-secondary" title="View source" href="https://github.com/SeleniumHQ/selenium/blob/trunk/dotnet/src/webdriver/BiDi/Broker.cs/#L148"><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; SubscribeAsync&lt;TEventArgs&gt;(string eventName, Action&lt;TEventArgs&gt; action, SubscriptionOptions? options, JsonTypeInfo&lt;TEventArgs&gt; jsonTypeInfo) where TEventArgs : EventArgs</code></pre>
</div>
<h4 class="section">Parameters</h4>
<dl class="parameters">
<dt><code>eventName</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></dt>
<dd></dd>
<dt><code>action</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.action-1">Action</a>&lt;TEventArgs&gt;</dt>
<dd></dd>
<dt><code>options</code> <a class="xref" href="OpenQA.Selenium.BiDi.SubscriptionOptions.html">SubscriptionOptions</a></dt>
<dd></dd>
<dt><code>jsonTypeInfo</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.text.json.serialization.metadata.jsontypeinfo-1">JsonTypeInfo</a>&lt;TEventArgs&gt;</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>
<h4 class="section">Type Parameters</h4>
<dl class="parameters">
<dt><code>TEventArgs</code></dt>
<dd></dd>
</dl>
<a id="OpenQA_Selenium_BiDi_Broker_SubscribeAsync_" data-uid="OpenQA.Selenium.BiDi.Broker.SubscribeAsync*"></a>
<h3 id="OpenQA_Selenium_BiDi_Broker_SubscribeAsync__1_System_String_System_Func___0_System_Threading_Tasks_Task__OpenQA_Selenium_BiDi_SubscriptionOptions_System_Text_Json_Serialization_Metadata_JsonTypeInfo___0__" data-uid="OpenQA.Selenium.BiDi.Broker.SubscribeAsync``1(System.String,System.Func{``0,System.Threading.Tasks.Task},OpenQA.Selenium.BiDi.SubscriptionOptions,System.Text.Json.Serialization.Metadata.JsonTypeInfo{``0})">
SubscribeAsync&lt;TEventArgs&gt;(string, Func&lt;TEventArgs, Task&gt;, SubscriptionOptions?, JsonTypeInfo&lt;TEventArgs&gt;)
<a class="header-action link-secondary" title="View source" href="https://github.com/SeleniumHQ/selenium/blob/trunk/dotnet/src/webdriver/BiDi/Broker.cs/#L164"><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; SubscribeAsync&lt;TEventArgs&gt;(string eventName, Func&lt;TEventArgs, Task&gt; func, SubscriptionOptions? options, JsonTypeInfo&lt;TEventArgs&gt; jsonTypeInfo) where TEventArgs : EventArgs</code></pre>
</div>
<h4 class="section">Parameters</h4>
<dl class="parameters">
<dt><code>eventName</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></dt>
<dd></dd>
<dt><code>func</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.func-2">Func</a>&lt;TEventArgs, <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>
<dt><code>jsonTypeInfo</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.text.json.serialization.metadata.jsontypeinfo-1">JsonTypeInfo</a>&lt;TEventArgs&gt;</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>
<h4 class="section">Type Parameters</h4>
<dl class="parameters">
<dt><code>TEventArgs</code></dt>
<dd></dd>
</dl>
<a id="OpenQA_Selenium_BiDi_Broker_UnsubscribeAsync_" data-uid="OpenQA.Selenium.BiDi.Broker.UnsubscribeAsync*"></a>
<h3 id="OpenQA_Selenium_BiDi_Broker_UnsubscribeAsync_OpenQA_Selenium_BiDi_Subscription_" data-uid="OpenQA.Selenium.BiDi.Broker.UnsubscribeAsync(OpenQA.Selenium.BiDi.Subscription)">
UnsubscribeAsync(Subscription)
<a class="header-action link-secondary" title="View source" href="https://github.com/SeleniumHQ/selenium/blob/trunk/dotnet/src/webdriver/BiDi/Broker.cs/#L180"><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 UnsubscribeAsync(Subscription subscription)</code></pre>
</div>
<h4 class="section">Parameters</h4>
<dl class="parameters">
<dt><code>subscription</code> <a class="xref" href="OpenQA.Selenium.BiDi.Subscription.html">Subscription</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/Broker.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>