UNPKG

blockstack

Version:

The Blockstack Javascript library for authentication, identity, and storage.

432 lines 23.5 kB
<!doctype html> <html class="default no-js"> <head> <meta charset="utf-8"> <meta http-equiv="X-UA-Compatible" content="IE=edge"> <title>SessionData | blockstack</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">blockstack</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-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="sessiondata.html">SessionData</a> </li> </ul> <h1>Class SessionData</h1> </div> </div> </header> <div class="container container-main"> <div class="row"> <div class="col-8 col-content"> <section class="tsd-panel tsd-hierarchy"> <h3>Hierarchy</h3> <ul class="tsd-hierarchy"> <li> <span class="target">SessionData</span> </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"><a href="sessiondata.html#constructor" class="tsd-kind-icon">constructor</a></li> </ul> </section> <section class="tsd-index-section "> <h3>Properties</h3> <ul class="tsd-index-list"> <li class="tsd-kind-property tsd-parent-kind-class"><a href="sessiondata.html#appprivatekey" class="tsd-kind-icon">app<wbr>Private<wbr>Key</a></li> <li class="tsd-kind-property tsd-parent-kind-class"><a href="sessiondata.html#corenode" class="tsd-kind-icon">core<wbr>Node</a></li> <li class="tsd-kind-property tsd-parent-kind-class"><a href="sessiondata.html#huburl" class="tsd-kind-icon">hub<wbr>Url</a></li> <li class="tsd-kind-property tsd-parent-kind-class"><a href="sessiondata.html#identityaddress" class="tsd-kind-icon">identity<wbr>Address</a></li> <li class="tsd-kind-property tsd-parent-kind-class"><a href="sessiondata.html#transitkey" class="tsd-kind-icon">transit<wbr>Key</a></li> <li class="tsd-kind-property tsd-parent-kind-class"><a href="sessiondata.html#userdata" class="tsd-kind-icon">user<wbr>Data</a></li> <li class="tsd-kind-property tsd-parent-kind-class"><a href="sessiondata.html#username" class="tsd-kind-icon">username</a></li> <li class="tsd-kind-property tsd-parent-kind-class"><a href="sessiondata.html#version" class="tsd-kind-icon">version</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="sessiondata.html#getgaiahubconfig" class="tsd-kind-icon">get<wbr>Gaia<wbr>Hub<wbr>Config</a></li> <li class="tsd-kind-method tsd-parent-kind-class"><a href="sessiondata.html#setgaiahubconfig" class="tsd-kind-icon">set<wbr>Gaia<wbr>Hub<wbr>Config</a></li> <li class="tsd-kind-method tsd-parent-kind-class"><a href="sessiondata.html#tostring" class="tsd-kind-icon">to<wbr>String</a></li> <li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><a href="sessiondata.html#fromjson" class="tsd-kind-icon">fromJSON</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"> <a name="constructor" class="tsd-anchor"></a> <h3>constructor</h3> <ul class="tsd-signatures tsd-kind-constructor tsd-parent-kind-class"> <li class="tsd-signature tsd-kind-icon">new <wbr>Session<wbr>Data<span class="tsd-signature-symbol">(</span>options<span class="tsd-signature-symbol">: </span><a href="../globals.html#sessionoptions" class="tsd-signature-type">SessionOptions</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="sessiondata.html" class="tsd-signature-type">SessionData</a></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/blockstack/blockstack.js/blob/master/src/auth/sessionData.ts#L39">auth/sessionData.ts:39</a></li> </ul> </aside> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5>options: <a href="../globals.html#sessionoptions" class="tsd-signature-type">SessionOptions</a></h5> </li> </ul> <h4 class="tsd-returns-title">Returns <a href="sessiondata.html" class="tsd-signature-type">SessionData</a></h4> </li> </ul> </section> </section> <section class="tsd-panel-group tsd-member-group "> <h2>Properties</h2> <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"> <a name="appprivatekey" class="tsd-anchor"></a> <h3><span class="tsd-flag ts-flagOptional">Optional</span> app<wbr>Private<wbr>Key</h3> <div class="tsd-signature tsd-kind-icon">app<wbr>Private<wbr>Key<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/blockstack/blockstack.js/blob/master/src/auth/sessionData.ts#L25">auth/sessionData.ts:25</a></li> </ul> </aside> </section> <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"> <a name="corenode" class="tsd-anchor"></a> <h3><span class="tsd-flag ts-flagOptional">Optional</span> core<wbr>Node</h3> <div class="tsd-signature tsd-kind-icon">core<wbr>Node<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/blockstack/blockstack.js/blob/master/src/auth/sessionData.ts#L31">auth/sessionData.ts:31</a></li> </ul> </aside> </section> <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"> <a name="huburl" class="tsd-anchor"></a> <h3><span class="tsd-flag ts-flagOptional">Optional</span> hub<wbr>Url</h3> <div class="tsd-signature tsd-kind-icon">hub<wbr>Url<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/blockstack/blockstack.js/blob/master/src/auth/sessionData.ts#L33">auth/sessionData.ts:33</a></li> </ul> </aside> </section> <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"> <a name="identityaddress" class="tsd-anchor"></a> <h3><span class="tsd-flag ts-flagOptional">Optional</span> identity<wbr>Address</h3> <div class="tsd-signature tsd-kind-icon">identity<wbr>Address<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/blockstack/blockstack.js/blob/master/src/auth/sessionData.ts#L27">auth/sessionData.ts:27</a></li> </ul> </aside> </section> <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"> <a name="transitkey" class="tsd-anchor"></a> <h3><span class="tsd-flag ts-flagOptional">Optional</span> transit<wbr>Key</h3> <div class="tsd-signature tsd-kind-icon">transit<wbr>Key<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/blockstack/blockstack.js/blob/master/src/auth/sessionData.ts#L35">auth/sessionData.ts:35</a></li> </ul> </aside> </section> <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"> <a name="userdata" class="tsd-anchor"></a> <h3><span class="tsd-flag ts-flagOptional">Optional</span> user<wbr>Data</h3> <div class="tsd-signature tsd-kind-icon">user<wbr>Data<span class="tsd-signature-symbol">:</span> <a href="../interfaces/userdata.html" class="tsd-signature-type">UserData</a></div> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/blockstack/blockstack.js/blob/master/src/auth/sessionData.ts#L39">auth/sessionData.ts:39</a></li> </ul> </aside> </section> <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"> <a name="username" class="tsd-anchor"></a> <h3><span class="tsd-flag ts-flagOptional">Optional</span> username</h3> <div class="tsd-signature tsd-kind-icon">username<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/blockstack/blockstack.js/blob/master/src/auth/sessionData.ts#L29">auth/sessionData.ts:29</a></li> </ul> </aside> </section> <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"> <a name="version" class="tsd-anchor"></a> <h3>version</h3> <div class="tsd-signature tsd-kind-icon">version<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/blockstack/blockstack.js/blob/master/src/auth/sessionData.ts#L23">auth/sessionData.ts:23</a></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="getgaiahubconfig" class="tsd-anchor"></a> <h3>get<wbr>Gaia<wbr>Hub<wbr>Config</h3> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"> <li class="tsd-signature tsd-kind-icon">get<wbr>Gaia<wbr>Hub<wbr>Config<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="../globals.html#gaiahubconfig" class="tsd-signature-type">GaiaHubConfig</a></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/blockstack/blockstack.js/blob/master/src/auth/sessionData.ts#L52">auth/sessionData.ts:52</a></li> </ul> </aside> <h4 class="tsd-returns-title">Returns <a href="../globals.html#gaiahubconfig" class="tsd-signature-type">GaiaHubConfig</a></h4> </li> </ul> </section> <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"> <a name="setgaiahubconfig" class="tsd-anchor"></a> <h3>set<wbr>Gaia<wbr>Hub<wbr>Config</h3> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"> <li class="tsd-signature tsd-kind-icon">set<wbr>Gaia<wbr>Hub<wbr>Config<span class="tsd-signature-symbol">(</span>config<span class="tsd-signature-symbol">: </span><a href="../globals.html#gaiahubconfig" class="tsd-signature-type">GaiaHubConfig</a><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 <a href="https://github.com/blockstack/blockstack.js/blob/master/src/auth/sessionData.ts#L56">auth/sessionData.ts:56</a></li> </ul> </aside> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5>config: <a href="../globals.html#gaiahubconfig" class="tsd-signature-type">GaiaHubConfig</a></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-class"> <a name="tostring" class="tsd-anchor"></a> <h3>to<wbr>String</h3> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"> <li class="tsd-signature tsd-kind-icon">to<wbr>String<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 <a href="https://github.com/blockstack/blockstack.js/blob/master/src/auth/sessionData.ts#L76">auth/sessionData.ts:76</a></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-class tsd-is-static"> <a name="fromjson" class="tsd-anchor"></a> <h3><span class="tsd-flag ts-flagStatic">Static</span> fromJSON</h3> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-static"> <li class="tsd-signature tsd-kind-icon">fromJSON<span class="tsd-signature-symbol">(</span>json<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><a href="sessiondata.html" class="tsd-signature-type">SessionData</a></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/blockstack/blockstack.js/blob/master/src/auth/sessionData.ts#L60">auth/sessionData.ts:60</a></li> </ul> </aside> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5>json: <span class="tsd-signature-type">any</span></h5> </li> </ul> <h4 class="tsd-returns-title">Returns <a href="sessiondata.html" class="tsd-signature-type">SessionData</a></h4> </li> </ul> </section> </section> </div> <div class="col-4 col-menu menu-sticky-wrap menu-highlight"> <nav class="tsd-navigation primary"> <ul> <li class="globals "> <a href="../globals.html"><em>Globals</em></a> </li> </ul> </nav> <nav class="tsd-navigation secondary menu-sticky"> <ul class="before-current"> </ul> <ul class="current"> <li class="current tsd-kind-class"> <a href="sessiondata.html" class="tsd-kind-icon">Session<wbr>Data</a> <ul> <li class=" tsd-kind-constructor tsd-parent-kind-class"> <a href="sessiondata.html#constructor" class="tsd-kind-icon">constructor</a> </li> <li class=" tsd-kind-property tsd-parent-kind-class"> <a href="sessiondata.html#appprivatekey" class="tsd-kind-icon">app<wbr>Private<wbr>Key</a> </li> <li class=" tsd-kind-property tsd-parent-kind-class"> <a href="sessiondata.html#corenode" class="tsd-kind-icon">core<wbr>Node</a> </li> <li class=" tsd-kind-property tsd-parent-kind-class"> <a href="sessiondata.html#huburl" class="tsd-kind-icon">hub<wbr>Url</a> </li> <li class=" tsd-kind-property tsd-parent-kind-class"> <a href="sessiondata.html#identityaddress" class="tsd-kind-icon">identity<wbr>Address</a> </li> <li class=" tsd-kind-property tsd-parent-kind-class"> <a href="sessiondata.html#transitkey" class="tsd-kind-icon">transit<wbr>Key</a> </li> <li class=" tsd-kind-property tsd-parent-kind-class"> <a href="sessiondata.html#userdata" class="tsd-kind-icon">user<wbr>Data</a> </li> <li class=" tsd-kind-property tsd-parent-kind-class"> <a href="sessiondata.html#username" class="tsd-kind-icon">username</a> </li> <li class=" tsd-kind-property tsd-parent-kind-class"> <a href="sessiondata.html#version" class="tsd-kind-icon">version</a> </li> <li class=" tsd-kind-method tsd-parent-kind-class"> <a href="sessiondata.html#getgaiahubconfig" class="tsd-kind-icon">get<wbr>Gaia<wbr>Hub<wbr>Config</a> </li> <li class=" tsd-kind-method tsd-parent-kind-class"> <a href="sessiondata.html#setgaiahubconfig" class="tsd-kind-icon">set<wbr>Gaia<wbr>Hub<wbr>Config</a> </li> <li class=" tsd-kind-method tsd-parent-kind-class"> <a href="sessiondata.html#tostring" class="tsd-kind-icon">to<wbr>String</a> </li> <li class=" tsd-kind-method tsd-parent-kind-class tsd-is-static"> <a href="sessiondata.html#fromjson" class="tsd-kind-icon">fromJSON</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-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li> <li class="tsd-kind-method tsd-parent-kind-interface"><span class="tsd-kind-icon">Method</span></li> <li class="tsd-kind-index-signature tsd-parent-kind-interface"><span class="tsd-kind-icon">Index signature</span></li> </ul> <ul class="tsd-legend"> <li class="tsd-kind-class"><span class="tsd-kind-icon">Class</span></li> <li class="tsd-kind-class tsd-has-type-parameter"><span class="tsd-kind-icon">Class with type parameter</span></li> <li class="tsd-kind-constructor tsd-parent-kind-class"><span class="tsd-kind-icon">Constructor</span></li> <li class="tsd-kind-property tsd-parent-kind-class"><span class="tsd-kind-icon">Property</span></li> <li class="tsd-kind-method tsd-parent-kind-class"><span class="tsd-kind-icon">Method</span></li> <li class="tsd-kind-accessor tsd-parent-kind-class"><span class="tsd-kind-icon">Accessor</span></li> <li class="tsd-kind-index-signature tsd-parent-kind-class"><span class="tsd-kind-icon">Index signature</span></li> </ul> <ul class="tsd-legend"> <li class="tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited constructor</span></li> <li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited property</span></li> <li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited method</span></li> <li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited accessor</span></li> </ul> <ul class="tsd-legend"> <li class="tsd-kind-property tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected property</span></li> <li class="tsd-kind-method tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected method</span></li> <li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected accessor</span></li> </ul> <ul class="tsd-legend"> <li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private property</span></li> <li class="tsd-kind-method tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private method</span></li> <li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private accessor</span></li> </ul> <ul class="tsd-legend"> <li class="tsd-kind-property tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static property</span></li> <li class="tsd-kind-call-signature tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static method</span></li> </ul> </div> </div> </footer> <div class="container tsd-generator"> <p>Generated using <a href="http://typedoc.org/" target="_blank">TypeDoc</a></p> </div> <div class="overlay"></div> <script src="../assets/js/main.js"></script> <script>if (location.protocol == 'file:') document.write('<script src="../assets/js/search.js"><' + '/script>');</script> </body> </html>