react-native-auth0
Version:
React Native toolkit for Auth0 API
282 lines (259 loc) • 8.85 kB
HTML
<html lang="en">
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width,initial-scale=1" />
<title>Global - 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="Auth.html">Auth</a></span>
</li>
<li class="nav-item">
<span class="nav-item-type type-function">F</span
><span class="nav-item-name"
><a href="Auth.html#.authorizeUrl">authorizeUrl</a></span
>
</li>
<li class="nav-item">
<span class="nav-item-type type-function">F</span
><span class="nav-item-name"
><a href="Auth.html#.createUser">createUser</a></span
>
</li>
<li class="nav-item">
<span class="nav-item-type type-function">F</span
><span class="nav-item-name"
><a href="Auth.html#.exchange">exchange</a></span
>
</li>
<li class="nav-item">
<span class="nav-item-type type-function">F</span
><span class="nav-item-name"
><a href="Auth.html#.exchangeNativeSocial"
>exchangeNativeSocial</a
></span
>
</li>
<li class="nav-item">
<span class="nav-item-type type-function">F</span
><span class="nav-item-name"
><a href="Auth.html#.loginWithEmail">loginWithEmail</a></span
>
</li>
<li class="nav-item">
<span class="nav-item-type type-function">F</span
><span class="nav-item-name"
><a href="Auth.html#.loginWithSMS">loginWithSMS</a></span
>
</li>
<li class="nav-item">
<span class="nav-item-type type-function">F</span
><span class="nav-item-name"
><a href="Auth.html#.logoutUrl">logoutUrl</a></span
>
</li>
<li class="nav-item">
<span class="nav-item-type type-function">F</span
><span class="nav-item-name"
><a href="Auth.html#.passwordlessWithEmail"
>passwordlessWithEmail</a
></span
>
</li>
<li class="nav-item">
<span class="nav-item-type type-function">F</span
><span class="nav-item-name"
><a href="Auth.html#.passwordlessWithSMS"
>passwordlessWithSMS</a
></span
>
</li>
<li class="nav-item">
<span class="nav-item-type type-function">F</span
><span class="nav-item-name"
><a href="Auth.html#.passwordRealm">passwordRealm</a></span
>
</li>
<li class="nav-item">
<span class="nav-item-type type-function">F</span
><span class="nav-item-name"
><a href="Auth.html#.refreshToken">refreshToken</a></span
>
</li>
<li class="nav-item">
<span class="nav-item-type type-function">F</span
><span class="nav-item-name"
><a href="Auth.html#.resetPassword">resetPassword</a></span
>
</li>
<li class="nav-item">
<span class="nav-item-type type-function">F</span
><span class="nav-item-name"
><a href="Auth.html#.revoke">revoke</a></span
>
</li>
<li class="nav-item">
<span class="nav-item-type type-function">F</span
><span class="nav-item-name"
><a href="Auth.html#.userInfo">userInfo</a></span
>
</li>
<li class="nav-heading">
<span class="nav-item-type type-class">C</span
><span class="nav-item-name"><a href="Auth0.html">Auth0</a></span>
</li>
<li class="nav-heading">
<span class="nav-item-type type-class">C</span
><span class="nav-item-name"
><a href="Auth0.module.exports.html">module.exports</a></span
>
</li>
<li class="nav-heading">
<span class="nav-item-type type-class">C</span
><span class="nav-item-name"><a href="Users.html">Users</a></span>
</li>
<li class="nav-item">
<span class="nav-item-type type-function">F</span
><span class="nav-item-name"
><a href="Users.html#.getUser">getUser</a></span
>
</li>
<li class="nav-item">
<span class="nav-item-type type-function">F</span
><span class="nav-item-name"
><a href="Users.html#.patchUser">patchUser</a></span
>
</li>
<li class="nav-heading">
<span class="nav-item-type type-class">C</span
><span class="nav-item-name"><a href="WebAuth.html">WebAuth</a></span>
</li>
<li class="nav-item">
<span class="nav-item-type type-function">F</span
><span class="nav-item-name"
><a href="WebAuth.html#.authorize">authorize</a></span
>
</li>
<li class="nav-item">
<span class="nav-item-type type-function">F</span
><span class="nav-item-name"
><a href="WebAuth.html#.clearSession">clearSession</a></span
>
</li>
<li class="nav-heading"><a href="global.html">Globals</a></li>
<li class="nav-item">
<span class="nav-item-type type-function">F</span
><span class="nav-item-name"
><a href="global.html#users">users</a></span
>
</li>
</nav>
<div id="main">
<h1 class="page-title">Global</h1>
<section>
<header>
<h2></h2>
</header>
<article>
<div class="container-overview">
<dl class="details"></dl>
</div>
<h3 class="subsection-title">Methods</h3>
<div class="section-method">
<h4 class="name" id="users">
<span class="type-signature"></span>users<span class="signature"
>(token)</span
><span class="type-signature">
→ {<a href="Users.html">Users</a>}</span
>
</h4>
<div class="description">
<p>Creates a Users API client</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#line33">line 33</a>
</li>
</ul>
</dd>
</dl>
<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>token</code></td>
<td class="type">
<span class="param-type"><code>String</code></span>
</td>
<td class="description last">
<p>for Management API</p>
</td>
</tr>
</tbody>
</table>
<div class="section-returns">
<h5>Returns:</h5>
<dl class="param-type">
<dt>
Type:
</dt>
<dd>
<span class="param-type"
><code><a href="Users.html">Users</a></code></span
>
</dd>
</dl>
</div>
</div>
</article>
</section>
</div>
<br class="clear" />
<footer>
Generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.6</a> on
Tue Jun 22 2021 14:24:13 GMT-0300 (Argentina Standard Time) using the
Minami theme.
</footer>
<script>
prettyPrint();
</script>
<script src="scripts/linenumber.js"></script>
</body>
</html>