mirror of
https://github.com/CommunitySolidServer/CommunitySolidServer.git
synced 2024-10-03 14:55:10 +00:00
18 lines
13 KiB
HTML
18 lines
13 KiB
HTML
<!DOCTYPE html><html class="default no-js"><head><meta charSet="utf-8"/><meta http-equiv="X-UA-Compatible" content="IE=edge"/><title>SetupHttpHandlerArgs | Community Solid Server - v2.0.0</title><meta name="description" content="Documentation for Community Solid Server - v2.0.0"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script async src="../assets/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-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget search no-caption">Search</label><input type="text" id="tsd-search-field"/></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 - v2.0.0</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 - v2.0.0</a></li><li><a href="SetupHttpHandlerArgs.html">SetupHttpHandlerArgs</a></li></ul><h1>Interface SetupHttpHandlerArgs</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">SetupHttpHandlerArgs</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="SetupHttpHandlerArgs.html#converter" class="tsd-kind-icon">converter</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="SetupHttpHandlerArgs.html#errorHandler" class="tsd-kind-icon">error<wbr/>Handler</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="SetupHttpHandlerArgs.html#initializer" class="tsd-kind-icon">initializer</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="SetupHttpHandlerArgs.html#registrationManager" class="tsd-kind-icon">registration<wbr/>Manager</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="SetupHttpHandlerArgs.html#responseTemplate" class="tsd-kind-icon">response<wbr/>Template</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="SetupHttpHandlerArgs.html#storage" class="tsd-kind-icon">storage</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="SetupHttpHandlerArgs.html#storageKey" class="tsd-kind-icon">storage<wbr/>Key</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="SetupHttpHandlerArgs.html#viewTemplate" class="tsd-kind-icon">view<wbr/>Template</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="converter" class="tsd-anchor"></a><h3>converter</h3><div class="tsd-signature tsd-kind-icon">converter<span class="tsd-signature-symbol">:</span> <a href="../classes/RepresentationConverter.html" class="tsd-signature-type" data-tsd-kind="Class">RepresentationConverter</a></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/solid/community-server/blob/216788e/src/init/setup/SetupHttpHandler.ts#L52">src/init/setup/SetupHttpHandler.ts:52</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>Used for content negotiation.</p>
|
|
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a name="errorHandler" class="tsd-anchor"></a><h3>error<wbr/>Handler</h3><div class="tsd-signature tsd-kind-icon">error<wbr/>Handler<span class="tsd-signature-symbol">:</span> <a href="../classes/ErrorHandler.html" class="tsd-signature-type" data-tsd-kind="Class">ErrorHandler</a></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/solid/community-server/blob/216788e/src/init/setup/SetupHttpHandler.ts#L72">src/init/setup/SetupHttpHandler.ts:72</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>Used for converting output errors.</p>
|
|
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a name="initializer" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> initializer</h3><div class="tsd-signature tsd-kind-icon">initializer<span class="tsd-signature-symbol">?:</span> <a href="../classes/Initializer.html" class="tsd-signature-type" data-tsd-kind="Class">Initializer</a></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/solid/community-server/blob/216788e/src/init/setup/SetupHttpHandler.ts#L48">src/init/setup/SetupHttpHandler.ts:48</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>Initializer to call in case no registration procedure needs to happen.
|
|
This Initializer should make sure the necessary resources are there so the server can work correctly.</p>
|
|
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a name="registrationManager" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> registration<wbr/>Manager</h3><div class="tsd-signature tsd-kind-icon">registration<wbr/>Manager<span class="tsd-signature-symbol">?:</span> <a href="../classes/RegistrationManager.html" class="tsd-signature-type" data-tsd-kind="Class">RegistrationManager</a></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/solid/community-server/blob/216788e/src/init/setup/SetupHttpHandler.ts#L43">src/init/setup/SetupHttpHandler.ts:43</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>Used for registering a pod during setup.</p>
|
|
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a name="responseTemplate" class="tsd-anchor"></a><h3>response<wbr/>Template</h3><div class="tsd-signature tsd-kind-icon">response<wbr/>Template<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/216788e/src/init/setup/SetupHttpHandler.ts#L68">src/init/setup/SetupHttpHandler.ts:68</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>Template to show when setup was completed successfully.</p>
|
|
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a name="storage" class="tsd-anchor"></a><h3>storage</h3><div class="tsd-signature tsd-kind-icon">storage<span class="tsd-signature-symbol">:</span> <a href="KeyValueStorage.html" class="tsd-signature-type" data-tsd-kind="Interface">KeyValueStorage</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">></span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/solid/community-server/blob/216788e/src/init/setup/SetupHttpHandler.ts#L60">src/init/setup/SetupHttpHandler.ts:60</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>Used to store setup status.</p>
|
|
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a name="storageKey" class="tsd-anchor"></a><h3>storage<wbr/>Key</h3><div class="tsd-signature tsd-kind-icon">storage<wbr/>Key<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/216788e/src/init/setup/SetupHttpHandler.ts#L56">src/init/setup/SetupHttpHandler.ts:56</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>Key that is used to store the boolean in the storage indicating setup is finished.</p>
|
|
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a name="viewTemplate" class="tsd-anchor"></a><h3>view<wbr/>Template</h3><div class="tsd-signature tsd-kind-icon">view<wbr/>Template<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/216788e/src/init/setup/SetupHttpHandler.ts#L64">src/init/setup/SetupHttpHandler.ts:64</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>Template to use for GET requests.</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></ul></nav><nav class="tsd-navigation secondary menu-sticky"><ul><li class="current tsd-kind-interface"><a href="SetupHttpHandlerArgs.html" class="tsd-kind-icon">Setup<wbr/>Http<wbr/>Handler<wbr/>Args</a><ul><li class="tsd-kind-property tsd-parent-kind-interface"><a href="SetupHttpHandlerArgs.html#converter" class="tsd-kind-icon">converter</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="SetupHttpHandlerArgs.html#errorHandler" class="tsd-kind-icon">error<wbr/>Handler</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="SetupHttpHandlerArgs.html#initializer" class="tsd-kind-icon">initializer</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="SetupHttpHandlerArgs.html#registrationManager" class="tsd-kind-icon">registration<wbr/>Manager</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="SetupHttpHandlerArgs.html#responseTemplate" class="tsd-kind-icon">response<wbr/>Template</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="SetupHttpHandlerArgs.html#storage" class="tsd-kind-icon">storage</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="SetupHttpHandlerArgs.html#storageKey" class="tsd-kind-icon">storage<wbr/>Key</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="SetupHttpHandlerArgs.html#viewTemplate" class="tsd-kind-icon">view<wbr/>Template</a></li></ul></li></ul></nav></div></div></div><footer class=""><div class="container"><h2>Legend</h2><div class="tsd-legend-group"><ul class="tsd-legend"><li class="tsd-kind-constructor tsd-parent-kind-class"><span class="tsd-kind-icon">Constructor</span></li><li class="tsd-kind-property tsd-parent-kind-class"><span class="tsd-kind-icon">Property</span></li><li class="tsd-kind-method tsd-parent-kind-class"><span class="tsd-kind-icon">Method</span></li><li class="tsd-kind-accessor tsd-parent-kind-class"><span class="tsd-kind-icon">Accessor</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-property tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited property</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-interface"><span class="tsd-kind-icon">Property</span></li><li class="tsd-kind-method tsd-parent-kind-interface"><span class="tsd-kind-icon">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><li class="tsd-kind-method tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected 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><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-method tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static method</span></li></ul></div><h2>Settings</h2><p>Theme <select id="theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></p></div></footer><div class="overlay"></div><script src="../assets/main.js"></script></body></html> |