nodejs/hanko
1
0
Fork 0
mirror of https://github.com/teamhanko/hanko.git synced 2025-10-31 08:35:47 +08:00
Code Issues Packages Projects Releases Wiki Activity
Files
hanko/docs/static/jsdoc/hanko-frontend-sdk/WebauthnState.html
lfleischmann eec7a473a5 feat: add third party integrations 
add third party integrations
2023-02-23 13:05:05 +01:00

1345 lines
22 KiB
HTML
Raw Blame History

<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1">
<title> WebauthnState</title>
<script src="https://cdn.jsdelivr.net/gh/google/code-prettify@master/loader/run_prettify.js"></script>
<script src="https://unpkg.com/@babel/standalone/babel.min.js"></script>
<script src="./build/entry.js"></script>
<script src="https://ajax.googleapis.com/ajax/libs/jquery/3.3.1/jquery.min.js"></script>
<!--[if lt IE 9]>
<script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
<![endif]-->
<link href="https://fonts.googleapis.com/css?family=Roboto:100,400,700|Inconsolata,700" rel="stylesheet">
<link rel="stylesheet" href="https://use.fontawesome.com/releases/v5.6.3/css/all.css" integrity="sha384-UHRtZLI+pbxtHCWp1t77Bi1L4ZtiqrqD80Kn4Z8NTSRyMA2Fd33n5dQ8lWUE00s/" crossorigin="anonymous">
<link type="text/css" rel="stylesheet" href="https://jmblog.github.io/color-themes-for-google-code-prettify/themes/tomorrow-night.min.css">
<link type="text/css" rel="stylesheet" href="styles/app.min.css">
<link type="text/css" rel="stylesheet" href="styles/iframe.css">
<link type="text/css" rel="stylesheet" href="">
<script async defer src="https://buttons.github.io/buttons.js"></script>
</head>
<body class="layout small-header">
<div id="stickyNavbarOverlay"></div>
<div class="top-nav">
<div class="inner">
<a id="hamburger" role="button" class="navbar-burger" aria-label="menu" aria-expanded="false">
<span aria-hidden="true"></span>
<span aria-hidden="true"></span>
<span aria-hidden="true"></span>
</a>
<div class="logo">
</div>
<div class="menu">
<div class="navigation">
<a
href="index.html"
class="link"
>
Documentation
</a>
</div>
</div>
</div>
</div>
<div id="main">
<div
class="sidebar "
id="sidebarNav"
>
<nav>
<h2><a href="index.html">Documentation</a></h2><div class="category"><h3>Classes</h3><ul><li><a href="Hanko.html">Hanko</a></li></ul></div><div class="category"><h2>SDK</h2><h3>Classes / Internal</h3><ul><li><a href="Client.html">Client</a></li><li><a href="Headers.html">Headers</a></li><li><a href="HttpClient.html">HttpClient</a></li><li><a href="PasscodeState.html">PasscodeState</a></li><li><a href="PasswordState.html">PasswordState</a></li><li><a href="Response.html">Response</a></li><li><a href="State.html">State</a></li><li><a href="UserState.html">UserState</a></li><li><a href="WebauthnState.html">WebauthnState</a></li></ul><h3>Classes / Clients</h3><ul><li><a href="ConfigClient.html">ConfigClient</a></li><li><a href="EmailClient.html">EmailClient</a></li><li><a href="PasscodeClient.html">PasscodeClient</a></li><li><a href="PasswordClient.html">PasswordClient</a></li><li><a href="ThirdPartyClient.html">ThirdPartyClient</a></li><li><a href="UserClient.html">UserClient</a></li><li><a href="WebauthnClient.html">WebauthnClient</a></li></ul><h3>Classes / Errors</h3><ul><li><a href="ConflictError.html">ConflictError</a></li><li><a href="EmailAddressAlreadyExistsError.html">EmailAddressAlreadyExistsError</a></li><li><a href="HankoError.html">HankoError</a></li><li><a href="InvalidPasscodeError.html">InvalidPasscodeError</a></li><li><a href="InvalidPasswordError.html">InvalidPasswordError</a></li><li><a href="InvalidWebauthnCredentialError.html">InvalidWebauthnCredentialError</a></li><li><a href="MaxNumOfEmailAddressesReachedError.html">MaxNumOfEmailAddressesReachedError</a></li><li><a href="MaxNumOfPasscodeAttemptsReachedError.html">MaxNumOfPasscodeAttemptsReachedError</a></li><li><a href="NotFoundError.html">NotFoundError</a></li><li><a href="PasscodeExpiredError.html">PasscodeExpiredError</a></li><li><a href="RequestTimeoutError.html">RequestTimeoutError</a></li><li><a href="TechnicalError.html">TechnicalError</a></li><li><a href="ThirdPartyError.html">ThirdPartyError</a></li><li><a href="TooManyRequestsError.html">TooManyRequestsError</a></li><li><a href="UnauthorizedError.html">UnauthorizedError</a></li><li><a href="UserVerificationError.html">UserVerificationError</a></li><li><a href="WebauthnRequestCancelledError.html">WebauthnRequestCancelledError</a></li></ul><h3>Classes / Utilities</h3><ul><li><a href="WebauthnSupport.html">WebauthnSupport</a></li></ul><h3>Interfaces / DTO</h3><ul><li><a href="Config.html">Config</a></li><li><a href="Credential.html">Credential</a></li><li><a href="Email.html">Email</a></li><li><a href="EmailConfig.html">EmailConfig</a></li><li><a href="Emails.html">Emails</a></li><li><a href="Identity.html">Identity</a></li><li><a href="Passcode.html">Passcode</a></li><li><a href="PasswordConfig.html">PasswordConfig</a></li><li><a href="User.html">User</a></li><li><a href="UserInfo.html">UserInfo</a></li><li><a href="WebauthnCredential.html">WebauthnCredential</a></li><li><a href="WebauthnCredentials.html">WebauthnCredentials</a></li><li><a href="WebauthnFinalized.html">WebauthnFinalized</a></li><li><a href="WebauthnTransports.html">WebauthnTransports</a></li></ul><h3>Interfaces / Internal</h3><ul><li><a href="LocalStorage.html">LocalStorage</a></li><li><a href="LocalStoragePasscode.html">LocalStoragePasscode</a></li><li><a href="LocalStoragePassword.html">LocalStoragePassword</a></li><li><a href="LocalStorageUser.html">LocalStorageUser</a></li><li><a href="LocalStorageUsers.html">LocalStorageUsers</a></li><li><a href="LocalStorageWebauthn.html">LocalStorageWebauthn</a></li></ul></div>
</nav>
</div>
<div class="core" id="main-content-wrapper">
<div class="content">
<header class="page-title">
<p>Class</p>
<h1>WebauthnState</h1>
</header>
<section>
<header>
<h2><span class="attribs"><span class="type-signature"></span></span>WebauthnState<span class="signature">()</span><span class="type-signature"></span></h2>
<div class="class-description">A class that manages WebAuthn credentials via local storage.</div>
</header>
<article>
<div class="container-overview">
<div class='vertical-section'>
<div class="members">
<div class="member">
<div class=name>
<span class="tag">Constructor</span>
</div>
<h4 class="name" id="WebauthnState">
<a class="href-link" href="#WebauthnState">#</a>
<span class="code-name">
new WebauthnState<span class="signature">()</span><span class="type-signature"></span>
</span>
</h4>
<dl class="details">
<p class="tag-source">
<a href="lib_state_WebauthnState.ts.html" class="button">View Source</a>
<span>
<a href="lib_state_WebauthnState.ts.html">lib/state/WebauthnState.ts</a>, <a href="lib_state_WebauthnState.ts.html#line10">line 10</a>
</span>
</p>
</dl>
</div>
</div>
</div>
</div>
<h3 class="subsection-title">Extends</h3>
<ul>
<li><a href="UserState.html">UserState</a></li>
</ul>
<div class='vertical-section'>
<h1>Members</h1>
<div class="members">
<div class="member">
<span class="method-parameter is-pulled-right">
<label>Type:</label>
<code class="param-type"><a href="LocalStorage.html">LocalStorage</a></code>
</span>
<h4 class="name" id="ls">
<a class="href-link" href="#ls">#</a>
<span class="code-name">
ls
</span>
</h4>
<dl class="details">
<dt class="inherited-from">Inherited From:</dt>
<dd class="inherited-from"><ul class="dummy"><li>
<a href="State.html#ls">State#ls</a>
</li></ul></dd>
<p class="tag-source">
<a href="lib_state_State.ts.html" class="button">View Source</a>
<span>
<a href="lib_state_State.ts.html">lib/state/State.ts</a>, <a href="lib_state_State.ts.html#line23">line 23</a>
</span>
</p>
</dl>
</div>
</div>
</div>
<div class='vertical-section'>
<h1>Methods</h1>
<div class="members">
<div class="member">
<h4 class="name" id="addCredential">
<a class="href-link" href="#addCredential">#</a>
<span class="code-name">
addCredential<span class="signature">(userID, credentialID)</span><span class="type-signature"> &rarr; {<a href="WebauthnState.html">WebauthnState</a>}</span>
</span>
</h4>
<div class="description">
Adds the credential to the list of known credentials.
</div>
<h5>Parameters:</h5>
<div class="table-container">
<table class="params table">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr class="deep-level-0">
<td class="name"><code>userID</code></td>
<td class="type">
<code class="param-type">string</code>
</td>
<td class="description last">The UUID of the user.</td>
</tr>
<tr class="deep-level-0">
<td class="name"><code>credentialID</code></td>
<td class="type">
<code class="param-type">string</code>
</td>
<td class="description last">The WebAuthn credential ID.</td>
</tr>
</tbody>
</table>
</div>
<dl class="details">
<p class="tag-source">
<a href="lib_state_WebauthnState.ts.html" class="button">View Source</a>
<span>
<a href="lib_state_WebauthnState.ts.html">lib/state/WebauthnState.ts</a>, <a href="lib_state_WebauthnState.ts.html#line111">line 111</a>
</span>
</p>
</dl>
<div class='columns method-parameter'>
<div class="column is-2"><label>Returns:</label></div>
<div class="column is-10">
<div class="columns">
<div class='column is-5 has-text-left'>
<label>Type: </label>
<code class="param-type"><a href="WebauthnState.html">WebauthnState</a></code>
</div>
</div>
</div>
</div>
</div>
<div class="member">
<h4 class="name" id="getCredentials">
<a class="href-link" href="#getCredentials">#</a>
<span class="code-name">
getCredentials<span class="signature">(userID)</span><span class="type-signature"> &rarr; {Array.&lt;string>}</span>
</span>
</h4>
<div class="description">
Gets the list of known credentials on the current browser.
</div>
<h5>Parameters:</h5>
<div class="table-container">
<table class="params table">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr class="deep-level-0">
<td class="name"><code>userID</code></td>
<td class="type">
<code class="param-type">string</code>
</td>
<td class="description last">The UUID of the user.</td>
</tr>
</tbody>
</table>
</div>
<dl class="details">
<p class="tag-source">
<a href="lib_state_WebauthnState.ts.html" class="button">View Source</a>
<span>
<a href="lib_state_WebauthnState.ts.html">lib/state/WebauthnState.ts</a>, <a href="lib_state_WebauthnState.ts.html#line102">line 102</a>
</span>
</p>
</dl>
<div class='columns method-parameter'>
<div class="column is-2"><label>Returns:</label></div>
<div class="column is-10">
<div class="columns">
<div class='column is-5 has-text-left'>
<label>Type: </label>
<code class="param-type">Array.&lt;string></code>
</div>
</div>
</div>
</div>
</div>
<div class="member">
<h4 class="name" id="getUserState">
<a class="href-link" href="#getUserState">#</a>
<span class="code-name">
getUserState<span class="signature">(userID)</span><span class="type-signature"> &rarr; {<a href="LocalStorageUser.html">LocalStorageUser</a>}</span>
</span>
</h4>
<div class="description">
Gets the state of the specified user.
</div>
<h5>Parameters:</h5>
<div class="table-container">
<table class="params table">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr class="deep-level-0">
<td class="name"><code>userID</code></td>
<td class="type">
<code class="param-type">string</code>
</td>
<td class="description last">The UUID of the user.</td>
</tr>
</tbody>
</table>
</div>
<dl class="details">
<dt class="tag-overrides">Overrides:</dt>
<dd class="tag-overrides"><ul class="dummy"><li>
<a href="UserState.html#getUserState">UserState#getUserState</a>
</li></ul></dd>
<p class="tag-source">
<a href="lib_state_UserState.ts.html" class="button">View Source</a>
<span>
<a href="lib_state_UserState.ts.html">lib/state/UserState.ts</a>, <a href="lib_state_UserState.ts.html#line25">line 25</a>
</span>
</p>
</dl>
<div class='columns method-parameter'>
<div class="column is-2"><label>Returns:</label></div>
<div class="column is-10">
<div class="columns">
<div class='column is-5 has-text-left'>
<label>Type: </label>
<code class="param-type"><a href="LocalStorageUser.html">LocalStorageUser</a></code>
</div>
</div>
</div>
</div>
</div>
<div class="member">
<h4 class="name" id="matchCredentials">
<a class="href-link" href="#matchCredentials">#</a>
<span class="code-name">
matchCredentials<span class="signature">(userID, match)</span><span class="type-signature"> &rarr; {Array.&lt;<a href="Credential.html">Credential</a>>}</span>
</span>
</h4>
<div class="description">
Returns the intersection between the specified list of credentials and the known credentials stored in
the local storage.
</div>
<h5>Parameters:</h5>
<div class="table-container">
<table class="params table">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr class="deep-level-0">
<td class="name"><code>userID</code></td>
<td class="type">
<code class="param-type">string</code>
</td>
<td class="description last">The UUID of the user.</td>
</tr>
<tr class="deep-level-0">
<td class="name"><code>match</code></td>
<td class="type">
<code class="param-type">Array.&lt;<a href="Credential.html">Credential</a>></code>
</td>
<td class="description last">A list of credential IDs to be matched against the local storage.</td>
</tr>
</tbody>
</table>
</div>
<dl class="details">
<p class="tag-source">
<a href="lib_state_WebauthnState.ts.html" class="button">View Source</a>
<span>
<a href="lib_state_WebauthnState.ts.html">lib/state/WebauthnState.ts</a>, <a href="lib_state_WebauthnState.ts.html#line121">line 121</a>
</span>
</p>
</dl>
<div class='columns method-parameter'>
<div class="column is-2"><label>Returns:</label></div>
<div class="column is-10">
<div class="columns">
<div class='column is-5 has-text-left'>
<label>Type: </label>
<code class="param-type">Array.&lt;<a href="Credential.html">Credential</a>></code>
</div>
</div>
</div>
</div>
</div>
<div class="member">
<h4 class="name" id="read">
<a class="href-link" href="#read">#</a>
<span class="code-name">
read<span class="signature">()</span><span class="type-signature"> &rarr; {<a href="WebauthnState.html">WebauthnState</a>}</span>
</span>
</h4>
<div class="description">
Reads the current state.
</div>
<dl class="details">
<dt class="tag-overrides">Overrides:</dt>
<dd class="tag-overrides"><ul class="dummy"><li>
<a href="UserState.html#read">UserState#read</a>
</li></ul></dd>
<p class="tag-source">
<a href="lib_state_WebauthnState.ts.html" class="button">View Source</a>
<span>
<a href="lib_state_WebauthnState.ts.html">lib/state/WebauthnState.ts</a>, <a href="lib_state_WebauthnState.ts.html#line94">line 94</a>
</span>
</p>
</dl>
<div class='columns method-parameter'>
<div class="column is-2"><label>Returns:</label></div>
<div class="column is-10">
<div class="columns">
<div class='column is-5 has-text-left'>
<label>Type: </label>
<code class="param-type"><a href="WebauthnState.html">WebauthnState</a></code>
</div>
</div>
</div>
</div>
</div>
<div class="member">
<h4 class="name" id="write">
<a class="href-link" href="#write">#</a>
<span class="code-name">
write<span class="signature">()</span><span class="type-signature"> &rarr; {<a href="State.html">State</a>}</span>
</span>
</h4>
<div class="description">
Encodes and writes the data to the local storage.
</div>
<dl class="details">
<dt class="inherited-from">Inherited From:</dt>
<dd class="inherited-from"><ul class="dummy"><li>
<a href="State.html#write">State#write</a>
</li></ul></dd>
<p class="tag-source">
<a href="lib_state_State.ts.html" class="button">View Source</a>
<span>
<a href="lib_state_State.ts.html">lib/state/State.ts</a>, <a href="lib_state_State.ts.html#line49">line 49</a>
</span>
</p>
</dl>
<div class='columns method-parameter'>
<div class="column is-2"><label>Returns:</label></div>
<div class="column is-10">
<div class="columns">
<div class='column is-5 has-text-left'>
<label>Type: </label>
<code class="param-type"><a href="State.html">State</a></code>
</div>
</div>
</div>
</div>
</div>
</div>
</div>
</article>
</section>
</div>
<footer class="footer">
<div class="content has-text-centered">
<p>Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.11</a></p>
<p class="sidebar-created-by">
<a href="https://github.com/SoftwareBrothers/better-docs" target="_blank">BetterDocs theme</a> provided with <i class="fas fa-heart"></i> by
<a href="http://softwarebrothers.co" target="_blank">SoftwareBrothers - JavaScript Development Agency</a>
</p>
</div>
</footer>
</div>
<div id="side-nav" class="side-nav">
</div>
</div>
<script src="scripts/app.min.js"></script>
<script>PR.prettyPrint();</script>
<script src="scripts/linenumber.js"> </script>
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink