@jp-web/ts-sdk

<!doctype html> <html class="default no-js"> <head> <meta charset="utf-8"> <meta http-equiv="X-UA-Compatible" content="IE=edge"> <title>TaskQueue | wechat-conference-sdk</title> <meta name="description" content="Documentation for wechat-conference-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">wechat-conference-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="../modules/_tools_taskqueue_.html">"tools/TaskQueue"</a> </li> <li> <a href="_tools_taskqueue_.taskqueue.html">TaskQueue</a> </li> </ul> <h1>Class TaskQueue</h1> </div> </div> </header> <div class="container container-main"> <div class="row"> <div class="col-8 col-content"> <section class="tsd-panel tsd-hierarchy"> <h3>Hierarchy</h3> <ul class="tsd-hierarchy"> <li> <span class="target">TaskQueue</span> </li> </ul> </section> <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>Constructors</h3> <ul class="tsd-index-list"> <li class="tsd-kind-constructor tsd-parent-kind-class tsd-is-external"><a href="_tools_taskqueue_.taskqueue.html#constructor" class="tsd-kind-icon">constructor</a></li> </ul> </section> <section class="tsd-index-section tsd-is-external"> <h3>Events</h3> <ul class="tsd-index-list"> <li class="tsd-kind-event tsd-parent-kind-class tsd-is-external"><a href="_tools_taskqueue_.taskqueue.html#ontaskcomplete" class="tsd-kind-icon">on<wbr>Task<wbr>Complete</a></li> </ul> </section> <section class="tsd-index-section tsd-is-external"> <h3>Properties</h3> <ul class="tsd-index-list"> <li class="tsd-kind-property tsd-parent-kind-class tsd-is-external"><a href="_tools_taskqueue_.taskqueue.html#_queue" class="tsd-kind-icon">_queue</a></li> <li class="tsd-kind-property tsd-parent-kind-class tsd-is-external"><a href="_tools_taskqueue_.taskqueue.html#_state" class="tsd-kind-icon">_state</a></li> </ul> </section> <section class="tsd-index-section tsd-is-external"> <h3>Methods</h3> <ul class="tsd-index-list"> <li class="tsd-kind-method tsd-parent-kind-class tsd-is-external"><a href="_tools_taskqueue_.taskqueue.html#_exec" class="tsd-kind-icon">_exec</a></li> <li class="tsd-kind-method tsd-parent-kind-class tsd-is-external"><a href="_tools_taskqueue_.taskqueue.html#push" class="tsd-kind-icon">push</a></li> </ul> </section> </div> </section> </section> <section class="tsd-panel-group tsd-member-group tsd-is-external"> <h2>Constructors</h2> <section class="tsd-panel tsd-member tsd-kind-constructor tsd-parent-kind-class tsd-is-external"> <a name="constructor" class="tsd-anchor"></a> <h3>constructor</h3> <ul class="tsd-signatures tsd-kind-constructor tsd-parent-kind-class tsd-is-external"> <li class="tsd-signature tsd-kind-icon">new <wbr>Task<wbr>Queue<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="_tools_taskqueue_.taskqueue.html" class="tsd-signature-type">TaskQueue</a></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> </aside> <h4 class="tsd-returns-title">Returns <a href="_tools_taskqueue_.taskqueue.html" class="tsd-signature-type">TaskQueue</a></h4> </li> </ul> </section> </section> <section class="tsd-panel-group tsd-member-group tsd-is-external"> <h2>Events</h2> <section class="tsd-panel tsd-member tsd-kind-event tsd-parent-kind-class tsd-is-external"> <a name="ontaskcomplete" class="tsd-anchor"></a> <h3>on<wbr>Task<wbr>Complete</h3> <ul class="tsd-signatures tsd-kind-event tsd-parent-kind-class tsd-is-external"> <li class="tsd-signature tsd-kind-icon">on<wbr>Task<wbr>Complete<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"> <aside class="tsd-sources"> </aside> <div class="tsd-comment tsd-typography"> </div> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4> </li> </ul> </section> </section> <section class="tsd-panel-group tsd-member-group tsd-is-external"> <h2>Properties</h2> <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-external"> <a name="_queue" class="tsd-anchor"></a> <h3>_queue</h3> <div class="tsd-signature tsd-kind-icon">_queue<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Array</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-symbol">{ </span>arguments<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Array</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">; </span>task<span class="tsd-signature-symbol">: </span><a href="../modules/_tools_taskqueue_.html#asynctask" class="tsd-signature-type">AsyncTask</a><span class="tsd-signature-symbol"> | </span><a href="../modules/_tools_taskqueue_.html#synctask" class="tsd-signature-type">SyncTask</a><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol">></span></div> <aside class="tsd-sources"> </aside> </section> <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-external"> <a name="_state" class="tsd-anchor"></a> <h3>_state</h3> <div class="tsd-signature tsd-kind-icon">_state<span class="tsd-signature-symbol">:</span> <a href="../enums/_tools_taskqueue_.taskqueuestate.html" class="tsd-signature-type">TaskQueueState</a></div> <aside class="tsd-sources"> </aside> </section> </section> <section class="tsd-panel-group tsd-member-group tsd-is-external"> <h2>Methods</h2> <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-external"> <a name="_exec" class="tsd-anchor"></a> <h3>_exec</h3> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-external"> <li class="tsd-signature tsd-kind-icon">_exec<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"> <aside class="tsd-sources"> </aside> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4> </li> </ul> </section> <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-external"> <a name="push" class="tsd-anchor"></a> <h3>push</h3> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-external"> <li class="tsd-signature tsd-kind-icon">push<span class="tsd-signature-symbol">(</span>task<span class="tsd-signature-symbol">: </span><a href="../modules/_tools_taskqueue_.html#asynctask" class="tsd-signature-type">AsyncTask</a><span class="tsd-signature-symbol"> | </span><a href="../modules/_tools_taskqueue_.html#synctask" class="tsd-signature-type">SyncTask</a>, <span class="tsd-signature-symbol">...</span>args<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Array</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="../modules/_tools_taskqueue_.html#poptaskhandle" class="tsd-signature-type">PopTaskHandle</a></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>向队列中压入一个任务, 如果此时队列是空闲状态则会立即执行, 否则会等待较早压入的任务执行完毕后再执行.</p> </div> </div> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5>task: <a href="../modules/_tools_taskqueue_.html#asynctask" class="tsd-signature-type">AsyncTask</a><span class="tsd-signature-symbol"> | </span><a href="../modules/_tools_taskqueue_.html#synctask" class="tsd-signature-type">SyncTask</a></h5> </li> <li> <h5><span class="tsd-flag ts-flagRest">Rest</span> <span class="tsd-signature-symbol">...</span>args: <span class="tsd-signature-type">Array</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span></h5> </li> </ul> <h4 class="tsd-returns-title">Returns <a href="../modules/_tools_taskqueue_.html#poptaskhandle" class="tsd-signature-type">PopTaskHandle</a></h4> </li> </ul> </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="../modules/_tools_taskqueue_.html">"tools/<wbr>Task<wbr>Queue"</a> </li> </ul> </nav> <nav class="tsd-navigation secondary menu-sticky"> <ul class="before-current"> <li class=" tsd-kind-enum tsd-parent-kind-module tsd-is-external tsd-is-not-exported"> <a href="../enums/_tools_taskqueue_.taskqueuestate.html" class="tsd-kind-icon">Task<wbr>Queue<wbr>State</a> </li> </ul> <ul class="current"> <li class="current tsd-kind-class tsd-parent-kind-module tsd-is-external"> <a href="_tools_taskqueue_.taskqueue.html" class="tsd-kind-icon">Task<wbr>Queue</a> <ul> <li class=" tsd-kind-constructor tsd-parent-kind-class tsd-is-external"> <a href="_tools_taskqueue_.taskqueue.html#constructor" class="tsd-kind-icon">constructor</a> </li> <li class=" tsd-kind-event tsd-parent-kind-class tsd-is-external"> <a href="_tools_taskqueue_.taskqueue.html#ontaskcomplete" class="tsd-kind-icon">on<wbr>Task<wbr>Complete</a> </li> <li class=" tsd-kind-property tsd-parent-kind-class tsd-is-external"> <a href="_tools_taskqueue_.taskqueue.html#_queue" class="tsd-kind-icon">_queue</a> </li> <li class=" tsd-kind-property tsd-parent-kind-class tsd-is-external"> <a href="_tools_taskqueue_.taskqueue.html#_state" class="tsd-kind-icon">_state</a> </li> <li class=" tsd-kind-method tsd-parent-kind-class tsd-is-external"> <a href="_tools_taskqueue_.taskqueue.html#_exec" class="tsd-kind-icon">_exec</a> </li> <li class=" tsd-kind-method tsd-parent-kind-class tsd-is-external"> <a href="_tools_taskqueue_.taskqueue.html#push" class="tsd-kind-icon">push</a> </li> </ul> </li> </ul> <ul class="after-current"> <li class=" tsd-kind-type-alias tsd-parent-kind-module tsd-is-external"> <a href="../modules/_tools_taskqueue_.html#asynctask" class="tsd-kind-icon">Async<wbr>Task</a> </li> <li class=" tsd-kind-type-alias tsd-parent-kind-module tsd-is-external"> <a href="../modules/_tools_taskqueue_.html#poptaskhandle" class="tsd-kind-icon">Pop<wbr>Task<wbr>Handle</a> </li> <li class=" tsd-kind-type-alias tsd-parent-kind-module tsd-is-external"> <a href="../modules/_tools_taskqueue_.html#synctask" class="tsd-kind-icon">Sync<wbr>Task</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>