lcars-library-node
Version:
NodeJS module for creating a library for the LCARS dashboard system
744 lines (458 loc) • 18.9 kB
HTML
<html lang="en">
<head>
<meta charset="utf-8">
<title>User - lcars-library-node</title>
<link rel="stylesheet" href="http://yui.yahooapis.com/3.9.1/build/cssgrids/cssgrids-min.css">
<link rel="stylesheet" href="../assets/vendor/prettify/prettify-min.css">
<link rel="stylesheet" href="../assets/css/main.css" id="site_styles">
<link rel="icon" href="../assets/favicon.ico">
<script src="http://yui.yahooapis.com/combo?3.9.1/build/yui/yui-min.js"></script>
</head>
<body class="yui3-skin-sam">
<div id="doc">
<div id="hd" class="yui3-g header">
<div class="yui3-u-3-4">
<h1><img src="../assets/css/logo.png" title="lcars-library-node" width="117" height="52"></h1>
</div>
<div class="yui3-u-1-4 version">
<em>API Docs for: 0.0.0</em>
</div>
</div>
<div id="bd" class="yui3-g">
<div class="yui3-u-1-4">
<div id="docs-sidebar" class="sidebar apidocs">
<div id="api-list">
<h2 class="off-left">APIs</h2>
<div id="api-tabview" class="tabview">
<ul class="tabs">
<li><a href="#api-classes">Classes</a></li>
<li><a href="#api-modules">Modules</a></li>
</ul>
<div id="api-tabview-filter">
<input type="search" id="api-filter" placeholder="Type to filter APIs">
</div>
<div id="api-tabview-panel">
<ul id="api-classes" class="apis classes">
<li><a href="../classes/Circulation.html">Circulation</a></li>
<li><a href="../classes/Distress.html">Distress</a></li>
<li><a href="../classes/Edge.html">Edge</a></li>
<li><a href="../classes/Element.html">Element</a></li>
<li><a href="../classes/Event.html">Event</a></li>
<li><a href="../classes/Exception.html">Exception</a></li>
<li><a href="../classes/External.html">External</a></li>
<li><a href="../classes/LCARSLibrary.html">LCARSLibrary</a></li>
<li><a href="../classes/LCARSServer.html">LCARSServer</a></li>
<li><a href="../classes/Modification.html">Modification</a></li>
<li><a href="../classes/Random.html">Random</a></li>
<li><a href="../classes/Search.html">Search</a></li>
<li><a href="../classes/Session.html">Session</a></li>
<li><a href="../classes/Set.html">Set</a></li>
<li><a href="../classes/Storage.html">Storage</a></li>
<li><a href="../classes/Terminal.html">Terminal</a></li>
<li><a href="../classes/User.html">User</a></li>
</ul>
<ul id="api-modules" class="apis modules">
<li><a href="../modules/Connections.html">Connections</a></li>
<li><a href="../modules/Elements.html">Elements</a></li>
</ul>
</div>
</div>
</div>
</div>
</div>
<div class="yui3-u-3-4">
<div id="api-options">
Show:
<label for="api-show-inherited">
<input type="checkbox" id="api-show-inherited" checked>
Inherited
</label>
<label for="api-show-protected">
<input type="checkbox" id="api-show-protected">
Protected
</label>
<label for="api-show-private">
<input type="checkbox" id="api-show-private">
Private
</label>
<label for="api-show-deprecated">
<input type="checkbox" id="api-show-deprecated">
Deprecated
</label>
</div>
<div class="apidocs">
<div id="docs-main">
<div class="content">
<h1>User Class</h1>
<div class="box meta">
<div class="foundat">
Defined in: <a href="../files/library_connections_user.js.html#l7"><code>library\connections\user.js:7</code></a>
</div>
Module: <a href="../modules/Connections.html">Connections</a>
</div>
<div class="box intro">
</div>
<div class="constructor">
<h2>Constructor</h2>
<div id="method_User" class="method item">
<h3 class="name"><code>User</code></h3>
<div class="args">
<span class="paren">(</span><ul class="args-list inline commas">
<li class="arg">
<code>details</code>
</li>
</ul><span class="paren">)</span>
</div>
<div class="meta">
<p>
Defined in
<a href="../files/library_connections_user.js.html#l7"><code>library\connections\user.js:7</code></a>
</p>
</div>
<div class="description">
</div>
<div class="params">
<h4>Parameters:</h4>
<ul class="params-list">
<li class="param">
<code class="param-name">details</code>
<span class="type">Object</span>
<div class="param-description">
</div>
</li>
</ul>
</div>
</div>
</div>
<div id="classdocs" class="tabview">
<ul class="api-class-tabs">
<li class="api-class-tab index"><a href="#index">Index</a></li>
<li class="api-class-tab methods"><a href="#methods">Methods</a></li>
<li class="api-class-tab properties"><a href="#properties">Properties</a></li>
</ul>
<div>
<div id="index" class="api-class-tabpanel index">
<h2 class="off-left">Item Index</h2>
<div class="index-section methods">
<h3>Methods</h3>
<ul class="index-list methods">
<li class="index-item method private">
<a href="#method_userID">userID</a>
<span class="flag static">static</span>
</li>
</ul>
</div>
<div class="index-section properties">
<h3>Properties</h3>
<ul class="index-list properties">
<li class="index-item property">
<a href="#property_authorized">authorized</a>
</li>
<li class="index-item property">
<a href="#property_battlenet">battlenet</a>
</li>
<li class="index-item property">
<a href="#property_contact">contact</a>
</li>
<li class="index-item property">
<a href="#property_data">data</a>
</li>
<li class="index-item property">
<a href="#property_gmail">gmail</a>
</li>
<li class="index-item property">
<a href="#property_gmail">gmail</a>
</li>
<li class="index-item property">
<a href="#property_id">id</a>
</li>
<li class="index-item property">
<a href="#property_image">image</a>
</li>
<li class="index-item property">
<a href="#property_ips">ips</a>
</li>
<li class="index-item property">
<a href="#property_minecraft">minecraft</a>
</li>
<li class="index-item property">
<a href="#property_name">name</a>
</li>
<li class="index-item property">
<a href="#property_pvpnet">pvpnet</a>
</li>
<li class="index-item property">
<a href="#property_sessions">sessions</a>
</li>
<li class="index-item property">
<a href="#property_steam">steam</a>
</li>
<li class="index-item property">
<a href="#property_username">username</a>
</li>
<li class="index-item property">
<a href="#property_username">username</a>
</li>
</ul>
</div>
</div>
<div id="methods" class="api-class-tabpanel">
<h2 class="off-left">Methods</h2>
<div id="method_userID" class="method item private">
<h3 class="name"><code>userID</code></h3>
<span class="paren">()</span>
<span class="returns-inline">
<span class="type">String</span>
</span>
<span class="flag private">private</span>
<span class="flag static">static</span>
<div class="meta">
<p>
Defined in
<a href="../files/library_connections__user.js.html#l53"><code>library\connections\_user.js:53</code></a>
</p>
</div>
<div class="description">
<p>Return an identifier for a User.</p>
</div>
<div class="returns">
<h4>Returns:</h4>
<div class="returns-description">
<span class="type">String</span>:
<p>A string for identifying an event.</p>
</div>
</div>
</div>
</div>
<div id="properties" class="api-class-tabpanel">
<h2 class="off-left">Properties</h2>
<div id="property_authorized" class="property item">
<h3 class="name"><code>authorized</code></h3>
<span class="type">Object</span>
<div class="meta">
<p>
Defined in
<a href="../files/library_connections_user.js.html#l86"><code>library\connections\user.js:86</code></a>
</p>
</div>
<div class="description">
<p>Map of authorizations by grant for lookup. This is based on the
authorizations array and stored for debugging.</p>
</div>
</div>
<div id="property_battlenet" class="property item">
<h3 class="name"><code>battlenet</code></h3>
<span class="type">String</span>
<div class="meta">
<p>
Defined in
<a href="../files/library_connections_user.js.html#l67"><code>library\connections\user.js:67</code></a>
</p>
</div>
<div class="description">
<p>BattleNet Tag</p>
</div>
</div>
<div id="property_contact" class="property item">
<h3 class="name"><code>contact</code></h3>
<span class="type">String</span>
<div class="meta">
<p>
Defined in
<a href="../files/library_connections_user.js.html#l47"><code>library\connections\user.js:47</code></a>
</p>
</div>
<div class="description">
<p>Describes where to contact the user, type is prepended as
a protocol and is partially defined by parsing the contact
string for patterns.</p>
</div>
</div>
<div id="property_data" class="property item">
<h3 class="name"><code>data</code></h3>
<span class="type">Object</span>
<div class="meta">
<p>
Defined in
<a href="../files/library_connections__user.js.html#l31"><code>library\connections\_user.js:31</code></a>
</p>
</div>
<div class="description">
<p>Field values for arbitrary data.</p>
</div>
</div>
<div id="property_gmail" class="property item">
<h3 class="name"><code>gmail</code></h3>
<span class="type">String</span>
<div class="meta">
<p>
Defined in
<a href="../files/library_connections_user.js.html#l35"><code>library\connections\user.js:35</code></a>
</p>
</div>
<div class="description">
<p>User's GMail account for google auth.</p>
</div>
</div>
<div id="property_gmail" class="property item">
<h3 class="name"><code>gmail</code></h3>
<span class="type">String</span>
<div class="meta">
<p>
Defined in
<a href="../files/library_connections_user.js.html#l41"><code>library\connections\user.js:41</code></a>
</p>
</div>
<div class="description">
<p>User's eMail account for general correspondence.</p>
</div>
</div>
<div id="property_id" class="property item">
<h3 class="name"><code>id</code></h3>
<span class="type">String</span>
<div class="meta">
<p>
Defined in
<a href="../files/library_connections__user.js.html#l25"><code>library\connections\_user.js:25</code></a>
</p>
</div>
<div class="description">
</div>
</div>
<div id="property_image" class="property item">
<h3 class="name"><code>image</code></h3>
<span class="type">String</span>
<div class="meta">
<p>
Defined in
<a href="../files/library_connections_user.js.html#l23"><code>library\connections\user.js:23</code></a>
</p>
</div>
<div class="description">
<p>URL of profile picture</p>
</div>
</div>
<div id="property_ips" class="property item">
<h3 class="name"><code>ips</code></h3>
<span class="type">String</span>
<div class="meta">
<p>
Defined in
<a href="../files/library_connections_user.js.html#l100"><code>library\connections\user.js:100</code></a>
</p>
</div>
<div class="description">
<p>List of seen IPs for security purposes.</p>
</div>
</div>
<div id="property_minecraft" class="property item">
<h3 class="name"><code>minecraft</code></h3>
<span class="type">String</span>
<div class="meta">
<p>
Defined in
<a href="../files/library_connections_user.js.html#l55"><code>library\connections\user.js:55</code></a>
</p>
</div>
<div class="description">
<p>The minecraft user for this user</p>
</div>
</div>
<div id="property_name" class="property item">
<h3 class="name"><code>name</code></h3>
<span class="type">String</span>
<div class="meta">
<p>
Defined in
<a href="../files/library_connections_user.js.html#l17"><code>library\connections\user.js:17</code></a>
</p>
</div>
<div class="description">
<p>Full name of user</p>
</div>
</div>
<div id="property_pvpnet" class="property item">
<h3 class="name"><code>pvpnet</code></h3>
<span class="type">String</span>
<div class="meta">
<p>
Defined in
<a href="../files/library_connections_user.js.html#l73"><code>library\connections\user.js:73</code></a>
</p>
</div>
<div class="description">
<p>League of Legends Main</p>
</div>
</div>
<div id="property_sessions" class="property item">
<h3 class="name"><code>sessions</code></h3>
<span class="type">String</span>
<div class="meta">
<p>
Defined in
<a href="../files/library_connections_user.js.html#l93"><code>library\connections\user.js:93</code></a>
</p>
</div>
<div class="description">
<p>String array of session ObjectId's (This prevents
other sessions from being exposed in links).</p>
</div>
</div>
<div id="property_steam" class="property item">
<h3 class="name"><code>steam</code></h3>
<span class="type">String</span>
<div class="meta">
<p>
Defined in
<a href="../files/library_connections_user.js.html#l61"><code>library\connections\user.js:61</code></a>
</p>
</div>
<div class="description">
<p>The steam user for this user</p>
</div>
</div>
<div id="property_username" class="property item">
<h3 class="name"><code>username</code></h3>
<span class="type">String</span>
<div class="meta">
<p>
Defined in
<a href="../files/library_connections_user.js.html#l29"><code>library\connections\user.js:29</code></a>
</p>
</div>
<div class="description">
<p>User's username.</p>
</div>
</div>
<div id="property_username" class="property item">
<h3 class="name"><code>username</code></h3>
<span class="type">String</span>
<div class="meta">
<p>
Defined in
<a href="../files/library_connections__user.js.html#l19"><code>library\connections\_user.js:19</code></a>
</p>
</div>
<div class="description">
</div>
</div>
</div>
</div>
</div>
</div>
</div>
</div>
</div>
</div>
</div>
<script src="../assets/vendor/prettify/prettify-min.js"></script>
<script>prettyPrint();</script>
<script src="../assets/js/yui-prettify.js"></script>
<script src="../assets/../api.js"></script>
<script src="../assets/js/api-filter.js"></script>
<script src="../assets/js/api-list.js"></script>
<script src="../assets/js/api-search.js"></script>
<script src="../assets/js/apidocs.js"></script>
</body>
</html>