UNPKG

com.phloxui

Version:

PhloxUI Ng2+ Framework

835 lines 69.8 kB
<!doctype html> <html class="default no-js"> <head> <meta charset="utf-8"> <meta http-equiv="X-UA-Compatible" content="IE=edge"> <title>IConnectionManager | com.phloxui</title> <meta name="description" content=""> <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.js" 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">com.phloxui</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/_iconnectionmanager_.html">&quot;IConnectionManager&quot;</a> </li> <li> <a href="_iconnectionmanager_.iconnectionmanager.html">IConnectionManager</a> </li> </ul> <h1>Interface IConnectionManager</h1> </div> </div> </header> <div class="container container-main"> <div class="row"> <div class="col-8 col-content"> <section class="tsd-panel tsd-comment"> <div class="tsd-comment tsd-typography"> <div class="lead"> <p style="text-indent: 2em;"> A <code>ng</code> service interface mainly handles the <code>application</code>&#39;s connections. This service uses <a href="_ibackgroundprocessmanager_.ibackgroundprocessmanager.html">IBackgroundProcessManager</a> as <code>background process</code> executor for non-blocking network I/O. So, you can get alive connections using <a href="_iconnectionmanager_.iconnectionmanager.html#getrunningprocesses">getRunningProcesses</a> or <a href="_iconnectionmanager_.iconnectionmanager.html#getrunningprocessescount">getRunningProcessesCount</a> method. All connections created via this service will be monitored the <code>connection quality</code> which will be displayed on user&#39;s screen. You can get the <code>connection quality</code> of the <code>application</code> by using method <a href="_iconnectionmanager_.iconnectionmanager.html#getconnectionquality">getConnectionQuality</a>. </p> </div> <dl class="tsd-comment-tags"> <dt>author</dt> <dd><p>shiorin, tee4cute</p> </dd> <dt>see</dt> <dd><p><a href="_ibackgroundprocessmanager_.ibackgroundprocessmanager.html">IBackgroundProcessManager</a></p> </dd> </dl> </div> </section> <section class="tsd-panel tsd-hierarchy"> <h3>Hierarchy</h3> <ul class="tsd-hierarchy"> <li> <span class="target">IConnectionManager</span> </li> </ul> </section> <section class="tsd-panel"> <h3>Implemented by</h3> <ul class="tsd-hierarchy"> <li><a href="../classes/_service_connectionmanager_service_.connectionmanager.html" class="tsd-signature-type">ConnectionManager</a></li> <li><a href="../classes/_service_instanceconnectionmanager_service_.instanceconnectionmanager.html" class="tsd-signature-type">InstanceConnectionManager</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>Methods</h3> <ul class="tsd-index-list"> <li class="tsd-kind-method tsd-parent-kind-interface"><a href="_iconnectionmanager_.iconnectionmanager.html#delete" class="tsd-kind-icon">delete</a></li> <li class="tsd-kind-method tsd-parent-kind-interface"><a href="_iconnectionmanager_.iconnectionmanager.html#deletewithhttpinfo" class="tsd-kind-icon">delete<wbr>With<wbr>Http<wbr>Info</a></li> <li class="tsd-kind-method tsd-parent-kind-interface"><a href="_iconnectionmanager_.iconnectionmanager.html#get" class="tsd-kind-icon">get</a></li> <li class="tsd-kind-method tsd-parent-kind-interface"><a href="_iconnectionmanager_.iconnectionmanager.html#getconnectionquality" class="tsd-kind-icon">get<wbr>Connection<wbr>Quality</a></li> <li class="tsd-kind-method tsd-parent-kind-interface"><a href="_iconnectionmanager_.iconnectionmanager.html#getname" class="tsd-kind-icon">get<wbr>Name</a></li> <li class="tsd-kind-method tsd-parent-kind-interface"><a href="_iconnectionmanager_.iconnectionmanager.html#getrunningprocesses" class="tsd-kind-icon">get<wbr>Running<wbr>Processes</a></li> <li class="tsd-kind-method tsd-parent-kind-interface"><a href="_iconnectionmanager_.iconnectionmanager.html#getrunningprocessescount" class="tsd-kind-icon">get<wbr>Running<wbr>Processes<wbr>Count</a></li> <li class="tsd-kind-method tsd-parent-kind-interface"><a href="_iconnectionmanager_.iconnectionmanager.html#getwithhttpinfo" class="tsd-kind-icon">get<wbr>With<wbr>Http<wbr>Info</a></li> <li class="tsd-kind-method tsd-parent-kind-interface"><a href="_iconnectionmanager_.iconnectionmanager.html#head" class="tsd-kind-icon">head</a></li> <li class="tsd-kind-method tsd-parent-kind-interface"><a href="_iconnectionmanager_.iconnectionmanager.html#headwithhttpinfo" class="tsd-kind-icon">head<wbr>With<wbr>Http<wbr>Info</a></li> <li class="tsd-kind-method tsd-parent-kind-interface"><a href="_iconnectionmanager_.iconnectionmanager.html#options" class="tsd-kind-icon">options</a></li> <li class="tsd-kind-method tsd-parent-kind-interface"><a href="_iconnectionmanager_.iconnectionmanager.html#optionswithhttpinfo" class="tsd-kind-icon">options<wbr>With<wbr>Http<wbr>Info</a></li> <li class="tsd-kind-method tsd-parent-kind-interface"><a href="_iconnectionmanager_.iconnectionmanager.html#patch" class="tsd-kind-icon">patch</a></li> <li class="tsd-kind-method tsd-parent-kind-interface"><a href="_iconnectionmanager_.iconnectionmanager.html#patchwithhttpinfo" class="tsd-kind-icon">patch<wbr>With<wbr>Http<wbr>Info</a></li> <li class="tsd-kind-method tsd-parent-kind-interface"><a href="_iconnectionmanager_.iconnectionmanager.html#post" class="tsd-kind-icon">post</a></li> <li class="tsd-kind-method tsd-parent-kind-interface"><a href="_iconnectionmanager_.iconnectionmanager.html#postwithhttpinfo" class="tsd-kind-icon">post<wbr>With<wbr>Http<wbr>Info</a></li> <li class="tsd-kind-method tsd-parent-kind-interface"><a href="_iconnectionmanager_.iconnectionmanager.html#put" class="tsd-kind-icon">put</a></li> <li class="tsd-kind-method tsd-parent-kind-interface"><a href="_iconnectionmanager_.iconnectionmanager.html#putwithhttpinfo" class="tsd-kind-icon">put<wbr>With<wbr>Http<wbr>Info</a></li> <li class="tsd-kind-method tsd-parent-kind-interface"><a href="_iconnectionmanager_.iconnectionmanager.html#removedefaultheader" class="tsd-kind-icon">remove<wbr>Default<wbr>Header</a></li> <li class="tsd-kind-method tsd-parent-kind-interface"><a href="_iconnectionmanager_.iconnectionmanager.html#removeparam" class="tsd-kind-icon">remove<wbr>Param</a></li> <li class="tsd-kind-method tsd-parent-kind-interface"><a href="_iconnectionmanager_.iconnectionmanager.html#removesearch" class="tsd-kind-icon">remove<wbr>Search</a></li> <li class="tsd-kind-method tsd-parent-kind-interface"><a href="_iconnectionmanager_.iconnectionmanager.html#request" class="tsd-kind-icon">request</a></li> <li class="tsd-kind-method tsd-parent-kind-interface"><a href="_iconnectionmanager_.iconnectionmanager.html#requestwithhttpinfo" class="tsd-kind-icon">request<wbr>With<wbr>Http<wbr>Info</a></li> <li class="tsd-kind-method tsd-parent-kind-interface"><a href="_iconnectionmanager_.iconnectionmanager.html#resetbaseurls" class="tsd-kind-icon">reset<wbr>BaseURLs</a></li> <li class="tsd-kind-method tsd-parent-kind-interface"><a href="_iconnectionmanager_.iconnectionmanager.html#resetdefaultheaders" class="tsd-kind-icon">reset<wbr>Default<wbr>Headers</a></li> <li class="tsd-kind-method tsd-parent-kind-interface"><a href="_iconnectionmanager_.iconnectionmanager.html#resetparams" class="tsd-kind-icon">reset<wbr>Params</a></li> <li class="tsd-kind-method tsd-parent-kind-interface"><a href="_iconnectionmanager_.iconnectionmanager.html#resetsearch" class="tsd-kind-icon">reset<wbr>Search</a></li> <li class="tsd-kind-method tsd-parent-kind-interface"><a href="_iconnectionmanager_.iconnectionmanager.html#setbaseurls" class="tsd-kind-icon">set<wbr>BaseURLs</a></li> <li class="tsd-kind-method tsd-parent-kind-interface"><a href="_iconnectionmanager_.iconnectionmanager.html#setdefaultheader" class="tsd-kind-icon">set<wbr>Default<wbr>Header</a></li> <li class="tsd-kind-method tsd-parent-kind-interface"><a href="_iconnectionmanager_.iconnectionmanager.html#setname" class="tsd-kind-icon">set<wbr>Name</a></li> <li class="tsd-kind-method tsd-parent-kind-interface"><a href="_iconnectionmanager_.iconnectionmanager.html#setparam" class="tsd-kind-icon">set<wbr>Param</a></li> <li class="tsd-kind-method tsd-parent-kind-interface"><a href="_iconnectionmanager_.iconnectionmanager.html#setsearch" class="tsd-kind-icon">set<wbr>Search</a></li> </ul> </section> </div> </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-interface"> <a name="delete" class="tsd-anchor"></a> <h3>delete</h3> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface"> <li class="tsd-signature tsd-kind-icon">delete<span class="tsd-signature-symbol">(</span>url<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, requestOptionsArgs<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">RequestOptionsArgs</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">&gt;</span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> <ul> <li>Defined in IConnectionManager.ts:55</li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p style="text-indent: 1em;"> Send <code>DELETE</code> request to the specified <code><b>url</b></code>. </p> </div> </div> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5>url: <span class="tsd-signature-type">string</span></h5> </li> <li> <h5>requestOptionsArgs: <span class="tsd-signature-type">RequestOptionsArgs</span></h5> </li> </ul> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">&gt;</span></h4> </li> </ul> </section> <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface"> <a name="deletewithhttpinfo" class="tsd-anchor"></a> <h3>delete<wbr>With<wbr>Http<wbr>Info</h3> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface"> <li class="tsd-signature tsd-kind-icon">delete<wbr>With<wbr>Http<wbr>Info<span class="tsd-signature-symbol">(</span>url<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, requestOptionsArgs<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">RequestOptionsArgs</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">Response</span><span class="tsd-signature-symbol">&gt;</span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> <ul> <li>Defined in IConnectionManager.ts:57</li> </ul> </aside> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5>url: <span class="tsd-signature-type">string</span></h5> </li> <li> <h5>requestOptionsArgs: <span class="tsd-signature-type">RequestOptionsArgs</span></h5> </li> </ul> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">Response</span><span class="tsd-signature-symbol">&gt;</span></h4> </li> </ul> </section> <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface"> <a name="get" class="tsd-anchor"></a> <h3>get</h3> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface"> <li class="tsd-signature tsd-kind-icon">get<span class="tsd-signature-symbol">(</span>url<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, requestOptionsArgs<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">RequestOptionsArgs</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">&gt;</span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> <ul> <li>Defined in IConnectionManager.ts:28</li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p style="text-indent: 1em;"> Send a <code>GET</code> request to the specified <code><b>url</b></code>. </p> </div> </div> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5>url: <span class="tsd-signature-type">string</span></h5> </li> <li> <h5>requestOptionsArgs: <span class="tsd-signature-type">RequestOptionsArgs</span></h5> </li> </ul> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">&gt;</span></h4> </li> </ul> </section> <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface"> <a name="getconnectionquality" class="tsd-anchor"></a> <h3>get<wbr>Connection<wbr>Quality</h3> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface"> <li class="tsd-signature tsd-kind-icon">get<wbr>Connection<wbr>Quality<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> <ul> <li>Defined in IConnectionManager.ts:115</li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p style="text-indent: 1em;"> Get connection quality of the <code>application</code> indicated by values between [0, 100]. </p> </div> </div> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">number</span></h4> <p>A percentage of connection quality.</p> </li> </ul> </section> <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface"> <a name="getname" class="tsd-anchor"></a> <h3>get<wbr>Name</h3> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface"> <li class="tsd-signature tsd-kind-icon">get<wbr>Name<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> <ul> <li>Defined in IConnectionManager.ts:19</li> </ul> </aside> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4> </li> </ul> </section> <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface"> <a name="getrunningprocesses" class="tsd-anchor"></a> <h3>get<wbr>Running<wbr>Processes</h3> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface"> <li class="tsd-signature tsd-kind-icon">get<wbr>Running<wbr>Processes<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">[]</span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> <ul> <li>Defined in IConnectionManager.ts:106</li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p style="text-indent: 1em;"> Get underlying <code>background process</code> models of alive connections. </p> </div> </div> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">[]</span></h4> <p>Returns <code>empty array</code> if there is no alive connections.</p> </li> </ul> </section> <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface"> <a name="getrunningprocessescount" class="tsd-anchor"></a> <h3>get<wbr>Running<wbr>Processes<wbr>Count</h3> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface"> <li class="tsd-signature tsd-kind-icon">get<wbr>Running<wbr>Processes<wbr>Count<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> <ul> <li>Defined in IConnectionManager.ts:97</li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p style="text-indent: 1em;"> Get underlying <code>background process</code>es count of alive connections. </p> </div> </div> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">number</span></h4> <p>Returns <code>0</code> if there is no alive connections.</p> </li> </ul> </section> <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface"> <a name="getwithhttpinfo" class="tsd-anchor"></a> <h3>get<wbr>With<wbr>Http<wbr>Info</h3> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface"> <li class="tsd-signature tsd-kind-icon">get<wbr>With<wbr>Http<wbr>Info<span class="tsd-signature-symbol">(</span>url<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, requestOptionsArgs<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">RequestOptionsArgs</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">Response</span><span class="tsd-signature-symbol">&gt;</span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> <ul> <li>Defined in IConnectionManager.ts:30</li> </ul> </aside> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5>url: <span class="tsd-signature-type">string</span></h5> </li> <li> <h5>requestOptionsArgs: <span class="tsd-signature-type">RequestOptionsArgs</span></h5> </li> </ul> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">Response</span><span class="tsd-signature-symbol">&gt;</span></h4> </li> </ul> </section> <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface"> <a name="head" class="tsd-anchor"></a> <h3>head</h3> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface"> <li class="tsd-signature tsd-kind-icon">head<span class="tsd-signature-symbol">(</span>url<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, requestOptionsArgs<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">RequestOptionsArgs</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">&gt;</span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> <ul> <li>Defined in IConnectionManager.ts:73</li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p style="text-indent: 1em;"> Send <code>HEAD</code> request to the specified <code><b>url</b></code>. </p> </div> </div> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5>url: <span class="tsd-signature-type">string</span></h5> </li> <li> <h5>requestOptionsArgs: <span class="tsd-signature-type">RequestOptionsArgs</span></h5> </li> </ul> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">&gt;</span></h4> </li> </ul> </section> <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface"> <a name="headwithhttpinfo" class="tsd-anchor"></a> <h3>head<wbr>With<wbr>Http<wbr>Info</h3> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface"> <li class="tsd-signature tsd-kind-icon">head<wbr>With<wbr>Http<wbr>Info<span class="tsd-signature-symbol">(</span>url<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, requestOptionsArgs<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">RequestOptionsArgs</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">Response</span><span class="tsd-signature-symbol">&gt;</span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> <ul> <li>Defined in IConnectionManager.ts:75</li> </ul> </aside> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5>url: <span class="tsd-signature-type">string</span></h5> </li> <li> <h5>requestOptionsArgs: <span class="tsd-signature-type">RequestOptionsArgs</span></h5> </li> </ul> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">Response</span><span class="tsd-signature-symbol">&gt;</span></h4> </li> </ul> </section> <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface"> <a name="options" class="tsd-anchor"></a> <h3>options</h3> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface"> <li class="tsd-signature tsd-kind-icon">options<span class="tsd-signature-symbol">(</span>url<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, requestOptionsArgs<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">RequestOptionsArgs</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">&gt;</span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> <ul> <li>Defined in IConnectionManager.ts:82</li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p style="text-indent: 1em;"> Send <code>OPTIONS</code> request to the specified <code><b>url</b></code>. </p> </div> </div> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5>url: <span class="tsd-signature-type">string</span></h5> </li> <li> <h5>requestOptionsArgs: <span class="tsd-signature-type">RequestOptionsArgs</span></h5> </li> </ul> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">&gt;</span></h4> </li> </ul> </section> <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface"> <a name="optionswithhttpinfo" class="tsd-anchor"></a> <h3>options<wbr>With<wbr>Http<wbr>Info</h3> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface"> <li class="tsd-signature tsd-kind-icon">options<wbr>With<wbr>Http<wbr>Info<span class="tsd-signature-symbol">(</span>url<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, requestOptionsArgs<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">RequestOptionsArgs</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">Response</span><span class="tsd-signature-symbol">&gt;</span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> <ul> <li>Defined in IConnectionManager.ts:84</li> </ul> </aside> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5>url: <span class="tsd-signature-type">string</span></h5> </li> <li> <h5>requestOptionsArgs: <span class="tsd-signature-type">RequestOptionsArgs</span></h5> </li> </ul> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">Response</span><span class="tsd-signature-symbol">&gt;</span></h4> </li> </ul> </section> <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface"> <a name="patch" class="tsd-anchor"></a> <h3>patch</h3> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface"> <li class="tsd-signature tsd-kind-icon">patch<span class="tsd-signature-symbol">(</span>url<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, body<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span>, requestOptionsArgs<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">RequestOptionsArgs</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">&gt;</span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> <ul> <li>Defined in IConnectionManager.ts:64</li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p style="text-indent: 1em;"> Send <code>PATCH</code> request to the specified <code><b>url</b></code>. </p> </div> </div> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5>url: <span class="tsd-signature-type">string</span></h5> </li> <li> <h5>body: <span class="tsd-signature-type">any</span></h5> </li> <li> <h5>requestOptionsArgs: <span class="tsd-signature-type">RequestOptionsArgs</span></h5> </li> </ul> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">&gt;</span></h4> </li> </ul> </section> <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface"> <a name="patchwithhttpinfo" class="tsd-anchor"></a> <h3>patch<wbr>With<wbr>Http<wbr>Info</h3> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface"> <li class="tsd-signature tsd-kind-icon">patch<wbr>With<wbr>Http<wbr>Info<span class="tsd-signature-symbol">(</span>url<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, body<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span>, requestOptionsArgs<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">RequestOptionsArgs</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">Response</span><span class="tsd-signature-symbol">&gt;</span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> <ul> <li>Defined in IConnectionManager.ts:66</li> </ul> </aside> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5>url: <span class="tsd-signature-type">string</span></h5> </li> <li> <h5>body: <span class="tsd-signature-type">any</span></h5> </li> <li> <h5>requestOptionsArgs: <span class="tsd-signature-type">RequestOptionsArgs</span></h5> </li> </ul> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">Response</span><span class="tsd-signature-symbol">&gt;</span></h4> </li> </ul> </section> <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface"> <a name="post" class="tsd-anchor"></a> <h3>post</h3> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface"> <li class="tsd-signature tsd-kind-icon">post<span class="tsd-signature-symbol">(</span>url<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, body<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span>, requestOptionsArgs<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">RequestOptionsArgs</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">&gt;</span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> <ul> <li>Defined in IConnectionManager.ts:37</li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p style="text-indent: 1em;"> Send <code>POST</code> request to the specified <code><b>url</b></code>. </p> </div> </div> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5>url: <span class="tsd-signature-type">string</span></h5> </li> <li> <h5>body: <span class="tsd-signature-type">any</span></h5> </li> <li> <h5>requestOptionsArgs: <span class="tsd-signature-type">RequestOptionsArgs</span></h5> </li> </ul> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">&gt;</span></h4> </li> </ul> </section> <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface"> <a name="postwithhttpinfo" class="tsd-anchor"></a> <h3>post<wbr>With<wbr>Http<wbr>Info</h3> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface"> <li class="tsd-signature tsd-kind-icon">post<wbr>With<wbr>Http<wbr>Info<span class="tsd-signature-symbol">(</span>url<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, body<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span>, requestOptionsArgs<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">RequestOptionsArgs</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">Response</span><span class="tsd-signature-symbol">&gt;</span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> <ul> <li>Defined in IConnectionManager.ts:39</li> </ul> </aside> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5>url: <span class="tsd-signature-type">string</span></h5> </li> <li> <h5>body: <span class="tsd-signature-type">any</span></h5> </li> <li> <h5>requestOptionsArgs: <span class="tsd-signature-type">RequestOptionsArgs</span></h5> </li> </ul> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">Response</span><span class="tsd-signature-symbol">&gt;</span></h4> </li> </ul> </section> <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface"> <a name="put" class="tsd-anchor"></a> <h3>put</h3> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface"> <li class="tsd-signature tsd-kind-icon">put<span class="tsd-signature-symbol">(</span>url<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, body<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span>, requestOptionsArgs<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">RequestOptionsArgs</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">&gt;</span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> <ul> <li>Defined in IConnectionManager.ts:46</li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p style="text-indent: 1em;"> Send <code>PUT</code> request to the specified <code><b>url</b></code>. </p> </div> </div> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5>url: <span class="tsd-signature-type">string</span></h5> </li> <li> <h5>body: <span class="tsd-signature-type">any</span></h5> </li> <li> <h5>requestOptionsArgs: <span class="tsd-signature-type">RequestOptionsArgs</span></h5> </li> </ul> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">&gt;</span></h4> </li> </ul> </section> <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface"> <a name="putwithhttpinfo" class="tsd-anchor"></a> <h3>put<wbr>With<wbr>Http<wbr>Info</h3> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface"> <li class="tsd-signature tsd-kind-icon">put<wbr>With<wbr>Http<wbr>Info<span class="tsd-signature-symbol">(</span>url<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, body<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span>, requestOptionsArgs<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">RequestOptionsArgs</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">Response</span><span class="tsd-signature-symbol">&gt;</span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> <ul> <li>Defined in IConnectionManager.ts:48</li> </ul> </aside> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5>url: <span class="tsd-signature-type">string</span></h5> </li> <li> <h5>body: <span class="tsd-signature-type">any</span></h5> </li> <li> <h5>requestOptionsArgs: <span class="tsd-signature-type">RequestOptionsArgs</span></h5> </li> </ul> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">Response</span><span class="tsd-signature-symbol">&gt;</span></h4> </li> </ul> </section> <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface"> <a name="removedefaultheader" class="tsd-anchor"></a> <h3>remove<wbr>Default<wbr>Header</h3> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface"> <li class="tsd-signature tsd-kind-icon">remove<wbr>Default<wbr>Header<span class="tsd-signature-symbol">(</span>key<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</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"> <ul> <li>Defined in IConnectionManager.ts:123</li> </ul> </aside> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5>key: <span class="tsd-signature-type">string</span></h5> </li> </ul> <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-interface"> <a name="removeparam" class="tsd-anchor"></a> <h3>remove<wbr>Param</h3> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface"> <li class="tsd-signature tsd-kind-icon">remove<wbr>Param<span class="tsd-signature-symbol">(</span>key<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</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"> <ul> <li>Defined in IConnectionManager.ts:135</li> </ul> </aside> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5>key: <span class="tsd-signature-type">string</span></h5> </li> </ul> <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-interface"> <a name="removesearch" class="tsd-anchor"></a> <h3>remove<wbr>Search</h3> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface"> <li class="tsd-signature tsd-kind-icon">remove<wbr>Search<span class="tsd-signature-symbol">(</span>key<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</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"> <ul> <li>Defined in IConnectionManager.ts:129</li> </ul> </aside> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5>key: <span class="tsd-signature-type">string</span></h5> </li> </ul> <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-interface"> <a name="request" class="tsd-anchor"></a> <h3>request</h3> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface"> <li class="tsd-signature tsd-kind-icon">request<span class="tsd-signature-symbol">(</span>url<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, requestOptionsArgs<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">RequestOptionsArgs</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">&gt;</span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> <ul> <li>Defined in IConnectionManager.ts:86</li> </ul> </aside> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5>url: <span class="tsd-signature-type">string</span></h5> </li> <li> <h5>requestOptionsArgs: <span class="tsd-signature-type">RequestOptionsArgs</span></h5> </li> </ul> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">&gt;</span></h4> </li> </ul> </section> <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface"> <a name="requestwithhttpinfo" class="tsd-anchor"></a> <h3>request<wbr>With<wbr>Http<wbr>Info</h3> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface"> <li class="tsd-signature tsd-kind-icon">request<wbr>With<wbr>Http<wbr>Info<span class="tsd-signature-symbol">(</span>url<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, requestOptionsArgs<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">RequestOptionsArgs</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">Response</span><span class="tsd-signature-symbol">&gt;</span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> <ul> <li>Defined in IConnectionManager.ts:88</li> </ul> </aside> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5>url: <span class="tsd-signature-type">string</span></h5> </li> <li> <h5>requestOptionsArgs: <span class="tsd-signature-type">RequestOptionsArgs</span></h5> </li> </ul> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">Response</span><span class="tsd-signature-symbol">&gt;</span></h4> </li> </ul> </section> <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface"> <a name="resetbaseurls" class="tsd-anchor"></a> <h3>reset<wbr>BaseURLs</h3> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface"> <li class="tsd-signature tsd-kind-icon">reset<wbr>BaseURLs<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"> <ul> <li>Defined in IConnectionManager.ts:119</li> </ul> </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-interface"> <a name="resetdefaultheaders" class="tsd-anchor"></a> <h3>reset<wbr>Default<wbr>Headers</h3> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface"> <li class="tsd-signature tsd-kind-icon">reset<wbr>Default<wbr>Headers<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"> <ul> <li>Defined in IConnectionManager.ts:125</li> </ul> </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-interface"> <a name="resetparams" class="tsd-anchor"></a> <h3>reset<wbr>Params</h3> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface"> <li class="tsd-sign