UNPKG

@jp-web/ts-sdk

Version:

视频客服,视频会议Web端及微信小程序端SDK

238 lines 12.5 kB
<!doctype html> <html class="default no-js"> <head> <meta charset="utf-8"> <meta http-equiv="X-UA-Compatible" content="IE=edge"> <title>&quot;EventTarget&quot; | webrtc-guest-sdk</title> <meta name="description" content="Documentation for webrtc-guest-sdk"> <meta name="viewport" content="width=device-width, initial-scale=1"> <link rel="stylesheet" href="../assets/css/main.css"> </head> <body> <header> <div class="tsd-page-toolbar"> <div class="container"> <div class="table-wrap"> <div class="table-cell" id="tsd-search" data-index="../assets/js/search.json" data-base=".."> <div class="field"> <label for="tsd-search-field" class="tsd-widget search no-caption">Search</label> <input id="tsd-search-field" type="text" /> </div> <ul class="results"> <li class="state loading">Preparing search index...</li> <li class="state failure">The search index is not available</li> </ul> <a href="../index.html" class="title">webrtc-guest-sdk</a> </div> <div class="table-cell" id="tsd-widgets"> <div id="tsd-filter"> <a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a> <div class="tsd-filter-group"> <div class="tsd-select" id="tsd-filter-visibility"> <span class="tsd-select-label">All</span> <ul class="tsd-select-list"> <li data-value="public">Public</li> <li data-value="protected">Public/Protected</li> <li data-value="private" class="selected">All</li> </ul> </div> <input type="checkbox" id="tsd-filter-inherited" checked /> <label class="tsd-widget" for="tsd-filter-inherited">Inherited</label> <input type="checkbox" id="tsd-filter-externals" checked /> <label class="tsd-widget" for="tsd-filter-externals">Externals</label> <input type="checkbox" id="tsd-filter-only-exported" /> <label class="tsd-widget" for="tsd-filter-only-exported">Only exported</label> </div> </div> <a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a> </div> </div> </div> </div> <div class="tsd-page-title"> <div class="container"> <ul class="tsd-breadcrumb"> <li> <a href="../index.html">Globals</a> </li> <li> <a href="_eventtarget_.html">&quot;EventTarget&quot;</a> </li> </ul> <h1>Module &quot;EventTarget&quot;</h1> </div> </div> </header> <div class="container container-main"> <div class="row"> <div class="col-8 col-content"> <section class="tsd-panel-group tsd-index-group"> <h2>Index</h2> <section class="tsd-panel tsd-index-panel"> <div class="tsd-index-content"> <section class="tsd-index-section tsd-is-external"> <h3>Classes</h3> <ul class="tsd-index-list"> <li class="tsd-kind-class tsd-parent-kind-module tsd-is-external"><a href="../classes/_eventtarget_.errorevent.html" class="tsd-kind-icon">Error<wbr>Event</a></li> <li class="tsd-kind-class tsd-parent-kind-module tsd-is-external"><a href="../classes/_eventtarget_.event.html" class="tsd-kind-icon">Event</a></li> <li class="tsd-kind-class tsd-parent-kind-module tsd-is-external"><a href="../classes/_eventtarget_.eventtarget.html" class="tsd-kind-icon">Event<wbr>Target</a></li> </ul> </section> <section class="tsd-index-section tsd-is-external"> <h3>Interfaces</h3> <ul class="tsd-index-list"> <li class="tsd-kind-interface tsd-parent-kind-module tsd-is-external"><a href="../interfaces/_eventtarget_.eventlisteneroptions.html" class="tsd-kind-icon">Event<wbr>Listener<wbr>Options</a></li> </ul> </section> <section class="tsd-index-section tsd-is-external tsd-is-not-exported"> <h3>Type aliases</h3> <ul class="tsd-index-list"> <li class="tsd-kind-type-alias tsd-parent-kind-module tsd-is-external tsd-is-not-exported"><a href="_eventtarget_.html#eventtargetdata" class="tsd-kind-icon">Event<wbr>Target<wbr>Data</a></li> <li class="tsd-kind-type-alias tsd-parent-kind-module tsd-is-external tsd-is-not-exported"><a href="_eventtarget_.html#eventtargettype" class="tsd-kind-icon">Event<wbr>Target<wbr>Type</a></li> </ul> </section> <section class="tsd-index-section tsd-is-external tsd-is-not-exported"> <h3>Events</h3> <ul class="tsd-index-list"> <li class="tsd-kind-event tsd-parent-kind-module tsd-is-external tsd-is-not-exported"><a href="_eventtarget_.html#eventlistenertype" class="tsd-kind-icon">Event<wbr>Listener<wbr>Type</a></li> </ul> </section> </div> </section> </section> <section class="tsd-panel-group tsd-member-group tsd-is-external tsd-is-not-exported"> <h2>Type aliases</h2> <section class="tsd-panel tsd-member tsd-kind-type-alias tsd-parent-kind-module tsd-is-external tsd-is-not-exported"> <a name="eventtargetdata" class="tsd-anchor"></a> <h3>Event<wbr>Target<wbr>Data</h3> <div class="tsd-signature tsd-kind-icon">Event<wbr>Target<wbr>Data<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">any</span></div> <aside class="tsd-sources"> </aside> </section> <section class="tsd-panel tsd-member tsd-kind-type-alias tsd-parent-kind-module tsd-is-external tsd-is-not-exported"> <a name="eventtargettype" class="tsd-anchor"></a> <h3>Event<wbr>Target<wbr>Type</h3> <div class="tsd-signature tsd-kind-icon">Event<wbr>Target<wbr>Type<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">number</span></div> <aside class="tsd-sources"> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>监听器类型定义</p> </div> </div> </section> </section> <section class="tsd-panel-group tsd-member-group tsd-is-external tsd-is-not-exported"> <h2>Events</h2> <section class="tsd-panel tsd-member tsd-kind-event tsd-parent-kind-module tsd-is-external tsd-is-not-exported"> <a name="eventlistenertype" class="tsd-anchor"></a> <h3>Event<wbr>Listener<wbr>Type</h3> <div class="tsd-signature tsd-kind-icon">Event<wbr>Listener<wbr>Type<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span>event<span class="tsd-signature-symbol">: </span><a href="../classes/_eventtarget_.event.html" class="tsd-signature-type">Event</a><span class="tsd-signature-symbol"> | </span><a href="../classes/_eventtarget_.errorevent.html" class="tsd-signature-type">ErrorEvent</a>, removeSelf<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">void</span></div> <aside class="tsd-sources"> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>事件监听回调函数定义</p> </div> <dl class="tsd-comment-tags"> <dt>param</dt> <dd><p>触发的事件对象</p> </dd> <dt>param</dt> <dd><p>调用该函数可以将当前的事件监听函数移除</p> </dd> </dl> </div> <div class="tsd-type-declaration"> <h4>Type declaration</h4> <ul class="tsd-parameters"> <li class="tsd-parameter-signature"> <ul class="tsd-signatures tsd-kind-type-literal tsd-parent-kind-event tsd-is-not-exported"> <li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</span>event<span class="tsd-signature-symbol">: </span><a href="../classes/_eventtarget_.event.html" class="tsd-signature-type">Event</a><span class="tsd-signature-symbol"> | </span><a href="../classes/_eventtarget_.errorevent.html" class="tsd-signature-type">ErrorEvent</a>, removeSelf<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5>event: <a href="../classes/_eventtarget_.event.html" class="tsd-signature-type">Event</a><span class="tsd-signature-symbol"> | </span><a href="../classes/_eventtarget_.errorevent.html" class="tsd-signature-type">ErrorEvent</a></h5> </li> <li> <h5><span class="tsd-flag ts-flagOptional">Optional</span> removeSelf: <span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">void</span></h5> <ul class="tsd-parameters"> <li class="tsd-parameter-signature"> <ul class="tsd-signatures tsd-kind-type-literal tsd-is-not-exported"> <li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4> </li> </ul> </li> </ul> </li> </ul> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4> </li> </ul> </li> </ul> </div> </section> </section> </div> <div class="col-4 col-menu menu-sticky-wrap menu-highlight"> <nav class="tsd-navigation primary"> <ul> <li class="globals "> <a href="../index.html"><em>Globals</em></a> </li> <li class="current tsd-kind-module tsd-is-external"> <a href="_eventtarget_.html">&quot;<wbr>Event<wbr>Target&quot;</a> </li> </ul> </nav> <nav class="tsd-navigation secondary menu-sticky"> <ul class="before-current"> <li class=" tsd-kind-class tsd-parent-kind-module tsd-is-external"> <a href="../classes/_eventtarget_.errorevent.html" class="tsd-kind-icon">Error<wbr>Event</a> </li> <li class=" tsd-kind-class tsd-parent-kind-module tsd-is-external"> <a href="../classes/_eventtarget_.event.html" class="tsd-kind-icon">Event</a> </li> <li class=" tsd-kind-class tsd-parent-kind-module tsd-is-external"> <a href="../classes/_eventtarget_.eventtarget.html" class="tsd-kind-icon">Event<wbr>Target</a> </li> <li class=" tsd-kind-interface tsd-parent-kind-module tsd-is-external"> <a href="../interfaces/_eventtarget_.eventlisteneroptions.html" class="tsd-kind-icon">Event<wbr>Listener<wbr>Options</a> </li> <li class=" tsd-kind-type-alias tsd-parent-kind-module tsd-is-external tsd-is-not-exported"> <a href="_eventtarget_.html#eventtargetdata" class="tsd-kind-icon">Event<wbr>Target<wbr>Data</a> </li> <li class=" tsd-kind-type-alias tsd-parent-kind-module tsd-is-external tsd-is-not-exported"> <a href="_eventtarget_.html#eventtargettype" class="tsd-kind-icon">Event<wbr>Target<wbr>Type</a> </li> <li class=" tsd-kind-event tsd-parent-kind-module tsd-is-external tsd-is-not-exported"> <a href="_eventtarget_.html#eventlistenertype" class="tsd-kind-icon">Event<wbr>Listener<wbr>Type</a> </li> </ul> </nav> </div> </div> </div> <footer class="with-border-bottom"> <div class="container"> <h2>Legend</h2> <div class="tsd-legend-group"> </div> </div> </footer> <div class="container tsd-generator"> <p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p> </div> <div class="overlay"></div> <script src="../assets/js/main.js"></script> <script>if (location.protocol == 'file:') document.write('<script src="../assets/js/search.js"><' + '/script>');</script> </body> </html>