cv-dialog-sdk
Version:
Catavolt Dialog Javascript API
671 lines • 119 kB
HTML
<!doctype html>
<html class="default no-js">
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<title>DialogService | 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_dialogservice_.html">"dialog/DialogService"</a>
</li>
<li>
<a href="_dialog_dialogservice_.dialogservice.html">DialogService</a>
</li>
</ul>
<h1>Class DialogService</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">DialogService</span>
</li>
</ul>
</section>
<section class="tsd-panel">
<h3>Implements</h3>
<ul class="tsd-hierarchy">
<li><a href="../interfaces/_dialog_dialogapi_.dialogapi.html" class="tsd-signature-type">DialogApi</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>Constructors</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-constructor tsd-parent-kind-class"><a href="_dialog_dialogservice_.dialogservice.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_dialogservice_.dialogservice.html#apiversion" class="tsd-kind-icon">api<wbr>Version</a></li>
<li class="tsd-kind-property tsd-parent-kind-class"><a href="_dialog_dialogservice_.dialogservice.html#baseurl" class="tsd-kind-icon">base<wbr>Url</a></li>
<li class="tsd-kind-property tsd-parent-kind-class"><a href="_dialog_dialogservice_.dialogservice.html#client" class="tsd-kind-icon">client</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_dialogservice_.dialogservice.html#lastserviceactivity" class="tsd-kind-icon">last<wbr>Service<wbr>Activity</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_dialogservice_.dialogservice.html#addattachment" class="tsd-kind-icon">add<wbr>Attachment</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="_dialog_dialogservice_.dialogservice.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_dialogservice_.dialogservice.html#changemode" class="tsd-kind-icon">change<wbr>Mode</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="_dialog_dialogservice_.dialogservice.html#changeview" class="tsd-kind-icon">change<wbr>View</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="_dialog_dialogservice_.dialogservice.html#createsession" class="tsd-kind-icon">create<wbr>Session</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-private"><a href="_dialog_dialogservice_.dialogservice.html#d3lete" class="tsd-kind-icon">d3lete</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="_dialog_dialogservice_.dialogservice.html#deletedialog" class="tsd-kind-icon">delete<wbr>Dialog</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="_dialog_dialogservice_.dialogservice.html#deletesession" class="tsd-kind-icon">delete<wbr>Session</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-private"><a href="_dialog_dialogservice_.dialogservice.html#get" class="tsd-kind-icon">get</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="_dialog_dialogservice_.dialogservice.html#getactions" class="tsd-kind-icon">get<wbr>Actions</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="_dialog_dialogservice_.dialogservice.html#getavailablevalues" class="tsd-kind-icon">get<wbr>Available<wbr>Values</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="_dialog_dialogservice_.dialogservice.html#getcontent" class="tsd-kind-icon">get<wbr>Content</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="_dialog_dialogservice_.dialogservice.html#getdialog" class="tsd-kind-icon">get<wbr>Dialog</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="_dialog_dialogservice_.dialogservice.html#geteditorproperty" class="tsd-kind-icon">get<wbr>Editor<wbr>Property</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="_dialog_dialogservice_.dialogservice.html#getmode" class="tsd-kind-icon">get<wbr>Mode</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="_dialog_dialogservice_.dialogservice.html#getqueryproperty" class="tsd-kind-icon">get<wbr>Query<wbr>Property</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="_dialog_dialogservice_.dialogservice.html#getrecord" class="tsd-kind-icon">get<wbr>Record</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="_dialog_dialogservice_.dialogservice.html#getrecords" class="tsd-kind-icon">get<wbr>Records</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="_dialog_dialogservice_.dialogservice.html#getredirection" class="tsd-kind-icon">get<wbr>Redirection</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="_dialog_dialogservice_.dialogservice.html#getsession" class="tsd-kind-icon">get<wbr>Session</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="_dialog_dialogservice_.dialogservice.html#getview" class="tsd-kind-icon">get<wbr>View</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="_dialog_dialogservice_.dialogservice.html#getviews" class="tsd-kind-icon">get<wbr>Views</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="_dialog_dialogservice_.dialogservice.html#getworkbench" class="tsd-kind-icon">get<wbr>Workbench</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="_dialog_dialogservice_.dialogservice.html#getworkbenchactions" class="tsd-kind-icon">get<wbr>Workbench<wbr>Actions</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="_dialog_dialogservice_.dialogservice.html#getworkbenches" class="tsd-kind-icon">get<wbr>Workbenches</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="_dialog_dialogservice_.dialogservice.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_dialogservice_.dialogservice.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_dialogservice_.dialogservice.html#opencontentstream" class="tsd-kind-icon">open<wbr>Content<wbr>Stream</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="_dialog_dialogservice_.dialogservice.html#performaction" class="tsd-kind-icon">perform<wbr>Action</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="_dialog_dialogservice_.dialogservice.html#performworkbenchaction" class="tsd-kind-icon">perform<wbr>Workbench<wbr>Action</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-private"><a href="_dialog_dialogservice_.dialogservice.html#post" class="tsd-kind-icon">post</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="_dialog_dialogservice_.dialogservice.html#propertychange" class="tsd-kind-icon">property<wbr>Change</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-private"><a href="_dialog_dialogservice_.dialogservice.html#put" class="tsd-kind-icon">put</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="_dialog_dialogservice_.dialogservice.html#putrecord" class="tsd-kind-icon">put<wbr>Record</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="_dialog_dialogservice_.dialogservice.html#removeclientlistener" class="tsd-kind-icon">remove<wbr>Client<wbr>Listener</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-private"><a href="_dialog_dialogservice_.dialogservice.html#stream" class="tsd-kind-icon">stream</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="_dialog_dialogservice_.dialogservice.html#streamurl" class="tsd-kind-icon">stream<wbr>Url</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="_dialog_dialogservice_.dialogservice.html#writeproperty" class="tsd-kind-icon">write<wbr>Property</a></li>
</ul>
</section>
</div>
</section>
</section>
<section class="tsd-panel-group tsd-member-group ">
<h2>Constructors</h2>
<section class="tsd-panel tsd-member tsd-kind-constructor tsd-parent-kind-class">
<a name="constructor" class="tsd-anchor"></a>
<h3>constructor</h3>
<ul class="tsd-signatures tsd-kind-constructor tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">new <wbr>Dialog<wbr>Service<span class="tsd-signature-symbol">(</span>client<span class="tsd-signature-symbol">: </span><a href="../interfaces/_client_client_.client.html" class="tsd-signature-type">Client</a>, serverUrl<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, apiVersion<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="_dialog_dialogservice_.dialogservice.html" class="tsd-signature-type">DialogService</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/DialogService.ts#L33">dialog/DialogService.ts:33</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>client: <a href="../interfaces/_client_client_.client.html" class="tsd-signature-type">Client</a></h5>
</li>
<li>
<h5>serverUrl: <span class="tsd-signature-type">string</span></h5>
</li>
<li>
<h5>apiVersion: <span class="tsd-signature-type">any</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <a href="_dialog_dialogservice_.dialogservice.html" class="tsd-signature-type">DialogService</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="apiversion" class="tsd-anchor"></a>
<h3>api<wbr>Version</h3>
<div class="tsd-signature tsd-kind-icon">api<wbr>Version<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">any</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/DialogService.ts#L35">dialog/DialogService.ts:35</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class">
<a name="baseurl" class="tsd-anchor"></a>
<h3>base<wbr>Url</h3>
<div class="tsd-signature tsd-kind-icon">base<wbr>Url<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/catavolt-oss/cv-dialog-sdk/blob/ba57488/src/catavolt/dialog/DialogService.ts#L33">dialog/DialogService.ts:33</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class">
<a name="client" class="tsd-anchor"></a>
<h3>client</h3>
<div class="tsd-signature tsd-kind-icon">client<span class="tsd-signature-symbol">:</span> <a href="../interfaces/_client_client_.client.html" class="tsd-signature-type">Client</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/DialogService.ts#L35">dialog/DialogService.ts:35</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="lastserviceactivity" class="tsd-anchor"></a>
<h3>last<wbr>Service<wbr>Activity</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> lastServiceActivity<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Date</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/DialogService.ts#L303">dialog/DialogService.ts:303</a></li>
</ul>
</aside>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Date</span></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="addattachment" class="tsd-anchor"></a>
<h3>add<wbr>Attachment</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">add<wbr>Attachment<span class="tsd-signature-symbol">(</span>tenantId<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, sessionId<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, dialogId<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, attachment<span class="tsd-signature-symbol">: </span><a href="_models_attachment_.attachment.html" class="tsd-signature-type">Attachment</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">void</span><span class="tsd-signature-symbol">></span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<p>Implementation of <a href="../interfaces/_dialog_dialogapi_.dialogapi.html">DialogApi</a>.<a href="../interfaces/_dialog_dialogapi_.dialogapi.html#addattachment">addAttachment</a></p>
<ul>
<li>Defined in <a href="https://github.com/catavolt-oss/cv-dialog-sdk/blob/ba57488/src/catavolt/dialog/DialogService.ts#L40">dialog/DialogService.ts:40</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>sessionId: <span class="tsd-signature-type">string</span></h5>
</li>
<li>
<h5>dialogId: <span class="tsd-signature-type">string</span></h5>
</li>
<li>
<h5>attachment: <a href="_models_attachment_.attachment.html" class="tsd-signature-type">Attachment</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">void</span><span class="tsd-signature-symbol">></span></h4>
</li>
</ul>
</section>
<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>, 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">
<p>Implementation of <a href="../interfaces/_dialog_dialogapi_.dialogapi.html">DialogApi</a>.<a href="../interfaces/_dialog_dialogapi_.dialogapi.html#addclientlistener">addClientListener</a></p>
<ul>
<li>Defined in <a href="https://github.com/catavolt-oss/cv-dialog-sdk/blob/ba57488/src/catavolt/dialog/DialogService.ts#L44">dialog/DialogService.ts:44</a></li>
</ul>
</aside>
<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>
</li>
<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-method tsd-parent-kind-class">
<a name="changemode" class="tsd-anchor"></a>
<h3>change<wbr>Mode</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">change<wbr>Mode<span class="tsd-signature-symbol">(</span>tenantId<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, sessionId<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, dialogId<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, mode<span class="tsd-signature-symbol">: </span><a href="../modules/_models_types_.html#viewmode" class="tsd-signature-type">ViewMode</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="_models_editordialog_.editordialog.html" class="tsd-signature-type">EditorDialog</a><span class="tsd-signature-symbol"> | </span><a href="../interfaces/_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">
<p>Implementation of <a href="../interfaces/_dialog_dialogapi_.dialogapi.html">DialogApi</a>.<a href="../interfaces/_dialog_dialogapi_.dialogapi.html#changemode">changeMode</a></p>
<ul>
<li>Defined in <a href="https://github.com/catavolt-oss/cv-dialog-sdk/blob/ba57488/src/catavolt/dialog/DialogService.ts#L261">dialog/DialogService.ts:261</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>sessionId: <span class="tsd-signature-type">string</span></h5>
</li>
<li>
<h5>dialogId: <span class="tsd-signature-type">string</span></h5>
</li>
<li>
<h5>mode: <a href="../modules/_models_types_.html#viewmode" class="tsd-signature-type">ViewMode</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="_models_editordialog_.editordialog.html" class="tsd-signature-type">EditorDialog</a><span class="tsd-signature-symbol"> | </span><a href="../interfaces/_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-class">
<a name="changeview" class="tsd-anchor"></a>
<h3>change<wbr>View</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">change<wbr>View<span class="tsd-signature-symbol">(</span>tenantId<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, sessionId<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, dialogId<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, viewId<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_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">
<p>Implementation of <a href="../interfaces/_dialog_dialogapi_.dialogapi.html">DialogApi</a>.<a href="../interfaces/_dialog_dialogapi_.dialogapi.html#changeview">changeView</a></p>
<ul>
<li>Defined in <a href="https://github.com/catavolt-oss/cv-dialog-sdk/blob/ba57488/src/catavolt/dialog/DialogService.ts#L279">dialog/DialogService.ts:279</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>sessionId: <span class="tsd-signature-type">string</span></h5>
</li>
<li>
<h5>dialogId: <span class="tsd-signature-type">string</span></h5>
</li>
<li>
<h5>viewId: <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_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-class">
<a name="createsession" class="tsd-anchor"></a>
<h3>create<wbr>Session</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">create<wbr>Session<span class="tsd-signature-symbol">(</span>tenantId<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, login<span class="tsd-signature-symbol">: </span><a href="../interfaces/_models_login_.login.html" class="tsd-signature-type">Login</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="../interfaces/_models_session_.session.html" class="tsd-signature-type">Session</a><span class="tsd-signature-symbol"> | </span><a href="../interfaces/_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">
<p>Implementation of <a href="../interfaces/_dialog_dialogapi_.dialogapi.html">DialogApi</a>.<a href="../interfaces/_dialog_dialogapi_.dialogapi.html#createsession">createSession</a></p>
<ul>
<li>Defined in <a href="https://github.com/catavolt-oss/cv-dialog-sdk/blob/ba57488/src/catavolt/dialog/DialogService.ts#L52">dialog/DialogService.ts:52</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>login: <a href="../interfaces/_models_login_.login.html" class="tsd-signature-type">Login</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="../interfaces/_models_session_.session.html" class="tsd-signature-type">Session</a><span class="tsd-signature-symbol"> | </span><a href="../interfaces/_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-class tsd-is-private">
<a name="d3lete" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagPrivate">Private</span> d3lete</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-private">
<li class="tsd-signature tsd-kind-icon">d3lete<span class="tsd-signature-symbol">(</span>path<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="_client_jsonclientresponse_.jsonclientresponse.html" class="tsd-signature-type">JsonClientResponse</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/DialogService.ts#L317">dialog/DialogService.ts:317</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>path: <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="_client_jsonclientresponse_.jsonclientresponse.html" class="tsd-signature-type">JsonClientResponse</a><span class="tsd-signature-symbol">></span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
<a name="deletedialog" class="tsd-anchor"></a>
<h3>delete<wbr>Dialog</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">delete<wbr>Dialog<span class="tsd-signature-symbol">(</span>tenantId<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, sessionId<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</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><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">
<p>Implementation of <a href="../interfaces/_dialog_dialogapi_.dialogapi.html">DialogApi</a>.<a href="../interfaces/_dialog_dialogapi_.dialogapi.html#deletedialog">deleteDialog</a></p>
<ul>
<li>Defined in <a href="https://github.com/catavolt-oss/cv-dialog-sdk/blob/ba57488/src/catavolt/dialog/DialogService.ts#L105">dialog/DialogService.ts:105</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>sessionId: <span class="tsd-signature-type">string</span></h5>
</li>
<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><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-class">
<a name="deletesession" class="tsd-anchor"></a>
<h3>delete<wbr>Session</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">delete<wbr>Session<span class="tsd-signature-symbol">(</span>tenantId<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, sessionId<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></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<p>Implementation of <a href="../interfaces/_dialog_dialogapi_.dialogapi.html">DialogApi</a>.<a href="../interfaces/_dialog_dialogapi_.dialogapi.html#deletesession">deleteSession</a></p>
<ul>
<li>Defined in <a href="https://github.com/catavolt-oss/cv-dialog-sdk/blob/ba57488/src/catavolt/dialog/DialogService.ts#L63">dialog/DialogService.ts:63</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>sessionId: <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><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-class tsd-is-private">
<a name="get" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagPrivate">Private</span> get</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-private">
<li class="tsd-signature tsd-kind-icon">get<span class="tsd-signature-symbol">(</span>path<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, queryParams<span class="tsd-signature-symbol">?: </span><a href="../interfaces/_util_stringdictionary_.stringdictionary.html" class="tsd-signature-type">StringDictionary</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="_client_jsonclientresponse_.jsonclientresponse.html" class="tsd-signature-type">JsonClientResponse</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/DialogService.ts#L309">dialog/DialogService.ts:309</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>path: <span class="tsd-signature-type">string</span></h5>
</li>
<li>
<h5><span class="tsd-flag ts-flagOptional">Optional</span> queryParams: <a href="../interfaces/_util_stringdictionary_.stringdictionary.html" class="tsd-signature-type">StringDictionary</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="_client_jsonclientresponse_.jsonclientresponse.html" class="tsd-signature-type">JsonClientResponse</a><span class="tsd-signature-symbol">></span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
<a name="getactions" class="tsd-anchor"></a>
<h3>get<wbr>Actions</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">get<wbr>Actions<span class="tsd-signature-symbol">(</span>tenantId<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, sessionId<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</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><span class="tsd-signature-type">Array</span><span class="tsd-signature-symbol"><</span><a href="_models_menu_.menu.html" class="tsd-signature-type">Menu</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<p>Implementation of <a href="../interfaces/_dialog_dialogapi_.dialogapi.html">DialogApi</a>.<a href="../interfaces/_dialog_dialogapi_.dialogapi.html#getactions">getActions</a></p>
<ul>
<li>Defined in <a href="https://github.com/catavolt-oss/cv-dialog-sdk/blob/ba57488/src/catavolt/dialog/DialogService.ts#L111">dialog/DialogService.ts:111</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>sessionId: <span class="tsd-signature-type">string</span></h5>
</li>
<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><span class="tsd-signature-type">Array</span><span class="tsd-signature-symbol"><</span><a href="_models_menu_.menu.html" class="tsd-signature-type">Menu</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
<a name="getavailablevalues" class="tsd-anchor"></a>
<h3>get<wbr>Available<wbr>Values</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">get<wbr>Available<wbr>Values<span class="tsd-signature-symbol">(</span>tenantId<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, sessionId<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, dialogId<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, propertyName<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, availableValuesParams<span class="tsd-signature-symbol">: </span><a href="../interfaces/_models_availablevaluesparameters_.availablevaluesparameters.html" class="tsd-signature-type">AvailableValuesParameters</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">Array</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<p>Implementation of <a href="../interfaces/_dialog_dialogapi_.dialogapi.html">DialogApi</a>.<a href="../interfaces/_dialog_dialogapi_.dialogapi.html#getavailablevalues">getAvailableValues</a></p>
<ul>
<li>Defined in <a href="https://github.com/catavolt-oss/cv-dialog-sdk/blob/ba57488/src/catavolt/dialog/DialogService.ts#L236">dialog/DialogService.ts:236</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>sessionId: <span class="tsd-signature-type">string</span></h5>
</li>
<li>
<h5>dialogId: <span class="tsd-signature-type">string</span></h5>
</li>
<li>
<h5>propertyName: <span class="tsd-signature-type">string</span></h5>
</li>
<li>
<h5>availableValuesParams: <a href="../interfaces/_models_availablevaluesparameters_.availablevaluesparameters.html" class="tsd-signature-type">AvailableValuesParameters</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">Array</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
<a name="getcontent" class="tsd-anchor"></a>
<h3>get<wbr>Content</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">get<wbr>Content<span class="tsd-signature-symbol">(</span>tenantId<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, sessionId<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, contentId<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, readLargePropertyParams<span class="tsd-signature-symbol">: </span><a href="../interfaces/_models_readlargepropertyparameters_.readlargepropertyparameters.html" class="tsd-signature-type">ReadLargePropertyParameters</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="_models_largeproperty_.largeproperty.html" class="tsd-signature-type">LargeProperty</a><span class="tsd-signature-symbol">></span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<p>Implementation of <a href="../interfaces/_dialog_dialogapi_.dialogapi.html">DialogApi</a>.<a href="../interfaces/_dialog_dialogapi_.dialogapi.html#getcontent">getContent</a></p>
<ul>
<li>Defined in <a href="https://github.com/catavolt-oss/cv-dialog-sdk/blob/ba57488/src/catavolt/dialog/DialogService.ts#L69">dialog/DialogService.ts:69</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>sessionId: <span class="tsd-signature-type">string</span></h5>
</li>
<li>
<h5>contentId: <span class="tsd-signature-type">string</span></h5>
</li>
<li>
<h5>readLargePropertyParams: <a href="../interfaces/_models_readlargepropertyparameters_.readlargepropertyparameters.html" class="tsd-signature-type">ReadLargePropertyParameters</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="_models_largeproperty_.largeproperty.html" class="tsd-signature-type">LargeProperty</a><span class="tsd-signature-symbol">></span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
<a name="getdialog" class="tsd-anchor"></a>
<h3>get<wbr>Dialog</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">get<wbr>Dialog<span class="tsd-signature-symbol">(</span>tenantId<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, sessionId<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</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="_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">
<p>Implementation of <a href="../interfaces/_dialog_dialogapi_.dialogapi.html">DialogApi</a>.<a href="../interfaces/_dialog_dialogapi_.dialogapi.html#getdialog">getDialog</a></p>
<ul>
<li>Defined in <a href="https://github.com/catavolt-oss/cv-dialog-sdk/blob/ba57488/src/catavolt/dialog/DialogService.ts#L99">dialog/DialogService.ts:99</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>sessionId: <span class="tsd-signature-type">string</span></h5>
</li>
<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="_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-class">
<a name="geteditorproperty" class="tsd-anchor"></a>
<h3>get<wbr>Editor<wbr>Property</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">get<wbr>Editor<wbr>Property<span class="tsd-signature-symbol">(</span>tenantId<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, sessionId<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, dialogId<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, propertyName<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, readLargePropertyParams<span class="tsd-signature-symbol">: </span><a href="../interfaces/_models_readlargepropertyparameters_.readlargepropertyparameters.html" class="tsd-signature-type">ReadLargePropertyParameters</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="_models_largeproperty_.largeproperty.html" class="tsd-signature-type">LargeProperty</a><span class="tsd-signature-symbol">></span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<p>Implementation of <a href="../interfaces/_dialog_dialogapi_.dialogapi.html">DialogApi</a>.<a href="../interfaces/_dialog_dialogapi_.dialogapi.html#geteditorproperty">getEditorProperty</a></p>
<ul>
<li>Defined in <a href="https://github.com/catavolt-oss/cv-dialog-sdk/blob/ba57488/src/catavolt/dialog/DialogService.ts#L182">dialog/DialogService.ts:182</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>sessionId: <span class="tsd-signature-type">string</span></h5>
</li>
<li>
<h5>dialogId: <span class="tsd-signature-type">string</span></h5>
</li>
<li>
<h5>propertyName: <span class="tsd-signature-type">string</span></h5>
</li>
<li>
<h5>readLargePropertyParams: <a href="../interfaces/_models_readlargepropertyparameters_.readlargepropertyparameters.html" class="tsd-signature-type">ReadLargePropertyParameters</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="_models_largeproperty_.largeproperty.html" class="tsd-signature-type">LargeProperty</a><span class="tsd-signature-symbol">></span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
<a name="getmode" class="tsd-anchor"></a>
<h3>get<wbr>Mode</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">get<wbr>Mode<span class="tsd-signature-symbol">(</span>tenantId<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, sessionId<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</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