mscs-face-api
Version:
Microsoft Cognitive Services Face API
336 lines (100 loc) • 4.31 kB
HTML
<html lang="en">
<head>
<meta charset="utf-8">
<title>JSDoc: Module: mscs-face-api</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">Module: mscs-face-api</h1>
<section>
<header>
</header>
<article>
<div class="container-overview">
<div class="description">This module helps you to comunicate with the Microsoft Cognitive Services Face API.
Be aware that not all functionalities from the API are implemented since they were not necessary to the project that was being developed.</div>
<dl class="details">
<dt class="tag-author">Author:</dt>
<dd class="tag-author">
<ul>
<li>itsdanielmatos</li>
</ul>
</dd>
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="mscs-face-api.js.html">mscs-face-api.js</a>, <a href="mscs-face-api.js.html#line3">line 3</a>
</li></ul></dd>
</dl>
</div>
<h3 class="subsection-title">Requires</h3>
<ul>
<li>module:axios</li>
</ul>
<h3 class="subsection-title">Classes</h3>
<dl>
<dt><a href="module-mscs-face-api.MSCSFaceApi.html">MSCSFaceApi</a></dt>
<dd></dd>
</dl>
<h3 class="subsection-title">Methods</h3>
<h4 class="name" id=".getServer"><span class="type-signature">(static) </span>getServer<span class="signature">(server)</span><span class="type-signature"> → {String}</span></h4>
<div class="description">
Retrieves the full name of the server correspondent to the short name received.
</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>server</code></td>
<td class="type">
<span class="param-type">String</span>
</td>
<td class="description last">Server short name to use this API. Options: WUS (westus), EUS2 (eastus2), WCUS (westcentralus), WE (westeurope) and SA (southeastasia).</td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="mscs-face-api.js.html">mscs-face-api.js</a>, <a href="mscs-face-api.js.html#line365">line 365</a>
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
If the short name for the server exists it will return the full name. If it doesn't returns undefined.
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">String</span>
</dd>
</dl>
</article>
</section>
</div>
<nav>
<h2><a href="index.html">Home</a></h2><h3>Modules</h3><ul><li><a href="module-mscs-face-api.html">mscs-face-api</a></li></ul><h3>Classes</h3><ul><li><a href="module-mscs-face-api.MSCSFaceApi.html">MSCSFaceApi</a></li></ul>
</nav>
<br class="clear">
<footer>
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.3</a> on Tue Jun 06 2017 19:43:41 GMT+0100 (Hora de Verão de GMT)
</footer>
<script> prettyPrint(); </script>
<script src="scripts/linenumber.js"> </script>
</body>
</html>