lcars-library-node
Version:
NodeJS module for creating a library for the LCARS dashboard system
557 lines (355 loc) • 15.2 kB
HTML
<html lang="en">
<head>
<meta charset="utf-8">
<title>Session - 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>Session Class</h1>
<div class="box meta">
<div class="foundat">
Defined in: <a href="../files/library_connections_session.js.html#l5"><code>library\connections\session.js:5</code></a>
</div>
Module: <a href="../modules/Connections.html">Connections</a>
</div>
<div class="box intro">
<p>Representation of message access request to retrieve information
from the library and process any needed session information.</p>
</div>
<div class="constructor">
<h2>Constructor</h2>
<div id="method_Session" class="method item">
<h3 class="name"><code>Session</code></h3>
<div class="args">
<span class="paren">(</span><ul class="args-list inline commas">
<li class="arg">
<code>description</code>
</li>
<li class="arg">
<code>description</code>
</li>
</ul><span class="paren">)</span>
</div>
<div class="meta">
<p>
Defined in
<a href="../files/library_connections_session.js.html#l5"><code>library\connections\session.js:5</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">description</code>
<span class="type">Object</span>
<div class="param-description">
</div>
</li>
<li class="param">
<code class="param-name">description</code>
<span class="type">WebSocket | Socket | Request</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 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 properties">
<h3>Properties</h3>
<ul class="index-list properties">
<li class="index-item property">
<a href="#property_authenticated">authenticated</a>
</li>
<li class="index-item property">
<a href="#property_authenticator">authenticator</a>
</li>
<li class="index-item property">
<a href="#property_connected">connected</a>
</li>
<li class="index-item property">
<a href="#property_connector">connector</a>
</li>
<li class="index-item property">
<a href="#property_id">id</a>
</li>
<li class="index-item property">
<a href="#property_ips">ips</a>
</li>
<li class="index-item property">
<a href="#property_last">last</a>
</li>
<li class="index-item property">
<a href="#property_source">source</a>
</li>
<li class="index-item property deprecated">
<a href="#property_srcip">srcip</a>
<span class="flag deprecated">deprecated</span>
</li>
<li class="index-item property">
<a href="#property_user">user</a>
</li>
<li class="index-item property">
<a href="#property_username">username</a>
</li>
</ul>
</div>
</div>
<div id="properties" class="api-class-tabpanel">
<h2 class="off-left">Properties</h2>
<div id="property_authenticated" class="property item">
<h3 class="name"><code>authenticated</code></h3>
<span class="type">Number</span>
<div class="meta">
<p>
Defined in
<a href="../files/library_connections_session.js.html#l71"><code>library\connections\session.js:71</code></a>
</p>
</div>
<div class="description">
<p>When this session was established.</p>
</div>
</div>
<div id="property_authenticator" class="property item">
<h3 class="name"><code>authenticator</code></h3>
<span class="type">String</span>
<div class="meta">
<p>
Defined in
<a href="../files/library_connections_session.js.html#l78"><code>library\connections\session.js:78</code></a>
</p>
</div>
<div class="description">
<p>The String representing the code for this session.</p>
</div>
</div>
<div id="property_connected" class="property item">
<h3 class="name"><code>connected</code></h3>
<span class="type">String</span>
<div class="meta">
<p>
Defined in
<a href="../files/library_connections_session.js.html#l93"><code>library\connections\session.js:93</code></a>
</p>
</div>
<div class="description">
<p>When set, this names the Tower instance to which the user has an
active websocket.</p>
</div>
</div>
<div id="property_connector" class="property item">
<h3 class="name"><code>connector</code></h3>
<span class="type">String</span>
<div class="meta">
<p>
Defined in
<a href="../files/library_connections_session.js.html#l85"><code>library\connections\session.js:85</code></a>
</p>
</div>
<div class="description">
<p>String used for looking up this session that should be deleted
after fetch.</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_session.js.html#l31"><code>library\connections\session.js:31</code></a>
</p>
</div>
<div class="description">
</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_session.js.html#l56"><code>library\connections\session.js:56</code></a>
</p>
</div>
<div class="description">
<p>Tracks IP addresses seen inside this session</p>
</div>
</div>
<div id="property_last" class="property item">
<h3 class="name"><code>last</code></h3>
<span class="type">Number</span>
<div class="meta">
<p>
Defined in
<a href="../files/library_connections_session.js.html#l101"><code>library\connections\session.js:101</code></a>
</p>
</div>
<div class="description">
<p>The last time this session was used.</p>
</div>
</div>
<div id="property_source" class="property item">
<h3 class="name"><code>source</code></h3>
<span class="type">String</span>
<div class="meta">
<p>
Defined in
<a href="../files/library_connections_session.js.html#l63"><code>library\connections\session.js:63</code></a>
</p>
</div>
<div class="description">
<p>The passport request string that generated
this request.</p>
</div>
</div>
<div id="property_srcip" class="property item deprecated">
<h3 class="name"><code>srcip</code></h3>
<span class="type">String</span>
<span class="flag deprecated">deprecated</span>
<div class="meta">
<p>
Defined in
<a href="../files/library_connections_session.js.html#l45"><code>library\connections\session.js:45</code></a>
</p>
</div>
<div class="description">
<p>Due to the way passport processes requests, the source
IP isn't available at sign-in. Additionally, this field
is being moved to an array to track possible multitudes
of IP addresses.</p>
</div>
</div>
<div id="property_user" class="property item">
<h3 class="name"><code>user</code></h3>
<span class="type">String</span>
<div class="meta">
<p>
Defined in
<a href="../files/library_connections_session.js.html#l108"><code>library\connections\session.js:108</code></a>
</p>
</div>
<div class="description">
<p>The Refuge user id</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_session.js.html#l38"><code>library\connections\session.js:38</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>