jsdk-offical

<!doctype html> <html class="default no-js"> <head> <meta charset="utf-8"> <meta http-equiv="X-UA-Compatible" content="IE=edge"> <title>Service | JSDK 2.7.0 API</title> <meta name="description" content="Documentation for JSDK 2.7.0 API"> <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">JSDK 2.7.0 API</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="../globals.html">Globals</a> </li> <li> <a href="../modules/js.html">JS</a> </li> <li> <a href="../modules/js.app.html">app</a> </li> <li> <a href="js.app.service.html">Service</a> </li> </ul> <h1>Class Service</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">Service</span> </li> </ul> </section> <section class="tsd-panel"> <h3>Implements</h3> <ul class="tsd-hierarchy"> <li><a href="../interfaces/js.ioc.icompo.html" class="tsd-signature-type">ICompo</a></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 "> <h3>Properties</h3> <ul class="tsd-index-list"> <li class="tsd-kind-property tsd-parent-kind-class tsd-is-protected"><a href="js.app.service.html#_proxy" class="tsd-kind-icon">_proxy</a></li> <li class="tsd-kind-property tsd-parent-kind-class tsd-is-static"><a href="js.app.service.html#default_proxy" class="tsd-kind-icon">DEFAULT_<wbr>PROXY</a></li> </ul> </section> <section class="tsd-index-section "> <h3>Methods</h3> <ul class="tsd-index-list"> <li class="tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter"><a href="js.app.service.html#call" class="tsd-kind-icon">call</a></li> <li class="tsd-kind-method tsd-parent-kind-class"><a href="js.app.service.html#destroy" class="tsd-kind-icon">destroy</a></li> <li class="tsd-kind-method tsd-parent-kind-class"><a href="js.app.service.html#initialize" class="tsd-kind-icon">initialize</a></li> <li class="tsd-kind-method tsd-parent-kind-class"><a href="js.app.service.html#proxy" class="tsd-kind-icon">proxy</a></li> </ul> </section> </div> </section> </section> <section class="tsd-panel-group tsd-member-group "> <h2>Properties</h2> <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-protected"> <a name="_proxy" class="tsd-anchor"></a> <h3><span class="tsd-flag ts-flagProtected">Protected</span> _proxy</h3> <div class="tsd-signature tsd-kind-icon">_proxy<span class="tsd-signature-symbol">:</span> <a href="js.model.ajaxproxy.html" class="tsd-signature-type">AjaxProxy</a></div> <aside class="tsd-sources"> </aside> </section> <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-static"> <a name="default_proxy" class="tsd-anchor"></a> <h3><span class="tsd-flag ts-flagStatic">Static</span> DEFAULT_<wbr>PROXY</h3> <div class="tsd-signature tsd-kind-icon">DEFAULT_<wbr>PROXY<span class="tsd-signature-symbol">:</span> <a href="../interfaces/js.lang.klass.html" class="tsd-signature-type">Klass</a><span class="tsd-signature-symbol"><</span><a href="js.model.ajaxproxy.html" class="tsd-signature-type">AjaxProxy</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol"> = JsonProxy</span></div> <aside class="tsd-sources"> </aside> </section> </section> <section class="tsd-panel-group tsd-member-group "> <h2>Methods</h2> <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter"> <a name="call" class="tsd-anchor"></a> <h3>call</h3> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter"> <li class="tsd-signature tsd-kind-icon">call<T><span class="tsd-signature-symbol">(</span>api<span class="tsd-signature-symbol">: </span><a href="../interfaces/js.app.api.html" class="tsd-signature-type">Api</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">T</span><span class="tsd-signature-symbol">></span>, params<span class="tsd-signature-symbol">?: </span><a href="../modules/js.lang.html#jsonobject" class="tsd-signature-type">JsonObject</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="../interfaces/promise.html" class="tsd-signature-type">Promise</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">T</span><span class="tsd-signature-symbol">></span></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>Call an api with parameters.</p> </div> </div> <h4 class="tsd-type-parameters-title">Type parameters</h4> <ul class="tsd-type-parameters"> <li> <h4>T</h4> </li> </ul> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5>api: <a href="../interfaces/js.app.api.html" class="tsd-signature-type">Api</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">T</span><span class="tsd-signature-symbol">></span></h5> </li> <li> <h5><span class="tsd-flag ts-flagOptional">Optional</span> params: <a href="../modules/js.lang.html#jsonobject" class="tsd-signature-type">JsonObject</a></h5> <div class="tsd-comment tsd-typography"> </div> </li> </ul> <h4 class="tsd-returns-title">Returns <a href="../interfaces/promise.html" class="tsd-signature-type">Promise</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">T</span><span class="tsd-signature-symbol">></span></h4> </li> </ul> </section> <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"> <a name="destroy" class="tsd-anchor"></a> <h3>destroy</h3> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"> <li class="tsd-signature tsd-kind-icon">destroy<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"> <p>Implementation of <a href="../interfaces/js.ioc.icompo.html">ICompo</a>.<a href="../interfaces/js.ioc.icompo.html#destroy">destroy</a></p> </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"> <a name="initialize" class="tsd-anchor"></a> <h3>initialize</h3> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"> <li class="tsd-signature tsd-kind-icon">initialize<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"> <p>Implementation of <a href="../interfaces/js.ioc.icompo.html">ICompo</a>.<a href="../interfaces/js.ioc.icompo.html#initialize">initialize</a></p> </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"> <a name="proxy" class="tsd-anchor"></a> <h3>proxy</h3> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"> <li class="tsd-signature tsd-kind-icon">proxy<span class="tsd-signature-symbol">(</span>proxy<span class="tsd-signature-symbol">: </span><a href="js.model.ajaxproxy.html" class="tsd-signature-type">AjaxProxy</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">this</span></li> <li class="tsd-signature tsd-kind-icon">proxy<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="js.model.ajaxproxy.html" class="tsd-signature-type">AjaxProxy</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>Sets the api proxy for data access.</p> </div> </div> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5>proxy: <a href="js.model.ajaxproxy.html" class="tsd-signature-type">AjaxProxy</a></h5> </li> </ul> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">this</span></h4> </li> <li class="tsd-description"> <aside class="tsd-sources"> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>Gets the api proxy for data access.</p> </div> </div> <h4 class="tsd-returns-title">Returns <a href="js.model.ajaxproxy.html" class="tsd-signature-type">AjaxProxy</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="../globals.html"><em>Globals</em></a> </li> <li class="current tsd-kind-namespace"> <a href="../modules/js.html">JS</a> <ul> <li class=" tsd-kind-namespace tsd-parent-kind-namespace"> <a href="../modules/js.an.html">an</a> </li> <li class="current tsd-kind-namespace tsd-parent-kind-namespace"> <a href="../modules/js.app.html">app</a> </li> <li class=" tsd-kind-namespace tsd-parent-kind-namespace"> <a href="../modules/js.core.html">core</a> </li> <li class=" tsd-kind-namespace tsd-parent-kind-namespace"> <a href="../modules/js.d2.html">d2</a> </li> <li class=" tsd-kind-namespace tsd-parent-kind-namespace"> <a href="../modules/js.ds.html">ds</a> </li> <li class=" tsd-kind-namespace tsd-parent-kind-namespace"> <a href="../modules/js.fx.html">fx</a> </li> <li class=" tsd-kind-namespace tsd-parent-kind-namespace"> <a href="../modules/js.input.html">input</a> </li> <li class=" tsd-kind-namespace tsd-parent-kind-namespace"> <a href="../modules/js.ioc.html">ioc</a> </li> <li class=" tsd-kind-namespace tsd-parent-kind-namespace"> <a href="../modules/js.lang.html">lang</a> </li> <li class=" tsd-kind-namespace tsd-parent-kind-namespace"> <a href="../modules/js.math.html">math</a> </li> <li class=" tsd-kind-namespace tsd-parent-kind-namespace"> <a href="../modules/js.media.html">media</a> </li> <li class=" tsd-kind-namespace tsd-parent-kind-namespace"> <a href="../modules/js.model.html">model</a> </li> <li class=" tsd-kind-namespace tsd-parent-kind-namespace"> <a href="../modules/js.net.html">net</a> </li> <li class=" tsd-kind-namespace tsd-parent-kind-namespace"> <a href="../modules/js.store.html">store</a> </li> <li class=" tsd-kind-namespace tsd-parent-kind-namespace"> <a href="../modules/js.sugar.html">sugar</a> </li> <li class=" tsd-kind-namespace tsd-parent-kind-namespace"> <a href="../modules/js.ui.html">ui</a> </li> <li class=" tsd-kind-namespace tsd-parent-kind-namespace"> <a href="../modules/js.unit.html">unit</a> </li> <li class=" tsd-kind-namespace tsd-parent-kind-namespace"> <a href="../modules/js.util.html">util</a> </li> <li class=" tsd-kind-namespace tsd-parent-kind-namespace"> <a href="../modules/js.view.html">view</a> </li> </ul> </li> </ul> </nav> <nav class="tsd-navigation secondary menu-sticky"> <ul class="before-current"> <li class=" tsd-kind-class tsd-parent-kind-namespace"> <a href="js.app.app.html" class="tsd-kind-icon">App</a> </li> <li class=" tsd-kind-class tsd-parent-kind-namespace"> <a href="js.app.appevent.html" class="tsd-kind-icon">App<wbr>Event</a> </li> <li class=" tsd-kind-class tsd-parent-kind-namespace"> <a href="js.app.page.html" class="tsd-kind-icon">Page</a> </li> </ul> <ul class="current"> <li class="current tsd-kind-class tsd-parent-kind-namespace"> <a href="js.app.service.html" class="tsd-kind-icon">Service</a> <ul> <li class=" tsd-kind-property tsd-parent-kind-class tsd-is-protected"> <a href="js.app.service.html#_proxy" class="tsd-kind-icon">_proxy</a> </li> <li class=" tsd-kind-property tsd-parent-kind-class tsd-is-static"> <a href="js.app.service.html#default_proxy" class="tsd-kind-icon">DEFAULT_<wbr>PROXY</a> </li> <li class=" tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter"> <a href="js.app.service.html#call" class="tsd-kind-icon">call</a> </li> <li class=" tsd-kind-method tsd-parent-kind-class"> <a href="js.app.service.html#destroy" class="tsd-kind-icon">destroy</a> </li> <li class=" tsd-kind-method tsd-parent-kind-class"> <a href="js.app.service.html#initialize" class="tsd-kind-icon">initialize</a> </li> <li class=" tsd-kind-method tsd-parent-kind-class"> <a href="js.app.service.html#proxy" class="tsd-kind-icon">proxy</a> </li> </ul> </li> </ul> <ul class="after-current"> <li class=" tsd-kind-interface tsd-parent-kind-namespace tsd-has-type-parameter"> <a href="../interfaces/js.app.api.html" class="tsd-kind-icon">Api</a> </li> <li class=" tsd-kind-type-alias tsd-parent-kind-namespace"> <a href="../modules/js.app.html#appconfig" class="tsd-kind-icon">App<wbr>Config</a> </li> <li class=" tsd-kind-type-alias tsd-parent-kind-namespace"> <a href="../modules/js.app.html#pageevents" class="tsd-kind-icon">Page<wbr>Events</a> </li> </ul> </nav> </div> </div> </div> <footer> <div class="container"> <h2>Legend</h2> <div class="tsd-legend-group"> <ul class="tsd-legend"> <li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li> <li class="tsd-kind-method tsd-parent-kind-interface"><span class="tsd-kind-icon">Method</span></li> </ul> <ul class="tsd-legend"> <li class="tsd-kind-method tsd-parent-kind-class"><span class="tsd-kind-icon">Method</span></li> </ul> <ul class="tsd-legend"> <li class="tsd-kind-property tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected property</span></li> </ul> <ul class="tsd-legend"> <li class="tsd-kind-property tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static property</span></li> </ul> </div> </div> </footer> <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>