mirror of
https://github.com/CommunitySolidServer/CommunitySolidServer.git
synced 2024-10-03 14:55:10 +00:00
507 lines
36 KiB
HTML
507 lines
36 KiB
HTML
<!doctype html>
|
||
<html class="default no-js">
|
||
<head>
|
||
<meta charset="utf-8">
|
||
<meta http-equiv="X-UA-Compatible" content="IE=edge">
|
||
<title>IndexRepresentationStore | Community Solid Server - v1.0.0-beta.2</title>
|
||
<meta name="description" content="Documentation for Community Solid Server - v1.0.0-beta.2">
|
||
<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 - v1.0.0-beta.2</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 - v1.0.0-beta.2</a>
|
||
</li>
|
||
<li>
|
||
<a href="../modules/storage_indexrepresentationstore.html">storage/IndexRepresentationStore</a>
|
||
</li>
|
||
<li>
|
||
<a href="storage_indexrepresentationstore.indexrepresentationstore.html">IndexRepresentationStore</a>
|
||
</li>
|
||
</ul>
|
||
<h1>Class IndexRepresentationStore</h1>
|
||
</div>
|
||
</div>
|
||
</header>
|
||
<div class="container container-main">
|
||
<div class="row">
|
||
<div class="col-8 col-content">
|
||
<section class="tsd-panel tsd-comment">
|
||
<div class="tsd-comment tsd-typography">
|
||
<div class="lead">
|
||
<p>Allow containers to have a custom representation.
|
||
The index representation will be returned when the following conditions are fulfilled:</p>
|
||
<ul>
|
||
<li>The request targets a container.</li>
|
||
<li>A resource with the given <code>indexName</code> exists in the container. (default: "index.html")</li>
|
||
<li>The highest weighted preference matches the <code>mediaRange</code> (default: "text/html")
|
||
Otherwise the request will be passed on to the source store.
|
||
In case the index representation should always be returned when it exists,
|
||
the <code>mediaRange</code> should be set to "*∕*".</li>
|
||
</ul>
|
||
</div>
|
||
<p>Note: this functionality is not yet part of the specification. Relevant issues are:</p>
|
||
<ul>
|
||
<li><a href="https://github.com/solid/specification/issues/69">https://github.com/solid/specification/issues/69</a></li>
|
||
<li><a href="https://github.com/solid/specification/issues/198">https://github.com/solid/specification/issues/198</a></li>
|
||
<li><a href="https://github.com/solid/specification/issues/109">https://github.com/solid/specification/issues/109</a></li>
|
||
<li><a href="https://github.com/solid/web-access-control-spec/issues/36">https://github.com/solid/web-access-control-spec/issues/36</a></li>
|
||
</ul>
|
||
</div>
|
||
</section>
|
||
<section class="tsd-panel tsd-hierarchy">
|
||
<h3>Hierarchy</h3>
|
||
<ul class="tsd-hierarchy">
|
||
<li>
|
||
<a href="storage_passthroughstore.passthroughstore.html" class="tsd-signature-type" data-tsd-kind="Class">PassthroughStore</a>
|
||
<ul class="tsd-hierarchy">
|
||
<li>
|
||
<span class="target">IndexRepresentationStore</span>
|
||
</li>
|
||
</ul>
|
||
</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>Constructors</h3>
|
||
<ul class="tsd-index-list">
|
||
<li class="tsd-kind-constructor tsd-parent-kind-class tsd-is-overwrite"><a href="storage_indexrepresentationstore.indexrepresentationstore.html#constructor" class="tsd-kind-icon">constructor</a></li>
|
||
</ul>
|
||
</section>
|
||
<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="storage_indexrepresentationstore.indexrepresentationstore.html#indexname" class="tsd-kind-icon">index<wbr>Name</a></li>
|
||
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><a href="storage_indexrepresentationstore.indexrepresentationstore.html#mediarange" class="tsd-kind-icon">media<wbr>Range</a></li>
|
||
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-protected"><a href="storage_indexrepresentationstore.indexrepresentationstore.html#source" class="tsd-kind-icon">source</a></li>
|
||
</ul>
|
||
</section>
|
||
<section class="tsd-index-section ">
|
||
<h3>Methods</h3>
|
||
<ul class="tsd-index-list">
|
||
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="storage_indexrepresentationstore.indexrepresentationstore.html#addresource" class="tsd-kind-icon">add<wbr>Resource</a></li>
|
||
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="storage_indexrepresentationstore.indexrepresentationstore.html#deleteresource" class="tsd-kind-icon">delete<wbr>Resource</a></li>
|
||
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-overwrite"><a href="storage_indexrepresentationstore.indexrepresentationstore.html#getrepresentation" class="tsd-kind-icon">get<wbr>Representation</a></li>
|
||
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-private"><a href="storage_indexrepresentationstore.indexrepresentationstore.html#matchespreferences" class="tsd-kind-icon">matches<wbr>Preferences</a></li>
|
||
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="storage_indexrepresentationstore.indexrepresentationstore.html#modifyresource" class="tsd-kind-icon">modify<wbr>Resource</a></li>
|
||
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="storage_indexrepresentationstore.indexrepresentationstore.html#resourceexists" class="tsd-kind-icon">resource<wbr>Exists</a></li>
|
||
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="storage_indexrepresentationstore.indexrepresentationstore.html#setrepresentation" class="tsd-kind-icon">set<wbr>Representation</a></li>
|
||
</ul>
|
||
</section>
|
||
</div>
|
||
</section>
|
||
</section>
|
||
<section class="tsd-panel-group tsd-member-group ">
|
||
<h2>Constructors</h2>
|
||
<section class="tsd-panel tsd-member tsd-kind-constructor tsd-parent-kind-class tsd-is-overwrite">
|
||
<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>Index<wbr>Representation<wbr>Store<span class="tsd-signature-symbol">(</span>source<span class="tsd-signature-symbol">: </span><a href="../interfaces/storage_resourcestore.resourcestore.html" class="tsd-signature-type" data-tsd-kind="Interface">ResourceStore</a>, indexName<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span>, mediaRange<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="storage_indexrepresentationstore.indexrepresentationstore.html" class="tsd-signature-type" data-tsd-kind="Class">IndexRepresentationStore</a></li>
|
||
</ul>
|
||
<ul class="tsd-descriptions">
|
||
<li class="tsd-description">
|
||
<aside class="tsd-sources">
|
||
<p>Overrides <a href="storage_passthroughstore.passthroughstore.html">PassthroughStore</a>.<a href="storage_passthroughstore.passthroughstore.html#constructor">constructor</a></p>
|
||
<ul>
|
||
<li>Defined in <a href="https://github.com/solid/community-server/blob/fdd1a37/src/storage/IndexRepresentationStore.ts#L30">src/storage/IndexRepresentationStore.ts:30</a></li>
|
||
</ul>
|
||
</aside>
|
||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||
<ul class="tsd-parameters">
|
||
<li>
|
||
<h5>source: <a href="../interfaces/storage_resourcestore.resourcestore.html" class="tsd-signature-type" data-tsd-kind="Interface">ResourceStore</a></h5>
|
||
</li>
|
||
<li>
|
||
<h5>indexName: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> = 'index.html'</span></h5>
|
||
</li>
|
||
<li>
|
||
<h5>mediaRange: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> = 'text/html'</span></h5>
|
||
</li>
|
||
</ul>
|
||
<h4 class="tsd-returns-title">Returns <a href="storage_indexrepresentationstore.indexrepresentationstore.html" class="tsd-signature-type" data-tsd-kind="Class">IndexRepresentationStore</a></h4>
|
||
</li>
|
||
</ul>
|
||
</section>
|
||
</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="indexname" class="tsd-anchor"></a>
|
||
<h3><span class="tsd-flag ts-flagPrivate">Private</span> <span class="tsd-flag ts-flagReadonly">Readonly</span> index<wbr>Name</h3>
|
||
<div class="tsd-signature tsd-kind-icon">index<wbr>Name<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/fdd1a37/src/storage/IndexRepresentationStore.ts#L29">src/storage/IndexRepresentationStore.ts:29</a></li>
|
||
</ul>
|
||
</aside>
|
||
</section>
|
||
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-private">
|
||
<a name="mediarange" class="tsd-anchor"></a>
|
||
<h3><span class="tsd-flag ts-flagPrivate">Private</span> <span class="tsd-flag ts-flagReadonly">Readonly</span> media<wbr>Range</h3>
|
||
<div class="tsd-signature tsd-kind-icon">media<wbr>Range<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/fdd1a37/src/storage/IndexRepresentationStore.ts#L30">src/storage/IndexRepresentationStore.ts:30</a></li>
|
||
</ul>
|
||
</aside>
|
||
</section>
|
||
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-protected">
|
||
<a name="source" class="tsd-anchor"></a>
|
||
<h3><span class="tsd-flag ts-flagProtected">Protected</span> <span class="tsd-flag ts-flagReadonly">Readonly</span> source</h3>
|
||
<div class="tsd-signature tsd-kind-icon">source<span class="tsd-signature-symbol">:</span> <a href="../interfaces/storage_resourcestore.resourcestore.html" class="tsd-signature-type" data-tsd-kind="Interface">ResourceStore</a></div>
|
||
<aside class="tsd-sources">
|
||
<p>Inherited from <a href="storage_passthroughstore.passthroughstore.html">PassthroughStore</a>.<a href="storage_passthroughstore.passthroughstore.html#source">source</a></p>
|
||
<ul>
|
||
<li>Defined in <a href="https://github.com/solid/community-server/blob/fdd1a37/src/storage/PassthroughStore.ts#L14">src/storage/PassthroughStore.ts:14</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="addresource" class="tsd-anchor"></a>
|
||
<h3>add<wbr>Resource</h3>
|
||
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
|
||
<li class="tsd-signature tsd-kind-icon">add<wbr>Resource<span class="tsd-signature-symbol">(</span>container<span class="tsd-signature-symbol">: </span><a href="../interfaces/ldp_representation_resourceidentifier.resourceidentifier.html" class="tsd-signature-type" data-tsd-kind="Interface">ResourceIdentifier</a>, representation<span class="tsd-signature-symbol">: </span><a href="../interfaces/ldp_representation_representation.representation.html" class="tsd-signature-type" data-tsd-kind="Interface">Representation</a>, conditions<span class="tsd-signature-symbol">?: </span><a href="../interfaces/storage_conditions.conditions.html" class="tsd-signature-type" data-tsd-kind="Interface">Conditions</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"><</span><a href="../interfaces/ldp_representation_resourceidentifier.resourceidentifier.html" class="tsd-signature-type" data-tsd-kind="Interface">ResourceIdentifier</a><span class="tsd-signature-symbol">></span></li>
|
||
</ul>
|
||
<ul class="tsd-descriptions">
|
||
<li class="tsd-description">
|
||
<aside class="tsd-sources">
|
||
<p>Inherited from <a href="storage_passthroughstore.passthroughstore.html">PassthroughStore</a>.<a href="storage_passthroughstore.passthroughstore.html#addresource">addResource</a></p>
|
||
<ul>
|
||
<li>Defined in <a href="https://github.com/solid/community-server/blob/fdd1a37/src/storage/PassthroughStore.ts#L29">src/storage/PassthroughStore.ts:29</a></li>
|
||
</ul>
|
||
</aside>
|
||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||
<ul class="tsd-parameters">
|
||
<li>
|
||
<h5>container: <a href="../interfaces/ldp_representation_resourceidentifier.resourceidentifier.html" class="tsd-signature-type" data-tsd-kind="Interface">ResourceIdentifier</a></h5>
|
||
</li>
|
||
<li>
|
||
<h5>representation: <a href="../interfaces/ldp_representation_representation.representation.html" class="tsd-signature-type" data-tsd-kind="Interface">Representation</a></h5>
|
||
</li>
|
||
<li>
|
||
<h5><span class="tsd-flag ts-flagOptional">Optional</span> conditions: <a href="../interfaces/storage_conditions.conditions.html" class="tsd-signature-type" data-tsd-kind="Interface">Conditions</a></h5>
|
||
</li>
|
||
</ul>
|
||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/ldp_representation_resourceidentifier.resourceidentifier.html" class="tsd-signature-type" data-tsd-kind="Interface">ResourceIdentifier</a><span class="tsd-signature-symbol">></span></h4>
|
||
</li>
|
||
</ul>
|
||
</section>
|
||
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
|
||
<a name="deleteresource" class="tsd-anchor"></a>
|
||
<h3>delete<wbr>Resource</h3>
|
||
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
|
||
<li class="tsd-signature tsd-kind-icon">delete<wbr>Resource<span class="tsd-signature-symbol">(</span>identifier<span class="tsd-signature-symbol">: </span><a href="../interfaces/ldp_representation_resourceidentifier.resourceidentifier.html" class="tsd-signature-type" data-tsd-kind="Interface">ResourceIdentifier</a>, conditions<span class="tsd-signature-symbol">?: </span><a href="../interfaces/storage_conditions.conditions.html" class="tsd-signature-type" data-tsd-kind="Interface">Conditions</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"><</span><a href="../interfaces/ldp_representation_resourceidentifier.resourceidentifier.html" class="tsd-signature-type" data-tsd-kind="Interface">ResourceIdentifier</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span></li>
|
||
</ul>
|
||
<ul class="tsd-descriptions">
|
||
<li class="tsd-description">
|
||
<aside class="tsd-sources">
|
||
<p>Inherited from <a href="storage_passthroughstore.passthroughstore.html">PassthroughStore</a>.<a href="storage_passthroughstore.passthroughstore.html#deleteresource">deleteResource</a></p>
|
||
<ul>
|
||
<li>Defined in <a href="https://github.com/solid/community-server/blob/fdd1a37/src/storage/PassthroughStore.ts#L34">src/storage/PassthroughStore.ts:34</a></li>
|
||
</ul>
|
||
</aside>
|
||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||
<ul class="tsd-parameters">
|
||
<li>
|
||
<h5>identifier: <a href="../interfaces/ldp_representation_resourceidentifier.resourceidentifier.html" class="tsd-signature-type" data-tsd-kind="Interface">ResourceIdentifier</a></h5>
|
||
</li>
|
||
<li>
|
||
<h5><span class="tsd-flag ts-flagOptional">Optional</span> conditions: <a href="../interfaces/storage_conditions.conditions.html" class="tsd-signature-type" data-tsd-kind="Interface">Conditions</a></h5>
|
||
</li>
|
||
</ul>
|
||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/ldp_representation_resourceidentifier.resourceidentifier.html" class="tsd-signature-type" data-tsd-kind="Interface">ResourceIdentifier</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span></h4>
|
||
</li>
|
||
</ul>
|
||
</section>
|
||
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-overwrite">
|
||
<a name="getrepresentation" class="tsd-anchor"></a>
|
||
<h3>get<wbr>Representation</h3>
|
||
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-overwrite">
|
||
<li class="tsd-signature tsd-kind-icon">get<wbr>Representation<span class="tsd-signature-symbol">(</span>identifier<span class="tsd-signature-symbol">: </span><a href="../interfaces/ldp_representation_resourceidentifier.resourceidentifier.html" class="tsd-signature-type" data-tsd-kind="Interface">ResourceIdentifier</a>, preferences<span class="tsd-signature-symbol">: </span><a href="../interfaces/ldp_representation_representationpreferences.representationpreferences.html" class="tsd-signature-type" data-tsd-kind="Interface">RepresentationPreferences</a>, conditions<span class="tsd-signature-symbol">?: </span><a href="../interfaces/storage_conditions.conditions.html" class="tsd-signature-type" data-tsd-kind="Interface">Conditions</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"><</span><a href="../interfaces/ldp_representation_representation.representation.html" class="tsd-signature-type" data-tsd-kind="Interface">Representation</a><span class="tsd-signature-symbol">></span></li>
|
||
</ul>
|
||
<ul class="tsd-descriptions">
|
||
<li class="tsd-description">
|
||
<aside class="tsd-sources">
|
||
<p>Overrides <a href="storage_passthroughstore.passthroughstore.html">PassthroughStore</a>.<a href="storage_passthroughstore.passthroughstore.html#getrepresentation">getRepresentation</a></p>
|
||
<ul>
|
||
<li>Defined in <a href="https://github.com/solid/community-server/blob/fdd1a37/src/storage/IndexRepresentationStore.ts#L39">src/storage/IndexRepresentationStore.ts:39</a></li>
|
||
</ul>
|
||
</aside>
|
||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||
<ul class="tsd-parameters">
|
||
<li>
|
||
<h5>identifier: <a href="../interfaces/ldp_representation_resourceidentifier.resourceidentifier.html" class="tsd-signature-type" data-tsd-kind="Interface">ResourceIdentifier</a></h5>
|
||
</li>
|
||
<li>
|
||
<h5>preferences: <a href="../interfaces/ldp_representation_representationpreferences.representationpreferences.html" class="tsd-signature-type" data-tsd-kind="Interface">RepresentationPreferences</a></h5>
|
||
</li>
|
||
<li>
|
||
<h5><span class="tsd-flag ts-flagOptional">Optional</span> conditions: <a href="../interfaces/storage_conditions.conditions.html" class="tsd-signature-type" data-tsd-kind="Interface">Conditions</a></h5>
|
||
</li>
|
||
</ul>
|
||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/ldp_representation_representation.representation.html" class="tsd-signature-type" data-tsd-kind="Interface">Representation</a><span class="tsd-signature-symbol">></span></h4>
|
||
</li>
|
||
</ul>
|
||
</section>
|
||
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-private">
|
||
<a name="matchespreferences" class="tsd-anchor"></a>
|
||
<h3><span class="tsd-flag ts-flagPrivate">Private</span> matches<wbr>Preferences</h3>
|
||
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-private">
|
||
<li class="tsd-signature tsd-kind-icon">matches<wbr>Preferences<span class="tsd-signature-symbol">(</span>preferences<span class="tsd-signature-symbol">: </span><a href="../interfaces/ldp_representation_representationpreferences.representationpreferences.html" class="tsd-signature-type" data-tsd-kind="Interface">RepresentationPreferences</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span></li>
|
||
</ul>
|
||
<ul class="tsd-descriptions">
|
||
<li class="tsd-description">
|
||
<aside class="tsd-sources">
|
||
<ul>
|
||
<li>Defined in <a href="https://github.com/solid/community-server/blob/fdd1a37/src/storage/IndexRepresentationStore.ts#L70">src/storage/IndexRepresentationStore.ts:70</a></li>
|
||
</ul>
|
||
</aside>
|
||
<div class="tsd-comment tsd-typography">
|
||
<div class="lead">
|
||
<p>Makes sure the stored media range explicitly matches the highest weight preference.</p>
|
||
</div>
|
||
</div>
|
||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||
<ul class="tsd-parameters">
|
||
<li>
|
||
<h5>preferences: <a href="../interfaces/ldp_representation_representationpreferences.representationpreferences.html" class="tsd-signature-type" data-tsd-kind="Interface">RepresentationPreferences</a></h5>
|
||
</li>
|
||
</ul>
|
||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4>
|
||
</li>
|
||
</ul>
|
||
</section>
|
||
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
|
||
<a name="modifyresource" class="tsd-anchor"></a>
|
||
<h3>modify<wbr>Resource</h3>
|
||
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
|
||
<li class="tsd-signature tsd-kind-icon">modify<wbr>Resource<span class="tsd-signature-symbol">(</span>identifier<span class="tsd-signature-symbol">: </span><a href="../interfaces/ldp_representation_resourceidentifier.resourceidentifier.html" class="tsd-signature-type" data-tsd-kind="Interface">ResourceIdentifier</a>, patch<span class="tsd-signature-symbol">: </span><a href="../interfaces/ldp_http_patch.patch.html" class="tsd-signature-type" data-tsd-kind="Interface">Patch</a>, conditions<span class="tsd-signature-symbol">?: </span><a href="../interfaces/storage_conditions.conditions.html" class="tsd-signature-type" data-tsd-kind="Interface">Conditions</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"><</span><a href="../interfaces/ldp_representation_resourceidentifier.resourceidentifier.html" class="tsd-signature-type" data-tsd-kind="Interface">ResourceIdentifier</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span></li>
|
||
</ul>
|
||
<ul class="tsd-descriptions">
|
||
<li class="tsd-description">
|
||
<aside class="tsd-sources">
|
||
<p>Inherited from <a href="storage_passthroughstore.passthroughstore.html">PassthroughStore</a>.<a href="storage_passthroughstore.passthroughstore.html#modifyresource">modifyResource</a></p>
|
||
<ul>
|
||
<li>Defined in <a href="https://github.com/solid/community-server/blob/fdd1a37/src/storage/PassthroughStore.ts#L39">src/storage/PassthroughStore.ts:39</a></li>
|
||
</ul>
|
||
</aside>
|
||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||
<ul class="tsd-parameters">
|
||
<li>
|
||
<h5>identifier: <a href="../interfaces/ldp_representation_resourceidentifier.resourceidentifier.html" class="tsd-signature-type" data-tsd-kind="Interface">ResourceIdentifier</a></h5>
|
||
</li>
|
||
<li>
|
||
<h5>patch: <a href="../interfaces/ldp_http_patch.patch.html" class="tsd-signature-type" data-tsd-kind="Interface">Patch</a></h5>
|
||
</li>
|
||
<li>
|
||
<h5><span class="tsd-flag ts-flagOptional">Optional</span> conditions: <a href="../interfaces/storage_conditions.conditions.html" class="tsd-signature-type" data-tsd-kind="Interface">Conditions</a></h5>
|
||
</li>
|
||
</ul>
|
||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/ldp_representation_resourceidentifier.resourceidentifier.html" class="tsd-signature-type" data-tsd-kind="Interface">ResourceIdentifier</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span></h4>
|
||
</li>
|
||
</ul>
|
||
</section>
|
||
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
|
||
<a name="resourceexists" class="tsd-anchor"></a>
|
||
<h3>resource<wbr>Exists</h3>
|
||
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
|
||
<li class="tsd-signature tsd-kind-icon">resource<wbr>Exists<span class="tsd-signature-symbol">(</span>identifier<span class="tsd-signature-symbol">: </span><a href="../interfaces/ldp_representation_resourceidentifier.resourceidentifier.html" class="tsd-signature-type" data-tsd-kind="Interface">ResourceIdentifier</a>, conditions<span class="tsd-signature-symbol">?: </span><a href="../interfaces/storage_conditions.conditions.html" class="tsd-signature-type" data-tsd-kind="Interface">Conditions</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"><</span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">></span></li>
|
||
</ul>
|
||
<ul class="tsd-descriptions">
|
||
<li class="tsd-description">
|
||
<aside class="tsd-sources">
|
||
<p>Inherited from <a href="storage_passthroughstore.passthroughstore.html">PassthroughStore</a>.<a href="storage_passthroughstore.passthroughstore.html#resourceexists">resourceExists</a></p>
|
||
<ul>
|
||
<li>Defined in <a href="https://github.com/solid/community-server/blob/fdd1a37/src/storage/PassthroughStore.ts#L20">src/storage/PassthroughStore.ts:20</a></li>
|
||
</ul>
|
||
</aside>
|
||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||
<ul class="tsd-parameters">
|
||
<li>
|
||
<h5>identifier: <a href="../interfaces/ldp_representation_resourceidentifier.resourceidentifier.html" class="tsd-signature-type" data-tsd-kind="Interface">ResourceIdentifier</a></h5>
|
||
</li>
|
||
<li>
|
||
<h5><span class="tsd-flag ts-flagOptional">Optional</span> conditions: <a href="../interfaces/storage_conditions.conditions.html" class="tsd-signature-type" data-tsd-kind="Interface">Conditions</a></h5>
|
||
</li>
|
||
</ul>
|
||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">></span></h4>
|
||
</li>
|
||
</ul>
|
||
</section>
|
||
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
|
||
<a name="setrepresentation" class="tsd-anchor"></a>
|
||
<h3>set<wbr>Representation</h3>
|
||
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
|
||
<li class="tsd-signature tsd-kind-icon">set<wbr>Representation<span class="tsd-signature-symbol">(</span>identifier<span class="tsd-signature-symbol">: </span><a href="../interfaces/ldp_representation_resourceidentifier.resourceidentifier.html" class="tsd-signature-type" data-tsd-kind="Interface">ResourceIdentifier</a>, representation<span class="tsd-signature-symbol">: </span><a href="../interfaces/ldp_representation_representation.representation.html" class="tsd-signature-type" data-tsd-kind="Interface">Representation</a>, conditions<span class="tsd-signature-symbol">?: </span><a href="../interfaces/storage_conditions.conditions.html" class="tsd-signature-type" data-tsd-kind="Interface">Conditions</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"><</span><a href="../interfaces/ldp_representation_resourceidentifier.resourceidentifier.html" class="tsd-signature-type" data-tsd-kind="Interface">ResourceIdentifier</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span></li>
|
||
</ul>
|
||
<ul class="tsd-descriptions">
|
||
<li class="tsd-description">
|
||
<aside class="tsd-sources">
|
||
<p>Inherited from <a href="storage_passthroughstore.passthroughstore.html">PassthroughStore</a>.<a href="storage_passthroughstore.passthroughstore.html#setrepresentation">setRepresentation</a></p>
|
||
<ul>
|
||
<li>Defined in <a href="https://github.com/solid/community-server/blob/fdd1a37/src/storage/PassthroughStore.ts#L44">src/storage/PassthroughStore.ts:44</a></li>
|
||
</ul>
|
||
</aside>
|
||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||
<ul class="tsd-parameters">
|
||
<li>
|
||
<h5>identifier: <a href="../interfaces/ldp_representation_resourceidentifier.resourceidentifier.html" class="tsd-signature-type" data-tsd-kind="Interface">ResourceIdentifier</a></h5>
|
||
</li>
|
||
<li>
|
||
<h5>representation: <a href="../interfaces/ldp_representation_representation.representation.html" class="tsd-signature-type" data-tsd-kind="Interface">Representation</a></h5>
|
||
</li>
|
||
<li>
|
||
<h5><span class="tsd-flag ts-flagOptional">Optional</span> conditions: <a href="../interfaces/storage_conditions.conditions.html" class="tsd-signature-type" data-tsd-kind="Interface">Conditions</a></h5>
|
||
</li>
|
||
</ul>
|
||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/ldp_representation_resourceidentifier.resourceidentifier.html" class="tsd-signature-type" data-tsd-kind="Interface">ResourceIdentifier</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span></h4>
|
||
</li>
|
||
</ul>
|
||
</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">Modules</a>
|
||
</li>
|
||
<li class="current tsd-kind-module">
|
||
<a href="../modules/storage_indexrepresentationstore.html">storage/<wbr>Index<wbr>Representation<wbr>Store</a>
|
||
</li>
|
||
</ul>
|
||
</nav>
|
||
<nav class="tsd-navigation secondary menu-sticky">
|
||
<ul class="before-current">
|
||
</ul>
|
||
<ul class="current">
|
||
<li class="current tsd-kind-class tsd-parent-kind-module">
|
||
<a href="storage_indexrepresentationstore.indexrepresentationstore.html" class="tsd-kind-icon">Index<wbr>Representation<wbr>Store</a>
|
||
<ul>
|
||
<li class=" tsd-kind-constructor tsd-parent-kind-class tsd-is-overwrite">
|
||
<a href="storage_indexrepresentationstore.indexrepresentationstore.html#constructor" class="tsd-kind-icon">constructor</a>
|
||
</li>
|
||
<li class=" tsd-kind-property tsd-parent-kind-class tsd-is-private">
|
||
<a href="storage_indexrepresentationstore.indexrepresentationstore.html#indexname" class="tsd-kind-icon">index<wbr>Name</a>
|
||
</li>
|
||
<li class=" tsd-kind-property tsd-parent-kind-class tsd-is-private">
|
||
<a href="storage_indexrepresentationstore.indexrepresentationstore.html#mediarange" class="tsd-kind-icon">media<wbr>Range</a>
|
||
</li>
|
||
<li class=" tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-protected">
|
||
<a href="storage_indexrepresentationstore.indexrepresentationstore.html#source" class="tsd-kind-icon">source</a>
|
||
</li>
|
||
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
|
||
<a href="storage_indexrepresentationstore.indexrepresentationstore.html#addresource" class="tsd-kind-icon">add<wbr>Resource</a>
|
||
</li>
|
||
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
|
||
<a href="storage_indexrepresentationstore.indexrepresentationstore.html#deleteresource" class="tsd-kind-icon">delete<wbr>Resource</a>
|
||
</li>
|
||
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-overwrite">
|
||
<a href="storage_indexrepresentationstore.indexrepresentationstore.html#getrepresentation" class="tsd-kind-icon">get<wbr>Representation</a>
|
||
</li>
|
||
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-private">
|
||
<a href="storage_indexrepresentationstore.indexrepresentationstore.html#matchespreferences" class="tsd-kind-icon">matches<wbr>Preferences</a>
|
||
</li>
|
||
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
|
||
<a href="storage_indexrepresentationstore.indexrepresentationstore.html#modifyresource" class="tsd-kind-icon">modify<wbr>Resource</a>
|
||
</li>
|
||
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
|
||
<a href="storage_indexrepresentationstore.indexrepresentationstore.html#resourceexists" class="tsd-kind-icon">resource<wbr>Exists</a>
|
||
</li>
|
||
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
|
||
<a href="storage_indexrepresentationstore.indexrepresentationstore.html#setrepresentation" class="tsd-kind-icon">set<wbr>Representation</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-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">
|
||
<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>
|
||
</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-inherited"><span class="tsd-kind-icon">Inherited method</span></li>
|
||
</ul>
|
||
</div>
|
||
</div>
|
||
</footer>
|
||
<div class="overlay"></div>
|
||
<script src="../assets/js/main.js"></script>
|
||
</body>
|
||
</html> |