This commit is contained in:
RubenVerborgh
2021-08-04 15:27:33 +00:00
parent 7efe96d24f
commit 14b9e3ac63
521 changed files with 5584 additions and 6173 deletions

View File

@@ -3,8 +3,8 @@
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<title>SessionHttpHandler | Community Solid Server - v1.0.0-beta.2</title>
<meta name="description" content="Documentation for Community Solid Server - v1.0.0-beta.2">
<title>SessionHttpHandler | Community Solid Server - v1.0.0</title>
<meta name="description" content="Documentation for Community Solid Server - v1.0.0">
<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>
@@ -23,7 +23,7 @@
<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>
<a href="../index.html" class="title">Community Solid Server - v1.0.0</a>
</div>
<div class="table-cell" id="tsd-widgets">
<div id="tsd-filter">
@@ -52,7 +52,7 @@
<div class="container">
<ul class="tsd-breadcrumb">
<li>
<a href="../modules.html">Community Solid Server - v1.0.0-beta.2</a>
<a href="../modules.html">Community Solid Server - v1.0.0</a>
</li>
<li>
<a href="../modules/identity_interaction_sessionhttphandler.html">identity/interaction/SessionHttpHandler</a>
@@ -79,7 +79,7 @@
<h3>Hierarchy</h3>
<ul class="tsd-hierarchy">
<li>
<a href="identity_interaction_interactionhttphandler.interactionhttphandler.html" class="tsd-signature-type" data-tsd-kind="Class">InteractionHttpHandler</a>
<a href="identity_interaction_email_password_handler_interactionhandler.interactionhandler.html" class="tsd-signature-type" data-tsd-kind="Class">InteractionHandler</a>
<ul class="tsd-hierarchy">
<li>
<span class="target">SessionHttpHandler</span>
@@ -92,16 +92,10 @@
<h2>Index</h2>
<section class="tsd-panel tsd-index-panel">
<div class="tsd-index-content">
<section class="tsd-index-section ">
<section class="tsd-index-section tsd-is-inherited">
<h3>Constructors</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-constructor tsd-parent-kind-class tsd-is-overwrite"><a href="identity_interaction_sessionhttphandler.sessionhttphandler.html#constructor" class="tsd-kind-icon">constructor</a></li>
</ul>
</section>
<section class="tsd-index-section tsd-is-private tsd-is-private-protected">
<h3>Properties</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><a href="identity_interaction_sessionhttphandler.sessionhttphandler.html#interactioncompleter" class="tsd-kind-icon">interaction<wbr>Completer</a></li>
<li class="tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited"><a href="identity_interaction_sessionhttphandler.sessionhttphandler.html#constructor" class="tsd-kind-icon">constructor</a></li>
</ul>
</section>
<section class="tsd-index-section ">
@@ -115,60 +109,38 @@
</div>
</section>
</section>
<section class="tsd-panel-group tsd-member-group ">
<section class="tsd-panel-group tsd-member-group tsd-is-inherited">
<h2>Constructors</h2>
<section class="tsd-panel tsd-member tsd-kind-constructor tsd-parent-kind-class tsd-is-overwrite">
<section class="tsd-panel tsd-member tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited">
<a name="constructor" class="tsd-anchor"></a>
<h3>constructor</h3>
<ul class="tsd-signatures tsd-kind-constructor tsd-parent-kind-class tsd-is-overwrite">
<li class="tsd-signature tsd-kind-icon">new <wbr>Session<wbr>Http<wbr>Handler<span class="tsd-signature-symbol">(</span>interactionCompleter<span class="tsd-signature-symbol">: </span><a href="identity_interaction_util_interactioncompleter.interactioncompleter.html" class="tsd-signature-type" data-tsd-kind="Class">InteractionCompleter</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="identity_interaction_sessionhttphandler.sessionhttphandler.html" class="tsd-signature-type" data-tsd-kind="Class">SessionHttpHandler</a></li>
<ul class="tsd-signatures tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature tsd-kind-icon">new <wbr>Session<wbr>Http<wbr>Handler<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="identity_interaction_sessionhttphandler.sessionhttphandler.html" class="tsd-signature-type" data-tsd-kind="Class">SessionHttpHandler</a></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<p>Overrides <a href="identity_interaction_interactionhttphandler.interactionhttphandler.html">InteractionHttpHandler</a>.<a href="identity_interaction_interactionhttphandler.interactionhttphandler.html#constructor">constructor</a></p>
<ul>
<li>Defined in <a href="https://github.com/solid/community-server/blob/fdd1a37/src/identity/interaction/SessionHttpHandler.ts#L10">src/identity/interaction/SessionHttpHandler.ts:10</a></li>
</ul>
<p>Inherited from <a href="identity_interaction_email_password_handler_interactionhandler.interactionhandler.html">InteractionHandler</a>.<a href="identity_interaction_email_password_handler_interactionhandler.interactionhandler.html#constructor">constructor</a></p>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>interactionCompleter: <a href="identity_interaction_util_interactioncompleter.interactioncompleter.html" class="tsd-signature-type" data-tsd-kind="Class">InteractionCompleter</a></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <a href="identity_interaction_sessionhttphandler.sessionhttphandler.html" class="tsd-signature-type" data-tsd-kind="Class">SessionHttpHandler</a></h4>
</li>
</ul>
</section>
</section>
<section class="tsd-panel-group tsd-member-group tsd-is-private tsd-is-private-protected">
<h2>Properties</h2>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-private">
<a name="interactioncompleter" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagPrivate">Private</span> <span class="tsd-flag ts-flagReadonly">Readonly</span> interaction<wbr>Completer</h3>
<div class="tsd-signature tsd-kind-icon">interaction<wbr>Completer<span class="tsd-signature-symbol">:</span> <a href="identity_interaction_util_interactioncompleter.interactioncompleter.html" class="tsd-signature-type" data-tsd-kind="Class">InteractionCompleter</a></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/solid/community-server/blob/fdd1a37/src/identity/interaction/SessionHttpHandler.ts#L10">src/identity/interaction/SessionHttpHandler.ts:10</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 tsd-is-inherited">
<a name="canhandle" class="tsd-anchor"></a>
<h3>can<wbr>Handle</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature tsd-kind-icon">can<wbr>Handle<span class="tsd-signature-symbol">(</span>input<span class="tsd-signature-symbol">: </span><a href="../modules/identity_interaction_interactionhttphandler.html#interactionhttphandlerinput" class="tsd-signature-type" data-tsd-kind="Type alias">InteractionHttpHandlerInput</a><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>
<li class="tsd-signature tsd-kind-icon">can<wbr>Handle<span class="tsd-signature-symbol">(</span>input<span class="tsd-signature-symbol">: </span><a href="../interfaces/identity_interaction_email_password_handler_interactionhandler.interactionhandlerinput.html" class="tsd-signature-type" data-tsd-kind="Interface">InteractionHandlerInput</a><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>Inherited from <a href="identity_interaction_interactionhttphandler.interactionhttphandler.html">InteractionHttpHandler</a>.<a href="identity_interaction_interactionhttphandler.interactionhttphandler.html#canhandle">canHandle</a></p>
<p>Inherited from <a href="identity_interaction_email_password_handler_interactionhandler.interactionhandler.html">InteractionHandler</a>.<a href="identity_interaction_email_password_handler_interactionhandler.interactionhandler.html#canhandle">canHandle</a></p>
<ul>
<li>Defined in <a href="https://github.com/solid/community-server/blob/fdd1a37/src/util/handlers/AsyncHandler.ts#L13">src/util/handlers/AsyncHandler.ts:13</a></li>
<li>Defined in <a href="https://github.com/solid/community-server/blob/ce27b55/src/util/handlers/AsyncHandler.ts#L13">src/util/handlers/AsyncHandler.ts:13</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@@ -180,7 +152,7 @@
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>input: <a href="../modules/identity_interaction_interactionhttphandler.html#interactionhttphandlerinput" class="tsd-signature-type" data-tsd-kind="Type alias">InteractionHttpHandlerInput</a></h5>
<h5>input: <a href="../interfaces/identity_interaction_email_password_handler_interactionhandler.interactionhandlerinput.html" class="tsd-signature-type" data-tsd-kind="Interface">InteractionHandlerInput</a></h5>
<div class="tsd-comment tsd-typography">
<p>Input data that could potentially be handled.</p>
</div>
@@ -195,14 +167,14 @@
<a name="handle" class="tsd-anchor"></a>
<h3>handle</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-overwrite">
<li class="tsd-signature tsd-kind-icon">handle<span class="tsd-signature-symbol">(</span>input<span class="tsd-signature-symbol">: </span><a href="../modules/identity_interaction_interactionhttphandler.html#interactionhttphandlerinput" class="tsd-signature-type" data-tsd-kind="Type alias">InteractionHttpHandlerInput</a><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>
<li class="tsd-signature tsd-kind-icon">handle<span class="tsd-signature-symbol">(</span>__namedParameters<span class="tsd-signature-symbol">: </span><a href="../interfaces/identity_interaction_email_password_handler_interactionhandler.interactionhandlerinput.html" class="tsd-signature-type" data-tsd-kind="Interface">InteractionHandlerInput</a><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><a href="../interfaces/identity_interaction_email_password_handler_interactionhandler.interactioncompleteresult.html" class="tsd-signature-type" data-tsd-kind="Interface">InteractionCompleteResult</a><span class="tsd-signature-symbol">&gt;</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<p>Overrides <a href="identity_interaction_interactionhttphandler.interactionhttphandler.html">InteractionHttpHandler</a>.<a href="identity_interaction_interactionhttphandler.interactionhttphandler.html#handle">handle</a></p>
<p>Overrides <a href="identity_interaction_email_password_handler_interactionhandler.interactionhandler.html">InteractionHandler</a>.<a href="identity_interaction_email_password_handler_interactionhandler.interactionhandler.html#handle">handle</a></p>
<ul>
<li>Defined in <a href="https://github.com/solid/community-server/blob/fdd1a37/src/identity/interaction/SessionHttpHandler.ts#L17">src/identity/interaction/SessionHttpHandler.ts:17</a></li>
<li>Defined in <a href="https://github.com/solid/community-server/blob/ce27b55/src/identity/interaction/SessionHttpHandler.ts#L9">src/identity/interaction/SessionHttpHandler.ts:9</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@@ -214,10 +186,10 @@
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>input: <a href="../modules/identity_interaction_interactionhttphandler.html#interactionhttphandlerinput" class="tsd-signature-type" data-tsd-kind="Type alias">InteractionHttpHandlerInput</a></h5>
<h5>__namedParameters: <a href="../interfaces/identity_interaction_email_password_handler_interactionhandler.interactionhandlerinput.html" class="tsd-signature-type" data-tsd-kind="Interface">InteractionHandlerInput</a></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>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/identity_interaction_email_password_handler_interactionhandler.interactioncompleteresult.html" class="tsd-signature-type" data-tsd-kind="Interface">InteractionCompleteResult</a><span class="tsd-signature-symbol">&gt;</span></h4>
<p>A promise resolving when the handling is finished. Return value depends on the given type.</p>
</li>
</ul>
@@ -226,14 +198,14 @@
<a name="handlesafe" class="tsd-anchor"></a>
<h3>handle<wbr>Safe</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature tsd-kind-icon">handle<wbr>Safe<span class="tsd-signature-symbol">(</span>input<span class="tsd-signature-symbol">: </span><a href="../modules/identity_interaction_interactionhttphandler.html#interactionhttphandlerinput" class="tsd-signature-type" data-tsd-kind="Type alias">InteractionHttpHandlerInput</a><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>
<li class="tsd-signature tsd-kind-icon">handle<wbr>Safe<span class="tsd-signature-symbol">(</span>input<span class="tsd-signature-symbol">: </span><a href="../interfaces/identity_interaction_email_password_handler_interactionhandler.interactionhandlerinput.html" class="tsd-signature-type" data-tsd-kind="Interface">InteractionHandlerInput</a><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><a href="../modules/identity_interaction_email_password_handler_interactionhandler.html#interactionhandlerresult" class="tsd-signature-type" data-tsd-kind="Type alias">InteractionHandlerResult</a><span class="tsd-signature-symbol">&gt;</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<p>Inherited from <a href="identity_interaction_interactionhttphandler.interactionhttphandler.html">InteractionHttpHandler</a>.<a href="identity_interaction_interactionhttphandler.interactionhttphandler.html#handlesafe">handleSafe</a></p>
<p>Inherited from <a href="identity_interaction_email_password_handler_interactionhandler.interactionhandler.html">InteractionHandler</a>.<a href="identity_interaction_email_password_handler_interactionhandler.interactionhandler.html#handlesafe">handleSafe</a></p>
<ul>
<li>Defined in <a href="https://github.com/solid/community-server/blob/fdd1a37/src/util/handlers/AsyncHandler.ts#L35">src/util/handlers/AsyncHandler.ts:35</a></li>
<li>Defined in <a href="https://github.com/solid/community-server/blob/ce27b55/src/util/handlers/AsyncHandler.ts#L35">src/util/handlers/AsyncHandler.ts:35</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@@ -246,13 +218,13 @@
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>input: <a href="../modules/identity_interaction_interactionhttphandler.html#interactionhttphandlerinput" class="tsd-signature-type" data-tsd-kind="Type alias">InteractionHttpHandlerInput</a></h5>
<h5>input: <a href="../interfaces/identity_interaction_email_password_handler_interactionhandler.interactionhandlerinput.html" class="tsd-signature-type" data-tsd-kind="Interface">InteractionHandlerInput</a></h5>
<div class="tsd-comment tsd-typography">
<p>Input data that will be handled if it can be handled.</p>
</div>
</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>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../modules/identity_interaction_email_password_handler_interactionhandler.html#interactionhandlerresult" class="tsd-signature-type" data-tsd-kind="Type alias">InteractionHandlerResult</a><span class="tsd-signature-symbol">&gt;</span></h4>
<p>A promise resolving if the input can be handled, rejecting with an Error if not.
Return value depends on the given type.</p>
</li>
@@ -278,12 +250,9 @@
<li class="current tsd-kind-class tsd-parent-kind-module">
<a href="identity_interaction_sessionhttphandler.sessionhttphandler.html" class="tsd-kind-icon">Session<wbr>Http<wbr>Handler</a>
<ul>
<li class=" tsd-kind-constructor tsd-parent-kind-class tsd-is-overwrite">
<li class=" tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited">
<a href="identity_interaction_sessionhttphandler.sessionhttphandler.html#constructor" class="tsd-kind-icon">constructor</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-class tsd-is-private">
<a href="identity_interaction_sessionhttphandler.sessionhttphandler.html#interactioncompleter" class="tsd-kind-icon">interaction<wbr>Completer</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a href="identity_interaction_sessionhttphandler.sessionhttphandler.html#canhandle" class="tsd-kind-icon">can<wbr>Handle</a>
</li>
@@ -316,7 +285,6 @@
<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">
@@ -324,11 +292,9 @@
<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-constructor tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited constructor</span></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited method</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>
</ul>
</div>
</div>
</footer>