UNPKG

io.parrots

Version:

Parrots.io App

768 lines 53.2 kB
<!doctype html> <html class="default no-js"> <head> <meta charset="utf-8"> <meta http-equiv="X-UA-Compatible" content="IE=edge"> <title>ParrotsAccountResource | io.parrots</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">io.parrots</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/_lib_share_resource_parrotsaccountresource_.html">&quot;lib/share/resource/ParrotsAccountResource&quot;</a> </li> <li> <a href="_lib_share_resource_parrotsaccountresource_.parrotsaccountresource.html">ParrotsAccountResource</a> </li> </ul> <h1>Class ParrotsAccountResource</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="tsd-signature-type">AbstractServerResource</span> <ul class="tsd-hierarchy"> <li> <span class="target">ParrotsAccountResource</span> </li> </ul> </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>Constructors</h3> <ul class="tsd-index-list"> <li class="tsd-kind-constructor tsd-parent-kind-class tsd-is-overwrite"><a href="_lib_share_resource_parrotsaccountresource_.parrotsaccountresource.html#constructor" class="tsd-kind-icon">constructor</a></li> </ul> </section> <section class="tsd-index-section tsd-is-private-protected"> <h3>Properties</h3> <ul class="tsd-index-list"> <li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><a href="_lib_share_resource_parrotsaccountresource_.parrotsaccountresource.html#basepath" class="tsd-kind-icon">base<wbr>Path</a></li> <li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-protected"><a href="_lib_share_resource_parrotsaccountresource_.parrotsaccountresource.html#connectionmgr" class="tsd-kind-icon">connection<wbr>Mgr</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"><a href="_lib_share_resource_parrotsaccountresource_.parrotsaccountresource.html#activateaccountwithhttpinfo" class="tsd-kind-icon">activate<wbr>Account<wbr>With<wbr>Http<wbr>Info</a></li> <li class="tsd-kind-method tsd-parent-kind-class tsd-is-private"><a href="_lib_share_resource_parrotsaccountresource_.parrotsaccountresource.html#addingheaderrequestoptionsargs" class="tsd-kind-icon">adding<wbr>Header<wbr>Request<wbr>Options<wbr>Args</a></li> <li class="tsd-kind-method tsd-parent-kind-class"><a href="_lib_share_resource_parrotsaccountresource_.parrotsaccountresource.html#changepassword" class="tsd-kind-icon">change<wbr>Password</a></li> <li class="tsd-kind-method tsd-parent-kind-class"><a href="_lib_share_resource_parrotsaccountresource_.parrotsaccountresource.html#changepasswordwithhttpinfo" class="tsd-kind-icon">change<wbr>Password<wbr>With<wbr>Http<wbr>Info</a></li> <li class="tsd-kind-method tsd-parent-kind-class"><a href="_lib_share_resource_parrotsaccountresource_.parrotsaccountresource.html#check" class="tsd-kind-icon">check</a></li> <li class="tsd-kind-method tsd-parent-kind-class"><a href="_lib_share_resource_parrotsaccountresource_.parrotsaccountresource.html#checkwithhttpinfo" class="tsd-kind-icon">check<wbr>With<wbr>Http<wbr>Info</a></li> <li class="tsd-kind-method tsd-parent-kind-class"><a href="_lib_share_resource_parrotsaccountresource_.parrotsaccountresource.html#createoauthwithhttpinfo" class="tsd-kind-icon">create<wbr>Oauth<wbr>With<wbr>Http<wbr>Info</a></li> <li class="tsd-kind-method tsd-parent-kind-class"><a href="_lib_share_resource_parrotsaccountresource_.parrotsaccountresource.html#getaccountsinfo" class="tsd-kind-icon">get<wbr>Accounts<wbr>Info</a></li> <li class="tsd-kind-method tsd-parent-kind-class"><a href="_lib_share_resource_parrotsaccountresource_.parrotsaccountresource.html#getaccountsinfos" class="tsd-kind-icon">get<wbr>Accounts<wbr>Infos</a></li> <li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="_lib_share_resource_parrotsaccountresource_.parrotsaccountresource.html#getconnectionmanager" class="tsd-kind-icon">get<wbr>Connection<wbr>Manager</a></li> <li class="tsd-kind-method tsd-parent-kind-class"><a href="_lib_share_resource_parrotsaccountresource_.parrotsaccountresource.html#loginwithhttpinfo" class="tsd-kind-icon">login<wbr>With<wbr>Http<wbr>Info</a></li> <li class="tsd-kind-method tsd-parent-kind-class"><a href="_lib_share_resource_parrotsaccountresource_.parrotsaccountresource.html#oauthloginwithhttpinfo" class="tsd-kind-icon">oauth<wbr>Login<wbr>With<wbr>Http<wbr>Info</a></li> <li class="tsd-kind-method tsd-parent-kind-class"><a href="_lib_share_resource_parrotsaccountresource_.parrotsaccountresource.html#register" class="tsd-kind-icon">register</a></li> <li class="tsd-kind-method tsd-parent-kind-class"><a href="_lib_share_resource_parrotsaccountresource_.parrotsaccountresource.html#registerwithhttpinfo" class="tsd-kind-icon">register<wbr>With<wbr>Http<wbr>Info</a></li> <li class="tsd-kind-method tsd-parent-kind-class"><a href="_lib_share_resource_parrotsaccountresource_.parrotsaccountresource.html#sendemailchangepassword" class="tsd-kind-icon">send<wbr>Email<wbr>Change<wbr>Password</a></li> <li class="tsd-kind-method tsd-parent-kind-class"><a href="_lib_share_resource_parrotsaccountresource_.parrotsaccountresource.html#sendemailchangepasswordwithhttpinfo" class="tsd-kind-icon">send<wbr>Email<wbr>Change<wbr>Password<wbr>With<wbr>Http<wbr>Info</a></li> <li class="tsd-kind-method tsd-parent-kind-class"><a href="_lib_share_resource_parrotsaccountresource_.parrotsaccountresource.html#sendemailvalidationaccount" class="tsd-kind-icon">send<wbr>Email<wbr>Validation<wbr>Account</a></li> <li class="tsd-kind-method tsd-parent-kind-class"><a href="_lib_share_resource_parrotsaccountresource_.parrotsaccountresource.html#sendemailvalidationaccountwithhttpinfo" class="tsd-kind-icon">send<wbr>Email<wbr>Validation<wbr>Account<wbr>With<wbr>Http<wbr>Info</a></li> <li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="_lib_share_resource_parrotsaccountresource_.parrotsaccountresource.html#setconnectionmanager" class="tsd-kind-icon">set<wbr>Connection<wbr>Manager</a></li> </ul> </section> </div> </section> </section> <section class="tsd-panel-group tsd-member-group "> <h2>Constructors</h2> <section class="tsd-panel tsd-member tsd-kind-constructor tsd-parent-kind-class tsd-is-overwrite"> <a name="constructor" class="tsd-anchor"></a> <h3>constructor</h3> <ul class="tsd-signatures tsd-kind-constructor tsd-parent-kind-class tsd-is-overwrite"> <li class="tsd-signature tsd-kind-icon">new <wbr>Parrots<wbr>Account<wbr>Resource<span class="tsd-signature-symbol">(</span>connectionMgr<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">IConnectionManager</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="_lib_share_resource_parrotsaccountresource_.parrotsaccountresource.html" class="tsd-signature-type">ParrotsAccountResource</a></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> <p>Overrides AbstractServerResource.__constructor</p> <ul> <li>Defined in lib/share/resource/ParrotsAccountResource.ts:10</li> </ul> </aside> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5>connectionMgr: <span class="tsd-signature-type">IConnectionManager</span></h5> </li> </ul> <h4 class="tsd-returns-title">Returns <a href="_lib_share_resource_parrotsaccountresource_.parrotsaccountresource.html" class="tsd-signature-type">ParrotsAccountResource</a></h4> </li> </ul> </section> </section> <section class="tsd-panel-group tsd-member-group tsd-is-private-protected"> <h2>Properties</h2> <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-private"> <a name="basepath" class="tsd-anchor"></a> <h3><span class="tsd-flag ts-flagPrivate">Private</span> base<wbr>Path</h3> <div class="tsd-signature tsd-kind-icon">base<wbr>Path<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> =&nbsp;&quot;./account&quot;</span></div> <aside class="tsd-sources"> <ul> <li>Defined in lib/share/resource/ParrotsAccountResource.ts:10</li> </ul> </aside> </section> <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-protected"> <a name="connectionmgr" class="tsd-anchor"></a> <h3><span class="tsd-flag ts-flagProtected">Protected</span> connection<wbr>Mgr</h3> <div class="tsd-signature tsd-kind-icon">connection<wbr>Mgr<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">IConnectionManager</span></div> <aside class="tsd-sources"> <p>Inherited from AbstractServerResource.connectionMgr</p> <ul> <li>Defined in /Users/shiorin/parrot_sourceTree/parrots.io-platform/node/io.parrots/node_modules/com.phloxui/lib/share/AbstractServerResource.d.ts:3</li> </ul> </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"> <a name="activateaccountwithhttpinfo" class="tsd-anchor"></a> <h3>activate<wbr>Account<wbr>With<wbr>Http<wbr>Info</h3> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"> <li class="tsd-signature tsd-kind-icon">activate<wbr>Account<wbr>With<wbr>Http<wbr>Info<span class="tsd-signature-symbol">(</span>userId<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, secret<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">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 lib/share/resource/ParrotsAccountResource.ts:188</li> </ul> </aside> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5>userId: <span class="tsd-signature-type">string</span></h5> </li> <li> <h5>secret: <span class="tsd-signature-type">string</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-class tsd-is-private"> <a name="addingheaderrequestoptionsargs" class="tsd-anchor"></a> <h3><span class="tsd-flag ts-flagPrivate">Private</span> adding<wbr>Header<wbr>Request<wbr>Options<wbr>Args</h3> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-private"> <li class="tsd-signature tsd-kind-icon">adding<wbr>Header<wbr>Request<wbr>Options<wbr>Args<span class="tsd-signature-symbol">(</span>options<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">RequestOptionsArgs</span>, headerData<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">object</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">RequestOptionsArgs</span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> <ul> <li>Defined in lib/share/resource/ParrotsAccountResource.ts:16</li> </ul> </aside> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5>options: <span class="tsd-signature-type">RequestOptionsArgs</span></h5> </li> <li> <h5>headerData: <span class="tsd-signature-type">object</span></h5> <ul class="tsd-parameters"> <li class="tsd-parameter-index-signature"> <h5><span class="tsd-signature-symbol">[</span>name: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">]: </span><span class="tsd-signature-type">string</span></h5> </li> </ul> </li> </ul> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">RequestOptionsArgs</span></h4> </li> </ul> </section> <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"> <a name="changepassword" class="tsd-anchor"></a> <h3>change<wbr>Password</h3> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"> <li class="tsd-signature tsd-kind-icon">change<wbr>Password<span class="tsd-signature-symbol">(</span>body<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-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 lib/share/resource/ParrotsAccountResource.ts:58</li> </ul> </aside> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5>body: <span class="tsd-signature-type">any</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-class"> <a name="changepasswordwithhttpinfo" class="tsd-anchor"></a> <h3>change<wbr>Password<wbr>With<wbr>Http<wbr>Info</h3> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"> <li class="tsd-signature tsd-kind-icon">change<wbr>Password<wbr>With<wbr>Http<wbr>Info<span class="tsd-signature-symbol">(</span>body<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-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 lib/share/resource/ParrotsAccountResource.ts:34</li> </ul> </aside> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5>body: <span class="tsd-signature-type">any</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-class"> <a name="check" class="tsd-anchor"></a> <h3>check</h3> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"> <li class="tsd-signature tsd-kind-icon">check<span class="tsd-signature-symbol">(</span>req<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-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 lib/share/resource/ParrotsAccountResource.ts:361</li> </ul> </aside> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5>req: <span class="tsd-signature-type">any</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-class"> <a name="checkwithhttpinfo" class="tsd-anchor"></a> <h3>check<wbr>With<wbr>Http<wbr>Info</h3> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"> <li class="tsd-signature tsd-kind-icon">check<wbr>With<wbr>Http<wbr>Info<span class="tsd-signature-symbol">(</span>req<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-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 lib/share/resource/ParrotsAccountResource.ts:333</li> </ul> </aside> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5>req: <span class="tsd-signature-type">any</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-class"> <a name="createoauthwithhttpinfo" class="tsd-anchor"></a> <h3>create<wbr>Oauth<wbr>With<wbr>Http<wbr>Info</h3> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"> <li class="tsd-signature tsd-kind-icon">create<wbr>Oauth<wbr>With<wbr>Http<wbr>Info<span class="tsd-signature-symbol">(</span>authenProvider<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, clientId<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, token<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, registerDTO<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-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 lib/share/resource/ParrotsAccountResource.ts:409</li> </ul> </aside> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5>authenProvider: <span class="tsd-signature-type">string</span></h5> </li> <li> <h5>clientId: <span class="tsd-signature-type">string</span></h5> </li> <li> <h5>token: <span class="tsd-signature-type">string</span></h5> </li> <li> <h5>registerDTO: <span class="tsd-signature-type">any</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-class"> <a name="getaccountsinfo" class="tsd-anchor"></a> <h3>get<wbr>Accounts<wbr>Info</h3> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"> <li class="tsd-signature tsd-kind-icon">get<wbr>Accounts<wbr>Info<span class="tsd-signature-symbol">(</span>value<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-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 lib/share/resource/ParrotsAccountResource.ts:216</li> </ul> </aside> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5>value: <span class="tsd-signature-type">any</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-class"> <a name="getaccountsinfos" class="tsd-anchor"></a> <h3>get<wbr>Accounts<wbr>Infos</h3> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"> <li class="tsd-signature tsd-kind-icon">get<wbr>Accounts<wbr>Infos<span class="tsd-signature-symbol">(</span>body<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-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 lib/share/resource/ParrotsAccountResource.ts:239</li> </ul> </aside> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5>body: <span class="tsd-signature-type">any</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-class tsd-is-inherited"> <a name="getconnectionmanager" class="tsd-anchor"></a> <h3>get<wbr>Connection<wbr>Manager</h3> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited"> <li class="tsd-signature tsd-kind-icon">get<wbr>Connection<wbr>Manager<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">IConnectionManager</span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> <p>Inherited from AbstractServerResource.getConnectionManager</p> <ul> <li>Defined in /Users/shiorin/parrot_sourceTree/parrots.io-platform/node/io.parrots/node_modules/com.phloxui/lib/share/AbstractServerResource.d.ts:5</li> </ul> </aside> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">IConnectionManager</span></h4> </li> </ul> </section> <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"> <a name="loginwithhttpinfo" class="tsd-anchor"></a> <h3>login<wbr>With<wbr>Http<wbr>Info</h3> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"> <li class="tsd-signature tsd-kind-icon">login<wbr>With<wbr>Http<wbr>Info<span class="tsd-signature-symbol">(</span>username<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, password<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">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 lib/share/resource/ParrotsAccountResource.ts:262</li> </ul> </aside> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5>username: <span class="tsd-signature-type">string</span></h5> </li> <li> <h5>password: <span class="tsd-signature-type">string</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-class"> <a name="oauthloginwithhttpinfo" class="tsd-anchor"></a> <h3>oauth<wbr>Login<wbr>With<wbr>Http<wbr>Info</h3> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"> <li class="tsd-signature tsd-kind-icon">oauth<wbr>Login<wbr>With<wbr>Http<wbr>Info<span class="tsd-signature-symbol">(</span>authenProvider<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, clientId<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, token<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, clientName<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span>, clientData<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-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 lib/share/resource/ParrotsAccountResource.ts:389</li> </ul> </aside> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5>authenProvider: <span class="tsd-signature-type">string</span></h5> </li> <li> <h5>clientId: <span class="tsd-signature-type">string</span></h5> </li> <li> <h5>token: <span class="tsd-signature-type">string</span></h5> </li> <li> <h5><span class="tsd-flag ts-flagOptional">Optional</span> clientName: <span class="tsd-signature-type">string</span></h5> </li> <li> <h5><span class="tsd-flag ts-flagOptional">Optional</span> clientData: <span class="tsd-signature-type">any</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-class"> <a name="register" class="tsd-anchor"></a> <h3>register</h3> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"> <li class="tsd-signature tsd-kind-icon">register<span class="tsd-signature-symbol">(</span>createAccountDTO<span class="tsd-signature-symbol">: </span><a href="_lib_share_model_dto_createaccountdto_.createaccountdto.html" class="tsd-signature-type">CreateAccountDTO</a><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 lib/share/resource/ParrotsAccountResource.ts:307</li> </ul> </aside> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5>createAccountDTO: <a href="_lib_share_model_dto_createaccountdto_.createaccountdto.html" class="tsd-signature-type">CreateAccountDTO</a></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-class"> <a name="registerwithhttpinfo" class="tsd-anchor"></a> <h3>register<wbr>With<wbr>Http<wbr>Info</h3> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"> <li class="tsd-signature tsd-kind-icon">register<wbr>With<wbr>Http<wbr>Info<span class="tsd-signature-symbol">(</span>createAccountDTO<span class="tsd-signature-symbol">: </span><a href="_lib_share_model_dto_createaccountdto_.createaccountdto.html" class="tsd-signature-type">CreateAccountDTO</a><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 lib/share/resource/ParrotsAccountResource.ts:281</li> </ul> </aside> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5>createAccountDTO: <a href="_lib_share_model_dto_createaccountdto_.createaccountdto.html" class="tsd-signature-type">CreateAccountDTO</a></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-class"> <a name="sendemailchangepassword" class="tsd-anchor"></a> <h3>send<wbr>Email<wbr>Change<wbr>Password</h3> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"> <li class="tsd-signature tsd-kind-icon">send<wbr>Email<wbr>Change<wbr>Password<span class="tsd-signature-symbol">(</span>email<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">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 lib/share/resource/ParrotsAccountResource.ts:109</li> </ul> </aside> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5>email: <span class="tsd-signature-type">string</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-class"> <a name="sendemailchangepasswordwithhttpinfo" class="tsd-anchor"></a> <h3>send<wbr>Email<wbr>Change<wbr>Password<wbr>With<wbr>Http<wbr>Info</h3> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"> <li class="tsd-signature tsd-kind-icon">send<wbr>Email<wbr>Change<wbr>Password<wbr>With<wbr>Http<wbr>Info<span class="tsd-signature-symbol">(</span>email<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">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 lib/share/resource/ParrotsAccountResource.ts:82</li> </ul> </aside> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5>email: <span class="tsd-signature-type">string</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-class"> <a name="sendemailvalidationaccount" class="tsd-anchor"></a> <h3>send<wbr>Email<wbr>Validation<wbr>Account</h3> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"> <li class="tsd-signature tsd-kind-icon">send<wbr>Email<wbr>Validation<wbr>Account<span class="tsd-signature-symbol">(</span>body<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-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 lib/share/resource/ParrotsAccountResource.ts:162</li> </ul> </aside> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5>body: <span class="tsd-signature-type">any</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-class"> <a name="sendemailvalidationaccountwithhttpinfo" class="tsd-anchor"></a> <h3>send<wbr>Email<wbr>Validation<wbr>Account<wbr>With<wbr>Http<wbr>Info</h3> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"> <li class="tsd-signature tsd-kind-icon">send<wbr>Email<wbr>Validation<wbr>Account<wbr>With<wbr>Http<wbr>Info<span class="tsd-signature-symbol">(</span>body<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-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 lib/share/resource/ParrotsAccountResource.ts:136</li> </ul> </aside> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5>body: <span class="tsd-signature-type">any</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-class tsd-is-inherited"> <a name="setconnectionmanager" class="tsd-anchor"></a> <h3>set<wbr>Connection<wbr>Manager</h3> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited"> <li class="tsd-signature tsd-kind-icon">set<wbr>Connection<wbr>Manager<span class="tsd-signature-symbol">(</span>connectionMgr<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">IConnectionManager</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>Inherited from AbstractServerResource.setConnectionManager</p> <ul> <li>Defined in /Users/shiorin/parrot_sourceTree/parrots.io-platform/node/io.parrots/node_modules/com.phloxui/lib/share/AbstractServerResource.d.ts:6</li> </ul> </aside> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5>connectionMgr: <span class="tsd-signature-type">IConnectionManager</span></h5> </li> </ul> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></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-external-module"> <a href="../modules/_lib_share_resource_parrotsaccountresource_.html">"lib/share/resource/<wbr>Parrots<wbr>Account<wbr>Resource"</a> </li> </ul> </nav> <nav class="tsd-navigation secondary menu-sticky"> <ul class="before-current"> </ul> <ul class="current"> <li class="current tsd-kind-class tsd-parent-kind-external-module"> <a href="_lib_share_resource_parrotsaccountresource_.parrotsaccountresource.html" class="tsd-kind-icon">Parrots<wbr>Account<wbr>Resource</a> <ul> <li class=" tsd-kind-constructor tsd-parent-kind-class tsd-is-overwrite"> <a href="_lib_share_resource_parrotsaccountresource_.parrotsaccountresource.html#constructor" class="tsd-kind-icon">constructor</a> </li> <li class=" tsd-kind-property tsd-parent-kind-class tsd-is-private"> <a href="_lib_share_resource_parrotsaccountresource_.parrotsaccountresource.html#basepath" class="tsd-kind-icon">base<wbr>Path</a> </li> <li class=" tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-protected"> <a href="_lib_share_resource_parrotsaccountresource_.parrotsaccountresource.html#connectionmgr" class="tsd-kind-icon">connection<wbr>Mgr</a> </li> <li class=" tsd-kind-method tsd-parent-kind-class"> <a href="_lib_share_resource_parrotsaccountresource_.parrotsaccountresource.html#activateaccountwithhttpinfo" class="tsd-kind-icon">activate<wbr>Account<wbr>With<wbr>Http<wbr>Info</a> </li> <li class=" tsd-kind-method tsd-parent-kind-class tsd-is-private"> <a href="_lib_share_resource_parrotsaccountresource_.parrotsaccountresource.html#addingheaderrequestoptionsargs" class="tsd-kind-icon">adding<wbr>Header<wbr>Request<wbr>Options<wbr>Args</a> </li> <li class=" tsd-kind-method tsd-parent-kind-class"> <a href="_lib_share_resource_parrotsaccountresource_.parrotsaccountresource.html#changepassword" class="tsd-kind-icon">change<wbr>Password</a> </li> <li class=" tsd-kind-method tsd-parent-kind-class"> <a href="_lib_share_resource_parrotsaccountresource_.parrotsaccountresource.html#changepasswordwithhttpinfo" class="tsd-kind-icon">change<wbr>Password<wbr>With<wbr>Http<wbr>Info</a> </li> <li class=" tsd-kind-method tsd-parent-kind-class"> <a href="_lib_share_resource_parrotsaccountresource_.parrotsaccountresource.html#check" class="tsd-kind-icon">check</a> </li> <li class=" tsd-kind-method tsd-parent-kind-class"> <a href="_lib_share_resource_parrotsaccountresource_.parrotsaccountresource.html#checkwithhttpinfo" class="tsd-kind-icon">check<wbr>With<wbr>Http<wbr>Info</a> </li> <li class=" tsd-kind-method tsd-parent-kind-class"> <a href="_lib_share_resource_parrotsaccountresource_.parrotsaccountresource.html#createoauthwithhttpinfo" class="tsd-kind-icon">create<wbr>Oauth<wbr>With<wbr>Http<wbr>Info</a> </li> <li class=" tsd-kind-method tsd-parent-kind-class"> <a href="_lib_share_resource_parrotsaccountresource_.parrotsaccountresource.html#getaccountsinfo" class="tsd-kind-icon">get<wbr>Accounts<wbr>Info</a> </li> <li class=" tsd-kind-method tsd-parent-kind-class"> <a href="_lib_share_resource_parrotsaccountresource_.parrotsaccountresource.html#getaccountsinfos" class="tsd-kind-icon">get<wbr>Accounts<wbr>Infos</a> </li> <li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited"> <a href="_lib_share_resource_parrotsaccountresource_.parrotsaccountresource.html#getconnectionmanager" class="tsd-kind-icon">get<wbr>Connection<wbr>Manager</a> </li> <li class=" tsd-kind-method tsd-parent-kind-class"> <a href="_lib_share_resource_parrotsaccountresource_.parrotsaccountresource.html#loginwithhttpinfo" class="tsd-kind-icon">login<wbr>With<wbr>Http<wbr>Info</a> </li> <li class=" tsd-kind-method tsd-parent-kind-class"> <a href="_lib_share_resource_parrotsaccountresource_.parrotsaccountresource.html#oauthloginwithhttpinfo" class="tsd-kind-icon">oauth<wbr>Login<wbr>With<wbr>Http<wbr>Info</a> </li> <li class=" tsd-kind-method tsd-parent-kind-class"> <a href="_lib_share_resource_parrotsaccountresource_.parrotsaccountresource.html#register" class="tsd-kind-icon">register</a> </li> <li class=" tsd-kind-method tsd-parent-kind-class"> <a href="_lib_share_resource_parrotsaccountresource_.parrotsaccountresource.html#registerwithhttpinfo" class="tsd-kind-icon">register<wbr>With<wbr>Http<wbr>Info</a> </li> <li class=" tsd-kind-method tsd-parent-kind-class"> <a href="_lib_share_resource_parrotsaccountresource_.parrotsaccountresource.html#sendemailchangepassword" class="tsd-kind-icon">send<wbr>Email<wbr>Change<wbr>Password</a> </li> <li class=" tsd-kind-method tsd-parent-kind-class"> <a href="_lib_share_resource_parrotsaccountresource_.parrotsaccountresource.html#sendemailchangepasswordwithhttpinfo" class="tsd-kind-icon">send<wbr>Email<wbr>Change<wbr>Password<wbr>With<wbr>Http<wbr>Info</a> </li> <li class=" tsd-kind-method tsd-parent-kind-class"> <a href="_lib_share_resource_parrotsaccountresource_.parrotsaccountresource.html#sendemailvalidationaccount" class="tsd-kind-icon">send<wbr>Email<wbr>Validation<wbr>Account</a> </li> <li class=" tsd-kind-method tsd-parent-kind-class"> <a href="_lib_share_resource_parrotsaccountresource_.parrotsaccountresource.html#sendemailvalidationaccountwithhttpinfo" class="tsd-kind-icon">send<wbr>Email<wbr>Validation<wbr>Account<wbr>With<wbr>Http<wbr>Info</a> </li> <li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited"> <a href="_lib_share_resource_parrotsaccountresource_.parrotsaccountresource.html#setconnectionmanager" class="tsd-kind-icon">set<wbr>Connection<wbr>Manager</a> </li> </ul> </li> </ul> <ul class="after-current"> </ul> </nav> </div> </div> </div> <footer class="with-border-bottom"> <div class="container"> <h2>Legend</h2> <div class="tsd-legend-group"> <ul class="tsd-legend"> <li class="tsd-kind-module"><span class="tsd-kind-icon">Module</span></li> <li class="tsd-kind-object-literal"><span class="tsd-kind-icon">Object literal</span></li> <li class="tsd-kind-variable"><span class="tsd-kind-icon">Variable</span></li> <li class="tsd-kind-function"><span class="tsd-kind-icon">Function</span></li> <li class="tsd-kind-function tsd-has-type-parameter"><span class="tsd-kind-icon">Function with type parameter</span></li> <li class="tsd-kind-index-signature"><span class="tsd-kind-icon">Index signature</span></li> <li class="tsd-kind-type-alias"><span class="tsd-kind-icon">Type alias</span></li> </ul> <ul class="tsd-legend"> <li class="tsd-kind-enum"><span class="tsd-kind-icon">Enumeration</span></li> <li class="tsd-kind-enum-member"><span class="tsd-kind-icon">Enumeration member</span></li> <li class="tsd-kind-property tsd-parent-kind-enum"><span class="tsd-kind-icon">Property</span></li> <li class="tsd-kind-method tsd-parent-kind-enum"><span class="tsd-kind-icon">Method</span></li> </ul> <ul class="tsd-legend"> <li class="tsd-kind-interface"><span class="tsd-kind-icon">Interface</span></li> <li class="tsd-kind-interface tsd-has-type-parameter"><span class="tsd-kind-icon">Interface with type parameter</span></li> <li class="tsd-kind-constructor tsd-parent-kind-interface"><span class="tsd-kind-icon">Constructor</span></li> <li class="tsd-kind-p