onemsdk
Version:
ONEm developer library for NodeJS
675 lines (257 loc) • 12.2 kB
HTML
<html lang="en">
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>
FormMeta - Documentation
</title>
<link href="https://www.braintreepayments.com/images/favicon-ccda0b14.png" rel="icon" type="image/png">
<script src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/9.7.0/highlight.min.js"></script>
<script>hljs.initHighlightingOnLoad();</script>
<script src="https://ajax.googleapis.com/ajax/libs/jquery/3.1.0/jquery.min.js"></script>
<link type="text/css" rel="stylesheet" href="styles/prettify-tomorrow.css">
<link type="text/css" rel="stylesheet" href="styles/jsdoc-default.css">
<link type="text/css" rel="stylesheet" href="styles/collapse.css">
<!-- start Mixpanel -->
<script type="text/javascript">(function(e,a){if(!a.__SV){var b=window;try{var c,l,i,j=b.location,g=j.hash;c=function(a,b){return(l=a.match(RegExp(b+"=([^&]*)")))?l[1]:null};g&&c(g,"state")&&(i=JSON.parse(decodeURIComponent(c(g,"state"))),"mpeditor"===i.action&&(b.sessionStorage.setItem("_mpcehash",g),history.replaceState(i.desiredHash||"",e.title,j.pathname+j.search)))}catch(m){}var k,h;window.mixpanel=a;a._i=[];a.init=function(b,c,f){function e(b,a){var c=a.split(".");2==c.length&&(b=b[c[0]],a=c[1]);b[a]=function(){b.push([a].concat(Array.prototype.slice.call(arguments,
0)))}}var d=a;"undefined"!==typeof f?d=a[f]=[]:f="mixpanel";d.people=d.people||[];d.toString=function(b){var a="mixpanel";"mixpanel"!==f&&(a+="."+f);b||(a+=" (stub)");return a};d.people.toString=function(){return d.toString(1)+".people (stub)"};k="disable time_event track track_pageview track_links track_forms register register_once alias unregister identify name_tag set_config reset people.set people.set_once people.increment people.append people.union people.track_charge people.clear_charges people.delete_user".split(" ");
for(h=0;h<k.length;h++)e(d,k[h]);a._i.push([b,c,f])};a.__SV=1.2;b=e.createElement("script");b.type="text/javascript";b.async=!0;b.src="undefined"!==typeof MIXPANEL_CUSTOM_LIB_URL?MIXPANEL_CUSTOM_LIB_URL:"file:"===e.location.protocol&&"//cdn.mxpnl.com/libs/mixpanel-2-latest.min.js".match(/^\/\//)?"https://cdn.mxpnl.com/libs/mixpanel-2-latest.min.js":"//cdn.mxpnl.com/libs/mixpanel-2-latest.min.js";c=e.getElementsByTagName("script")[0];c.parentNode.insertBefore(b,c)}})(document,window.mixpanel||[]);
mixpanel.init("1919205b2da72e4da3b9b6639b444d59");</script>
<!-- end Mixpanel -->
</head>
<body>
<svg style="display: none;">
<defs>
<symbol id="linkIcon" fill="#706d77" height="24" viewBox="0 0 24 24" width="24" xmlns="http://www.w3.org/2000/svg">
<path d="M0 0h24v24H0z" fill="none"/>
<path d="M3.9 12c0-1.71 1.39-3.1 3.1-3.1h4V7H7c-2.76 0-5 2.24-5 5s2.24 5 5 5h4v-1.9H7c-1.71 0-3.1-1.39-3.1-3.1zM8 13h8v-2H8v2zm9-6h-4v1.9h4c1.71 0 3.1 1.39 3.1 3.1s-1.39 3.1-3.1 3.1h-4V17h4c2.76 0 5-2.24 5-5s-2.24-5-5-5z"/>
</symbol>
</defs>
</svg>
<input type="checkbox" id="nav-trigger" class="nav-trigger" />
<label for="nav-trigger" class="navicon-button x">
<div class="navicon"></div>
</label>
<label for="nav-trigger" class="overlay"></label>
<div class="top-nav-wrapper">
<ul>
<li >
<a href="index.html">
<svg fill="#6D6D6D" height="24" viewBox="0 0 24 24" width="24" xmlns="http://www.w3.org/2000/svg">
<path d="M10 20v-6h4v6h5v-8h3L12 3 2 12h3v8z"/>
<path d="M0 0h24v24H0z" fill="none"/>
</svg>
</a>
</li>
</ul>
</div>
<nav>
<h3 class="reference-title">
NodeJS ONEm SDK
</h3>
<h3>Classes</h3><ul><li id="Form-nav"><a href="Form.html">Form</a><ul class='methods'><li data-type="method" id="Form-fromTag-nav"><a href="Form.html#.fromTag">fromTag</a></li></ul></li><li id="FormItem-nav"><a href="FormItem.html">FormItem</a><ul class='methods'><li data-type="method" id="FormItem-fromTag-nav"><a href="FormItem.html#.fromTag">fromTag</a></li></ul></li><li id="FormMeta-nav"><a href="FormMeta.html">FormMeta</a></li><li id="Menu-nav"><a href="Menu.html">Menu</a><ul class='methods'><li data-type="method" id="Menu-fromTag-nav"><a href="Menu.html#.fromTag">fromTag</a></li></ul></li><li id="MenuFormItemMeta-nav"><a href="MenuFormItemMeta.html">MenuFormItemMeta</a></li><li id="MenuItem-nav"><a href="MenuItem.html">MenuItem</a><ul class='methods'><li data-type="method" id="MenuItem-fromTag-nav"><a href="MenuItem.html#.fromTag">fromTag</a></li></ul></li><li id="MenuItemFormItem-nav"><a href="MenuItemFormItem.html">MenuItemFormItem</a><ul class='methods'><li data-type="method" id="MenuItemFormItem-fromTag-nav"><a href="MenuItemFormItem.html#.fromTag">fromTag</a></li></ul></li><li id="MenuMeta-nav"><a href="MenuMeta.html">MenuMeta</a></li><li id="Response-nav"><a href="Response.html">Response</a><ul class='methods'><li data-type="method" id="Response-fromTag-nav"><a href="Response.html#.fromTag">fromTag</a></li></ul></li></ul>
</nav>
<div id="main">
<h1 class="page-title">
FormMeta
</h1>
<section>
<header>
<h2>
FormMeta
</h2>
<div class="class-description">
<p><a href="Form.html"><code>Form</code></a> related component holding configuration fields for the form. A FormMeta object as defined in the JSON schema.</p>
</div>
</header>
<article>
<div class="container-overview">
<h2>Constructor</h2>
<span class='name-container'>
<a class="link-icon" href="#FormMeta">
<svg height="20" width="20" style="fill: black;">
<use xlink:href="#linkIcon"></use>
</svg>
</a>
<h4 class="name" id="FormMeta">
<span class="type-signature"></span>new FormMeta<span class="signature">(props)</span><span class="type-signature"></span>
</h4>
</span>
<div class="description">
<p>Instantiates a new FormMeta</p>
</div>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>props</code></td>
<td class="type">
<span class="param-type">
object
</span>
</td>
<td class="description last">
<p>Properties to initialize the FormMeta with</p>
<h6>Properties</h6>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th>Attributes</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>completionStatusShow</code></td>
<td class="type">
<span class="param-type">
boolean
</span>
</td>
<td class="attributes">
<optional><br>
</td>
<td class="description last">
<p>Sets <a href="FormMeta.html#completionStatusShow"><code>FormMeta#completionStatusShow</code></a></p>
</td>
</tr>
<tr>
<td class="name"><code>completionStatusInHeader</code></td>
<td class="type">
<span class="param-type">
boolean
</span>
</td>
<td class="attributes">
<optional><br>
</td>
<td class="description last">
<p>Sets <a href="FormMeta.html#completionStatusInHeader"><code>FormMeta#completionStatusInHeader</code></a></p>
</td>
</tr>
<tr>
<td class="name"><code>skipConfirmation</code></td>
<td class="type">
<span class="param-type">
boolean
</span>
</td>
<td class="attributes">
<optional><br>
</td>
<td class="description last">
<p>Sets <a href="FormMeta.html#skipConfirmation"><code>FormMeta#skipConfirmation</code></a></p>
</td>
</tr>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source">
<ul class="dummy">
<li>
<a href="index.js.html">index.js</a>, <a href="index.js.html#line120">line 120</a>
</li>
</ul>
</dd>
</dl>
</div>
<h3 class="subsection-title">Members</h3>
<h4 class="name" id="completionStatusInHeader">
<span class="type-signature"></span>completionStatusInHeader<span class="type-signature"> :boolean</span>
</h4>
<div class="description">
<p>If <code>true</code> will indicate the status in the header. Defaults to <code>false</code>, which means it will be shown below
header if the completion status is shown.</p>
</div>
<dl class="details">
<dt class="tag-default">Default Value:</dt>
<dd class="tag-default">
<ul class="dummy">
<li>
false
</li>
</ul>
</dd>
<dt class="tag-source">Source:</dt>
<dd class="tag-source">
<ul class="dummy">
<li>
<a href="index.js.html">index.js</a>, <a href="index.js.html#line141">line 141</a>
</li>
</ul>
</dd>
</dl>
<h4 class="name" id="completionStatusShow">
<span class="type-signature"></span>completionStatusShow<span class="type-signature"> :boolean</span>
</h4>
<div class="description">
<p>If <code>true</code> will show a completion status. Defaults to <code>false</code>.</p>
</div>
<dl class="details">
<dt class="tag-default">Default Value:</dt>
<dd class="tag-default">
<ul class="dummy">
<li>
false
</li>
</ul>
</dd>
<dt class="tag-source">Source:</dt>
<dd class="tag-source">
<ul class="dummy">
<li>
<a href="index.js.html">index.js</a>, <a href="index.js.html#line132">line 132</a>
</li>
</ul>
</dd>
</dl>
<h4 class="name" id="skipConfirmation">
<span class="type-signature"></span>skipConfirmation<span class="type-signature"> :boolean</span>
</h4>
<div class="description">
<p>If <code>true</code> will not ask for confirmation. Defaults to <code>false</code>.</p>
</div>
<dl class="details">
<dt class="tag-default">Default Value:</dt>
<dd class="tag-default">
<ul class="dummy">
<li>
false
</li>
</ul>
</dd>
<dt class="tag-source">Source:</dt>
<dd class="tag-source">
<ul class="dummy">
<li>
<a href="index.js.html">index.js</a>, <a href="index.js.html#line151">line 151</a>
</li>
</ul>
</dd>
</dl>
</article>
</section>
</div>
<br class="clear">
<footer>
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.3</a>
</footer>
<script src="scripts/linenumber.js"></script>
<script src="scripts/pagelocation.js"></script>
</body>
</html>