mirror of
https://github.com/CommunitySolidServer/CommunitySolidServer.git
synced 2024-10-03 14:55:10 +00:00
deploy: 0be82228bb
This commit is contained in:
RubenVerborgh
@@ -3,8 +3,8 @@
|
||||
<head>
|
||||
<meta charset="utf-8">
|
||||
<meta http-equiv="X-UA-Compatible" content="IE=edge">
|
||||
<title>InitialInteractionHandler | Community Solid Server - v1.0.0-beta.0</title>
|
||||
<meta name="description" content="Documentation for Community Solid Server - v1.0.0-beta.0">
|
||||
<title>InitialInteractionHandler | 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_initialinteractionhandler.html">identity/interaction/util/InitialInteractionHandler</a>
|
||||
@@ -71,15 +71,13 @@
|
||||
<section class="tsd-panel tsd-comment">
|
||||
<div class="tsd-comment tsd-typography">
|
||||
<div class="lead">
|
||||
<p>An <a href="identity_interaction_interactionhttphandler.interactionhttphandler.html">InteractionHttpHandler</a> that redirects requests
|
||||
to a specific <a href="identity_interaction_util_idprenderhandler.idprenderhandler.html">IdpRenderHandler</a> based on their prompt.
|
||||
<p>An <a href="identity_interaction_interactionhttphandler.interactionhttphandler.html">InteractionHttpHandler</a> that redirects requests based on their prompt.
|
||||
A list of possible prompts can be found at <a href="https://openid.net/specs/openid-connect-core-1_0.html#AuthRequest">https://openid.net/specs/openid-connect-core-1_0.html#AuthRequest</a>
|
||||
In case there is no prompt or there is no match in the input map,
|
||||
the <code>default</code> render handler will be used.</p>
|
||||
the <code>default</code> redirect will be used.</p>
|
||||
</div>
|
||||
<p>Specifically, the prompt determines how the server should handle re-authentication and consent.</p>
|
||||
<p>Since this class specifically redirects to render handlers,
|
||||
it is advised to wrap it in a <a href="server_util_routerhandler.routerhandler.html">RouterHandler</a> that only allows GET requests.</p>
|
||||
<p>Specifically, this is used to redirect the client to the correct way to login,
|
||||
such as a login page, or a confirmation page if a login procedure already succeeded previously.</p>
|
||||
</div>
|
||||
</section>
|
||||
<section class="tsd-panel tsd-hierarchy">
|
||||
@@ -108,8 +106,9 @@
|
||||
<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-private"><a href="identity_interaction_util_initialinteractionhandler.initialinteractionhandler.html#baseurl" class="tsd-kind-icon">base<wbr>Url</a></li>
|
||||
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-protected"><a href="identity_interaction_util_initialinteractionhandler.initialinteractionhandler.html#logger" class="tsd-kind-icon">logger</a></li>
|
||||
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><a href="identity_interaction_util_initialinteractionhandler.initialinteractionhandler.html#renderhandlermap" class="tsd-kind-icon">render<wbr>Handler<wbr>Map</a></li>
|
||||
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><a href="identity_interaction_util_initialinteractionhandler.initialinteractionhandler.html#redirectmap" class="tsd-kind-icon">redirect<wbr>Map</a></li>
|
||||
</ul>
|
||||
</section>
|
||||
<section class="tsd-index-section ">
|
||||
@@ -129,20 +128,23 @@
|
||||
<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>Initial<wbr>Interaction<wbr>Handler<span class="tsd-signature-symbol">(</span>renderHandlerMap<span class="tsd-signature-symbol">: </span><a href="../interfaces/identity_interaction_util_initialinteractionhandler.renderhandlermap.html" class="tsd-signature-type" data-tsd-kind="Interface">RenderHandlerMap</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="identity_interaction_util_initialinteractionhandler.initialinteractionhandler.html" class="tsd-signature-type" data-tsd-kind="Class">InitialInteractionHandler</a></li>
|
||||
<li class="tsd-signature tsd-kind-icon">new <wbr>Initial<wbr>Interaction<wbr>Handler<span class="tsd-signature-symbol">(</span>baseUrl<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, redirectMap<span class="tsd-signature-symbol">: </span><a href="../interfaces/identity_interaction_util_initialinteractionhandler.redirectmap.html" class="tsd-signature-type" data-tsd-kind="Interface">RedirectMap</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="identity_interaction_util_initialinteractionhandler.initialinteractionhandler.html" class="tsd-signature-type" data-tsd-kind="Class">InitialInteractionHandler</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/d01382d/src/identity/interaction/util/InitialInteractionHandler.ts#L26">src/identity/interaction/util/InitialInteractionHandler.ts:26</a></li>
|
||||
<li>Defined in <a href="https://github.com/solid/community-server/blob/0be8222/src/identity/interaction/util/InitialInteractionHandler.ts#L24">src/identity/interaction/util/InitialInteractionHandler.ts:24</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||||
<ul class="tsd-parameters">
|
||||
<li>
|
||||
<h5>renderHandlerMap: <a href="../interfaces/identity_interaction_util_initialinteractionhandler.renderhandlermap.html" class="tsd-signature-type" data-tsd-kind="Interface">RenderHandlerMap</a></h5>
|
||||
<h5>baseUrl: <span class="tsd-signature-type">string</span></h5>
|
||||
</li>
|
||||
<li>
|
||||
<h5>redirectMap: <a href="../interfaces/identity_interaction_util_initialinteractionhandler.redirectmap.html" class="tsd-signature-type" data-tsd-kind="Interface">RedirectMap</a></h5>
|
||||
</li>
|
||||
</ul>
|
||||
<h4 class="tsd-returns-title">Returns <a href="identity_interaction_util_initialinteractionhandler.initialinteractionhandler.html" class="tsd-signature-type" data-tsd-kind="Class">InitialInteractionHandler</a></h4>
|
||||
@@ -152,23 +154,33 @@
|
||||
</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-private">
|
||||
<a name="baseurl" class="tsd-anchor"></a>
|
||||
<h3><span class="tsd-flag ts-flagPrivate">Private</span> <span class="tsd-flag ts-flagReadonly">Readonly</span> base<wbr>Url</h3>
|
||||
<div class="tsd-signature tsd-kind-icon">base<wbr>Url<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/0be8222/src/identity/interaction/util/InitialInteractionHandler.ts#L23">src/identity/interaction/util/InitialInteractionHandler.ts:23</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
</section>
|
||||
<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/d01382d/src/identity/interaction/util/InitialInteractionHandler.ts#L24">src/identity/interaction/util/InitialInteractionHandler.ts:24</a></li>
|
||||
<li>Defined in <a href="https://github.com/solid/community-server/blob/0be8222/src/identity/interaction/util/InitialInteractionHandler.ts#L21">src/identity/interaction/util/InitialInteractionHandler.ts:21</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
</section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-private">
|
||||
<a name="renderhandlermap" class="tsd-anchor"></a>
|
||||
<h3><span class="tsd-flag ts-flagPrivate">Private</span> <span class="tsd-flag ts-flagReadonly">Readonly</span> render<wbr>Handler<wbr>Map</h3>
|
||||
<div class="tsd-signature tsd-kind-icon">render<wbr>Handler<wbr>Map<span class="tsd-signature-symbol">:</span> <a href="../interfaces/identity_interaction_util_initialinteractionhandler.renderhandlermap.html" class="tsd-signature-type" data-tsd-kind="Interface">RenderHandlerMap</a></div>
|
||||
<a name="redirectmap" class="tsd-anchor"></a>
|
||||
<h3><span class="tsd-flag ts-flagPrivate">Private</span> <span class="tsd-flag ts-flagReadonly">Readonly</span> redirect<wbr>Map</h3>
|
||||
<div class="tsd-signature tsd-kind-icon">redirect<wbr>Map<span class="tsd-signature-symbol">:</span> <a href="../interfaces/identity_interaction_util_initialinteractionhandler.redirectmap.html" class="tsd-signature-type" data-tsd-kind="Interface">RedirectMap</a></div>
|
||||
<aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/solid/community-server/blob/d01382d/src/identity/interaction/util/InitialInteractionHandler.ts#L26">src/identity/interaction/util/InitialInteractionHandler.ts:26</a></li>
|
||||
<li>Defined in <a href="https://github.com/solid/community-server/blob/0be8222/src/identity/interaction/util/InitialInteractionHandler.ts#L24">src/identity/interaction/util/InitialInteractionHandler.ts:24</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
</section>
|
||||
@@ -186,7 +198,7 @@
|
||||
<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>
|
||||
<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">
|
||||
@@ -220,7 +232,7 @@
|
||||
<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>
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/solid/community-server/blob/d01382d/src/identity/interaction/util/InitialInteractionHandler.ts#L33">src/identity/interaction/util/InitialInteractionHandler.ts:33</a></li>
|
||||
<li>Defined in <a href="https://github.com/solid/community-server/blob/0be8222/src/identity/interaction/util/InitialInteractionHandler.ts#L32">src/identity/interaction/util/InitialInteractionHandler.ts:32</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
@@ -251,7 +263,7 @@
|
||||
<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>
|
||||
<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">
|
||||
@@ -299,11 +311,14 @@
|
||||
<li class=" tsd-kind-constructor tsd-parent-kind-class tsd-is-overwrite">
|
||||
<a href="identity_interaction_util_initialinteractionhandler.initialinteractionhandler.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_util_initialinteractionhandler.initialinteractionhandler.html#baseurl" class="tsd-kind-icon">base<wbr>Url</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-property tsd-parent-kind-class tsd-is-protected">
|
||||
<a href="identity_interaction_util_initialinteractionhandler.initialinteractionhandler.html#logger" class="tsd-kind-icon">logger</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-property tsd-parent-kind-class tsd-is-private">
|
||||
<a href="identity_interaction_util_initialinteractionhandler.initialinteractionhandler.html#renderhandlermap" class="tsd-kind-icon">render<wbr>Handler<wbr>Map</a>
|
||||
<a href="identity_interaction_util_initialinteractionhandler.initialinteractionhandler.html#redirectmap" class="tsd-kind-icon">redirect<wbr>Map</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
|
||||
<a href="identity_interaction_util_initialinteractionhandler.initialinteractionhandler.html#canhandle" class="tsd-kind-icon">can<wbr>Handle</a>
|
||||
@@ -319,7 +334,7 @@
|
||||
</ul>
|
||||
<ul class="after-current">
|
||||
<li class=" tsd-kind-interface tsd-parent-kind-module">
|
||||
<a href="../interfaces/identity_interaction_util_initialinteractionhandler.renderhandlermap.html" class="tsd-kind-icon">Render<wbr>Handler<wbr>Map</a>
|
||||
<a href="../interfaces/identity_interaction_util_initialinteractionhandler.redirectmap.html" class="tsd-kind-icon">Redirect<wbr>Map</a>
|
||||
</li>
|
||||
</ul>
|
||||
</nav>
|
||||
|
||||
Reference in New Issue
Block a user