fms-admin-client
Version:
A client designed to provide a framework for interactions with FileMaker Server Admin Tools.
752 lines (189 loc) • 9.57 kB
HTML
<html lang="en">
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width,initial-scale=1">
<title>Credentials - Documentation</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="https://code.ionicframework.com/ionicons/2.0.1/css/ionicons.min.css">
<link type="text/css" rel="stylesheet" href="styles/prettify-tomorrow.css">
<link type="text/css" rel="stylesheet" href="styles/jsdoc-default.css">
</head>
<body>
<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>
<nav>
<li class="nav-link nav-home-link"><a href="index.html">Home</a></li><li class="nav-heading">Classes</li><li class="nav-heading"><span class="nav-item-type type-class">C</span><span class="nav-item-name"><a href="Admin.html">Admin</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="Admin.html#preInit">preInit</a></span></li><li class="nav-heading"><span class="nav-item-type type-class">C</span><span class="nav-item-name"><a href="CLI.html">CLI</a></span></li><li class="nav-heading"><span class="nav-item-type type-class">C</span><span class="nav-item-name"><a href="Credentials.html">Credentials</a></span></li><li class="nav-heading">Modules</li><li class="nav-heading"><span class="nav-item-type type-module">M</span><span class="nav-item-name"><a href="module-Admin.html">Admin</a></span></li><li class="nav-heading"><span class="nav-item-type type-module">M</span><span class="nav-item-name"><a href="module-CLI.html">CLI</a></span></li><li class="nav-heading"><span class="nav-item-type type-module">M</span><span class="nav-item-name"><a href="module-Credentials.html">Credentials</a></span></li><li class="nav-heading"><a href="global.html">Globals</a></li><li class="nav-item"><span class="nav-item-type type-member">M</span><span class="nav-item-name"><a href="global.html#cli">cli</a></span></li>
</nav>
<div id="main">
<h1 class="page-title">Credentials</h1>
<section>
<header>
<h2>
Credentials
</h2>
<div class="class-description"><p>The class used to authenticate with into the FileMaker API.</p></div>
</header>
<article>
<div class="container-overview">
<div class="section-method">
<h2>Constructor</h2>
<h4 class="name" id="Credentials"><span class="type-signature"></span>new Credentials<span class="signature">()</span><span class="type-signature"></span></h4>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="migration.model.js.html">migration.model.js</a>, <a href="migration.model.js.html#line6">line 6</a>
</li></ul></dd>
</dl>
</div>
</div>
<h3 class="subsection-title">Members</h3>
<div class="section-members">
<h4 class="name" id="password"><span class="type-signature"></span>password<span class="type-signature"> :String</span></h4>
<div class="description">
<p>A string containing the time the token token was issued.</p>
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="credentials.model.js.html">credentials.model.js</a>, <a href="credentials.model.js.html#line13">line 13</a>
</li></ul></dd>
</dl>
<h5>Type:</h5>
<ul>
<li>
<span class="param-type"><code>String</code></span>
</li>
</ul>
</div>
<div class="section-members">
<h4 class="name" id="password"><span class="type-signature"></span>password<span class="type-signature"> :String</span></h4>
<div class="description">
<p>A string containing the time the token token was issued.</p>
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="migration.model.js.html">migration.model.js</a>, <a href="migration.model.js.html#line14">line 14</a>
</li></ul></dd>
</dl>
<h5>Type:</h5>
<ul>
<li>
<span class="param-type"><code>String</code></span>
</li>
</ul>
</div>
<div class="section-members">
<h4 class="name" id="user"><span class="type-signature"></span>user<span class="type-signature"> :String</span></h4>
<div class="description">
<p>The token to use when querying an endpoint.</p>
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="credentials.model.js.html">credentials.model.js</a>, <a href="credentials.model.js.html#line21">line 21</a>
</li></ul></dd>
</dl>
<h5>Type:</h5>
<ul>
<li>
<span class="param-type"><code>String</code></span>
</li>
</ul>
</div>
</article>
</section>
<section>
<header>
<h2>
Credentials
</h2>
<div class="class-description"><p>The class used to authenticate with into the FileMaker API.</p></div>
</header>
<article>
<div class="container-overview">
<div class="section-method">
<h2>Constructor</h2>
<h4 class="name" id="Credentials"><span class="type-signature"></span>new Credentials<span class="signature">()</span><span class="type-signature"></span></h4>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="credentials.model.js.html">credentials.model.js</a>, <a href="credentials.model.js.html#line5">line 5</a>
</li></ul></dd>
</dl>
</div>
</div>
<h3 class="subsection-title">Members</h3>
<div class="section-members">
<h4 class="name" id="password"><span class="type-signature"></span>password<span class="type-signature"> :String</span></h4>
<div class="description">
<p>A string containing the time the token token was issued.</p>
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="credentials.model.js.html">credentials.model.js</a>, <a href="credentials.model.js.html#line13">line 13</a>
</li></ul></dd>
</dl>
<h5>Type:</h5>
<ul>
<li>
<span class="param-type"><code>String</code></span>
</li>
</ul>
</div>
<div class="section-members">
<h4 class="name" id="password"><span class="type-signature"></span>password<span class="type-signature"> :String</span></h4>
<div class="description">
<p>A string containing the time the token token was issued.</p>
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="migration.model.js.html">migration.model.js</a>, <a href="migration.model.js.html#line14">line 14</a>
</li></ul></dd>
</dl>
<h5>Type:</h5>
<ul>
<li>
<span class="param-type"><code>String</code></span>
</li>
</ul>
</div>
<div class="section-members">
<h4 class="name" id="user"><span class="type-signature"></span>user<span class="type-signature"> :String</span></h4>
<div class="description">
<p>The token to use when querying an endpoint.</p>
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="credentials.model.js.html">credentials.model.js</a>, <a href="credentials.model.js.html#line21">line 21</a>
</li></ul></dd>
</dl>
<h5>Type:</h5>
<ul>
<li>
<span class="param-type"><code>String</code></span>
</li>
</ul>
</div>
</article>
</section>
</div>
<br class="clear">
<footer>
Generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Mon Oct 29 2018 22:49:18 GMT-0700 (PDT) using the Minami theme.
</footer>
<script>prettyPrint();</script>
<script src="scripts/linenumber.js"></script>
</body>
</html>