CommunitySolidServer/docs/interfaces/index.podhttphandlerargs.html
2021-01-01 15:40:37 +00:00

243 lines
11 KiB
HTML

<!doctype html>
<html class="default no-js">
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<title>PodHttpHandlerArgs | Community Solid Server</title>
<meta name="description" content="Documentation for Community Solid Server">
<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</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</a>
</li>
<li>
<a href="../modules/index.html">index</a>
</li>
<li>
<a href="index.podhttphandlerargs.html">PodHttpHandlerArgs</a>
</li>
</ul>
<h1>Interface PodHttpHandlerArgs</h1>
</div>
</div>
</header>
<div class="container container-main">
<div class="row">
<div class="col-8 col-content">
<section class="tsd-panel tsd-hierarchy">
<h3>Hierarchy</h3>
<ul class="tsd-hierarchy">
<li>
<span class="target">PodHttpHandlerArgs</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>Properties</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="index.podhttphandlerargs.html#agentparser" class="tsd-kind-icon">agent<wbr>Parser</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="index.podhttphandlerargs.html#manager" class="tsd-kind-icon">manager</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="index.podhttphandlerargs.html#requestparser" class="tsd-kind-icon">request<wbr>Parser</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="index.podhttphandlerargs.html#requestpath" class="tsd-kind-icon">request<wbr>Path</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="index.podhttphandlerargs.html#responsewriter" class="tsd-kind-icon">response<wbr>Writer</a></li>
</ul>
</section>
</div>
</section>
</section>
<section class="tsd-panel-group tsd-member-group ">
<h2>Properties</h2>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="agentparser" class="tsd-anchor"></a>
<h3>agent<wbr>Parser</h3>
<div class="tsd-signature tsd-kind-icon">agent<wbr>Parser<span class="tsd-signature-symbol">:</span> <a href="../classes/pods_agent_agentparser.agentparser.html" class="tsd-signature-type" data-tsd-kind="Class">AgentParser</a></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/solid/community-server/blob/49551eb/src/pods/PodManagerHttpHandler.ts#L19">src/pods/PodManagerHttpHandler.ts:19</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Parses the data stream to an Agent.</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="manager" class="tsd-anchor"></a>
<h3>manager</h3>
<div class="tsd-signature tsd-kind-icon">manager<span class="tsd-signature-symbol">:</span> <a href="pods_podmanager.podmanager.html" class="tsd-signature-type" data-tsd-kind="Interface">PodManager</a></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/solid/community-server/blob/49551eb/src/pods/PodManagerHttpHandler.ts#L21">src/pods/PodManagerHttpHandler.ts:21</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Handles the pod management.</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="requestparser" class="tsd-anchor"></a>
<h3>request<wbr>Parser</h3>
<div class="tsd-signature tsd-kind-icon">request<wbr>Parser<span class="tsd-signature-symbol">:</span> <a href="../classes/ldp_http_requestparser.requestparser.html" class="tsd-signature-type" data-tsd-kind="Class">RequestParser</a></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/solid/community-server/blob/49551eb/src/pods/PodManagerHttpHandler.ts#L17">src/pods/PodManagerHttpHandler.ts:17</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Parses the incoming request.</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="requestpath" class="tsd-anchor"></a>
<h3>request<wbr>Path</h3>
<div class="tsd-signature tsd-kind-icon">request<wbr>Path<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/49551eb/src/pods/PodManagerHttpHandler.ts#L15">src/pods/PodManagerHttpHandler.ts:15</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>The path on which this handler should intercept requests. Should start with a slash.</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="responsewriter" class="tsd-anchor"></a>
<h3>response<wbr>Writer</h3>
<div class="tsd-signature tsd-kind-icon">response<wbr>Writer<span class="tsd-signature-symbol">:</span> <a href="../classes/ldp_http_responsewriter.responsewriter.html" class="tsd-signature-type" data-tsd-kind="Class">ResponseWriter</a></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/solid/community-server/blob/49551eb/src/pods/PodManagerHttpHandler.ts#L23">src/pods/PodManagerHttpHandler.ts:23</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Writes the outgoing response.</p>
</div>
</div>
</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">Exports</a>
</li>
<li class="current tsd-kind-module">
<a href="../modules/index.html">index</a>
</li>
</ul>
</nav>
<nav class="tsd-navigation secondary menu-sticky">
<ul class="before-current">
</ul>
<ul class="current">
<li class="current tsd-kind-interface tsd-parent-kind-module">
<a href="index.podhttphandlerargs.html" class="tsd-kind-icon">Pod<wbr>Http<wbr>Handler<wbr>Args</a>
<ul>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="index.podhttphandlerargs.html#agentparser" class="tsd-kind-icon">agent<wbr>Parser</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="index.podhttphandlerargs.html#manager" class="tsd-kind-icon">manager</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="index.podhttphandlerargs.html#requestparser" class="tsd-kind-icon">request<wbr>Parser</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="index.podhttphandlerargs.html#requestpath" class="tsd-kind-icon">request<wbr>Path</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="index.podhttphandlerargs.html#responsewriter" class="tsd-kind-icon">response<wbr>Writer</a>
</li>
</ul>
</li>
</ul>
<ul class="after-current">
</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-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>
<li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</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>
</ul>
</div>
</div>
</footer>
<div class="overlay"></div>
<script src="../assets/js/main.js"></script>
</body>
</html>