cv-dialog-sdk
Version:
Catavolt Dialog Javascript API
786 lines • 109 kB
HTML
<!doctype html>
<html class="default no-js">
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<title>CatavoltApiImpl | 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/_dialog_catavolt_.html">"dialog/Catavolt"</a>
</li>
<li>
<a href="_dialog_catavolt_.catavoltapiimpl.html">CatavoltApiImpl</a>
</li>
</ul>
<h1>Class CatavoltApiImpl</h1>
</div>
</div>
</header>
<div class="container container-main">
<div class="row">
<div class="col-8 col-content">
<section class="tsd-panel tsd-comment">
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Top-level entry point into the Catavolt API</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-hierarchy">
<h3>Hierarchy</h3>
<ul class="tsd-hierarchy">
<li>
<span class="target">CatavoltApiImpl</span>
</li>
</ul>
</section>
<section class="tsd-panel">
<h3>Implements</h3>
<ul class="tsd-hierarchy">
<li><a href="../interfaces/_dialog_catavoltapi_.catavoltapi.html" class="tsd-signature-type">CatavoltApi</a></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 tsd-is-private tsd-is-private-protected">
<h3>Constructors</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-constructor tsd-parent-kind-class tsd-is-private"><a href="_dialog_catavolt_.catavoltapiimpl.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="_dialog_catavolt_.catavoltapiimpl.html#default_locale" class="tsd-kind-icon">DEFAULT_<wbr>LOCALE</a></li>
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><a href="_dialog_catavolt_.catavoltapiimpl.html#_devicepropsdynamic" class="tsd-kind-icon">_device<wbr>Props<wbr>Dynamic</a></li>
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><a href="_dialog_catavolt_.catavoltapiimpl.html#_devicepropsstatic" class="tsd-kind-icon">_device<wbr>Props<wbr>Static</a></li>
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><a href="_dialog_catavolt_.catavoltapiimpl.html#_dialogapi" class="tsd-kind-icon">_dialog<wbr>Api</a></li>
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><a href="_dialog_catavolt_.catavoltapiimpl.html#_locale" class="tsd-kind-icon">_locale</a></li>
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><a href="_dialog_catavolt_.catavoltapiimpl.html#_onsessionexpiration" class="tsd-kind-icon">_on<wbr>Session<wbr>Expiration</a></li>
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><a href="_dialog_catavolt_.catavoltapiimpl.html#_session" class="tsd-kind-icon">_session</a></li>
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><a href="_dialog_catavolt_.catavoltapiimpl.html#_sessiontimer" class="tsd-kind-icon">_session<wbr>Timer</a></li>
<li class="tsd-kind-property tsd-parent-kind-class"><a href="_dialog_catavolt_.catavoltapiimpl.html#datalastchangedtime" class="tsd-kind-icon">data<wbr>Last<wbr>Changed<wbr>Time</a></li>
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-private tsd-is-static"><a href="_dialog_catavolt_.catavoltapiimpl.html#check_session_interval_millis" class="tsd-kind-icon">CHECK_<wbr>SESSION_<wbr>INTERVAL_<wbr>MILLIS</a></li>
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-private tsd-is-static"><a href="_dialog_catavolt_.catavoltapiimpl.html#one_hour_in_millis" class="tsd-kind-icon">ONE_<wbr>HOUR_<wbr>IN_<wbr>MILLIS</a></li>
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-private tsd-is-static"><a href="_dialog_catavolt_.catavoltapiimpl.html#server_url" class="tsd-kind-icon">SERVER_<wbr>URL</a></li>
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-private tsd-is-static"><a href="_dialog_catavolt_.catavoltapiimpl.html#server_version" class="tsd-kind-icon">SERVER_<wbr>VERSION</a></li>
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-private tsd-is-static"><a href="_dialog_catavolt_.catavoltapiimpl.html#_singleton" class="tsd-kind-icon">_singleton</a></li>
</ul>
</section>
<section class="tsd-index-section ">
<h3>Accessors</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-get-signature tsd-parent-kind-class"><a href="_dialog_catavolt_.catavoltapiimpl.html#clienttimeoutmillis" class="tsd-kind-icon">client<wbr>Timeout<wbr>Millis</a></li>
<li class="tsd-kind-get-signature tsd-parent-kind-class"><a href="_dialog_catavolt_.catavoltapiimpl.html#currencysymbol" class="tsd-kind-icon">currency<wbr>Symbol</a></li>
<li class="tsd-kind-get-signature tsd-parent-kind-class"><a href="_dialog_catavolt_.catavoltapiimpl.html#deviceprops" class="tsd-kind-icon">device<wbr>Props</a></li>
<li class="tsd-kind-get-signature tsd-parent-kind-class"><a href="_dialog_catavolt_.catavoltapiimpl.html#dialogapi" class="tsd-kind-icon">dialog<wbr>Api</a></li>
<li class="tsd-kind-get-signature tsd-parent-kind-class"><a href="_dialog_catavolt_.catavoltapiimpl.html#isloggedin" class="tsd-kind-icon">is<wbr>Logged<wbr>In</a></li>
<li class="tsd-kind-accessor tsd-parent-kind-class"><a href="_dialog_catavolt_.catavoltapiimpl.html#locale" class="tsd-kind-icon">locale</a></li>
<li class="tsd-kind-set-signature tsd-parent-kind-class"><a href="_dialog_catavolt_.catavoltapiimpl.html#onsessionexpiration" class="tsd-kind-icon">on<wbr>Session<wbr>Expiration</a></li>
<li class="tsd-kind-get-signature tsd-parent-kind-class"><a href="_dialog_catavolt_.catavoltapiimpl.html#remainingsessiontime" class="tsd-kind-icon">remaining<wbr>Session<wbr>Time</a></li>
<li class="tsd-kind-get-signature tsd-parent-kind-class"><a href="_dialog_catavolt_.catavoltapiimpl.html#session" class="tsd-kind-icon">session</a></li>
<li class="tsd-kind-get-signature tsd-parent-kind-class"><a href="_dialog_catavolt_.catavoltapiimpl.html#sessionhasexpired" class="tsd-kind-icon">session<wbr>Has<wbr>Expired</a></li>
<li class="tsd-kind-get-signature tsd-parent-kind-class tsd-is-static"><a href="_dialog_catavolt_.catavoltapiimpl.html#defaultttlinmillis" class="tsd-kind-icon">defaultTTLIn<wbr>Millis</a></li>
<li class="tsd-kind-get-signature tsd-parent-kind-class tsd-is-static"><a href="_dialog_catavolt_.catavoltapiimpl.html#singleton" class="tsd-kind-icon">singleton</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="_dialog_catavolt_.catavoltapiimpl.html#addclientlistener" class="tsd-kind-icon">add<wbr>Client<wbr>Listener</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="_dialog_catavolt_.catavoltapiimpl.html#adddynamicdeviceprop" class="tsd-kind-icon">add<wbr>Dynamic<wbr>Device<wbr>Prop</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="_dialog_catavolt_.catavoltapiimpl.html#addstaticdeviceprop" class="tsd-kind-icon">add<wbr>Static<wbr>Device<wbr>Prop</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="_dialog_catavolt_.catavoltapiimpl.html#changepasswordandlogin" class="tsd-kind-icon">change<wbr>Password<wbr>And<wbr>Login</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="_dialog_catavolt_.catavoltapiimpl.html#getredirection" class="tsd-kind-icon">get<wbr>Redirection</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="_dialog_catavolt_.catavoltapiimpl.html#initdialogapi" class="tsd-kind-icon">init<wbr>Dialog<wbr>Api</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="_dialog_catavolt_.catavoltapiimpl.html#isanyuserinbriefcasemode" class="tsd-kind-icon">is<wbr>Any<wbr>User<wbr>InBriefcase<wbr>Mode</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="_dialog_catavolt_.catavoltapiimpl.html#isfeaturesetavailable" class="tsd-kind-icon">is<wbr>Feature<wbr>Set<wbr>Available</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="_dialog_catavolt_.catavoltapiimpl.html#isuserinbriefcasemode" class="tsd-kind-icon">is<wbr>User<wbr>InBriefcase<wbr>Mode</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="_dialog_catavolt_.catavoltapiimpl.html#login" class="tsd-kind-icon">login</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="_dialog_catavolt_.catavoltapiimpl.html#loginwithtoken" class="tsd-kind-icon">login<wbr>With<wbr>Token</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="_dialog_catavolt_.catavoltapiimpl.html#logout" class="tsd-kind-icon">logout</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="_dialog_catavolt_.catavoltapiimpl.html#opendialog" class="tsd-kind-icon">open<wbr>Dialog</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="_dialog_catavolt_.catavoltapiimpl.html#opendialogwithid" class="tsd-kind-icon">open<wbr>Dialog<wbr>With<wbr>Id</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="_dialog_catavolt_.catavoltapiimpl.html#openstream" class="tsd-kind-icon">open<wbr>Stream</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="_dialog_catavolt_.catavoltapiimpl.html#performworkbenchaction" class="tsd-kind-icon">perform<wbr>Workbench<wbr>Action</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="_dialog_catavolt_.catavoltapiimpl.html#performworkbenchactionforid" class="tsd-kind-icon">perform<wbr>Workbench<wbr>Action<wbr>For<wbr>Id</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-private"><a href="_dialog_catavolt_.catavoltapiimpl.html#processlogin" class="tsd-kind-icon">process<wbr>Login</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="_dialog_catavolt_.catavoltapiimpl.html#refreshsession" class="tsd-kind-icon">refresh<wbr>Session</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="_dialog_catavolt_.catavoltapiimpl.html#removeclientlistener" class="tsd-kind-icon">remove<wbr>Client<wbr>Listener</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="_dialog_catavolt_.catavoltapiimpl.html#streamcontent" class="tsd-kind-icon">stream<wbr>Content</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="_dialog_catavolt_.catavoltapiimpl.html#todialogorredirection" class="tsd-kind-icon">to<wbr>Dialog<wbr>OrRedirection</a></li>
</ul>
</section>
</div>
</section>
</section>
<section class="tsd-panel-group tsd-member-group tsd-is-private tsd-is-private-protected">
<h2>Constructors</h2>
<section class="tsd-panel tsd-member tsd-kind-constructor tsd-parent-kind-class tsd-is-private">
<a name="constructor" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagPrivate">Private</span> constructor</h3>
<ul class="tsd-signatures tsd-kind-constructor tsd-parent-kind-class tsd-is-private">
<li class="tsd-signature tsd-kind-icon">new <wbr>Catavolt<wbr>Api<wbr>Impl<span class="tsd-signature-symbol">(</span>serverUrl<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, serverVersion<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><a href="_dialog_catavolt_.catavoltapiimpl.html" class="tsd-signature-type">CatavoltApiImpl</a></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/catavolt-oss/cv-dialog-sdk/blob/ba57488/src/catavolt/dialog/Catavolt.ts#L76">dialog/Catavolt.ts:76</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Construct an CatavoltApiImpl
This should not be called directly, instead use the 'singleton' method</p>
</div>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>serverUrl: <span class="tsd-signature-type">string</span></h5>
</li>
<li>
<h5>serverVersion: <span class="tsd-signature-type">string</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <a href="_dialog_catavolt_.catavoltapiimpl.html" class="tsd-signature-type">CatavoltApiImpl</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="default_locale" class="tsd-anchor"></a>
<h3>DEFAULT_<wbr>LOCALE</h3>
<div class="tsd-signature tsd-kind-icon">DEFAULT_<wbr>LOCALE<span class="tsd-signature-symbol">:</span> <a href="_util_cvlocale_.cvlocale.html" class="tsd-signature-type">CvLocale</a><span class="tsd-signature-symbol"> = new CvLocale('en')</span></div>
<aside class="tsd-sources">
<p>Implementation of <a href="../interfaces/_dialog_catavoltapi_.catavoltapi.html">CatavoltApi</a>.<a href="../interfaces/_dialog_catavoltapi_.catavoltapi.html#default_locale">DEFAULT_LOCALE</a></p>
<ul>
<li>Defined in <a href="https://github.com/catavolt-oss/cv-dialog-sdk/blob/ba57488/src/catavolt/dialog/Catavolt.ts#L41">dialog/Catavolt.ts:41</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-private">
<a name="_devicepropsdynamic" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagPrivate">Private</span> _device<wbr>Props<wbr>Dynamic</h3>
<div class="tsd-signature tsd-kind-icon">_device<wbr>Props<wbr>Dynamic<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">object</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/catavolt-oss/cv-dialog-sdk/blob/ba57488/src/catavolt/dialog/Catavolt.ts#L46">dialog/Catavolt.ts:46</a></li>
</ul>
</aside>
<div class="tsd-type-declaration">
<h4>Type declaration</h4>
<ul class="tsd-parameters">
<li class="tsd-parameter-index-signature">
<h5><span class="tsd-signature-symbol">[</span>index: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">]: </span><span class="tsd-signature-type">function</span></h5>
<ul class="tsd-parameters">
<li class="tsd-parameter-siganture">
<ul class="tsd-signatures tsd-kind-type-literal tsd-is-not-exported">
<li class="tsd-signature tsd-kind-icon"><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">
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-private">
<a name="_devicepropsstatic" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagPrivate">Private</span> _device<wbr>Props<wbr>Static</h3>
<div class="tsd-signature tsd-kind-icon">_device<wbr>Props<wbr>Static<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">object</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/catavolt-oss/cv-dialog-sdk/blob/ba57488/src/catavolt/dialog/Catavolt.ts#L47">dialog/Catavolt.ts:47</a></li>
</ul>
</aside>
<div class="tsd-type-declaration">
<h4>Type declaration</h4>
<ul class="tsd-parameters">
<li class="tsd-parameter-index-signature">
<h5><span class="tsd-signature-symbol">[</span>index: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">]: </span><span class="tsd-signature-type">string</span></h5>
</li>
</ul>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-private">
<a name="_dialogapi" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagPrivate">Private</span> _dialog<wbr>Api</h3>
<div class="tsd-signature tsd-kind-icon">_dialog<wbr>Api<span class="tsd-signature-symbol">:</span> <a href="../interfaces/_dialog_dialogapi_.dialogapi.html" class="tsd-signature-type">DialogApi</a></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/catavolt-oss/cv-dialog-sdk/blob/ba57488/src/catavolt/dialog/Catavolt.ts#L44">dialog/Catavolt.ts:44</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-private">
<a name="_locale" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagPrivate">Private</span> _locale</h3>
<div class="tsd-signature tsd-kind-icon">_locale<span class="tsd-signature-symbol">:</span> <a href="_util_cvlocale_.cvlocale.html" class="tsd-signature-type">CvLocale</a><span class="tsd-signature-symbol"> = null</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/catavolt-oss/cv-dialog-sdk/blob/ba57488/src/catavolt/dialog/Catavolt.ts#L48">dialog/Catavolt.ts:48</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-private">
<a name="_onsessionexpiration" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagPrivate">Private</span> _on<wbr>Session<wbr>Expiration</h3>
<div class="tsd-signature tsd-kind-icon">_on<wbr>Session<wbr>Expiration<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol"> = null</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/catavolt-oss/cv-dialog-sdk/blob/ba57488/src/catavolt/dialog/Catavolt.ts#L50">dialog/Catavolt.ts:50</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-private">
<a name="_session" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagPrivate">Private</span> _session</h3>
<div class="tsd-signature tsd-kind-icon">_session<span class="tsd-signature-symbol">:</span> <a href="../interfaces/_models_session_.session.html" class="tsd-signature-type">Session</a></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/catavolt-oss/cv-dialog-sdk/blob/ba57488/src/catavolt/dialog/Catavolt.ts#L45">dialog/Catavolt.ts:45</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-private">
<a name="_sessiontimer" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagPrivate">Private</span> _session<wbr>Timer</h3>
<div class="tsd-signature tsd-kind-icon">_session<wbr>Timer<span class="tsd-signature-symbol">:</span> <a href="_util_sessiontimer_.sessiontimer.html" class="tsd-signature-type">SessionTimer</a><span class="tsd-signature-symbol"> = null</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/catavolt-oss/cv-dialog-sdk/blob/ba57488/src/catavolt/dialog/Catavolt.ts#L49">dialog/Catavolt.ts:49</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class">
<a name="datalastchangedtime" class="tsd-anchor"></a>
<h3>data<wbr>Last<wbr>Changed<wbr>Time</h3>
<div class="tsd-signature tsd-kind-icon">data<wbr>Last<wbr>Changed<wbr>Time<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Date</span><span class="tsd-signature-symbol"> = new Date()</span></div>
<aside class="tsd-sources">
<p>Implementation of <a href="../interfaces/_dialog_catavoltapi_.catavoltapi.html">CatavoltApi</a>.<a href="../interfaces/_dialog_catavoltapi_.catavoltapi.html#datalastchangedtime">dataLastChangedTime</a></p>
<ul>
<li>Defined in <a href="https://github.com/catavolt-oss/cv-dialog-sdk/blob/ba57488/src/catavolt/dialog/Catavolt.ts#L43">dialog/Catavolt.ts:43</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-private tsd-is-static">
<a name="check_session_interval_millis" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagStatic">Static</span> <span class="tsd-flag ts-flagPrivate">Private</span> CHECK_<wbr>SESSION_<wbr>INTERVAL_<wbr>MILLIS</h3>
<div class="tsd-signature tsd-kind-icon">CHECK_<wbr>SESSION_<wbr>INTERVAL_<wbr>MILLIS<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> = 30 * 1000</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/catavolt-oss/cv-dialog-sdk/blob/ba57488/src/catavolt/dialog/Catavolt.ts#L36">dialog/Catavolt.ts:36</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-private tsd-is-static">
<a name="one_hour_in_millis" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagStatic">Static</span> <span class="tsd-flag ts-flagPrivate">Private</span> ONE_<wbr>HOUR_<wbr>IN_<wbr>MILLIS</h3>
<div class="tsd-signature tsd-kind-icon">ONE_<wbr>HOUR_<wbr>IN_<wbr>MILLIS<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> = 60 * 60 * 1000</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/catavolt-oss/cv-dialog-sdk/blob/ba57488/src/catavolt/dialog/Catavolt.ts#L35">dialog/Catavolt.ts:35</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-private tsd-is-static">
<a name="server_url" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagStatic">Static</span> <span class="tsd-flag ts-flagPrivate">Private</span> SERVER_<wbr>URL</h3>
<div class="tsd-signature tsd-kind-icon">SERVER_<wbr>URL<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> = "https://dialog.hxgn-api.net"</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/catavolt-oss/cv-dialog-sdk/blob/ba57488/src/catavolt/dialog/Catavolt.ts#L38">dialog/Catavolt.ts:38</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-private tsd-is-static">
<a name="server_version" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagStatic">Static</span> <span class="tsd-flag ts-flagPrivate">Private</span> 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><span class="tsd-signature-symbol"> = "v0"</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/catavolt-oss/cv-dialog-sdk/blob/ba57488/src/catavolt/dialog/Catavolt.ts#L39">dialog/Catavolt.ts:39</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-private tsd-is-static">
<a name="_singleton" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagStatic">Static</span> <span class="tsd-flag ts-flagPrivate">Private</span> _singleton</h3>
<div class="tsd-signature tsd-kind-icon">_singleton<span class="tsd-signature-symbol">:</span> <a href="_dialog_catavolt_.catavoltapiimpl.html" class="tsd-signature-type">CatavoltApiImpl</a></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/catavolt-oss/cv-dialog-sdk/blob/ba57488/src/catavolt/dialog/Catavolt.ts#L33">dialog/Catavolt.ts:33</a></li>
</ul>
</aside>
</section>
</section>
<section class="tsd-panel-group tsd-member-group ">
<h2>Accessors</h2>
<section class="tsd-panel tsd-member tsd-kind-get-signature tsd-parent-kind-class">
<a name="clienttimeoutmillis" class="tsd-anchor"></a>
<h3>client<wbr>Timeout<wbr>Millis</h3>
<ul class="tsd-signatures tsd-kind-get-signature tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">get</span> clientTimeoutMillis<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/catavolt-oss/cv-dialog-sdk/blob/ba57488/src/catavolt/dialog/Catavolt.ts#L178">dialog/Catavolt.ts:178</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Get the number of millis that the client will remain active between calls
to the server.</p>
</div>
</div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">number</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-get-signature tsd-parent-kind-class">
<a name="currencysymbol" class="tsd-anchor"></a>
<h3>currency<wbr>Symbol</h3>
<ul class="tsd-signatures tsd-kind-get-signature tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">get</span> currencySymbol<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/catavolt-oss/cv-dialog-sdk/blob/ba57488/src/catavolt/dialog/Catavolt.ts#L187">dialog/Catavolt.ts:187</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Get the currency symbol override if defined from the server.</p>
</div>
</div>
<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-get-signature tsd-parent-kind-class">
<a name="deviceprops" class="tsd-anchor"></a>
<h3>device<wbr>Props</h3>
<ul class="tsd-signatures tsd-kind-get-signature tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">get</span> deviceProps<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">object</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/catavolt-oss/cv-dialog-sdk/blob/ba57488/src/catavolt/dialog/Catavolt.ts#L196">dialog/Catavolt.ts:196</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Get the device props</p>
</div>
</div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">object</span></h4>
<ul class="tsd-parameters">
<li class="tsd-parameter-index-signature">
<h5><span class="tsd-signature-symbol">[</span>index: <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>
</section>
<section class="tsd-panel tsd-member tsd-kind-get-signature tsd-parent-kind-class">
<a name="dialogapi" class="tsd-anchor"></a>
<h3>dialog<wbr>Api</h3>
<ul class="tsd-signatures tsd-kind-get-signature tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">get</span> dialogApi<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="../interfaces/_dialog_dialogapi_.dialogapi.html" class="tsd-signature-type">DialogApi</a></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/catavolt-oss/cv-dialog-sdk/blob/ba57488/src/catavolt/dialog/Catavolt.ts#L210">dialog/Catavolt.ts:210</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Get the DialogApi instance</p>
</div>
</div>
<h4 class="tsd-returns-title">Returns <a href="../interfaces/_dialog_dialogapi_.dialogapi.html" class="tsd-signature-type">DialogApi</a></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-get-signature tsd-parent-kind-class">
<a name="isloggedin" class="tsd-anchor"></a>
<h3>is<wbr>Logged<wbr>In</h3>
<ul class="tsd-signatures tsd-kind-get-signature tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">get</span> isLoggedIn<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/catavolt-oss/cv-dialog-sdk/blob/ba57488/src/catavolt/dialog/Catavolt.ts#L246">dialog/Catavolt.ts:246</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Checked logged in status</p>
</div>
</div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-accessor tsd-parent-kind-class">
<a name="locale" class="tsd-anchor"></a>
<h3>locale</h3>
<ul class="tsd-signatures tsd-kind-accessor tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">get</span> locale<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="_util_cvlocale_.cvlocale.html" class="tsd-signature-type">CvLocale</a></li>
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">set</span> locale<span class="tsd-signature-symbol">(</span>locale<span class="tsd-signature-symbol">: </span><a href="_util_cvlocale_.cvlocale.html" class="tsd-signature-type">CvLocale</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/catavolt-oss/cv-dialog-sdk/blob/ba57488/src/catavolt/dialog/Catavolt.ts#L136">dialog/Catavolt.ts:136</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Get the preferred locale</p>
</div>
</div>
<h4 class="tsd-returns-title">Returns <a href="_util_cvlocale_.cvlocale.html" class="tsd-signature-type">CvLocale</a></h4>
</li>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/catavolt-oss/cv-dialog-sdk/blob/ba57488/src/catavolt/dialog/Catavolt.ts#L158">dialog/Catavolt.ts:158</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Get the preferred locale</p>
</div>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>locale: <a href="_util_cvlocale_.cvlocale.html" class="tsd-signature-type">CvLocale</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-set-signature tsd-parent-kind-class">
<a name="onsessionexpiration" class="tsd-anchor"></a>
<h3>on<wbr>Session<wbr>Expiration</h3>
<ul class="tsd-signatures tsd-kind-set-signature tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">set</span> onSessionExpiration<span class="tsd-signature-symbol">(</span>onSessionExpiration<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">function</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">
<ul>
<li>Defined in <a href="https://github.com/catavolt-oss/cv-dialog-sdk/blob/ba57488/src/catavolt/dialog/Catavolt.ts#L451">dialog/Catavolt.ts:451</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Function that will be notified when the session expires</p>
</div>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>onSessionExpiration: <span class="tsd-signature-type">function</span></h5>
<div class="tsd-comment tsd-typography">
<div class="lead">
</div>
</div>
<ul class="tsd-parameters">
<li class="tsd-parameter-siganture">
<ul class="tsd-signatures tsd-kind-type-literal tsd-is-not-exported">
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</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">
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
</li>
</ul>
</li>
</ul>
</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-get-signature tsd-parent-kind-class">
<a name="remainingsessiontime" class="tsd-anchor"></a>
<h3>remaining<wbr>Session<wbr>Time</h3>
<ul class="tsd-signatures tsd-kind-get-signature tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">get</span> remainingSessionTime<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/catavolt-oss/cv-dialog-sdk/blob/ba57488/src/catavolt/dialog/Catavolt.ts#L419">dialog/Catavolt.ts:419</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Time remaining before this session is expired by the server</p>
</div>
</div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">number</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-get-signature tsd-parent-kind-class">
<a name="session" class="tsd-anchor"></a>
<h3>session</h3>
<ul class="tsd-signatures tsd-kind-get-signature tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">get</span> session<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="../interfaces/_models_session_.session.html" class="tsd-signature-type">Session</a></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/catavolt-oss/cv-dialog-sdk/blob/ba57488/src/catavolt/dialog/Catavolt.ts#L435">dialog/Catavolt.ts:435</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Get the Session</p>
</div>
</div>
<h4 class="tsd-returns-title">Returns <a href="../interfaces/_models_session_.session.html" class="tsd-signature-type">Session</a></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-get-signature tsd-parent-kind-class">
<a name="sessionhasexpired" class="tsd-anchor"></a>
<h3>session<wbr>Has<wbr>Expired</h3>
<ul class="tsd-signatures tsd-kind-get-signature tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">get</span> sessionHasExpired<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/catavolt-oss/cv-dialog-sdk/blob/ba57488/src/catavolt/dialog/Catavolt.ts#L443">dialog/Catavolt.ts:443</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Return whether or not the session has expired</p>
</div>
</div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-get-signature tsd-parent-kind-class tsd-is-static">
<a name="defaultttlinmillis" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagStatic">Static</span> defaultTTLIn<wbr>Millis</h3>
<ul class="tsd-signatures tsd-kind-get-signature tsd-parent-kind-class tsd-is-static">
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">get</span> defaultTTLInMillis<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/catavolt-oss/cv-dialog-sdk/blob/ba57488/src/catavolt/dialog/Catavolt.ts#L60">dialog/Catavolt.ts:60</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Get the default session time</p>
</div>
</div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">number</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-get-signature tsd-parent-kind-class tsd-is-static">
<a name="singleton" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagStatic">Static</span> singleton</h3>
<ul class="tsd-signatures tsd-kind-get-signature tsd-parent-kind-class tsd-is-static">
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">get</span> singleton<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="_dialog_catavolt_.catavoltapiimpl.html" class="tsd-signature-type">CatavoltApiImpl</a></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/catavolt-oss/cv-dialog-sdk/blob/ba57488/src/catavolt/dialog/Catavolt.ts#L68">dialog/Catavolt.ts:68</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Get the singleton instance of the CatavoltApiImpl</p>
</div>
</div>
<h4 class="tsd-returns-title">Returns <a href="_dialog_catavolt_.catavoltapiimpl.html" class="tsd-signature-type">CatavoltApiImpl</a></h4>
</li>
</ul>
</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="addclientlistener" class="tsd-anchor"></a>
<h3>add<wbr>Client<wbr>Listener</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">add<wbr>Client<wbr>Listener<span class="tsd-signature-symbol">(</span>clientListener<span class="tsd-signature-symbol">: </span><a href="../modules/_client_clientlistener_.html#clientlistener" class="tsd-signature-type">ClientListener</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">
<p>Implementation of <a href="../interfaces/_dialog_catavoltapi_.catavoltapi.html">CatavoltApi</a>.<a href="../interfaces/_dialog_catavoltapi_.catavoltapi.html#addclientlistener">addClientListener</a></p>
<ul>
<li>Defined in <a href="https://github.com/catavolt-oss/cv-dialog-sdk/blob/ba57488/src/catavolt/dialog/Catavolt.ts#L128">dialog/Catavolt.ts:128</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>clientListener: <a href="../modules/_client_clientlistener_.html#clientlistener" class="tsd-signature-type">ClientListener</a></h5>
<div class="tsd-comment tsd-typography">
</div>
</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="adddynamicdeviceprop" class="tsd-anchor"></a>
<h3>add<wbr>Dynamic<wbr>Device<wbr>Prop</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">add<wbr>Dynamic<wbr>Device<wbr>Prop<span class="tsd-signature-symbol">(</span>propName<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, propFn<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">function</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">
<ul>
<li>Defined in <a href="https://github.com/catavolt-oss/cv-dialog-sdk/blob/ba57488/src/catavolt/dialog/Catavolt.ts#L110">dialog/Catavolt.ts:110</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Add or replace a dynamic device property (func)</p>
</div>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>propName: <span class="tsd-signature-type">string</span></h5>
</li>
<li>
<h5>propFn: <span class="tsd-signature-type">function</span></h5>
<div class="tsd-comment tsd-typography">
</div>
<ul class="tsd-parameters">
<li class="tsd-parameter-siganture">
<ul class="tsd-signatures tsd-kind-type-literal tsd-is-not-exported">
<li class="tsd-signature tsd-kind-icon"><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">
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4>
</li>
</ul>
</li>
</ul>
</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="addstaticdeviceprop" class="tsd-anchor"></a>
<h3>add<wbr>Static<wbr>Device<wbr>Prop</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">add<wbr>Static<wbr>Device<wbr>Prop<span class="tsd-signature-symbol">(</span>propName<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, propValue<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">void</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<p>Implementation of <a href="../interfaces/_dialog_catavoltapi_.catavoltapi.html">CatavoltApi</a>.<a href="../interfaces/_dialog_catavoltapi_.catavoltapi.html#addstaticdeviceprop">addStaticDeviceProp</a></p>
<ul>
<li>Defined in <a href="https://github.com/catavolt-oss/cv-dialog-sdk/blob/ba57488/src/catavolt/dialog/Catavolt.ts#L120">dialog/Catavolt.ts:120</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Add or replace a static device property</p>
</div>
</div>
<h