This commit is contained in:
RubenVerborgh
2021-07-23 22:06:41 +00:00
parent 8591fda008
commit 9ba53b9d07
531 changed files with 10005 additions and 9931 deletions

View File

@@ -3,8 +3,8 @@
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<title>IdpRenderHandler | Community Solid Server - v1.0.0-beta.0</title>
<meta name="description" content="Documentation for Community Solid Server - v1.0.0-beta.0">
<title>IdpRenderHandler | Community Solid Server - v1.0.0-beta.1</title>
<meta name="description" content="Documentation for Community Solid Server - v1.0.0-beta.1">
<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.0</a>
<a href="../index.html" class="title">Community Solid Server - v1.0.0-beta.1</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.0</a>
<a href="../modules.html">Community Solid Server - v1.0.0-beta.1</a>
</li>
<li>
<a href="../modules/identity_interaction_util_idprenderhandler.html">identity/interaction/util/IdpRenderHandler</a>
@@ -80,7 +80,7 @@
<h3>Hierarchy</h3>
<ul class="tsd-hierarchy">
<li>
<a href="server_util_renderhandler.renderhandler.html" class="tsd-signature-type" data-tsd-kind="Class">RenderHandler</a><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/identity_interaction_util_idprenderhandler.idprenderhandlerprops.html" class="tsd-signature-type" data-tsd-kind="Interface">IdpRenderHandlerProps</a><span class="tsd-signature-symbol">&gt;</span>
<a href="server_util_templatehandler.templatehandler.html" class="tsd-signature-type" data-tsd-kind="Class">TemplateHandler</a><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/identity_interaction_util_idprenderhandler.idprenderhandlerprops.html" class="tsd-signature-type" data-tsd-kind="Interface">IdpRenderHandlerProps</a><span class="tsd-signature-symbol">&gt;</span>
<ul class="tsd-hierarchy">
<li>
<span class="target">IdpRenderHandler</span>
@@ -116,13 +116,25 @@
<a name="constructor" class="tsd-anchor"></a>
<h3>constructor</h3>
<ul class="tsd-signatures tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature tsd-kind-icon">new <wbr>Idp<wbr>Render<wbr>Handler<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="identity_interaction_util_idprenderhandler.idprenderhandler.html" class="tsd-signature-type" data-tsd-kind="Class">IdpRenderHandler</a></li>
<li class="tsd-signature tsd-kind-icon">new <wbr>Idp<wbr>Render<wbr>Handler<span class="tsd-signature-symbol">(</span>templateEngine<span class="tsd-signature-symbol">: </span><a href="../interfaces/util_templates_templateengine.templateengine.html" class="tsd-signature-type" data-tsd-kind="Interface">TemplateEngine</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">Dict</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">&gt;</span>, contentType<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><a href="identity_interaction_util_idprenderhandler.idprenderhandler.html" class="tsd-signature-type" data-tsd-kind="Class">IdpRenderHandler</a></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<p>Inherited from <a href="server_util_renderhandler.renderhandler.html">RenderHandler</a>.<a href="server_util_renderhandler.renderhandler.html#constructor">constructor</a></p>
<p>Inherited from <a href="server_util_templatehandler.templatehandler.html">TemplateHandler</a>.<a href="server_util_templatehandler.templatehandler.html#constructor">constructor</a></p>
<ul>
<li>Defined in <a href="https://github.com/solid/community-server/blob/0be8222/src/server/util/TemplateHandler.ts#L12">src/server/util/TemplateHandler.ts:12</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>templateEngine: <a href="../interfaces/util_templates_templateengine.templateengine.html" class="tsd-signature-type" data-tsd-kind="Interface">TemplateEngine</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">Dict</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">&gt;</span></h5>
</li>
<li>
<h5>contentType: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> = &#x27;text/html&#x27;</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <a href="identity_interaction_util_idprenderhandler.idprenderhandler.html" class="tsd-signature-type" data-tsd-kind="Class">IdpRenderHandler</a></h4>
</li>
</ul>
@@ -134,14 +146,14 @@
<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><span class="tsd-signature-symbol">{ </span>props<span class="tsd-signature-symbol">: </span><a href="../interfaces/identity_interaction_util_idprenderhandler.idprenderhandlerprops.html" class="tsd-signature-type" data-tsd-kind="Interface">IdpRenderHandlerProps</a><span class="tsd-signature-symbol">; </span>response<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">ServerResponse</span><span class="tsd-signature-symbol"> }</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>
<li class="tsd-signature tsd-kind-icon">can<wbr>Handle<span class="tsd-signature-symbol">(</span>input<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">{ </span>contents<span class="tsd-signature-symbol">: </span><a href="../interfaces/identity_interaction_util_idprenderhandler.idprenderhandlerprops.html" class="tsd-signature-type" data-tsd-kind="Interface">IdpRenderHandlerProps</a><span class="tsd-signature-symbol">; </span>response<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">ServerResponse</span><span class="tsd-signature-symbol"> }</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>Inherited from <a href="server_util_renderhandler.renderhandler.html">RenderHandler</a>.<a href="server_util_renderhandler.renderhandler.html#canhandle">canHandle</a></p>
<p>Inherited from <a href="server_util_templatehandler.templatehandler.html">TemplateHandler</a>.<a href="server_util_templatehandler.templatehandler.html#canhandle">canHandle</a></p>
<ul>
<li>Defined in <a href="https://github.com/solid/community-server/blob/d01382d/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/0be8222/src/util/handlers/AsyncHandler.ts#L13">src/util/handlers/AsyncHandler.ts:13</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@@ -153,13 +165,13 @@
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>input: <span class="tsd-signature-symbol">{ </span>props<span class="tsd-signature-symbol">: </span><a href="../interfaces/identity_interaction_util_idprenderhandler.idprenderhandlerprops.html" class="tsd-signature-type" data-tsd-kind="Interface">IdpRenderHandlerProps</a><span class="tsd-signature-symbol">; </span>response<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">ServerResponse</span><span class="tsd-signature-symbol"> }</span></h5>
<h5>input: <span class="tsd-signature-symbol">{ </span>contents<span class="tsd-signature-symbol">: </span><a href="../interfaces/identity_interaction_util_idprenderhandler.idprenderhandlerprops.html" class="tsd-signature-type" data-tsd-kind="Interface">IdpRenderHandlerProps</a><span class="tsd-signature-symbol">; </span>response<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">ServerResponse</span><span class="tsd-signature-symbol"> }</span></h5>
<div class="tsd-comment tsd-typography">
<p>Input data that could potentially be handled.</p>
</div>
<ul class="tsd-parameters">
<li class="tsd-parameter">
<h5>props<span class="tsd-signature-symbol">: </span><a href="../interfaces/identity_interaction_util_idprenderhandler.idprenderhandlerprops.html" class="tsd-signature-type" data-tsd-kind="Interface">IdpRenderHandlerProps</a></h5>
<h5>contents<span class="tsd-signature-symbol">: </span><a href="../interfaces/identity_interaction_util_idprenderhandler.idprenderhandlerprops.html" class="tsd-signature-type" data-tsd-kind="Interface">IdpRenderHandlerProps</a></h5>
</li>
<li class="tsd-parameter">
<h5>response<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">ServerResponse</span></h5>
@@ -174,16 +186,16 @@
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a name="handle" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagAbstract">Abstract</span> handle</h3>
<h3>handle</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature tsd-kind-icon">handle<span class="tsd-signature-symbol">(</span>input<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">{ </span>props<span class="tsd-signature-symbol">: </span><a href="../interfaces/identity_interaction_util_idprenderhandler.idprenderhandlerprops.html" class="tsd-signature-type" data-tsd-kind="Interface">IdpRenderHandlerProps</a><span class="tsd-signature-symbol">; </span>response<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">ServerResponse</span><span class="tsd-signature-symbol"> }</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>
<li class="tsd-signature tsd-kind-icon">handle<span class="tsd-signature-symbol">(</span>__namedParameters<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">{ </span>contents<span class="tsd-signature-symbol">: </span><a href="../interfaces/identity_interaction_util_idprenderhandler.idprenderhandlerprops.html" class="tsd-signature-type" data-tsd-kind="Interface">IdpRenderHandlerProps</a><span class="tsd-signature-symbol">; </span>response<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">ServerResponse</span><span class="tsd-signature-symbol"> }</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>Inherited from <a href="server_util_renderhandler.renderhandler.html">RenderHandler</a>.<a href="server_util_renderhandler.renderhandler.html#handle">handle</a></p>
<p>Inherited from <a href="server_util_templatehandler.templatehandler.html">TemplateHandler</a>.<a href="server_util_templatehandler.templatehandler.html#handle">handle</a></p>
<ul>
<li>Defined in <a href="https://github.com/solid/community-server/blob/d01382d/src/util/handlers/AsyncHandler.ts#L24">src/util/handlers/AsyncHandler.ts:24</a></li>
<li>Defined in <a href="https://github.com/solid/community-server/blob/0be8222/src/server/util/TemplateHandler.ts#L20">src/server/util/TemplateHandler.ts:20</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@@ -195,13 +207,10 @@
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>input: <span class="tsd-signature-symbol">{ </span>props<span class="tsd-signature-symbol">: </span><a href="../interfaces/identity_interaction_util_idprenderhandler.idprenderhandlerprops.html" class="tsd-signature-type" data-tsd-kind="Interface">IdpRenderHandlerProps</a><span class="tsd-signature-symbol">; </span>response<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">ServerResponse</span><span class="tsd-signature-symbol"> }</span></h5>
<div class="tsd-comment tsd-typography">
<p>Input data that needs to be handled.</p>
</div>
<h5>__namedParameters: <span class="tsd-signature-symbol">{ </span>contents<span class="tsd-signature-symbol">: </span><a href="../interfaces/identity_interaction_util_idprenderhandler.idprenderhandlerprops.html" class="tsd-signature-type" data-tsd-kind="Interface">IdpRenderHandlerProps</a><span class="tsd-signature-symbol">; </span>response<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">ServerResponse</span><span class="tsd-signature-symbol"> }</span></h5>
<ul class="tsd-parameters">
<li class="tsd-parameter">
<h5>props<span class="tsd-signature-symbol">: </span><a href="../interfaces/identity_interaction_util_idprenderhandler.idprenderhandlerprops.html" class="tsd-signature-type" data-tsd-kind="Interface">IdpRenderHandlerProps</a></h5>
<h5>contents<span class="tsd-signature-symbol">: </span><a href="../interfaces/identity_interaction_util_idprenderhandler.idprenderhandlerprops.html" class="tsd-signature-type" data-tsd-kind="Interface">IdpRenderHandlerProps</a></h5>
</li>
<li class="tsd-parameter">
<h5>response<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">ServerResponse</span></h5>
@@ -210,7 +219,6 @@
</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>
<p>A promise resolving when the handling is finished. Return value depends on the given type.</p>
</li>
</ul>
</section>
@@ -218,14 +226,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><span class="tsd-signature-symbol">{ </span>props<span class="tsd-signature-symbol">: </span><a href="../interfaces/identity_interaction_util_idprenderhandler.idprenderhandlerprops.html" class="tsd-signature-type" data-tsd-kind="Interface">IdpRenderHandlerProps</a><span class="tsd-signature-symbol">; </span>response<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">ServerResponse</span><span class="tsd-signature-symbol"> }</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>
<li class="tsd-signature tsd-kind-icon">handle<wbr>Safe<span class="tsd-signature-symbol">(</span>input<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">{ </span>contents<span class="tsd-signature-symbol">: </span><a href="../interfaces/identity_interaction_util_idprenderhandler.idprenderhandlerprops.html" class="tsd-signature-type" data-tsd-kind="Interface">IdpRenderHandlerProps</a><span class="tsd-signature-symbol">; </span>response<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">ServerResponse</span><span class="tsd-signature-symbol"> }</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>Inherited from <a href="server_util_renderhandler.renderhandler.html">RenderHandler</a>.<a href="server_util_renderhandler.renderhandler.html#handlesafe">handleSafe</a></p>
<p>Inherited from <a href="server_util_templatehandler.templatehandler.html">TemplateHandler</a>.<a href="server_util_templatehandler.templatehandler.html#handlesafe">handleSafe</a></p>
<ul>
<li>Defined in <a href="https://github.com/solid/community-server/blob/d01382d/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/0be8222/src/util/handlers/AsyncHandler.ts#L35">src/util/handlers/AsyncHandler.ts:35</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@@ -238,13 +246,13 @@
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>input: <span class="tsd-signature-symbol">{ </span>props<span class="tsd-signature-symbol">: </span><a href="../interfaces/identity_interaction_util_idprenderhandler.idprenderhandlerprops.html" class="tsd-signature-type" data-tsd-kind="Interface">IdpRenderHandlerProps</a><span class="tsd-signature-symbol">; </span>response<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">ServerResponse</span><span class="tsd-signature-symbol"> }</span></h5>
<h5>input: <span class="tsd-signature-symbol">{ </span>contents<span class="tsd-signature-symbol">: </span><a href="../interfaces/identity_interaction_util_idprenderhandler.idprenderhandlerprops.html" class="tsd-signature-type" data-tsd-kind="Interface">IdpRenderHandlerProps</a><span class="tsd-signature-symbol">; </span>response<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">ServerResponse</span><span class="tsd-signature-symbol"> }</span></h5>
<div class="tsd-comment tsd-typography">
<p>Input data that will be handled if it can be handled.</p>
</div>
<ul class="tsd-parameters">
<li class="tsd-parameter">
<h5>props<span class="tsd-signature-symbol">: </span><a href="../interfaces/identity_interaction_util_idprenderhandler.idprenderhandlerprops.html" class="tsd-signature-type" data-tsd-kind="Interface">IdpRenderHandlerProps</a></h5>
<h5>contents<span class="tsd-signature-symbol">: </span><a href="../interfaces/identity_interaction_util_idprenderhandler.idprenderhandlerprops.html" class="tsd-signature-type" data-tsd-kind="Interface">IdpRenderHandlerProps</a></h5>
</li>
<li class="tsd-parameter">
<h5>response<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">ServerResponse</span></h5>