cv-dialog-sdk
Version:
Catavolt Dialog Javascript API
371 lines • 20.1 kB
HTML
<html class="default no-js">
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<title>Session | cv-dialog-sdk</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">cv-dialog-sdk</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/_models_session_.html">"models/Session"</a>
</li>
<li>
<a href="_models_session_.session.html">Session</a>
</li>
</ul>
<h1>Interface Session</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">Session</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>Properties</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="_models_session_.session.html#appvendors" class="tsd-kind-icon">app<wbr>Vendors</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="_models_session_.session.html#appversion" class="tsd-kind-icon">app<wbr>Version</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="_models_session_.session.html#appwindow" class="tsd-kind-icon">app<wbr>Window</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="_models_session_.session.html#currentdivision" class="tsd-kind-icon">current<wbr>Division</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="_models_session_.session.html#id" class="tsd-kind-icon">id</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="_models_session_.session.html#serverassignment" class="tsd-kind-icon">server<wbr>Assignment</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="_models_session_.session.html#serverversion" class="tsd-kind-icon">server<wbr>Version</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="_models_session_.session.html#tenantid" class="tsd-kind-icon">tenant<wbr>Id</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="_models_session_.session.html#tenantproperties" class="tsd-kind-icon">tenant<wbr>Properties</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="_models_session_.session.html#type" class="tsd-kind-icon">type</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="_models_session_.session.html#userid" class="tsd-kind-icon">user<wbr>Id</a></li>
</ul>
</section>
</div>
</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-interface">
<a name="appvendors" class="tsd-anchor"></a>
<h3>app<wbr>Vendors</h3>
<div class="tsd-signature tsd-kind-icon">app<wbr>Vendors<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">ReadonlyArray</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">></span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/catavolt-oss/cv-dialog-sdk/blob/ba57488/src/catavolt/models/Session.ts#L5">models/Session.ts:5</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="appversion" class="tsd-anchor"></a>
<h3>app<wbr>Version</h3>
<div class="tsd-signature tsd-kind-icon">app<wbr>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/catavolt-oss/cv-dialog-sdk/blob/ba57488/src/catavolt/models/Session.ts#L9">models/Session.ts:9</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Current version of the underlying application (business) logic. This is not the middleware version.</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="appwindow" class="tsd-anchor"></a>
<h3>app<wbr>Window</h3>
<div class="tsd-signature tsd-kind-icon">app<wbr>Window<span class="tsd-signature-symbol">:</span> <a href="_models_appwindow_.appwindow.html" class="tsd-signature-type">AppWindow</a></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/catavolt-oss/cv-dialog-sdk/blob/ba57488/src/catavolt/models/Session.ts#L10">models/Session.ts:10</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="currentdivision" class="tsd-anchor"></a>
<h3>current<wbr>Division</h3>
<div class="tsd-signature tsd-kind-icon">current<wbr>Division<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/catavolt-oss/cv-dialog-sdk/blob/ba57488/src/catavolt/models/Session.ts#L15">models/Session.ts:15</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Current division is analagous to a "sub-tenant" and it's possible for users to tailor different desktops based
on their division.</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="id" class="tsd-anchor"></a>
<h3>id</h3>
<div class="tsd-signature tsd-kind-icon">id<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/catavolt-oss/cv-dialog-sdk/blob/ba57488/src/catavolt/models/Session.ts#L16">models/Session.ts:16</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="serverassignment" class="tsd-anchor"></a>
<h3>server<wbr>Assignment</h3>
<div class="tsd-signature tsd-kind-icon">server<wbr>Assignment<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/catavolt-oss/cv-dialog-sdk/blob/ba57488/src/catavolt/models/Session.ts#L22">models/Session.ts:22</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>The dialog layer interacts with an application endpoint, transparent to the user interface. The serverAssignment
is not used by the user interface directly, but this value can be useful when diagnosing problems.</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="serverversion" class="tsd-anchor"></a>
<h3>server<wbr>Version</h3>
<div class="tsd-signature tsd-kind-icon">server<wbr>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/catavolt-oss/cv-dialog-sdk/blob/ba57488/src/catavolt/models/Session.ts#L26">models/Session.ts:26</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Current version of the underlying middleware (not the application logic)</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="tenantid" class="tsd-anchor"></a>
<h3>tenant<wbr>Id</h3>
<div class="tsd-signature tsd-kind-icon">tenant<wbr>Id<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/catavolt-oss/cv-dialog-sdk/blob/ba57488/src/catavolt/models/Session.ts#L17">models/Session.ts:17</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="tenantproperties" class="tsd-anchor"></a>
<h3>tenant<wbr>Properties</h3>
<div class="tsd-signature tsd-kind-icon">tenant<wbr>Properties<span class="tsd-signature-symbol">:</span> <a href="_util_stringdictionary_.stringdictionary.html" class="tsd-signature-type">StringDictionary</a></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/catavolt-oss/cv-dialog-sdk/blob/ba57488/src/catavolt/models/Session.ts#L31">models/Session.ts:31</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>The tenantProperties object is arbitrary, its values are dynamically defined and it is used to return
tenant-specific values to the requesting client.</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="type" class="tsd-anchor"></a>
<h3>type</h3>
<div class="tsd-signature tsd-kind-icon">type<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/catavolt-oss/cv-dialog-sdk/blob/ba57488/src/catavolt/models/Session.ts#L33">models/Session.ts:33</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="userid" class="tsd-anchor"></a>
<h3>user<wbr>Id</h3>
<div class="tsd-signature tsd-kind-icon">user<wbr>Id<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/catavolt-oss/cv-dialog-sdk/blob/ba57488/src/catavolt/models/Session.ts#L35">models/Session.ts:35</a></li>
</ul>
</aside>
</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/_models_session_.html">"models/<wbr>Session"</a>
</li>
</ul>
</nav>
<nav class="tsd-navigation secondary menu-sticky">
<ul class="before-current">
</ul>
<ul class="current">
<li class="current tsd-kind-interface tsd-parent-kind-external-module">
<a href="_models_session_.session.html" class="tsd-kind-icon">Session</a>
<ul>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="_models_session_.session.html#appvendors" class="tsd-kind-icon">app<wbr>Vendors</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="_models_session_.session.html#appversion" class="tsd-kind-icon">app<wbr>Version</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="_models_session_.session.html#appwindow" class="tsd-kind-icon">app<wbr>Window</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="_models_session_.session.html#currentdivision" class="tsd-kind-icon">current<wbr>Division</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="_models_session_.session.html#id" class="tsd-kind-icon">id</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="_models_session_.session.html#serverassignment" class="tsd-kind-icon">server<wbr>Assignment</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="_models_session_.session.html#serverversion" class="tsd-kind-icon">server<wbr>Version</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="_models_session_.session.html#tenantid" class="tsd-kind-icon">tenant<wbr>Id</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="_models_session_.session.html#tenantproperties" class="tsd-kind-icon">tenant<wbr>Properties</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="_models_session_.session.html#type" class="tsd-kind-icon">type</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="_models_session_.session.html#userid" class="tsd-kind-icon">user<wbr>Id</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>