cv-dialog-sdk
Version:
Catavolt Dialog Javascript API
765 lines • 71.3 kB
HTML
<!doctype html>
<html class="default no-js">
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<title>CatavoltApi | 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_catavoltapi_.html">"dialog/CatavoltApi"</a>
</li>
<li>
<a href="_dialog_catavoltapi_.catavoltapi.html">CatavoltApi</a>
</li>
</ul>
<h1>Interface CatavoltApi</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">CatavoltApi</span>
</li>
</ul>
</section>
<section class="tsd-panel">
<h3>Implemented by</h3>
<ul class="tsd-hierarchy">
<li><a href="../classes/_dialog_catavolt_.catavoltapiimpl.html" class="tsd-signature-type">CatavoltApiImpl</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 ">
<h3>Properties</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="_dialog_catavoltapi_.catavoltapi.html#default_locale" class="tsd-kind-icon">DEFAULT_<wbr>LOCALE</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="_dialog_catavoltapi_.catavoltapi.html#clienttimeoutmillis" class="tsd-kind-icon">client<wbr>Timeout<wbr>Millis</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="_dialog_catavoltapi_.catavoltapi.html#currencysymbol" class="tsd-kind-icon">currency<wbr>Symbol</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="_dialog_catavoltapi_.catavoltapi.html#datalastchangedtime" class="tsd-kind-icon">data<wbr>Last<wbr>Changed<wbr>Time</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="_dialog_catavoltapi_.catavoltapi.html#deviceprops" class="tsd-kind-icon">device<wbr>Props</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="_dialog_catavoltapi_.catavoltapi.html#dialogapi" class="tsd-kind-icon">dialog<wbr>Api</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="_dialog_catavoltapi_.catavoltapi.html#isloggedin" class="tsd-kind-icon">is<wbr>Logged<wbr>In</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="_dialog_catavoltapi_.catavoltapi.html#locale" class="tsd-kind-icon">locale</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="_dialog_catavoltapi_.catavoltapi.html#onsessionexpiration" class="tsd-kind-icon">on<wbr>Session<wbr>Expiration</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="_dialog_catavoltapi_.catavoltapi.html#remainingsessiontime" class="tsd-kind-icon">remaining<wbr>Session<wbr>Time</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="_dialog_catavoltapi_.catavoltapi.html#session" class="tsd-kind-icon">session</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="_dialog_catavoltapi_.catavoltapi.html#sessionhasexpired" class="tsd-kind-icon">session<wbr>Has<wbr>Expired</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-interface"><a href="_dialog_catavoltapi_.catavoltapi.html#addclientlistener" class="tsd-kind-icon">add<wbr>Client<wbr>Listener</a></li>
<li class="tsd-kind-method tsd-parent-kind-interface"><a href="_dialog_catavoltapi_.catavoltapi.html#adddynamicdeviceprop" class="tsd-kind-icon">add<wbr>Dynamic<wbr>Device<wbr>Prop</a></li>
<li class="tsd-kind-method tsd-parent-kind-interface"><a href="_dialog_catavoltapi_.catavoltapi.html#addstaticdeviceprop" class="tsd-kind-icon">add<wbr>Static<wbr>Device<wbr>Prop</a></li>
<li class="tsd-kind-method tsd-parent-kind-interface"><a href="_dialog_catavoltapi_.catavoltapi.html#changepasswordandlogin" class="tsd-kind-icon">change<wbr>Password<wbr>And<wbr>Login</a></li>
<li class="tsd-kind-method tsd-parent-kind-interface"><a href="_dialog_catavoltapi_.catavoltapi.html#getredirection" class="tsd-kind-icon">get<wbr>Redirection</a></li>
<li class="tsd-kind-method tsd-parent-kind-interface"><a href="_dialog_catavoltapi_.catavoltapi.html#initdialogapi" class="tsd-kind-icon">init<wbr>Dialog<wbr>Api</a></li>
<li class="tsd-kind-method tsd-parent-kind-interface"><a href="_dialog_catavoltapi_.catavoltapi.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-interface"><a href="_dialog_catavoltapi_.catavoltapi.html#isfeaturesetavailable" class="tsd-kind-icon">is<wbr>Feature<wbr>Set<wbr>Available</a></li>
<li class="tsd-kind-method tsd-parent-kind-interface"><a href="_dialog_catavoltapi_.catavoltapi.html#isuserinbriefcasemode" class="tsd-kind-icon">is<wbr>User<wbr>InBriefcase<wbr>Mode</a></li>
<li class="tsd-kind-method tsd-parent-kind-interface"><a href="_dialog_catavoltapi_.catavoltapi.html#login" class="tsd-kind-icon">login</a></li>
<li class="tsd-kind-method tsd-parent-kind-interface"><a href="_dialog_catavoltapi_.catavoltapi.html#loginwithtoken" class="tsd-kind-icon">login<wbr>With<wbr>Token</a></li>
<li class="tsd-kind-method tsd-parent-kind-interface"><a href="_dialog_catavoltapi_.catavoltapi.html#logout" class="tsd-kind-icon">logout</a></li>
<li class="tsd-kind-method tsd-parent-kind-interface"><a href="_dialog_catavoltapi_.catavoltapi.html#opendialog" class="tsd-kind-icon">open<wbr>Dialog</a></li>
<li class="tsd-kind-method tsd-parent-kind-interface"><a href="_dialog_catavoltapi_.catavoltapi.html#opendialogwithid" class="tsd-kind-icon">open<wbr>Dialog<wbr>With<wbr>Id</a></li>
<li class="tsd-kind-method tsd-parent-kind-interface"><a href="_dialog_catavoltapi_.catavoltapi.html#openstream" class="tsd-kind-icon">open<wbr>Stream</a></li>
<li class="tsd-kind-method tsd-parent-kind-interface"><a href="_dialog_catavoltapi_.catavoltapi.html#performworkbenchaction" class="tsd-kind-icon">perform<wbr>Workbench<wbr>Action</a></li>
<li class="tsd-kind-method tsd-parent-kind-interface"><a href="_dialog_catavoltapi_.catavoltapi.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-interface"><a href="_dialog_catavoltapi_.catavoltapi.html#refreshsession" class="tsd-kind-icon">refresh<wbr>Session</a></li>
<li class="tsd-kind-method tsd-parent-kind-interface"><a href="_dialog_catavoltapi_.catavoltapi.html#removeclientlistener" class="tsd-kind-icon">remove<wbr>Client<wbr>Listener</a></li>
<li class="tsd-kind-method tsd-parent-kind-interface"><a href="_dialog_catavoltapi_.catavoltapi.html#streamcontent" class="tsd-kind-icon">stream<wbr>Content</a></li>
<li class="tsd-kind-method tsd-parent-kind-interface"><a href="_dialog_catavoltapi_.catavoltapi.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 ">
<h2>Properties</h2>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<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="../classes/_util_cvlocale_.cvlocale.html" class="tsd-signature-type">CvLocale</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/CatavoltApi.ts#L23">dialog/CatavoltApi.ts:23</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="clienttimeoutmillis" class="tsd-anchor"></a>
<h3>client<wbr>Timeout<wbr>Millis</h3>
<div class="tsd-signature tsd-kind-icon">client<wbr>Timeout<wbr>Millis<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</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/CatavoltApi.ts#L13">dialog/CatavoltApi.ts:13</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="currencysymbol" class="tsd-anchor"></a>
<h3>currency<wbr>Symbol</h3>
<div class="tsd-signature tsd-kind-icon">currency<wbr>Symbol<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/dialog/CatavoltApi.ts#L14">dialog/CatavoltApi.ts:14</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<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></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/catavolt-oss/cv-dialog-sdk/blob/ba57488/src/catavolt/dialog/CatavoltApi.ts#L11">dialog/CatavoltApi.ts:11</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="deviceprops" class="tsd-anchor"></a>
<h3>device<wbr>Props</h3>
<div class="tsd-signature tsd-kind-icon">device<wbr>Props<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/CatavoltApi.ts#L15">dialog/CatavoltApi.ts:15</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>p: <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-interface">
<a name="dialogapi" class="tsd-anchor"></a>
<h3>dialog<wbr>Api</h3>
<div class="tsd-signature tsd-kind-icon">dialog<wbr>Api<span class="tsd-signature-symbol">:</span> <a href="_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/CatavoltApi.ts#L16">dialog/CatavoltApi.ts:16</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="isloggedin" class="tsd-anchor"></a>
<h3>is<wbr>Logged<wbr>In</h3>
<div class="tsd-signature tsd-kind-icon">is<wbr>Logged<wbr>In<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</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/CatavoltApi.ts#L17">dialog/CatavoltApi.ts:17</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="locale" class="tsd-anchor"></a>
<h3>locale</h3>
<div class="tsd-signature tsd-kind-icon">locale<span class="tsd-signature-symbol">:</span> <a href="../classes/_util_cvlocale_.cvlocale.html" class="tsd-signature-type">CvLocale</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/CatavoltApi.ts#L12">dialog/CatavoltApi.ts:12</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="onsessionexpiration" class="tsd-anchor"></a>
<h3>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">function</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/CatavoltApi.ts#L18">dialog/CatavoltApi.ts:18</a></li>
</ul>
</aside>
<div class="tsd-type-declaration">
<h4>Type declaration</h4>
<ul class="tsd-parameters">
<li class="tsd-parameter-siganture">
<ul class="tsd-signatures tsd-kind-type-literal tsd-parent-kind-property 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>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="remainingsessiontime" class="tsd-anchor"></a>
<h3>remaining<wbr>Session<wbr>Time</h3>
<div class="tsd-signature tsd-kind-icon">remaining<wbr>Session<wbr>Time<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</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/CatavoltApi.ts#L19">dialog/CatavoltApi.ts:19</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="session" class="tsd-anchor"></a>
<h3>session</h3>
<div class="tsd-signature tsd-kind-icon">session<span class="tsd-signature-symbol">:</span> <a href="_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/CatavoltApi.ts#L20">dialog/CatavoltApi.ts:20</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="sessionhasexpired" class="tsd-anchor"></a>
<h3>session<wbr>Has<wbr>Expired</h3>
<div class="tsd-signature tsd-kind-icon">session<wbr>Has<wbr>Expired<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</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/CatavoltApi.ts#L21">dialog/CatavoltApi.ts:21</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-interface">
<a name="addclientlistener" class="tsd-anchor"></a>
<h3>add<wbr>Client<wbr>Listener</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface">
<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">
<ul>
<li>Defined in <a href="https://github.com/catavolt-oss/cv-dialog-sdk/blob/ba57488/src/catavolt/dialog/CatavoltApi.ts#L29">dialog/CatavoltApi.ts:29</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-interface">
<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-interface">
<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/CatavoltApi.ts#L36">dialog/CatavoltApi.ts:36</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-interface">
<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-interface">
<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">
<ul>
<li>Defined in <a href="https://github.com/catavolt-oss/cv-dialog-sdk/blob/ba57488/src/catavolt/dialog/CatavoltApi.ts#L44">dialog/CatavoltApi.ts:44</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Add or replace a static device property</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>propValue: <span class="tsd-signature-type">string</span></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-interface">
<a name="changepasswordandlogin" class="tsd-anchor"></a>
<h3>change<wbr>Password<wbr>And<wbr>Login</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface">
<li class="tsd-signature tsd-kind-icon">change<wbr>Password<wbr>And<wbr>Login<span class="tsd-signature-symbol">(</span>tenantId<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, clientType<span class="tsd-signature-symbol">: </span><a href="../modules/_models_types_.html#clienttype" class="tsd-signature-type">ClientType</a>, userId<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, existingPassword<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, newPassword<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">Promise</span><span class="tsd-signature-symbol"><</span><a href="_models_session_.session.html" class="tsd-signature-type">Session</a><span class="tsd-signature-symbol"> | </span><a href="_models_redirection_.redirection.html" class="tsd-signature-type">Redirection</a><span class="tsd-signature-symbol">></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/CatavoltApi.ts#L46">dialog/CatavoltApi.ts:46</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>tenantId: <span class="tsd-signature-type">string</span></h5>
</li>
<li>
<h5>clientType: <a href="../modules/_models_types_.html#clienttype" class="tsd-signature-type">ClientType</a></h5>
</li>
<li>
<h5>userId: <span class="tsd-signature-type">string</span></h5>
</li>
<li>
<h5>existingPassword: <span class="tsd-signature-type">string</span></h5>
</li>
<li>
<h5>newPassword: <span class="tsd-signature-type">string</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="_models_session_.session.html" class="tsd-signature-type">Session</a><span class="tsd-signature-symbol"> | </span><a href="_models_redirection_.redirection.html" class="tsd-signature-type">Redirection</a><span class="tsd-signature-symbol">></span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface">
<a name="getredirection" class="tsd-anchor"></a>
<h3>get<wbr>Redirection</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface">
<li class="tsd-signature tsd-kind-icon">get<wbr>Redirection<span class="tsd-signature-symbol">(</span>redirectionId<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">Promise</span><span class="tsd-signature-symbol"><</span><a href="_models_redirection_.redirection.html" class="tsd-signature-type">Redirection</a><span class="tsd-signature-symbol">></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/CatavoltApi.ts#L115">dialog/CatavoltApi.ts:115</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>redirectionId: <span class="tsd-signature-type">string</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="_models_redirection_.redirection.html" class="tsd-signature-type">Redirection</a><span class="tsd-signature-symbol">></span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface">
<a name="initdialogapi" class="tsd-anchor"></a>
<h3>init<wbr>Dialog<wbr>Api</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface">
<li class="tsd-signature tsd-kind-icon">init<wbr>Dialog<wbr>Api<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><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/CatavoltApi.ts#L60">dialog/CatavoltApi.ts:60</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Initialize a dialog service implementation for use by this CatavoltApiImpl</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>
<div class="tsd-comment tsd-typography">
</div>
</li>
<li>
<h5>serverVersion: <span class="tsd-signature-type">string</span></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-interface">
<a name="isanyuserinbriefcasemode" class="tsd-anchor"></a>
<h3>is<wbr>Any<wbr>User<wbr>InBriefcase<wbr>Mode</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface">
<li class="tsd-signature tsd-kind-icon">is<wbr>Any<wbr>User<wbr>InBriefcase<wbr>Mode<span class="tsd-signature-symbol">(</span>tenantId<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">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">></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/CatavoltApi.ts#L75">dialog/CatavoltApi.ts:75</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Check offline status</p>
</div>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>tenantId: <span class="tsd-signature-type">string</span></h5>
<div class="tsd-comment tsd-typography">
</div>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">></span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface">
<a name="isfeaturesetavailable" class="tsd-anchor"></a>
<h3>is<wbr>Feature<wbr>Set<wbr>Available</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface">
<li class="tsd-signature tsd-kind-icon">is<wbr>Feature<wbr>Set<wbr>Available<span class="tsd-signature-symbol">(</span>featureSet<span class="tsd-signature-symbol">: </span><a href="../modules/_dialog_catavolt_.html#featureset" class="tsd-signature-type">FeatureSet</a><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/CatavoltApi.ts#L68">dialog/CatavoltApi.ts:68</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Check for the availability of the given featureSet</p>
</div>
<dl class="tsd-comment-tags">
<dt>see</dt>
<dd><p>FeatureSet</p>
</dd>
</dl>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>featureSet: <a href="../modules/_dialog_catavolt_.html#featureset" class="tsd-signature-type">FeatureSet</a></h5>
</li>
</ul>
<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-method tsd-parent-kind-interface">
<a name="isuserinbriefcasemode" class="tsd-anchor"></a>
<h3>is<wbr>User<wbr>InBriefcase<wbr>Mode</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface">
<li class="tsd-signature tsd-kind-icon">is<wbr>User<wbr>InBriefcase<wbr>Mode<span class="tsd-signature-symbol">(</span>userInfo<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">__type</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">></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/CatavoltApi.ts#L81">dialog/CatavoltApi.ts:81</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>userInfo: <span class="tsd-signature-type">__type</span></h5>
<div class="tsd-comment tsd-typography">
</div>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">></span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface">
<a name="login" class="tsd-anchor"></a>
<h3>login</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface">
<li class="tsd-signature tsd-kind-icon">login<span class="tsd-signature-symbol">(</span>tenantId<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, clientType<span class="tsd-signature-symbol">: </span><a href="../modules/_models_types_.html#clienttype" class="tsd-signature-type">ClientType</a>, userId<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, password<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">Promise</span><span class="tsd-signature-symbol"><</span><a href="_models_session_.session.html" class="tsd-signature-type">Session</a><span class="tsd-signature-symbol"> | </span><a href="_models_redirection_.redirection.html" class="tsd-signature-type">Redirection</a><span class="tsd-signature-symbol">></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/CatavoltApi.ts#L93">dialog/CatavoltApi.ts:93</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Log in and retrieve the Session</p>
</div>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>tenantId: <span class="tsd-signature-type">string</span></h5>
</li>
<li>
<h5>clientType: <a href="../modules/_models_types_.html#clienttype" class="tsd-signature-type">ClientType</a></h5>
</li>
<li>
<h5>userId: <span class="tsd-signature-type">string</span></h5>
</li>
<li>
<h5>password: <span class="tsd-signature-type">string</span></h5>
<div class="tsd-comment tsd-typography">
</div>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="_models_session_.session.html" class="tsd-signature-type">Session</a><span class="tsd-signature-symbol"> | </span><a href="_models_redirection_.redirection.html" class="tsd-signature-type">Redirection</a><span class="tsd-signature-symbol">></span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface">
<a name="loginwithtoken" class="tsd-anchor"></a>
<h3>login<wbr>With<wbr>Token</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface">
<li class="tsd-signature tsd-kind-icon">login<wbr>With<wbr>Token<span class="tsd-signature-symbol">(</span>tenantId<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, clientType<span class="tsd-signature-symbol">: </span><a href="../modules/_models_types_.html#clienttype" class="tsd-signature-type">ClientType</a>, permissionToken<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, proofKey<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">Promise</span><span class="tsd-signature-symbol"><</span><a href="_models_session_.session.html" class="tsd-signature-type">Session</a><span class="tsd-signature-symbol"> | </span><a href="_models_redirection_.redirection.html" class="tsd-signature-type">Redirection</a><span class="tsd-signature-symbol">></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/CatavoltApi.ts#L95">dialog/CatavoltApi.ts:95</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>tenantId: <span class="tsd-signature-type">string</span></h5>
</li>
<li>
<h5>clientType: <a href="../modules/_models_types_.html#clienttype" class="tsd-signature-type">ClientType</a></h5>
</li>
<li>
<h5>permissionToken: <span class="tsd-signature-type">string</span></h5>
</li>
<li>
<h5>proofKey: <span class="tsd-signature-type">string</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="_models_session_.session.html" class="tsd-signature-type">Session</a><span class="tsd-signature-symbol"> | </span><a href="_models_redirection_.redirection.html" class="tsd-signature-type">Redirection</a><span class="tsd-signature-symbol">></span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface">
<a name="logout" class="tsd-anchor"></a>
<h3>logout</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface">
<li class="tsd-signature tsd-kind-icon">logout<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">object</span><span class="tsd-signature-symbol">></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/CatavoltApi.ts#L105">dialog/CatavoltApi.ts:105</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Logout and destroy the session</p>
</div>
</div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">object</span><span class="tsd-signature-symbol">></span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface">
<a name="opendialog" class="tsd-anchor"></a>
<h3>open<wbr>Dialog</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface">
<li class="tsd-signature tsd-kind-icon">open<wbr>Dialog<span class="tsd-signature-symbol">(</span>redirection<span class="tsd-signature-symbol">: </span><a href="_models_dialogredirection_.dialogredirection.html" class="tsd-signature-type">DialogRedirection</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../classes/_models_dialog_.dialog.html" class="tsd-signature-type">Dialog</a><span class="tsd-signature-symbol">></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/CatavoltApi.ts#L109">dialog/CatavoltApi.ts:109</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>redirection: <a href="_models_dialogredirection_.dialogredirection.html" class="tsd-signature-type">DialogRedirection</a></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../classes/_models_dialog_.dialog.html" class="tsd-signature-type">Dialog</a><span class="tsd-signature-symbol">></span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface">
<a name="opendialogwithid" class="tsd-anchor"></a>
<h3>open<wbr>Dialog<wbr>With<wbr>Id</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface">
<li class="tsd-signature tsd-kind-icon">open<wbr>Dialog<wbr>With<wbr>Id<span class="tsd-signature-symbol">(</span>dialogId<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">Promise</span><span class="tsd-signature-symbol"><</span><a href="../classes/_models_dialog_.dialog.html" class="tsd-signature-type">Dialog</a><span class="tsd-signature-symbol">></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/CatavoltApi.ts#L107">dialog/CatavoltApi.ts:107</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>dialogId: <span class="tsd-signature-type">string</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../classes/_models_dialog_.dialog.html" class="tsd-signature-type">Dialog</a><span class="tsd-signature-symbol">></span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface">
<a name="openstream" class="tsd-anchor"></a>
<h3>open<wbr>Stream</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface">
<li class="tsd-signature tsd-kind-icon">open<wbr>Stream<span class="tsd-signature-symbol">(</span>url<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">Promise</span><span class="tsd-signature-symbol"><</span><a href="_io_streamproducer_.streamproducer.html" class="tsd-signature-type">StreamProducer</a><span class="tsd-signature-symbol">></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/CatavoltApi.ts#L111">dialog/CatavoltApi.ts:111</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>url: <span class="tsd-signature-type">string</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="_io_streamproducer_.streamproducer.html" class="tsd-signature-type">StreamProducer</a><span class="tsd-signature-symbol">></span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface">
<a name="performworkbenchaction" class="tsd-anchor"></a>
<h3>perform<wbr>Workbench<wbr>Action</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface">
<li class="tsd-signature tsd-kind-icon">perform<wbr>Workbench<wbr>Action<span class="tsd-signature-symbol">(</span>workbenchAction<span class="tsd-signature-symbol">: </span><a href="_models_workbenchaction_.workbenchaction.html" class="tsd-signature-type">WorkbenchAction</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">object</span><span class="tsd-signature-symbol"> | </span><a href="_models_redirection_.redirection.html" class="tsd-signature-type">Redirection</a><span class="tsd-signature-symbol">></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/CatavoltApi.ts#L122">dialog/CatavoltApi.ts:122</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Open a <a href="_models_workbenchaction_.workbenchaction.html">WorkbenchAction</a></p>
</div>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>workbenchAction: <a href="_models_workbenchaction_.workbenchaction.html" class="tsd-signature-type">WorkbenchAction</a></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">object</span><span class="tsd-signature-symbol"> | </span><a href="_models_redirection_.redirection.html" class="tsd-signature-type">Redirection</a><span class="tsd-signature-symbol">></span></h4>
<p>| Redirection>}</p>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface">
<a name="performworkbenchactionforid" class="tsd-anchor"></a>
<h3>perform<wbr>Workbench<wbr>Action<wbr>For<wbr>Id</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface">
<li class="tsd-signature tsd-kind-icon">perform<wbr>Workbench<wbr>Action<wbr>For<wbr>Id<span class="tsd-signature-symbol">(</span>workbenchId<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, workbenchActionId<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">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">object</span><span class="tsd-signature-symbol"> | </span><a href="_models_redirection