Mirroristas/CommunitySolidServer
2
0
Fork 0
mirror of https://github.com/CommunitySolidServer/CommunitySolidServer.git synced 2024-10-03 14:55:10 +00:00
Code Issues Packages Projects Releases Wiki Activity
CommunitySolidServer/docs/classes/identity_storage_expiringadapterfactory.expiringadapter.html
RubenVerborgh 7efe96d24f deploy: fdd1a3732ed7ed422f80819641065c2977f7ea7f
2021-07-30 15:22:58 +00:00

588 lines
36 KiB
HTML
Raw Blame History

<!doctype html>
<html class="default no-js">
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<title>ExpiringAdapter | Community Solid Server - v1.0.0-beta.2</title>
<meta name="description" content="Documentation for Community Solid Server - v1.0.0-beta.2">
<meta name="viewport" content="width=device-width, initial-scale=1">
<link rel="stylesheet" href="../assets/css/main.css">
<script async src="../assets/js/search.js" id="search-script"></script>
</head>
<body>
<header>
<div class="tsd-page-toolbar">
<div class="container">
<div class="table-wrap">
<div class="table-cell" id="tsd-search" data-index="../assets/js/search.json" data-base="..">
<div class="field">
<label for="tsd-search-field" class="tsd-widget search no-caption">Search</label>
<input id="tsd-search-field" type="text" />
</div>
<ul class="results">
<li class="state loading">Preparing search index...</li>
<li class="state failure">The search index is not available</li>
</ul>
<a href="../index.html" class="title">Community Solid Server - v1.0.0-beta.2</a>
</div>
<div class="table-cell" id="tsd-widgets">
<div id="tsd-filter">
<a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a>
<div class="tsd-filter-group">
<div class="tsd-select" id="tsd-filter-visibility">
<span class="tsd-select-label">All</span>
<ul class="tsd-select-list">
<li data-value="public">Public</li>
<li data-value="protected">Public/Protected</li>
<li data-value="private" class="selected">All</li>
</ul>
</div>
<input type="checkbox" id="tsd-filter-inherited" checked />
<label class="tsd-widget" for="tsd-filter-inherited">Inherited</label>
<input type="checkbox" id="tsd-filter-externals" checked />
<label class="tsd-widget" for="tsd-filter-externals">Externals</label>
</div>
</div>
<a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a>
</div>
</div>
</div>
</div>
<div class="tsd-page-title">
<div class="container">
<ul class="tsd-breadcrumb">
<li>
<a href="../modules.html">Community Solid Server - v1.0.0-beta.2</a>
</li>
<li>
<a href="../modules/identity_storage_expiringadapterfactory.html">identity/storage/ExpiringAdapterFactory</a>
</li>
<li>
<a href="identity_storage_expiringadapterfactory.expiringadapter.html">ExpiringAdapter</a>
</li>
</ul>
<h1>Class ExpiringAdapter</h1>
</div>
</div>
</header>
<div class="container container-main">
<div class="row">
<div class="col-8 col-content">
<section class="tsd-panel tsd-comment">
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>An IDP storage adapter that uses an ExpiringStorage
to persist data.</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-hierarchy">
<h3>Hierarchy</h3>
<ul class="tsd-hierarchy">
<li>
<span class="target">ExpiringAdapter</span>
</li>
</ul>
</section>
<section class="tsd-panel">
<h3>Implements</h3>
<ul class="tsd-hierarchy">
<li><span class="tsd-signature-type">Adapter</span></li>
</ul>
</section>
<section class="tsd-panel-group tsd-index-group">
<h2>Index</h2>
<section class="tsd-panel tsd-index-panel">
<div class="tsd-index-content">
<section class="tsd-index-section ">
<h3>Constructors</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-constructor tsd-parent-kind-class"><a href="identity_storage_expiringadapterfactory.expiringadapter.html#constructor" class="tsd-kind-icon">constructor</a></li>
</ul>
</section>
<section class="tsd-index-section tsd-is-private-protected">
<h3>Properties</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-protected"><a href="identity_storage_expiringadapterfactory.expiringadapter.html#logger" class="tsd-kind-icon">logger</a></li>
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><a href="identity_storage_expiringadapterfactory.expiringadapter.html#name" class="tsd-kind-icon">name</a></li>
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><a href="identity_storage_expiringadapterfactory.expiringadapter.html#storage" class="tsd-kind-icon">storage</a></li>
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><a href="identity_storage_expiringadapterfactory.expiringadapter.html#storagename" class="tsd-kind-icon">storage<wbr>Name</a></li>
</ul>
</section>
<section class="tsd-index-section ">
<h3>Methods</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-method tsd-parent-kind-class"><a href="identity_storage_expiringadapterfactory.expiringadapter.html#consume" class="tsd-kind-icon">consume</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="identity_storage_expiringadapterfactory.expiringadapter.html#destroy" class="tsd-kind-icon">destroy</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="identity_storage_expiringadapterfactory.expiringadapter.html#find" class="tsd-kind-icon">find</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="identity_storage_expiringadapterfactory.expiringadapter.html#findbyuid" class="tsd-kind-icon">find<wbr>ByUid</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="identity_storage_expiringadapterfactory.expiringadapter.html#findbyusercode" class="tsd-kind-icon">find<wbr>ByUser<wbr>Code</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-private"><a href="identity_storage_expiringadapterfactory.expiringadapter.html#grantkeyfor" class="tsd-kind-icon">grant<wbr>Key<wbr>For</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-private"><a href="identity_storage_expiringadapterfactory.expiringadapter.html#keyfor" class="tsd-kind-icon">key<wbr>For</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="identity_storage_expiringadapterfactory.expiringadapter.html#revokebygrantid" class="tsd-kind-icon">revoke<wbr>ByGrant<wbr>Id</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-private"><a href="identity_storage_expiringadapterfactory.expiringadapter.html#uidkeyfor" class="tsd-kind-icon">uid<wbr>Key<wbr>For</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="identity_storage_expiringadapterfactory.expiringadapter.html#upsert" class="tsd-kind-icon">upsert</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-private"><a href="identity_storage_expiringadapterfactory.expiringadapter.html#usercodekeyfor" class="tsd-kind-icon">user<wbr>Code<wbr>Key<wbr>For</a></li>
</ul>
</section>
</div>
</section>
</section>
<section class="tsd-panel-group tsd-member-group ">
<h2>Constructors</h2>
<section class="tsd-panel tsd-member tsd-kind-constructor tsd-parent-kind-class">
<a name="constructor" class="tsd-anchor"></a>
<h3>constructor</h3>
<ul class="tsd-signatures tsd-kind-constructor tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">new <wbr>Expiring<wbr>Adapter<span class="tsd-signature-symbol">(</span>name<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, args<span class="tsd-signature-symbol">: </span><a href="../interfaces/identity_storage_expiringadapterfactory.expiringadapterargs.html" class="tsd-signature-type" data-tsd-kind="Interface">ExpiringAdapterArgs</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="identity_storage_expiringadapterfactory.expiringadapter.html" class="tsd-signature-type" data-tsd-kind="Class">ExpiringAdapter</a></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/solid/community-server/blob/fdd1a37/src/identity/storage/ExpiringAdapterFactory.ts#L20">src/identity/storage/ExpiringAdapterFactory.ts:20</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>name: <span class="tsd-signature-type">string</span></h5>
</li>
<li>
<h5>args: <a href="../interfaces/identity_storage_expiringadapterfactory.expiringadapterargs.html" class="tsd-signature-type" data-tsd-kind="Interface">ExpiringAdapterArgs</a></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <a href="identity_storage_expiringadapterfactory.expiringadapter.html" class="tsd-signature-type" data-tsd-kind="Class">ExpiringAdapter</a></h4>
</li>
</ul>
</section>
</section>
<section class="tsd-panel-group tsd-member-group tsd-is-private-protected">
<h2>Properties</h2>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-protected">
<a name="logger" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagProtected">Protected</span> <span class="tsd-flag ts-flagReadonly">Readonly</span> logger</h3>
<div class="tsd-signature tsd-kind-icon">logger<span class="tsd-signature-symbol">:</span> <a href="logging_logger.logger.html" class="tsd-signature-type" data-tsd-kind="Class">Logger</a><span class="tsd-signature-symbol"> = ...</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/solid/community-server/blob/fdd1a37/src/identity/storage/ExpiringAdapterFactory.ts#L16">src/identity/storage/ExpiringAdapterFactory.ts:16</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-private">
<a name="name" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagPrivate">Private</span> <span class="tsd-flag ts-flagReadonly">Readonly</span> name</h3>
<div class="tsd-signature tsd-kind-icon">name<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/solid/community-server/blob/fdd1a37/src/identity/storage/ExpiringAdapterFactory.ts#L19">src/identity/storage/ExpiringAdapterFactory.ts:19</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-private">
<a name="storage" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagPrivate">Private</span> <span class="tsd-flag ts-flagReadonly">Readonly</span> storage</h3>
<div class="tsd-signature tsd-kind-icon">storage<span class="tsd-signature-symbol">:</span> <a href="../interfaces/storage_keyvalue_expiringstorage.expiringstorage.html" class="tsd-signature-type" data-tsd-kind="Interface">ExpiringStorage</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">unknown</span><span class="tsd-signature-symbol">&gt;</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/solid/community-server/blob/fdd1a37/src/identity/storage/ExpiringAdapterFactory.ts#L20">src/identity/storage/ExpiringAdapterFactory.ts:20</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-private">
<a name="storagename" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagPrivate">Private</span> <span class="tsd-flag ts-flagReadonly">Readonly</span> storage<wbr>Name</h3>
<div class="tsd-signature tsd-kind-icon">storage<wbr>Name<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/solid/community-server/blob/fdd1a37/src/identity/storage/ExpiringAdapterFactory.ts#L18">src/identity/storage/ExpiringAdapterFactory.ts:18</a></li>
</ul>
</aside>
</section>
</section>
<section class="tsd-panel-group tsd-member-group ">
<h2>Methods</h2>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
<a name="consume" class="tsd-anchor"></a>
<h3>consume</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">consume<span class="tsd-signature-symbol">(</span>id<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<p>Implementation of Adapter.consume</p>
<ul>
<li>Defined in <a href="https://github.com/solid/community-server/blob/fdd1a37/src/identity/storage/ExpiringAdapterFactory.ts#L106">src/identity/storage/ExpiringAdapterFactory.ts:106</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>id: <span class="tsd-signature-type">string</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
<a name="destroy" class="tsd-anchor"></a>
<h3>destroy</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">destroy<span class="tsd-signature-symbol">(</span>id<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<p>Implementation of Adapter.destroy</p>
<ul>
<li>Defined in <a href="https://github.com/solid/community-server/blob/fdd1a37/src/identity/storage/ExpiringAdapterFactory.ts#L87">src/identity/storage/ExpiringAdapterFactory.ts:87</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>id: <span class="tsd-signature-type">string</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
<a name="find" class="tsd-anchor"></a>
<h3>find</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">find<span class="tsd-signature-symbol">(</span>id<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">AdapterPayload</span><span class="tsd-signature-symbol">&gt;</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<p>Implementation of Adapter.find</p>
<ul>
<li>Defined in <a href="https://github.com/solid/community-server/blob/fdd1a37/src/identity/storage/ExpiringAdapterFactory.ts#L73">src/identity/storage/ExpiringAdapterFactory.ts:73</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>id: <span class="tsd-signature-type">string</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">AdapterPayload</span><span class="tsd-signature-symbol">&gt;</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
<a name="findbyuid" class="tsd-anchor"></a>
<h3>find<wbr>ByUid</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">find<wbr>ByUid<span class="tsd-signature-symbol">(</span>uid<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">AdapterPayload</span><span class="tsd-signature-symbol">&gt;</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<p>Implementation of Adapter.findByUid</p>
<ul>
<li>Defined in <a href="https://github.com/solid/community-server/blob/fdd1a37/src/identity/storage/ExpiringAdapterFactory.ts#L82">src/identity/storage/ExpiringAdapterFactory.ts:82</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>uid: <span class="tsd-signature-type">string</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">AdapterPayload</span><span class="tsd-signature-symbol">&gt;</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
<a name="findbyusercode" class="tsd-anchor"></a>
<h3>find<wbr>ByUser<wbr>Code</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">find<wbr>ByUser<wbr>Code<span class="tsd-signature-symbol">(</span>userCode<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">AdapterPayload</span><span class="tsd-signature-symbol">&gt;</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<p>Implementation of Adapter.findByUserCode</p>
<ul>
<li>Defined in <a href="https://github.com/solid/community-server/blob/fdd1a37/src/identity/storage/ExpiringAdapterFactory.ts#L77">src/identity/storage/ExpiringAdapterFactory.ts:77</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>userCode: <span class="tsd-signature-type">string</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">AdapterPayload</span><span class="tsd-signature-symbol">&gt;</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-private">
<a name="grantkeyfor" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagPrivate">Private</span> grant<wbr>Key<wbr>For</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-private">
<li class="tsd-signature tsd-kind-icon">grant<wbr>Key<wbr>For<span class="tsd-signature-symbol">(</span>id<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/solid/community-server/blob/fdd1a37/src/identity/storage/ExpiringAdapterFactory.ts#L28">src/identity/storage/ExpiringAdapterFactory.ts:28</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>id: <span class="tsd-signature-type">string</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-private">
<a name="keyfor" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagPrivate">Private</span> key<wbr>For</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-private">
<li class="tsd-signature tsd-kind-icon">key<wbr>For<span class="tsd-signature-symbol">(</span>id<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/solid/community-server/blob/fdd1a37/src/identity/storage/ExpiringAdapterFactory.ts#L40">src/identity/storage/ExpiringAdapterFactory.ts:40</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>id: <span class="tsd-signature-type">string</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
<a name="revokebygrantid" class="tsd-anchor"></a>
<h3>revoke<wbr>ByGrant<wbr>Id</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">revoke<wbr>ByGrant<wbr>Id<span class="tsd-signature-symbol">(</span>grantId<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<p>Implementation of Adapter.revokeByGrantId</p>
<ul>
<li>Defined in <a href="https://github.com/solid/community-server/blob/fdd1a37/src/identity/storage/ExpiringAdapterFactory.ts#L91">src/identity/storage/ExpiringAdapterFactory.ts:91</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>grantId: <span class="tsd-signature-type">string</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-private">
<a name="uidkeyfor" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagPrivate">Private</span> uid<wbr>Key<wbr>For</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-private">
<li class="tsd-signature tsd-kind-icon">uid<wbr>Key<wbr>For<span class="tsd-signature-symbol">(</span>uid<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/solid/community-server/blob/fdd1a37/src/identity/storage/ExpiringAdapterFactory.ts#L36">src/identity/storage/ExpiringAdapterFactory.ts:36</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>uid: <span class="tsd-signature-type">string</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
<a name="upsert" class="tsd-anchor"></a>
<h3>upsert</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">upsert<span class="tsd-signature-symbol">(</span>id<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, payload<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">AdapterPayload</span>, expiresIn<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<p>Implementation of Adapter.upsert</p>
<ul>
<li>Defined in <a href="https://github.com/solid/community-server/blob/fdd1a37/src/identity/storage/ExpiringAdapterFactory.ts#L44">src/identity/storage/ExpiringAdapterFactory.ts:44</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>id: <span class="tsd-signature-type">string</span></h5>
</li>
<li>
<h5>payload: <span class="tsd-signature-type">AdapterPayload</span></h5>
</li>
<li>
<h5><span class="tsd-flag ts-flagOptional">Optional</span> expiresIn: <span class="tsd-signature-type">number</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-private">
<a name="usercodekeyfor" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagPrivate">Private</span> user<wbr>Code<wbr>Key<wbr>For</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-private">
<li class="tsd-signature tsd-kind-icon">user<wbr>Code<wbr>Key<wbr>For<span class="tsd-signature-symbol">(</span>userCode<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/solid/community-server/blob/fdd1a37/src/identity/storage/ExpiringAdapterFactory.ts#L32">src/identity/storage/ExpiringAdapterFactory.ts:32</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>userCode: <span class="tsd-signature-type">string</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4>
</li>
</ul>
</section>
</section>
</div>
<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
<nav class="tsd-navigation primary">
<ul>
<li class=" ">
<a href="../modules.html">Modules</a>
</li>
<li class="current tsd-kind-module">
<a href="../modules/identity_storage_expiringadapterfactory.html">identity/storage/<wbr>Expiring<wbr>Adapter<wbr>Factory</a>
</li>
</ul>
</nav>
<nav class="tsd-navigation secondary menu-sticky">
<ul class="before-current">
</ul>
<ul class="current">
<li class="current tsd-kind-class tsd-parent-kind-module">
<a href="identity_storage_expiringadapterfactory.expiringadapter.html" class="tsd-kind-icon">Expiring<wbr>Adapter</a>
<ul>
<li class=" tsd-kind-constructor tsd-parent-kind-class">
<a href="identity_storage_expiringadapterfactory.expiringadapter.html#constructor" class="tsd-kind-icon">constructor</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-class tsd-is-protected">
<a href="identity_storage_expiringadapterfactory.expiringadapter.html#logger" class="tsd-kind-icon">logger</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-class tsd-is-private">
<a href="identity_storage_expiringadapterfactory.expiringadapter.html#name" class="tsd-kind-icon">name</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-class tsd-is-private">
<a href="identity_storage_expiringadapterfactory.expiringadapter.html#storage" class="tsd-kind-icon">storage</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-class tsd-is-private">
<a href="identity_storage_expiringadapterfactory.expiringadapter.html#storagename" class="tsd-kind-icon">storage<wbr>Name</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class">
<a href="identity_storage_expiringadapterfactory.expiringadapter.html#consume" class="tsd-kind-icon">consume</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class">
<a href="identity_storage_expiringadapterfactory.expiringadapter.html#destroy" class="tsd-kind-icon">destroy</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class">
<a href="identity_storage_expiringadapterfactory.expiringadapter.html#find" class="tsd-kind-icon">find</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class">
<a href="identity_storage_expiringadapterfactory.expiringadapter.html#findbyuid" class="tsd-kind-icon">find<wbr>ByUid</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class">
<a href="identity_storage_expiringadapterfactory.expiringadapter.html#findbyusercode" class="tsd-kind-icon">find<wbr>ByUser<wbr>Code</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-private">
<a href="identity_storage_expiringadapterfactory.expiringadapter.html#grantkeyfor" class="tsd-kind-icon">grant<wbr>Key<wbr>For</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-private">
<a href="identity_storage_expiringadapterfactory.expiringadapter.html#keyfor" class="tsd-kind-icon">key<wbr>For</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class">
<a href="identity_storage_expiringadapterfactory.expiringadapter.html#revokebygrantid" class="tsd-kind-icon">revoke<wbr>ByGrant<wbr>Id</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-private">
<a href="identity_storage_expiringadapterfactory.expiringadapter.html#uidkeyfor" class="tsd-kind-icon">uid<wbr>Key<wbr>For</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class">
<a href="identity_storage_expiringadapterfactory.expiringadapter.html#upsert" class="tsd-kind-icon">upsert</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-private">
<a href="identity_storage_expiringadapterfactory.expiringadapter.html#usercodekeyfor" class="tsd-kind-icon">user<wbr>Code<wbr>Key<wbr>For</a>
</li>
</ul>
</li>
</ul>
<ul class="after-current">
<li class=" tsd-kind-class tsd-parent-kind-module">
<a href="identity_storage_expiringadapterfactory.expiringadapterfactory.html" class="tsd-kind-icon">Expiring<wbr>Adapter<wbr>Factory</a>
</li>
<li class=" tsd-kind-interface tsd-parent-kind-module">
<a href="../interfaces/identity_storage_expiringadapterfactory.expiringadapterargs.html" class="tsd-kind-icon">Expiring<wbr>Adapter<wbr>Args</a>
</li>
</ul>
</nav>
</div>
</div>
</div>
<footer>
<div class="container">
<h2>Legend</h2>
<div class="tsd-legend-group">
<ul class="tsd-legend">
<li class="tsd-kind-variable"><span class="tsd-kind-icon">Variable</span></li>
<li class="tsd-kind-function"><span class="tsd-kind-icon">Function</span></li>
<li class="tsd-kind-function tsd-has-type-parameter"><span class="tsd-kind-icon">Function with type parameter</span></li>
<li class="tsd-kind-type-alias"><span class="tsd-kind-icon">Type alias</span></li>
<li class="tsd-kind-type-alias tsd-has-type-parameter"><span class="tsd-kind-icon">Type alias with type parameter</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-class"><span class="tsd-kind-icon">Class</span></li>
<li class="tsd-kind-class tsd-has-type-parameter"><span class="tsd-kind-icon">Class with type parameter</span></li>
<li class="tsd-kind-constructor tsd-parent-kind-class"><span class="tsd-kind-icon">Constructor</span></li>
<li class="tsd-kind-method tsd-parent-kind-class"><span class="tsd-kind-icon">Method</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-interface"><span class="tsd-kind-icon">Interface</span></li>
<li class="tsd-kind-interface tsd-has-type-parameter"><span class="tsd-kind-icon">Interface with type parameter</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private property</span></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private method</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected property</span></li>
</ul>
</div>
</div>
</footer>
<div class="overlay"></div>
<script src="../assets/js/main.js"></script>
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink