GT2/GT2-iOS/node_modules/auth0/docs/external-RestClient.html

848 lines
40 KiB
HTML
Raw Normal View History

2018-02-12 17:26:06 +00:00
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width,initial-scale=1">
<title>RestClient - 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="module-auth.AuthenticationClient.html">AuthenticationClient</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="module-auth.AuthenticationClient.html#changePassword">changePassword</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="module-auth.AuthenticationClient.html#clientCredentialsGrant">clientCredentialsGrant</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="module-auth.AuthenticationClient.html#getClientInfo">getClientInfo</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="module-auth.AuthenticationClient.html#getDelegationToken">getDelegationToken</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="module-auth.AuthenticationClient.html#getProfile">getProfile</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="module-auth.AuthenticationClient.html#passwordGrant">passwordGrant</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="module-auth.AuthenticationClient.html#requestChangePasswordEmail">requestChangePasswordEmail</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="module-auth.AuthenticationClient.html#requestEmailCode">requestEmailCode</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="module-auth.AuthenticationClient.html#requestMagicLink">requestMagicLink</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="module-auth.AuthenticationClient.html#requestSMSCode">requestSMSCode</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="module-auth.AuthenticationClient.html#verifySMSCode">verifySMSCode</a></span></li><li class="nav-heading"><span class="nav-item-type type-class">C</span><span class="nav-item-name"><a href="module-auth.DatabaseAuthenticator.html">DatabaseAuthenticator</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="module-auth.DatabaseAuthenticator.html#changePassword">changePassword</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="module-auth.DatabaseAuthenticator.html#requestChangePasswordEmail">requestChangePasswordEmail</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="module-auth.DatabaseAuthenticator.html#signIn">signIn</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="module-auth.DatabaseAuthenticator.html#signUp">signUp</a></span></li><li class="nav-heading"><span class="nav-item-type type-class">C</span><span class="nav-item-name"><a href="module-auth.OAuthAuthenticator.html">OAuthAuthenticator</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="module-auth.OAuthAuthenticator.html#passwordGrant">passwordGrant</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="module-auth.OAuthAuthenticator.html#signIn">signIn</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="module-auth.OAuthAuthenticator.html#socialSignIn">s
</nav>
<div id="main">
<h1 class="page-title">RestClient</h1>
<section>
<header>
<h2>
RestClient
</h2>
</header>
<article>
<div class="container-overview">
<div class="description"><p>Simple facade for consuming a REST API endpoint.</p></div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="management_StatsManager.js.html">management/StatsManager.js</a>, <a href="management_StatsManager.js.html#line5">line 5</a>
</li></ul></dd>
<dt class="tag-see">See:</dt>
<dd class="tag-see">
<ul>
<li><a href="https://github.com/ngonzalvez/rest-facade">https://github.com/ngonzalvez/rest-facade</a></li>
</ul>
</dd>
</dl>
</div>
</article>
</section>
<section>
<header>
<h2>
RestClient
</h2>
</header>
<article>
<div class="container-overview">
<div class="description"><p>Simple facade for consuming a REST API endpoint.</p></div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="management_RulesManager.js.html">management/RulesManager.js</a>, <a href="management_RulesManager.js.html#line6">line 6</a>
</li></ul></dd>
<dt class="tag-see">See:</dt>
<dd class="tag-see">
<ul>
<li><a href="https://github.com/ngonzalvez/rest-facade">https://github.com/ngonzalvez/rest-facade</a></li>
</ul>
</dd>
</dl>
</div>
</article>
</section>
<section>
<header>
<h2>
RestClient
</h2>
</header>
<article>
<div class="container-overview">
<div class="description"><p>Simple facade for consuming a REST API endpoint.</p></div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="management_TenantManager.js.html">management/TenantManager.js</a>, <a href="management_TenantManager.js.html#line5">line 5</a>
</li></ul></dd>
<dt class="tag-see">See:</dt>
<dd class="tag-see">
<ul>
<li><a href="https://github.com/ngonzalvez/rest-facade">https://github.com/ngonzalvez/rest-facade</a></li>
</ul>
</dd>
</dl>
</div>
</article>
</section>
<section>
<header>
<h2>
RestClient
</h2>
</header>
<article>
<div class="container-overview">
<div class="description"><p>Simple facade for consuming a REST API endpoint.</p></div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="management_UsersManager.js.html">management/UsersManager.js</a>, <a href="management_UsersManager.js.html#line5">line 5</a>
</li></ul></dd>
<dt class="tag-see">See:</dt>
<dd class="tag-see">
<ul>
<li><a href="https://github.com/ngonzalvez/rest-facade">https://github.com/ngonzalvez/rest-facade</a></li>
</ul>
</dd>
</dl>
</div>
</article>
</section>
<section>
<header>
<h2>
RestClient
</h2>
</header>
<article>
<div class="container-overview">
<div class="description"><p>Simple facade for consuming a REST API endpoint.</p></div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="management_JobsManager.js.html">management/JobsManager.js</a>, <a href="management_JobsManager.js.html#line10">line 10</a>
</li></ul></dd>
<dt class="tag-see">See:</dt>
<dd class="tag-see">
<ul>
<li><a href="https://github.com/ngonzalvez/rest-facade">https://github.com/ngonzalvez/rest-facade</a></li>
</ul>
</dd>
</dl>
</div>
</article>
</section>
<section>
<header>
<h2>
RestClient
</h2>
</header>
<article>
<div class="container-overview">
<div class="description"><p>Simple facade for consuming a REST API endpoint.</p></div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="management_EmailProviderManager.js.html">management/EmailProviderManager.js</a>, <a href="management_EmailProviderManager.js.html#line6">line 6</a>
</li></ul></dd>
<dt class="tag-see">See:</dt>
<dd class="tag-see">
<ul>
<li><a href="https://github.com/ngonzalvez/rest-facade">https://github.com/ngonzalvez/rest-facade</a></li>
</ul>
</dd>
</dl>
</div>
</article>
</section>
<section>
<header>
<h2>
RestClient
</h2>
</header>
<article>
<div class="container-overview">
<div class="description"><p>Simple facade for consuming a REST API endpoint.</p></div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="management_DeviceCredentialsManager.js.html">management/DeviceCredentialsManager.js</a>, <a href="management_DeviceCredentialsManager.js.html#line6">line 6</a>
</li></ul></dd>
<dt class="tag-see">See:</dt>
<dd class="tag-see">
<ul>
<li><a href="https://github.com/ngonzalvez/rest-facade">https://github.com/ngonzalvez/rest-facade</a></li>
</ul>
</dd>
</dl>
</div>
</article>
</section>
<section>
<header>
<h2>
RestClient
</h2>
</header>
<article>
<div class="container-overview">
<div class="description"><p>Simple facade for consuming a REST API endpoint.</p></div>
<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#line1">line 1</a>
</li></ul></dd>
<dt class="tag-see">See:</dt>
<dd class="tag-see">
<ul>
<li><a href="https://github.com/ngonzalvez/rest-facade">https://github.com/ngonzalvez/rest-facade</a></li>
</ul>
</dd>
</dl>
</div>
</article>
</section>
</div>
<br class="clear">
<footer>
Generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.3</a> on Fri Dec 08 2017 10:01:22 GMT-0300 (-03) using the Minami theme.
</footer>
<script>prettyPrint();</script>
<script src="scripts/linenumber.js"></script>
</body>
</html>