scv-connector-base
Version:
Salesforce Service Cloud Connector Base
293 lines (90 loc) • 4.58 kB
HTML
<html lang="en">
<head>
<meta charset="utf-8">
<title>JSDoc: Class: LoginField</title>
<script src="scripts/prettify/prettify.js"> </script>
<script src="scripts/prettify/lang-css.js"> </script>
<!--[if lt IE 9]>
<script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
<![endif]-->
<link type="text/css" rel="stylesheet" href="styles/prettify-tomorrow.css">
<link type="text/css" rel="stylesheet" href="styles/jsdoc-default.css">
</head>
<body>
<div id="main">
<h1 class="page-title">Class: LoginField</h1>
<section>
<header>
<h2><span class="attribs"><span class="type-signature"></span></span>
<span class="ancestors"><a href="module-types.html">types</a>.</span>LoginField<span class="signature">(fieldId, fieldLabel, fieldType, fieldValues)</span><span class="type-signature"></span></h2>
<div class="class-description">Class representing a single login field</div>
</header>
<article>
<div class="container-overview">
<h2>Constructor</h2>
<h4 class="name" id="LoginField"><span class="type-signature"></span>new LoginField<span class="signature">(fieldId, fieldLabel, fieldType, fieldValues)</span><span class="type-signature"></span></h4>
<div class="description">
Create a Login Field
</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>fieldId</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="description last">Unique Id of the field</td>
</tr>
<tr>
<td class="name"><code>fieldLabel</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="description last">The label of the field to be shown in the UI</td>
</tr>
<tr>
<td class="name"><code>fieldType</code></td>
<td class="type">
<span class="param-type">FieldType</span>
</td>
<td class="description last">The type of field. This will deterine what UI control to show in the UI</td>
</tr>
<tr>
<td class="name"><code>fieldValues</code></td>
<td class="type">
<span class="param-type">FieldValues</span>
</td>
<td class="description last">Possible values to choose from in case of an Enum field type</td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="types.js.html">types.js</a>, <a href="types.js.html#line120">line 120</a>
</li></ul></dd>
</dl>
</div>
</article>
</section>
</div>
<nav>
<h2><a href="index.html">Home</a></h2><h3>Modules</h3><ul><li><a href="module-baseConnector.html">baseConnector</a></li><li><a href="module-types.html">types</a></li></ul><h3>Classes</h3><ul><li><a href="module-types.Contact.html">Contact</a></li><li><a href="module-types.LoginField.html">LoginField</a></li><li><a href="module-types.LoginSettings.html">LoginSettings</a></li><li><a href="module-types.PhoneCall.html">PhoneCall</a></li><li><a href="module-types.PhoneCallAttributes.html">PhoneCallAttributes</a></li><li><a href="module-types.TelephonySystemInfo.html">TelephonySystemInfo</a></li></ul>
</nav>
<br class="clear">
<footer>
Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.4</a> on Thu Jul 23 2020 18:27:15 GMT-0700 (Pacific Daylight Time)
</footer>
<script> prettyPrint(); </script>
<script src="scripts/linenumber.js"> </script>
</body>
</html>